Merge tag 'gadget-for-v3.7' of git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb into usb-next

usb: gadget: patches for v3.7 merge window

This pull request is large but the biggest part is the first part
of the cleanup on the gadget framework so we have a saner setup
to add configfs support for v3.8.

We have also some more conversions to the new udc_start/udc_stop
which makes us closer from dropping the old interfaces.

USB_GADGET_DUALSPEED and USB_GADGET_SUPERSPEED are finally gone,
thanks to Michal for his awesome work.

Other than that, we have the usual set of miscellaneous changes
and cleanups involving improvements to debug messages, removal
of duplicated includes, moving dereference after NULL test,
making renesas_hsbhs' irq handler Shared, unused code being dropped,
prevention of sleep-inside-spinlock bugs and a race condition fix
on udc-core.

2 files changed, 87 insertions, 43 deletions

diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h
index 9d8c3b634493..f8dda0621800 100644
--- a/include/linux/usb/composite.h
+++ b/include/linux/usb/composite.h
@@ -34,6 +34,8 @@
  * the composite model the host can use both functions at the same time.
  */
 
+#include <linux/bcd.h>
+#include <linux/version.h>
 #include <linux/usb/ch9.h>
 #include <linux/usb/gadget.h>
 
@@ -46,6 +48,9 @@
  */
 #define USB_GADGET_DELAYED_STATUS       0x7fff  /* Impossibly large value */
 
