Add missing descriptions for display settings, mirror various HAVE_* defines in the platform files and let the display settings be included based on those, lots of minor tweaks

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@15471 a1c6a512-1295-4272-9138-f99709370657

manual/configure_rockbox/display_options.tex

@@ -6,23 +6,29 @@
   \item[LCD Settings:]
     This sub menu contains settings that relate to the display of the \dap.
     \begin{description}
-    \nopt{ondiofm,ondiosp}{
+    \opt{HAVE_BACKLIGHT}{
       \item[Backlight:]
       The amount of time the backlight shines after a key press. If set to
       \setting{Off}, the backlight will not light when a button is pressed. If
       set to \setting{On}, the backlight will never shut off. If set to a time
       (1 to 90 seconds), the backlight will stay lit for that amount of time
       after a button press.
-      \item[Backlight on When Plugged:]
-      This setting is equivalent to the Backlight setting except it applies when
-      the \dap\ is plugged into the charger. 
+      \item[Backlight (While Plugged In):]
+      This setting is equivalent to the \setting{Backlight} setting except it
+      applies when the \dap{} is plugged into the charger.
+      \item[Backlight on Hold:]
+      This setting controls the behavior of the backlight when the Hold switch
+      is toggled. If set to \setting{Normal} the backlight will behave as usual.
+      If set to \setting{Off} the backlight will be turned off immediately when
+      the Hold switch is engaged and if set to \setting{On} the backlight will
+      be turned on and stay on while the Hold switch is engaged.
       \item[Caption Backlight:]
       This option turns on the backlight a number of seconds before the start
       of a new track, and keeps it on for the same number of seconds after the
       beginning so that the display can be read to see song information. The
       amount of time is determined by the value of the backlight timeout
       setting, but is no less than 5 seconds.
-      \opt{h1xx,ipodmini,ipodnano,ipodvideo}{
+      \opt{HAVE_BACKLIGHT_PWM_FADING}{
         \item[Backlight fade in:]
         The amount of time that the backlight will take to fade from off to on
         after a button is pressed. If set to \setting{Off} the backlight will
@@ -39,34 +45,39 @@
       With this option enabled the first keypress while the backlight is turned
       off will only turn the backlight on without having any other effect. When
       disabled the first keypress will \emph{also} perform its appropriate action.
-      \opt{h300,x5}{
+      
+      \opt{HAVE_LCD_SLEEP}{
+        \item[Sleep (After Backlight Off):]
+        This setting controls how long rockbox will wait before turning off the
+        display after the backlight is turned off. Turning off the display
+        saves a little bit of battery power but turning on the display takes
+        noticeably longer than just turning on the backlight.
+      }
+      
+      \opt{HAVE_BACKLIGHT_BRIGHTNESS}{
         \item[Brightness:]
         Changes the brightness of your LCD display.
       }
-    } % \nopt{ondiofm,ondiosp}
+    } % \opt{HAVE_BACKLIGHT}
     
     \opt{archos,h1xx,ipodmini,ipod3g,ipod4g,x5}{
       \item[Contrast:]
       Changes the contrast of your LCD display.
       \warn{Setting the contrast too dark or too light can make it hard to
         find this menu option again!}
-      \nopt{HAVE_LCD_COLOR,player}{
-        \item[LCD Mode:]
-        This setting lets you invert the whole screen, so now you get a
-        black background and light text and graphics.
-      } % \opt{HAVE_LCD_BITMAP}
     } % \opt{archos,h1xx,ipodmini,ipod4g,x5}
-    
-    \opt{HAVE_LCD_BITMAP}{
-      \nopt{ipodcolor,ipodnano,ipodvideo}{
-        \item[Upside Down:]
-        Displays the screen so that the top of the display is nearest the buttons.
-        This is sometimes useful when carrying the \dap\ in a pocket for easy
-        access to the headphone socket.
-      } % \nopt{ipodcolor,ipodnano.ipodvideo}
 
-      
-    } % \opt{HAVE_LCD_BITMAP}
+    \opt{HAVE_LCD_INVERT}{
+      \item[LCD Mode:]
+      This setting lets you invert the colours of the display.
+    }
+
+    \opt{HAVE_LCD_FLIP}{
+      \item[Upside Down:]
+      Displays the screen so that the top of the display is nearest the buttons.
+      This is sometimes useful when carrying the \dap{} in a pocket for easy
+      access to the headphone socket.
+    }
     \end{description}
 %
   \opt{HAVE_REMOTE_LCD}{

manual/platform/c200.tex

@@ -2,10 +2,13 @@
 \def\UseOption{c200}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,SANSA_C200_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
 \edef\UseOption{\UseOption,sansa}
 
 \newcommand{\playerman}{Sansa}

manual/platform/e200.tex

@@ -2,12 +2,17 @@
 \def\UseOption{e200}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
+\edef\UseOption{\UseOption,HAVE_LCD_SLEEP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,SANSA_E200_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
 \edef\UseOption{\UseOption,sansa}
 
 \newcommand{\playerman}{Sansa}

manual/platform/gigabeatf.tex

@@ -6,6 +6,8 @@
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,GIGABEAT_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
 \edef\UseOption{\UseOption,gigabeat}
 
 \newcommand{\playerman}{Toshiba}

manual/platform/h10.tex

@@ -2,10 +2,14 @@
 \def\UseOption{h10}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
+\edef\UseOption{\UseOption,HAVE_LCD_SLEEP}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IRIVER_H10_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,iriver}
 
 \newcommand{\playerman}{Iriver}

manual/platform/h10_5gb.tex

@@ -6,6 +6,7 @@
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IRIVER_H10_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,iriver}
 
 \newcommand{\playerman}{Iriver}

manual/platform/h1xx.tex

@@ -2,11 +2,15 @@
 \def\UseOption{h1xx}
 \edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IRIVER_H100_PAD}
 \edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
 \edef\UseOption{\UseOption,iriver}
 
 \newcommand{\playerman}{Iriver}

manual/platform/h300.tex

@@ -2,6 +2,7 @@
 \def\UseOption{h300}
 \edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,CONFIG_RTC}
@@ -9,6 +10,8 @@
 \edef\UseOption{\UseOption,IRIVER_H300_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
 \edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
 \edef\UseOption{\UseOption,iriver}
 
 \newcommand{\playerman}{Iriver}

manual/platform/ipod1g2g.tex

@@ -2,10 +2,13 @@
 \def\UseOption{ipod1g2g}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,HAVE_RTC_ALARM}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_3G_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipod3g.tex

@@ -2,10 +2,13 @@
 \def\UseOption{ipod3g}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,HAVE_RTC_ALARM}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_3G_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipod4g.tex

