New USB charging system, part 1 - API rework and user-visible setting update

1) "Charge during USB connection" option is now tristate: off/on/force. Currently "force" behaves just like "on", but in future it will allow charging even when it was not possible to positively identify a charger.

2) The H300 code has been adjusted to use the new system but there should be no functional differences, it already had the USB charging option and its USB/charging support is hardware controlled.

3) The Gigabeat S code has been adjusted to use the new system: the player now has the USB charging option, which wasn't previously available. The player will only charge at full speed when allowed to do so by a working USB host, so USB AC adapters won't work very well; however, they didn't work before either, so this is not a change in functionality.

4) The iPod Nano 2G code has been adjusted to use the new system: it already had the USB charging option. Using a USB AC adapter won't charge at full speed any more (it did before) - the old implementation was equivalent to the not-yet-implemented "force" option in the new system.

No other target should be affected. Support for the "force" mode and support for at least some other iPod models will come in a future commit :)


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

apps/debug_menu.c

@@ -1556,9 +1556,6 @@ static bool view_battery(void)
                 lcd_puts(0, 7, power_message);
                 lcd_putsf(0, 8, "USB Inserted: %s",
                          usb_inserted() ? "yes" : "no");
-#elif defined IRIVER_H300_SERIES
-                lcd_putsf(0, 9, "USB Charging Enabled: %s",
-                         usb_charging_enabled() ? "yes" : "no");
 #elif defined IPOD_NANO || defined IPOD_VIDEO
                 int usb_pwr  = (GPIOL_INPUT_VAL & 0x10)?true:false;
                 int ext_pwr  = (GPIOL_INPUT_VAL & 0x08)?false:true;
@@ -1610,8 +1607,6 @@ static bool view_battery(void)
                          (st & POWER_INPUT_MAIN_CHARGER) ? " Main" : "",
                          (st & POWER_INPUT_USB_CHARGER) ? " USB" : "");
 
-                lcd_putsf(0, line++, "IUSB Max: %d", usb_allowed_current());
-
                 y = ARRAYLEN(chrgstate_strings) - 1;
 
                 switch (charge_state)

apps/lang/english.lang

@@ -13776,3 +13776,17 @@
     *: ""
   </voice>
 </phrase>
+<phrase>
+  id: LANG_FORCE
+  desc: alternative to yes/no for tristate settings
+  user: core
+  <source>
+    *: "Force"
+  </source>
+  <dest>
+    *: "Force"
+  </dest>
+  <voice>
+    *: "Force"
+  </voice>
+</phrase>

apps/settings.h

@@ -669,7 +669,7 @@ struct user_settings
     bool spdif_enable; /* S/PDIF power on/off */
 #endif
 #ifdef HAVE_USB_CHARGING_ENABLE
-    bool usb_charging;
+    int usb_charging;
 #endif
 
     /* device settings */

apps/settings_list.c