+/* big enough to hold our biggest descriptor */
+#define USB_COMP_EP0_BUFSIZ     1024
+
 struct usb_configuration;
 
 /**
@@ -245,24 +250,31 @@ int usb_add_config(struct usb_composite_dev *,
 void usb_remove_config(struct usb_composite_dev *,
                 struct usb_configuration *);
 
+/* predefined index for usb_composite_driver */
+enum {
+        USB_GADGET_MANUFACTURER_IDX     = 0,
+        USB_GADGET_PRODUCT_IDX,
+        USB_GADGET_SERIAL_IDX,
+        USB_GADGET_FIRST_AVAIL_IDX,
+};
+
 /**
  * struct usb_composite_driver - groups configurations into a gadget
  * @name: For diagnostics, identifies the driver.
- * @iProduct: Used as iProduct override if @dev->iProduct is not set.
- *      If NULL value of @name is taken.
- * @iManufacturer: Used as iManufacturer override if @dev->iManufacturer is
- *      not set. If NULL a default "<system> <release> with <udc>" value
- *      will be used.
- * @iSerialNumber: Used as iSerialNumber override if @dev->iSerialNumber is
- *      not set.
  * @dev: Template descriptor for the device, including default device
  *      identifiers.
- * @strings: tables of strings, keyed by identifiers assigned during bind()
- *      and language IDs provided in control requests
+ * @strings: tables of strings, keyed by identifiers assigned during @bind
+ *      and language IDs provided in control requests. Note: The first entries
+ *      are predefined. The first entry that may be used is
+ *      USB_GADGET_FIRST_AVAIL_IDX
  * @max_speed: Highest speed the driver supports.
  * @needs_serial: set to 1 if the gadget needs userspace to provide
  *      a serial number.  If one is not provided, warning will be printed.
- * @unbind: Reverses bind; called as a side effect of unregistering
+ * @bind: (REQUIRED) Used to allocate resources that are shared across the
+ *      whole device, such as string IDs, and add its configurations using
+ *      @usb_add_config(). This may fail by returning a negative errno
+ *      value; it should return zero on successful initialization.
+ * @unbind: Reverses @bind; called as a side effect of unregistering
  *      this driver.
  * @disconnect: optional driver disconnect method
  * @suspend: Notifies when the host stops sending USB traffic,
@@ -271,9 +283,9 @@ void usb_remove_config(struct usb_composite_dev *,
  *      before function notifications
  *
  * Devices default to reporting self powered operation.  Devices which rely
- * on bus powered operation should report this in their @bind() method.
+ * on bus powered operation should report this in their @bind method.
  *
- * Before returning from bind, various fields in the template descriptor
+ * Before returning from @bind, various fields in the template descriptor
  * may be overridden.  These include the idVendor/idProduct/bcdDevice values
  * normally to bind the appropriate host side driver, and the three strings
  * (iManufacturer, iProduct, iSerialNumber) normally used to provide user
@@ -283,14 +295,12 @@ void usb_remove_config(struct usb_composite_dev *,
  */
 struct usb_composite_driver {
         const char                              *name;
-        const char                              *iProduct;
-        const char                              *iManufacturer;
-        const char                              *iSerialNumber;
         const struct usb_device_descriptor      *dev;
         struct usb_gadget_strings               **strings;
         enum usb_device_speed                   max_speed;
         unsigned                needs_serial:1;
 
+        int                     (*bind)(struct usb_composite_dev *cdev);
         int                     (*unbind)(struct usb_composite_dev *);
 
         void                    (*disconnect)(struct usb_composite_dev *);
@@ -298,10 +308,10 @@ struct usb_composite_driver {
         /* global suspend hooks */
         void                    (*suspend)(struct usb_composite_dev *);
         void                    (*resume)(struct usb_composite_dev *);
+        struct usb_gadget_driver                gadget_driver;
 };
 
-extern int usb_composite_probe(struct usb_composite_driver *driver,
-                               int (*bind)(struct usb_composite_dev *cdev));
+extern int usb_composite_probe(struct usb_composite_driver *driver);
 extern void usb_composite_unregister(struct usb_composite_driver *driver);
 extern void usb_composite_setup_continue(struct usb_composite_dev *cdev);
 
@@ -310,7 +320,6 @@ extern void usb_composite_setup_continue(struct usb_composite_dev *cdev);
  * struct usb_composite_device - represents one composite usb gadget
  * @gadget: read-only, abstracts the gadget's usb peripheral controller
  * @req: used for control responses; buffer is pre-allocated
- * @bufsiz: size of buffer pre-allocated in @req
  * @config: the currently active configuration
  *
  * One of these devices is allocated and initialized before the
@@ -341,7 +350,6 @@ extern void usb_composite_setup_continue(struct usb_composite_dev *cdev);
 struct usb_composite_dev {
         struct usb_gadget               *gadget;
         struct usb_request              *req;
-        unsigned                        bufsiz;
 
         struct usb_configuration        *config;
 
@@ -352,9 +360,7 @@ struct usb_composite_dev {
         struct list_head                configs;
         struct usb_composite_driver     *driver;
         u8                              next_string_id;
-        u8                              manufacturer_override;
-        u8                              product_override;
-        u8                              serial_override;
+        char                            *def_manufacturer;
 
         /* the gadget driver won't enable the data pullup
          * while the deactivation count is nonzero.
@@ -375,6 +381,53 @@ extern int usb_string_ids_tab(struct usb_composite_dev *c,
                               struct usb_string *str);
 extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n);
 
+/*
+ * Some systems will need runtime overrides for the  product identifiers
+ * published in the device descriptor, either numbers or strings or both.
+ * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
+ */
+struct usb_composite_overwrite {
+        u16     idVendor;
+        u16     idProduct;
+        u16     bcdDevice;
+        char    *serial_number;
+        char    *manufacturer;
+        char    *product;
+};
+#define USB_GADGET_COMPOSITE_OPTIONS()                                  \
+        static struct usb_composite_overwrite coverwrite;               \
+                                                                        \
+        module_param_named(idVendor, coverwrite.idVendor, ushort, S_IRUGO); \
+        MODULE_PARM_DESC(idVendor, "USB Vendor ID");                    \
+                                                                        \
+        module_param_named(idProduct, coverwrite.idProduct, ushort, S_IRUGO); \
+        MODULE_PARM_DESC(idProduct, "USB Product ID");                  \
+                                                                        \
+        module_param_named(bcdDevice, coverwrite.bcdDevice, ushort, S_IRUGO); \
+        MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");        \
+                                                                        \
+        module_param_named(iSerialNumber, coverwrite.serial_number, charp, \
+                        S_IRUGO); \
+        MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");         \
+                                                                        \
+        module_param_named(iManufacturer, coverwrite.manufacturer, charp, \
+                        S_IRUGO); \
+        MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");     \
+                                                                        \
+        module_param_named(iProduct, coverwrite.product, charp, S_IRUGO); \
+        MODULE_PARM_DESC(iProduct, "USB Product string")
+
+void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
+                struct usb_composite_overwrite *covr);
+
+static inline u16 get_default_bcdDevice(void)
+{
+        u16 bcdDevice;
+
+        bcdDevice = bin2bcd((LINUX_VERSION_CODE >> 16 & 0xff)) << 8;
+        bcdDevice |= bin2bcd((LINUX_VERSION_CODE >> 8 & 0xff));
+        return bcdDevice;
+}
 
 /* messaging utils */
 #define DBG(d, fmt, args...) \
diff --git a/include/linux/usb/gadget.h b/include/linux/usb/gadget.h
index 9517466ababb..5b6e50888248 100644
--- a/include/linux/usb/gadget.h
+++ b/include/linux/usb/gadget.h
@@ -474,7 +474,8 @@ struct usb_gadget_ops {
 
         /* Those two are deprecated */
         int     (*start)(struct usb_gadget_driver *,
-                        int (*bind)(struct usb_gadget *));
+                        int (*bind)(struct usb_gadget *,
+                                struct usb_gadget_driver *driver));
         int     (*stop)(struct usb_gadget_driver *);
 };
 
