drivers/usb/gadget/g_ffs.c

   1 #include <linux/module.h>
   2 #include <linux/utsname.h>
   3
   4
   5 /*
   6  * kbuild is not very cooperative with respect to linking separately
   7  * compiled library objects into one module.  So for now we won't use
   8  * separate compilation ... ensuring init/exit sections work to shrink
   9  * the runtime footprint, and giving us at least some parts of what
  10  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  11  */
  12
  13 #include "composite.c"
  14 #include "usbstring.c"
  15 #include "config.c"
  16 #include "epautoconf.c"
  17
  18 #if defined CONFIG_USB_FUNCTIONFS_ETH || defined CONFIG_USB_FUNCTIONFS_RNDIS
  19 #  if defined USB_ETH_RNDIS
  20 #    undef USB_ETH_RNDIS
  21 #  endif
  22 #  ifdef CONFIG_USB_FUNCTIONFS_RNDIS
  23 #    define USB_ETH_RNDIS y
  24 #  endif
  25
  26 #  include "f_ecm.c"
  27 #  include "f_subset.c"
  28 #  ifdef USB_ETH_RNDIS
  29 #    include "f_rndis.c"
  30 #    include "rndis.c"
  31 #  endif
  32 #  include "u_ether.c"
  33
  34 static u8 gfs_hostaddr[ETH_ALEN];
  35 #  ifdef CONFIG_USB_FUNCTIONFS_ETH
  36 static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]);
  37 #  endif
  38 #else
  39 #  define gether_cleanup() do { } while (0)
  40 #  define gether_setup(gadget, hostaddr)   ((int)0)
  41 #  define gfs_hostaddr NULL
  42 #endif
  43
  44 #include "f_fs.c"
  45
  46
  47 #define DRIVER_NAME     "g_ffs"
  48 #define DRIVER_DESC     "USB Function Filesystem"
  49 #define DRIVER_VERSION  "24 Aug 2004"
  50
  51 MODULE_DESCRIPTION(DRIVER_DESC);
  52 MODULE_AUTHOR("Michal Nazarewicz");
  53 MODULE_LICENSE("GPL");
  54
  55 #define GFS_VENDOR_ID   0x1d6b  /* Linux Foundation */
  56 #define GFS_PRODUCT_ID  0x0105  /* FunctionFS Gadget */
  57
  58 static struct usb_device_descriptor gfs_dev_desc = {
  59         .bLength                = sizeof gfs_dev_desc,
  60         .bDescriptorType        = USB_DT_DEVICE,
  61
  62         .bcdUSB                 = cpu_to_le16(0x0200),
  63         .bDeviceClass           = USB_CLASS_PER_INTERFACE,
  64
  65         .idVendor               = cpu_to_le16(GFS_VENDOR_ID),
  66         .idProduct              = cpu_to_le16(GFS_PRODUCT_ID),
  67 };
  68
  69 module_param_named(bDeviceClass,    gfs_dev_desc.bDeviceClass,    byte,   0644);
  70 MODULE_PARM_DESC(bDeviceClass, "USB Device class");
  71 module_param_named(bDeviceSubClass, gfs_dev_desc.bDeviceSubClass, byte,   0644);
  72 MODULE_PARM_DESC(bDeviceSubClass, "USB Device subclass");
  73 module_param_named(bDeviceProtocol, gfs_dev_desc.bDeviceProtocol, byte,   0644);
  74 MODULE_PARM_DESC(bDeviceProtocol, "USB Device protocol");
  75
  76
  77
  78 static const struct usb_descriptor_header *gfs_otg_desc[] = {
  79         (const struct usb_descriptor_header *)
  80         &(const struct usb_otg_descriptor) {
  81                 .bLength                = sizeof(struct usb_otg_descriptor),
  82                 .bDescriptorType        = USB_DT_OTG,
  83
  84                 /*
  85                  * REVISIT SRP-only hardware is possible, although
  86                  * it would not be called "OTG" ...
  87                  */
  88                 .bmAttributes           = USB_OTG_SRP | USB_OTG_HNP,
  89         },
  90
  91         NULL
  92 };
  93
  94 /* string IDs are assigned dynamically */
  95
  96 static struct usb_string gfs_strings[] = {
  97 #ifdef CONFIG_USB_FUNCTIONFS_RNDIS
  98         { .s = "FunctionFS + RNDIS" },
  99 #endif
 100 #ifdef CONFIG_USB_FUNCTIONFS_ETH
 101         { .s = "FunctionFS + ECM" },
 102 #endif
 103 #ifdef CONFIG_USB_FUNCTIONFS_GENERIC
 104         { .s = "FunctionFS" },
 105 #endif
 106         {  } /* end of list */
 107 };
 108
 109 static struct usb_gadget_strings *gfs_dev_strings[] = {
 110         &(struct usb_gadget_strings) {
 111                 .language       = 0x0409,       /* en-us */
 112                 .strings        = gfs_strings,
 113         },
 114         NULL,
 115 };
 116
 117
 118
 119 struct gfs_configuration {
 120         struct usb_configuration c;
 121         int (*eth)(struct usb_configuration *c, u8 *ethaddr);
 122 } gfs_configurations[] = {
 123 #ifdef CONFIG_USB_FUNCTIONFS_RNDIS
 124         {
 125                 .eth            = rndis_bind_config,
 126         },
 127 #endif
 128
 129 #ifdef CONFIG_USB_FUNCTIONFS_ETH
 130         {
 131                 .eth            = eth_bind_config,
 132         },
 133 #endif
 134
 135 #ifdef CONFIG_USB_FUNCTIONFS_GENERIC
 136         {
 137         },
 138 #endif
 139 };
 140
 141
 142 static int gfs_bind(struct usb_composite_dev *cdev);
 143 static int gfs_unbind(struct usb_composite_dev *cdev);
 144 static int gfs_do_config(struct usb_configuration *c);
 145
 146 static struct usb_composite_driver gfs_driver = {
 147         .name           = DRIVER_NAME,
 148         .dev            = &gfs_dev_desc,
 149         .strings        = gfs_dev_strings,
 150         .unbind         = gfs_unbind,
 151         .iProduct       = DRIVER_DESC,
 152 };
 153
 154
 155 static struct ffs_data *gfs_ffs_data;
 156 static unsigned long gfs_registered;
 157
 158
 159 static int  gfs_init(void)
 160 {
 161         ENTER();
 162
 163         return functionfs_init();
 164 }
 165 module_init(gfs_init);
 166
 167 static void  gfs_exit(void)
 168 {
 169         ENTER();
 170
 171         if (test_and_clear_bit(0, &gfs_registered))
 172                 usb_composite_unregister(&gfs_driver);
 173
 174         functionfs_cleanup();
 175 }
 176 module_exit(gfs_exit);
 177
 178
 179 static int functionfs_ready_callback(struct ffs_data *ffs)
 180 {
 181         int ret;
 182
 183         ENTER();
 184
 185         if (WARN_ON(test_and_set_bit(0, &gfs_registered)))
 186                 return -EBUSY;
 187
 188         gfs_ffs_data = ffs;
 189         ret = usb_composite_probe(&gfs_driver, gfs_bind);
 190         if (unlikely(ret < 0))
 191                 clear_bit(0, &gfs_registered);
 192         return ret;
 193 }
 194
 195 static void functionfs_closed_callback(struct ffs_data *ffs)
 196 {
 197         ENTER();
 198
 199         if (test_and_clear_bit(0, &gfs_registered))
 200                 usb_composite_unregister(&gfs_driver);
 201 }
 202
 203
 204 static int functionfs_check_dev_callback(const char *dev_name)
 205 {
 206         return 0;
 207 }
 208
 209
 210
 211 static int gfs_bind(struct usb_composite_dev *cdev)
 212 {
 213         int ret, i;
 214
 215         ENTER();
 216
 217         if (WARN_ON(!gfs_ffs_data))
 218                 return -ENODEV;
 219
 220         ret = gether_setup(cdev->gadget, gfs_hostaddr);
 221         if (unlikely(ret < 0))
 222                 goto error_quick;
 223
 224         ret = usb_string_ids_tab(cdev, gfs_strings);
 225         if (unlikely(ret < 0))
 226                 goto error;
 227
 228         ret = functionfs_bind(gfs_ffs_data, cdev);
 229         if (unlikely(ret < 0))
 230                 goto error;
 231
 232         for (i = 0; i < ARRAY_SIZE(gfs_configurations); ++i) {
 233                 struct gfs_configuration *c = gfs_configurations + i;
 234
 235                 c->c.label                      = gfs_strings[i].s;
 236                 c->c.iConfiguration             = gfs_strings[i].id;
 237                 c->c.bConfigurationValue        = 1 + i;
 238                 c->c.bmAttributes               = USB_CONFIG_ATT_SELFPOWER;
 239
 240                 ret = usb_add_config(cdev, &c->c, gfs_do_config);
 241                 if (unlikely(ret < 0))
 242                         goto error_unbind;
 243         }
 244
 245         return 0;
 246
 247 error_unbind:
 248         functionfs_unbind(gfs_ffs_data);
 249 error:
 250         gether_cleanup();
 251 error_quick:
 252         gfs_ffs_data = NULL;
 253         return ret;
 254 }
 255
 256 static int gfs_unbind(struct usb_composite_dev *cdev)
 257 {
 258         ENTER();
 259
 260         /*
 261          * We may have been called in an error recovery from
 262          * composite_bind() after gfs_unbind() failure so we need to
 263          * check if gfs_ffs_data is not NULL since gfs_bind() handles
 264          * all error recovery itself.  I'd rather we werent called
 265          * from composite on orror recovery, but what you're gonna
 266          * do...?
 267          */
 268         if (gfs_ffs_data) {
 269                 gether_cleanup();
 270                 functionfs_unbind(gfs_ffs_data);
 271                 gfs_ffs_data = NULL;
 272         }
 273
 274         return 0;
 275 }
 276
 277
 278 static int gfs_do_config(struct usb_configuration *c)
 279 {
 280         struct gfs_configuration *gc =
 281                 container_of(c, struct gfs_configuration, c);
 282         int ret;
 283
 284         if (WARN_ON(!gfs_ffs_data))
 285                 return -ENODEV;
 286
 287         if (gadget_is_otg(c->cdev->gadget)) {
 288                 c->descriptors = gfs_otg_desc;
 289                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 290         }
 291
 292         if (gc->eth) {
 293                 ret = gc->eth(c, gfs_hostaddr);
 294                 if (unlikely(ret < 0))
 295                         return ret;
 296         }
 297
 298         ret = functionfs_bind_config(c->cdev, c, gfs_ffs_data);
 299         if (unlikely(ret < 0))
 300                 return ret;
 301
 302         /*
 303          * After previous do_configs there may be some invalid
 304          * pointers in c->interface array.  This happens every time
 305          * a user space function with fewer interfaces than a user
 306          * space function that was run before the new one is run.  The
 307          * compasit's set_config() assumes that if there is no more
 308          * then MAX_CONFIG_INTERFACES interfaces in a configuration
 309          * then there is a NULL pointer after the last interface in
 310          * c->interface array.  We need to make sure this is true.
 311          */
 312         if (c->next_interface_id < ARRAY_SIZE(c->interface))
 313                 c->interface[c->next_interface_id] = NULL;
 314
 315         return 0;
 316 }
 317
 318
 319 #ifdef CONFIG_USB_FUNCTIONFS_ETH
 320
 321 static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN])
 322 {
 323         return can_support_ecm(c->cdev->gadget)
 324                 ? ecm_bind_config(c, ethaddr)
 325                 : geth_bind_config(c, ethaddr);
 326 }
 327
 328 #endif