@@ -1595,7 +1595,9 @@ const struct settings_list settings[] = {
     TEXT_SETTING(0,kbd_file,"kbd","-",ROCKBOX_DIR "/",".kbd"),
 #endif
 #ifdef HAVE_USB_CHARGING_ENABLE
-    OFFON_SETTING(0,usb_charging,LANG_USB_CHARGING,false,"usb charging",NULL),
+    CHOICE_SETTING(0, usb_charging, LANG_USB_CHARGING, 0, "usb charging",
+                   "off,on,force", NULL, 3, ID2P(LANG_SET_BOOL_NO),
+                   ID2P(LANG_SET_BOOL_YES), ID2P(LANG_FORCE)),
 #endif
     OFFON_SETTING(F_BANFROMQS,cuesheet,LANG_CUESHEET_ENABLE,false,"cuesheet support",
                   NULL),

firmware/export/config/gigabeats.h

@@ -173,6 +173,8 @@
 /* Charging implemented in a target-specific algorithm */
 #define CONFIG_CHARGING CHARGING_TARGET
 
+#define HAVE_USB_CHARGING_ENABLE
+
 /* define this if the hardware can be powered off while charging */
 /* We don't charge while powered down so maybe implement a
    finish-charging-and-then-poweroff mode */

firmware/export/usb.h

@@ -146,9 +146,16 @@ int usb_detect(void); /* return the raw hardware value - nothing/pc/charger */
 void usb_status_event(int current_status);
 #ifdef HAVE_USB_POWER
 bool usb_powered(void);
-#ifdef CONFIG_CHARGING
+#ifdef HAVE_USB_CHARGING_ENABLE
-bool usb_charging_enable(bool on);
+enum {
-bool usb_charging_enabled(void);
+    USB_CHARGING_DISABLE,
+    USB_CHARGING_ENABLE,
+    USB_CHARGING_FORCE
+};
+/* called by app, implemented by usb_core on targets with rockbox usb
+ * or target-specific code on others
+ */
+void usb_charging_enable(int state);
 #endif
 #endif
 #ifdef HAVE_USBSTACK

firmware/export/usb_core.h

@@ -59,8 +59,14 @@ void usb_core_release_endpoint(int dir);
 void usb_core_hotswap_event(int volume,bool inserted);
 #endif
 
-#ifdef HAVE_USB_POWER
+#ifdef HAVE_USB_CHARGING_ENABLE
-unsigned short usb_allowed_current(void);
+/* hardware which knows how to control usb current should use one
+ * of the following to find out from the usb stack how much is ok
+ */
+/* implemented by target, called by usb when value changes */
+void usb_charging_maxcurrent_change(int maxcurrent);
+/* implemented by usb, called by target to get value */
+int usb_charging_maxcurrent(void);
 #endif
 
 #endif

firmware/target/arm/imx31/gigabeat-s/power-gigabeat-s.c

@@ -43,7 +43,7 @@ unsigned int power_input_status(void)
     if (GPIO3_DR & (1 << 20))
         status |= POWER_INPUT_BATTERY;
 
-    if (usb_allowed_current() < 500)
+    if (usb_charging_maxcurrent() < 500)
     {
         /* ACK that USB is connected but NOT chargeable */
         status &= ~(POWER_INPUT_USB_CHARGER & POWER_INPUT_CHARGER);
@@ -52,6 +52,12 @@ unsigned int power_input_status(void)
     return status;
 }
 
+void usb_charging_maxcurrent_change(int maxcurrent)
+{
+    (void)maxcurrent;
+    /* Nothing to do */
+}
+
 /* Detect changes in presence of the AC adaptor. */
 void charger_main_detect_event(void)
 {

firmware/target/arm/s5l8700/ipodnano2g/power-nano2g.c

@@ -54,15 +54,10 @@ void power_init(void)
 #if CONFIG_CHARGING
 
 #ifdef HAVE_USB_CHARGING_ENABLE
-bool usb_charging_enable(bool on)
+void usb_charging_maxcurrent_change(int maxcurrent)
 {
+    bool on = (maxcurrent >= 500);
     PDAT11 = (PDAT11 & ~1) | (on ? 1 : 0);
-    return on;
-}
-
-bool usb_charging_enabled(void)
-{
-    return PDAT11 & 1;
 }
 #endif
 

firmware/target/coldfire/iriver/h300/power-h300.c

@@ -71,16 +71,14 @@ unsigned int power_input_status(void)
 }
 
 #ifdef HAVE_USB_POWER
-bool usb_charging_enable(bool on)
+void usb_charging_enable(int state)
 {
-    bool rc = false;
+    bool on = (state != USB_CHARGING_DISABLE);
     int irqlevel;
     logf("usb_charging_enable(%s)\n", on ? "on" : "off" );
     irqlevel = disable_irq_save();
     pcf50606_set_usb_charging(on);
-    rc = on;
     restore_irq(irqlevel);
-    return rc;
 }
 #endif /* HAVE_USB_POWER */
 
@@ -92,17 +90,6 @@ bool charging_state(void)
     return (GPIO_READ & 0x00800000)?true:false;
 }
 