@@ -502,6 +503,8 @@ struct usb_gadget_ops {
  * @name: Identifies the controller hardware type.  Used in diagnostics
  *      and sometimes configuration.
  * @dev: Driver model state for this abstract device.
+ * @out_epnum: last used out ep number
+ * @in_epnum: last used in ep number
  *
  * Gadgets have a mostly-portable "gadget driver" implementing device
  * functions, handling all usb configurations and interfaces.  Gadget
@@ -536,6 +539,8 @@ struct usb_gadget {
         unsigned                        a_alt_hnp_support:1;
         const char                      *name;
         struct device                   dev;
+        unsigned                        out_epnum;
+        unsigned                        in_epnum;
 };
 
 static inline void set_gadget_data(struct usb_gadget *gadget, void *data)
@@ -558,14 +563,7 @@ static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev)
  */
 static inline int gadget_is_dualspeed(struct usb_gadget *g)
 {
-#ifdef CONFIG_USB_GADGET_DUALSPEED
-        /* runtime test would check "g->max_speed" ... that might be
-         * useful to work around hardware bugs, but is mostly pointless
-         */
-        return 1;
-#else
-        return 0;
-#endif
+        return g->max_speed >= USB_SPEED_HIGH;
 }
 
 /**
@@ -575,15 +573,7 @@ static inline int gadget_is_dualspeed(struct usb_gadget *g)
  */
 static inline int gadget_is_superspeed(struct usb_gadget *g)
 {
-#ifdef CONFIG_USB_GADGET_SUPERSPEED
-        /*
-         * runtime test would check "g->max_speed" ... that might be
-         * useful to work around hardware bugs, but is mostly pointless
-         */
-        return 1;
-#else
-        return 0;
-#endif
+        return g->max_speed >= USB_SPEED_SUPER;
 }
 
 /**
@@ -781,6 +771,7 @@ static inline int usb_gadget_disconnect(struct usb_gadget *gadget)
  *      when the host is disconnected.  May be called in_interrupt; this
  *      may not sleep.  Some devices can't detect disconnect, so this might
  *      not be called except as part of controller shutdown.
+ * @bind: the driver's bind callback
  * @unbind: Invoked when the driver is unbound from a gadget,
  *      usually from rmmod (after a disconnect is reported).
  *      Called in a context that permits sleeping.
@@ -835,6 +826,8 @@ static inline int usb_gadget_disconnect(struct usb_gadget *gadget)
 struct usb_gadget_driver {
         char                    *function;
         enum usb_device_speed   max_speed;
+        int                     (*bind)(struct usb_gadget *gadget,
+                                        struct usb_gadget_driver *driver);
         void                    (*unbind)(struct usb_gadget *);
         int                     (*setup)(struct usb_gadget *,
                                         const struct usb_ctrlrequest *);
@@ -860,7 +853,6 @@ struct usb_gadget_driver {
 /**
  * usb_gadget_probe_driver - probe a gadget driver
  * @driver: the driver being registered
- * @bind: the driver's bind callback
  * Context: can sleep
  *
  * Call this in your gadget driver's module initialization function,
@@ -869,8 +861,7 @@ struct usb_gadget_driver {
  * registration call returns.  It's expected that the @bind() function will
  * be in init sections.
  */
-int usb_gadget_probe_driver(struct usb_gadget_driver *driver,
-                int (*bind)(struct usb_gadget *));
+int usb_gadget_probe_driver(struct usb_gadget_driver *driver);
 
 /**
  * usb_gadget_unregister_driver - unregister a gadget driver