@@ -2,10 +2,13 @@
 \def\UseOption{ipod4g}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,HAVE_RTC_ALARM}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_4G_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipodcolor.tex

@@ -7,6 +7,7 @@
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_4G_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipodmini.tex

@@ -2,10 +2,14 @@
 \def\UseOption{ipodmini}
 \edef\UseOption{\UseOption,HAVE_RB_BL_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,HAVE_RTC_ALARM}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_4G_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipodnano.tex

@@ -7,6 +7,8 @@
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_4G_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/ipodvideo.tex

@@ -7,6 +7,8 @@
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IPOD_4G_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_PWM_FADING}
 \edef\UseOption{\UseOption,ipod}
 
 \newcommand{\playerman}{Ipod}

manual/platform/m5.tex

@@ -2,11 +2,14 @@
 \def\UseOption{m5}
 \edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
 \edef\UseOption{\UseOption,IAUDIO_X5_PAD}
 \edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,iaudio}
 
 \newcommand{\playerman}{Iaudio}

manual/platform/ondiofm.tex

@@ -4,6 +4,8 @@
 % To not break the current manual
 \edef\UseOption{\UseOption,ondio}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,MASCODEC}

manual/platform/ondiosp.tex

@@ -3,6 +3,8 @@
 \def\UseOption{ondiosp}
 \edef\UseOption{\UseOption,ondio}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,MASCODEC}
 \edef\UseOption{\UseOption,ONDIO_PAD}
 \edef\UseOption{\UseOption,archos}

manual/platform/player.tex

@@ -2,6 +2,7 @@
 \def\UseOption{player}
 \edef\UseOption{\UseOption,MASCODEC}
 \edef\UseOption{\UseOption,PLAYER_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,archos}
 
 \newcommand{\playerman}{Archos}

manual/platform/recorder.tex

@@ -1,10 +1,13 @@
 % $Id$ %
 \def\UseOption{recorder}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,MASCODEC}
 \edef\UseOption{\UseOption,RECORDER_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,archos}
 
 \newcommand{\playerman}{Archos}

manual/platform/recorderv2fm.tex

@@ -1,12 +1,15 @@
 % $Id$ %
 \def\UseOption{recorderv2fm}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,HAVE_RTC_ALARM}
 \edef\UseOption{\UseOption,MASCODEC}
 \edef\UseOption{\UseOption,RECORDER_PAD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
 \edef\UseOption{\UseOption,archos}
 
 \newcommand{\playerman}{Archos}

manual/platform/x5.tex

@@ -2,6 +2,9 @@
 \def\UseOption{x5}
 \edef\UseOption{\UseOption,HAVE_RB_BL_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_LCD_INVERT}
+\edef\UseOption{\UseOption,HAVE_LCD_FLIP}
+\edef\UseOption{\UseOption,HAVE_LCD_SLEEP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
 \edef\UseOption{\UseOption,CONFIG_RTC}
@@ -9,6 +12,8 @@
 \edef\UseOption{\UseOption,IAUDIO_X5_PAD}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
 \edef\UseOption{\UseOption,HAVE_REMOTE_LCD}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT}
+\edef\UseOption{\UseOption,HAVE_BACKLIGHT_BRIGHTNESS}
 \edef\UseOption{\UseOption,iaudio}
 
 \newcommand{\playerman}{Iaudio}