Home | History | Annotate | Download | only in recovery
      1 /*
      2  * Copyright (C) 2007 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef RECOVERY_COMMON_H
     18 #define RECOVERY_COMMON_H
     19 
     20 #include <stdio.h>
     21 
     22 // Initialize the graphics system.
     23 void ui_init();
     24 
     25 // Use KEY_* codes from <linux/input.h> or KEY_DREAM_* from "minui/minui.h".
     26 int ui_wait_key();            // waits for a key/button press, returns the code
     27 int ui_key_pressed(int key);  // returns >0 if the code is currently pressed
     28 int ui_text_visible();        // returns >0 if text log is currently visible
     29 void ui_show_text(int visible);
     30 void ui_clear_key_queue();
     31 
     32 // Write a message to the on-screen log shown with Alt-L (also to stderr).
     33 // The screen is small, and users may need to report these messages to support,
     34 // so keep the output short and not too cryptic.
     35 void ui_print(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
     36 
     37 // Display some header text followed by a menu of items, which appears
     38 // at the top of the screen (in place of any scrolling ui_print()
     39 // output, if necessary).
     40 void ui_start_menu(char** headers, char** items, int initial_selection);
     41 // Set the menu highlight to the given index, and return it (capped to
     42 // the range [0..numitems).
     43 int ui_menu_select(int sel);
     44 // End menu mode, resetting the text overlay so that ui_print()
     45 // statements will be displayed.
     46 void ui_end_menu();
     47 
     48 // Set the icon (normally the only thing visible besides the progress bar).
     49 enum {
     50   BACKGROUND_ICON_NONE,
     51   BACKGROUND_ICON_INSTALLING,
     52   BACKGROUND_ICON_ERROR,
     53   NUM_BACKGROUND_ICONS
     54 };
     55 void ui_set_background(int icon);
     56 
     57 // Show a progress bar and define the scope of the next operation:
     58 //   portion - fraction of the progress bar the next operation will use
     59 //   seconds - expected time interval (progress bar moves at this minimum rate)
     60 void ui_show_progress(float portion, int seconds);
     61 void ui_set_progress(float fraction);  // 0.0 - 1.0 within the defined scope
     62 
     63 // Default allocation of progress bar segments to operations
     64 static const int VERIFICATION_PROGRESS_TIME = 60;
     65 static const float VERIFICATION_PROGRESS_FRACTION = 0.25;
     66 static const float DEFAULT_FILES_PROGRESS_FRACTION = 0.4;
     67 static const float DEFAULT_IMAGE_PROGRESS_FRACTION = 0.1;
     68 
     69 // Show a rotating "barberpole" for ongoing operations.  Updates automatically.
     70 void ui_show_indeterminate_progress();
     71 
     72 // Hide and reset the progress bar.
     73 void ui_reset_progress();
     74 
     75 #define LOGE(...) ui_print("E:" __VA_ARGS__)
     76 #define LOGW(...) fprintf(stdout, "W:" __VA_ARGS__)
     77 #define LOGI(...) fprintf(stdout, "I:" __VA_ARGS__)
     78 
     79 #if 0
     80 #define LOGV(...) fprintf(stdout, "V:" __VA_ARGS__)
     81 #define LOGD(...) fprintf(stdout, "D:" __VA_ARGS__)
     82 #else
     83 #define LOGV(...) do {} while (0)
     84 #define LOGD(...) do {} while (0)
     85 #endif
     86 
     87 #define STRINGIFY(x) #x
     88 #define EXPAND(x) STRINGIFY(x)
     89 
     90 typedef struct {
     91     const char* mount_point;  // eg. "/cache".  must live in the root directory.
     92 
     93     const char* fs_type;      // "yaffs2" or "ext4" or "vfat"
     94 
     95     const char* device;       // MTD partition name if fs_type == "yaffs"
     96                               // block device if fs_type == "ext4" or "vfat"
     97 
     98     const char* device2;      // alternative device to try if fs_type
     99                               // == "ext4" or "vfat" and mounting
    100                               // 'device' fails
    101 } Volume;
    102 
    103 #endif  // RECOVERY_COMMON_H
    104