-bool usb_charging_enabled(void)
-{
-    bool rc = false;
-    /* TODO: read the state of the GPOOD2 register...
-     * (this also means to set the irq level here) */
-    rc = pcf50606_usb_charging_enabled();
-
-    logf("usb charging %s", rc ? "enabled" : "disabled" );
-    return rc;
-}
-
 void ide_power_enable(bool on)
 {
     if(on)

firmware/usbstack/usb_core.c

@@ -166,6 +166,11 @@ static int usb_address = 0;
 static bool initialized = false;
 static enum { DEFAULT, ADDRESS, CONFIGURED } usb_state;
 
+#ifdef HAVE_USB_CHARGING_ENABLE
+static int usb_charging_mode = USB_CHARGING_DISABLE;
+static int usb_charging_current_requested = 500;
+#endif
+
 static int usb_core_num_interfaces;
 
 typedef void (*completion_handler_t)(int ep, int dir, int status, int length);
@@ -378,6 +383,9 @@ void usb_core_exit(void)
         initialized = false;
     }
     usb_state = DEFAULT;
+#ifdef HAVE_USB_CHARGING_ENABLE
+    usb_charging_maxcurrent_change(usb_charging_maxcurrent());
+#endif
     logf("usb_core_exit() finished");
 }
 
@@ -552,6 +560,16 @@ static void request_handler_device_get_descriptor(struct usb_ctrlrequest* req)
                     config_descriptor.bDescriptorType =
                         USB_DT_OTHER_SPEED_CONFIG;
                 }
+#ifdef HAVE_USB_CHARGING_ENABLE
+                if (usb_charging_mode == USB_CHARGING_DISABLE) {
+                    config_descriptor.bMaxPower = (100+1)/2;
+                    usb_charging_current_requested = 100;
+                }
+                else {
+                    config_descriptor.bMaxPower = (500+1)/2;
+                    usb_charging_current_requested = 500;
+                }
+#endif
                 size = sizeof(struct usb_config_descriptor);
 
                 for(i = 0; i < USB_NUM_DRIVERS; i++)
@@ -628,8 +646,10 @@ static void request_handler_device(struct usb_ctrlrequest* req)
                 }
                 else
                     usb_state = ADDRESS;
-                
                 usb_drv_send(EP_CONTROL, NULL, 0);
+#ifdef HAVE_USB_CHARGING_ENABLE
+                usb_charging_maxcurrent_change(usb_charging_maxcurrent());
+#endif
                 break;
             }
         case USB_REQ_SET_ADDRESS: {
@@ -809,6 +829,9 @@ void usb_core_bus_reset(void)
 {
     usb_address = 0;
     usb_state = DEFAULT;
+#ifdef HAVE_USB_CHARGING_ENABLE
+    usb_charging_maxcurrent_change(usb_charging_maxcurrent());
+#endif
 }
 
 /* called by usb_drv_transfer_completed() */
@@ -850,9 +873,20 @@ void usb_core_control_request(struct usb_ctrlrequest* req)
     usb_signal_transfer_completion(completion_event);
 }
 
-#ifdef HAVE_USB_POWER
+#ifdef HAVE_USB_CHARGING_ENABLE
-unsigned short usb_allowed_current()
+void usb_charging_enable(int state)
 {
-    return (usb_state == CONFIGURED) ? MAX(USB_MAX_CURRENT, 100) : 100;
+    usb_charging_mode = state;
+    usb_charging_maxcurrent_change(usb_charging_maxcurrent());
+}
+
+int usb_charging_maxcurrent()
+{
+    if (!initialized
+            || usb_charging_mode == USB_CHARGING_DISABLE
+            || usb_state != CONFIGURED)
+        return 100;
+    /* usb_state == CONFIGURED, charging enabled/forced */
+    return usb_charging_current_requested;
 }
 #endif