x1000: bootloader: add screenshot function

Screenshots of the recovery menu will be useful for documentation.

This can be disabled by turning off HAVE_BOOTLOADER_SCREENDUMP in
the target config file if the bootloader should ever run up against
max size limits.

Change-Id: I62ec1e465df2ca7a8a0e78625d88b31f6c4ef078

bootloader/x1000/gui.c

@@ -122,10 +122,17 @@ void splashf(long delay, const char* msg, ...)
 int get_button(int timeout)
 {
     int btn = button_get_w_tmo(timeout);
-    if(btn == SYS_USB_CONNECTED)
+    switch(btn) {
-        is_usb_connected = true;
+    case SYS_USB_CONNECTED:
-    else if(btn == SYS_USB_DISCONNECTED)
+    case SYS_USB_DISCONNECTED:
-        is_usb_connected = false;
+        is_usb_connected = (btn == SYS_USB_CONNECTED);
+        break;
+#ifdef HAVE_SCREENDUMP
+    case BL_SCREENSHOT:
+        screenshot();
+        break;
+#endif
+    }
 
     return btn;
 }

bootloader/x1000/recovery.c

@@ -65,6 +65,9 @@ static const struct menuitem recovery_items[] = {
 
 static const struct menuitem debug_menu_items[] = {
     {MENUITEM_HEADING,  "Debug tools",              NULL},
+#ifdef HAVE_SCREENDUMP
+    {MENUITEM_ACTION,       "Enable screenshots",   &screenshot_enable},
+#endif
 #ifdef OF_PLAYER_ADDR
     {MENUITEM_ACTION,       "Dump OF player",       &dump_of_player},
 #endif

bootloader/x1000/utils.c

@@ -29,6 +29,7 @@
 #include "rb-loader.h"
 #include "loader_strerror.h"
 #include "linuxboot.h"
+#include "screendump.h"
 #include "nand-x1000.h"
 
 /* Set to true if a SYS_USB_CONNECTED event is seen
@@ -37,6 +38,8 @@
  * TODO: this is an ugly kludge */
 bool is_usb_connected = false;
 
+static bool screenshot_enabled = false;
+
 /* this is both incorrect and incredibly racy... */
 int check_disk(bool wait)
 {
@@ -75,6 +78,25 @@ void usb_mode(void)
     splashf(3*HZ, "USB disconnected");
 }
 
+void screenshot(void)
+{
+#ifdef HAVE_SCREENDUMP
+    if(!screenshot_enabled || check_disk(false) != DISK_PRESENT)
+        return;
+
+    screen_dump();
+#endif
+}
+
+void screenshot_enable(void)
+{
+#ifdef HAVE_SCREENDUMP
+    splashf(3*HZ, "Screenshots enabled\nPress %s for screenshot",
+            BL_SCREENSHOT_NAME);
+    screenshot_enabled = true;
+#endif
+}
+
 int load_rockbox(const char* filename, size_t* sizep)
 {
     if(check_disk(true) != DISK_PRESENT)

bootloader/x1000/x1000bootloader.h

@@ -36,10 +36,12 @@ struct uimage_header;
 # define BL_DOWN            BUTTON_VOL_DOWN
 # define BL_SELECT          BUTTON_PLAY
 # define BL_QUIT            BUTTON_POWER
+# define BL_SCREENSHOT_NAME BUTTON_MENU
 # define BL_UP_NAME         "VOL+"
 # define BL_DOWN_NAME       "VOL-"
 # define BL_SELECT_NAME     "PLAY"
 # define BL_QUIT_NAME       "POWER"
+# define BL_SCREENSHOT_NAME "MENU"
 # define BOOTBACKUP_FILE    "/fiiom3k-boot.bin"
 # define OF_PLAYER_NAME     "FiiO player"
 # define OF_PLAYER_ADDR     0x20000
@@ -63,10 +65,12 @@ struct uimage_header;
 # define BL_DOWN            BUTTON_NEXT
 # define BL_SELECT          BUTTON_PLAY
 # define BL_QUIT            BUTTON_POWER
+# define BL_SCREENSHOT      BUTTON_TOPLEFT
 # define BL_UP_NAME         "PREV"
 # define BL_DOWN_NAME       "NEXT"
 # define BL_SELECT_NAME     "PLAY"
 # define BL_QUIT_NAME       "POWER"
+# define BL_SCREENSHOT_NAME "TOPLEFT"
 # define BOOTBACKUP_FILE    "/shanlingq1-boot.bin"
 # define OF_PLAYER_NAME     "Shanling player"
 # define OF_PLAYER_ADDR     0x140000
@@ -84,10 +88,12 @@ struct uimage_header;
 # define BL_DOWN            BUTTON_SCROLL_FWD
 # define BL_SELECT          BUTTON_PLAY
 # define BL_QUIT            BUTTON_POWER
+# define BL_SCREENSHOT      BUTTON_MENU
 # define BL_UP_NAME         "Up"
 # define BL_DOWN_NAME       "Scroll Down"
 # define BL_SELECT_NAME     "PLAY"
 # define BL_QUIT_NAME       "POWER"
+# define BL_SCREENSHOT_NAME "MENU"
 # define BOOTBACKUP_FILE    "/erosqnative-boot.bin"
 #else
 # error "Missing keymap!"
@@ -160,6 +166,8 @@ enum {
 
 int check_disk(bool wait);
 void usb_mode(void);
+void screenshot(void);
+void screenshot_enable(void);
 
 int load_rockbox(const char* filename, size_t* sizep);
 int load_uimage_file(const char* filename,

firmware/export/config/erosqnative.h

@@ -136,3 +136,4 @@
 #define HAVE_TAGCACHE
 #define HAVE_QUICKSCREEN
 #define HAVE_HOTKEY
+#define HAVE_BOOTLOADER_SCREENDUMP

firmware/export/config/fiiom3k.h

@@ -144,3 +144,4 @@
 #define HAVE_HOTKEY
 #define HAVE_LOCKED_ACTIONS
 #define AB_REPEAT_ENABLE
+#define HAVE_BOOTLOADER_SCREENDUMP

firmware/export/config/shanlingq1.h

@@ -128,3 +128,4 @@
 #define HAVE_QUICKSCREEN
 #define HAVE_HOTKEY
 #define AB_REPEAT_ENABLE
+#define HAVE_BOOTLOADER_SCREENDUMP