Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 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]; |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 35 | # ifdef CONFIG_USB_FUNCTIONFS_ETH |
| 36 | static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 37 | # endif |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 38 | #else |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 39 | # define gether_cleanup() do { } while (0) |
| 40 | # define gether_setup(gadget, hostaddr) ((int)0) |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 41 | # define gfs_hostaddr NULL |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 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 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 55 | #define GFS_VENDOR_ID 0x1d6b /* Linux Foundation */ |
| 56 | #define GFS_PRODUCT_ID 0x0105 /* FunctionFS Gadget */ |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 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 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 65 | .idVendor = cpu_to_le16(GFS_VENDOR_ID), |
| 66 | .idProduct = cpu_to_le16(GFS_PRODUCT_ID), |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 67 | }; |
| 68 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 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"); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 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 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 84 | /* |
| 85 | * REVISIT SRP-only hardware is possible, although |
| 86 | * it would not be called "OTG" ... |
| 87 | */ |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 88 | .bmAttributes = USB_OTG_SRP | USB_OTG_HNP, |
| 89 | }, |
| 90 | |
| 91 | NULL |
| 92 | }; |
| 93 | |
| 94 | /* string IDs are assigned dynamically */ |
| 95 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 96 | static struct usb_string gfs_strings[] = { |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 97 | #ifdef CONFIG_USB_FUNCTIONFS_RNDIS |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 98 | { .s = "FunctionFS + RNDIS" }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 99 | #endif |
| 100 | #ifdef CONFIG_USB_FUNCTIONFS_ETH |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 101 | { .s = "FunctionFS + ECM" }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 102 | #endif |
| 103 | #ifdef CONFIG_USB_FUNCTIONFS_GENERIC |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 104 | { .s = "FunctionFS" }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 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 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 118 | |
| 119 | struct gfs_configuration { |
| 120 | struct usb_configuration c; |
| 121 | int (*eth)(struct usb_configuration *c, u8 *ethaddr); |
| 122 | } gfs_configurations[] = { |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 123 | #ifdef CONFIG_USB_FUNCTIONFS_RNDIS |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 124 | { |
| 125 | .eth = rndis_bind_config, |
| 126 | }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 127 | #endif |
| 128 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 129 | #ifdef CONFIG_USB_FUNCTIONFS_ETH |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 130 | { |
| 131 | .eth = eth_bind_config, |
| 132 | }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 133 | #endif |
| 134 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 135 | #ifdef CONFIG_USB_FUNCTIONFS_GENERIC |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 136 | { |
| 137 | }, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 138 | #endif |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 139 | }; |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 140 | |
| 141 | |
| 142 | static int gfs_bind(struct usb_composite_dev *cdev); |
| 143 | static int gfs_unbind(struct usb_composite_dev *cdev); |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 144 | static int gfs_do_config(struct usb_configuration *c); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 145 | |
| 146 | static struct usb_composite_driver gfs_driver = { |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 147 | .name = DRIVER_NAME, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 148 | .dev = &gfs_dev_desc, |
| 149 | .strings = gfs_dev_strings, |
| 150 | .bind = gfs_bind, |
| 151 | .unbind = gfs_unbind, |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 152 | .iProduct = DRIVER_DESC, |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 153 | }; |
| 154 | |
| 155 | |
| 156 | static struct ffs_data *gfs_ffs_data; |
| 157 | static unsigned long gfs_registered; |
| 158 | |
| 159 | |
| 160 | static int gfs_init(void) |
| 161 | { |
| 162 | ENTER(); |
| 163 | |
| 164 | return functionfs_init(); |
| 165 | } |
| 166 | module_init(gfs_init); |
| 167 | |
| 168 | static void gfs_exit(void) |
| 169 | { |
| 170 | ENTER(); |
| 171 | |
| 172 | if (test_and_clear_bit(0, &gfs_registered)) |
| 173 | usb_composite_unregister(&gfs_driver); |
| 174 | |
| 175 | functionfs_cleanup(); |
| 176 | } |
| 177 | module_exit(gfs_exit); |
| 178 | |
| 179 | |
| 180 | static int functionfs_ready_callback(struct ffs_data *ffs) |
| 181 | { |
| 182 | int ret; |
| 183 | |
| 184 | ENTER(); |
| 185 | |
| 186 | if (WARN_ON(test_and_set_bit(0, &gfs_registered))) |
| 187 | return -EBUSY; |
| 188 | |
| 189 | gfs_ffs_data = ffs; |
| 190 | ret = usb_composite_register(&gfs_driver); |
| 191 | if (unlikely(ret < 0)) |
| 192 | clear_bit(0, &gfs_registered); |
| 193 | return ret; |
| 194 | } |
| 195 | |
| 196 | static void functionfs_closed_callback(struct ffs_data *ffs) |
| 197 | { |
| 198 | ENTER(); |
| 199 | |
| 200 | if (test_and_clear_bit(0, &gfs_registered)) |
| 201 | usb_composite_unregister(&gfs_driver); |
| 202 | } |
| 203 | |
| 204 | |
| 205 | static int functionfs_check_dev_callback(const char *dev_name) |
| 206 | { |
| 207 | return 0; |
| 208 | } |
| 209 | |
| 210 | |
| 211 | |
| 212 | static int gfs_bind(struct usb_composite_dev *cdev) |
| 213 | { |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 214 | int ret, i; |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 215 | |
| 216 | ENTER(); |
| 217 | |
| 218 | if (WARN_ON(!gfs_ffs_data)) |
| 219 | return -ENODEV; |
| 220 | |
| 221 | ret = gether_setup(cdev->gadget, gfs_hostaddr); |
| 222 | if (unlikely(ret < 0)) |
| 223 | goto error_quick; |
| 224 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 225 | ret = usb_string_ids_tab(cdev, gfs_strings); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 226 | if (unlikely(ret < 0)) |
| 227 | goto error; |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 228 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 229 | ret = functionfs_bind(gfs_ffs_data, cdev); |
| 230 | if (unlikely(ret < 0)) |
| 231 | goto error; |
| 232 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 233 | for (i = 0; i < ARRAY_SIZE(gfs_configurations); ++i) { |
| 234 | struct gfs_configuration *c = gfs_configurations + i; |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 235 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 236 | c->c.label = gfs_strings[i].s; |
| 237 | c->c.iConfiguration = gfs_strings[i].id; |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 238 | c->c.bind = gfs_do_config; |
| 239 | c->c.bConfigurationValue = 1 + i; |
| 240 | c->c.bmAttributes = USB_CONFIG_ATT_SELFPOWER; |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 241 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 242 | ret = usb_add_config(cdev, &c->c); |
| 243 | if (unlikely(ret < 0)) |
| 244 | goto error_unbind; |
| 245 | } |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 246 | |
| 247 | return 0; |
| 248 | |
| 249 | error_unbind: |
| 250 | functionfs_unbind(gfs_ffs_data); |
| 251 | error: |
| 252 | gether_cleanup(); |
| 253 | error_quick: |
| 254 | gfs_ffs_data = NULL; |
| 255 | return ret; |
| 256 | } |
| 257 | |
| 258 | static int gfs_unbind(struct usb_composite_dev *cdev) |
| 259 | { |
| 260 | ENTER(); |
| 261 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 262 | /* |
| 263 | * We may have been called in an error recovery from |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 264 | * composite_bind() after gfs_unbind() failure so we need to |
| 265 | * check if gfs_ffs_data is not NULL since gfs_bind() handles |
| 266 | * all error recovery itself. I'd rather we werent called |
| 267 | * from composite on orror recovery, but what you're gonna |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 268 | * do...? |
| 269 | */ |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 270 | if (gfs_ffs_data) { |
| 271 | gether_cleanup(); |
| 272 | functionfs_unbind(gfs_ffs_data); |
| 273 | gfs_ffs_data = NULL; |
| 274 | } |
| 275 | |
| 276 | return 0; |
| 277 | } |
| 278 | |
| 279 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 280 | static int gfs_do_config(struct usb_configuration *c) |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 281 | { |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 282 | struct gfs_configuration *gc = |
| 283 | container_of(c, struct gfs_configuration, c); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 284 | int ret; |
| 285 | |
| 286 | if (WARN_ON(!gfs_ffs_data)) |
| 287 | return -ENODEV; |
| 288 | |
| 289 | if (gadget_is_otg(c->cdev->gadget)) { |
| 290 | c->descriptors = gfs_otg_desc; |
| 291 | c->bmAttributes |= USB_CONFIG_ATT_WAKEUP; |
| 292 | } |
| 293 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 294 | if (gc->eth) { |
| 295 | ret = gc->eth(c, gfs_hostaddr); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 296 | if (unlikely(ret < 0)) |
| 297 | return ret; |
| 298 | } |
| 299 | |
Michal Nazarewicz | 7898aee | 2010-06-16 12:07:58 +0200 | [diff] [blame] | 300 | ret = functionfs_bind_config(c->cdev, c, gfs_ffs_data); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 301 | if (unlikely(ret < 0)) |
| 302 | return ret; |
| 303 | |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 304 | /* |
| 305 | * After previous do_configs there may be some invalid |
Michal Nazarewicz | f588c0d | 2010-06-14 10:43:34 +0200 | [diff] [blame] | 306 | * pointers in c->interface array. This happens every time |
| 307 | * a user space function with fewer interfaces than a user |
| 308 | * space function that was run before the new one is run. The |
| 309 | * compasit's set_config() assumes that if there is no more |
| 310 | * then MAX_CONFIG_INTERFACES interfaces in a configuration |
| 311 | * then there is a NULL pointer after the last interface in |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 312 | * c->interface array. We need to make sure this is true. |
| 313 | */ |
Michal Nazarewicz | f588c0d | 2010-06-14 10:43:34 +0200 | [diff] [blame] | 314 | if (c->next_interface_id < ARRAY_SIZE(c->interface)) |
| 315 | c->interface[c->next_interface_id] = NULL; |
| 316 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 317 | return 0; |
| 318 | } |
| 319 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 320 | |
| 321 | #ifdef CONFIG_USB_FUNCTIONFS_ETH |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 322 | |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 323 | static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]) |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 324 | { |
Michal Nazarewicz | f8dae53 | 2010-06-25 16:29:27 +0200 | [diff] [blame] | 325 | return can_support_ecm(c->cdev->gadget) |
| 326 | ? ecm_bind_config(c, ethaddr) |
| 327 | : geth_bind_config(c, ethaddr); |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 328 | } |
Michal Nazarewicz | fc19de6 | 2010-08-12 17:43:48 +0200 | [diff] [blame^] | 329 | |
Michal Nazarewicz | c6c5600 | 2010-05-05 12:53:15 +0200 | [diff] [blame] | 330 | #endif |