18443f2d2SAndrzej Pietrasiewicz /* 28443f2d2SAndrzej Pietrasiewicz * mass_storage.c -- Mass Storage USB Gadget 38443f2d2SAndrzej Pietrasiewicz * 48443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2003-2008 Alan Stern 58443f2d2SAndrzej Pietrasiewicz * Copyright (C) 2009 Samsung Electronics 68443f2d2SAndrzej Pietrasiewicz * Author: Michal Nazarewicz <mina86@mina86.com> 78443f2d2SAndrzej Pietrasiewicz * All rights reserved. 88443f2d2SAndrzej Pietrasiewicz * 98443f2d2SAndrzej Pietrasiewicz * This program is free software; you can redistribute it and/or modify 108443f2d2SAndrzej Pietrasiewicz * it under the terms of the GNU General Public License as published by 118443f2d2SAndrzej Pietrasiewicz * the Free Software Foundation; either version 2 of the License, or 128443f2d2SAndrzej Pietrasiewicz * (at your option) any later version. 138443f2d2SAndrzej Pietrasiewicz */ 148443f2d2SAndrzej Pietrasiewicz 158443f2d2SAndrzej Pietrasiewicz 168443f2d2SAndrzej Pietrasiewicz /* 178443f2d2SAndrzej Pietrasiewicz * The Mass Storage Gadget acts as a USB Mass Storage device, 188443f2d2SAndrzej Pietrasiewicz * appearing to the host as a disk drive or as a CD-ROM drive. In 198443f2d2SAndrzej Pietrasiewicz * addition to providing an example of a genuinely useful gadget 208443f2d2SAndrzej Pietrasiewicz * driver for a USB device, it also illustrates a technique of 218443f2d2SAndrzej Pietrasiewicz * double-buffering for increased throughput. Last but not least, it 228443f2d2SAndrzej Pietrasiewicz * gives an easy way to probe the behavior of the Mass Storage drivers 238443f2d2SAndrzej Pietrasiewicz * in a USB host. 248443f2d2SAndrzej Pietrasiewicz * 258443f2d2SAndrzej Pietrasiewicz * Since this file serves only administrative purposes and all the 268443f2d2SAndrzej Pietrasiewicz * business logic is implemented in f_mass_storage.* file. Read 278443f2d2SAndrzej Pietrasiewicz * comments in this file for more detailed description. 288443f2d2SAndrzej Pietrasiewicz */ 298443f2d2SAndrzej Pietrasiewicz 308443f2d2SAndrzej Pietrasiewicz 318443f2d2SAndrzej Pietrasiewicz #include <linux/kernel.h> 328443f2d2SAndrzej Pietrasiewicz #include <linux/usb/ch9.h> 338443f2d2SAndrzej Pietrasiewicz #include <linux/module.h> 348443f2d2SAndrzej Pietrasiewicz 358443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/ 368443f2d2SAndrzej Pietrasiewicz 378443f2d2SAndrzej Pietrasiewicz #define DRIVER_DESC "Mass Storage Gadget" 388443f2d2SAndrzej Pietrasiewicz #define DRIVER_VERSION "2009/09/11" 398443f2d2SAndrzej Pietrasiewicz 408443f2d2SAndrzej Pietrasiewicz /* 418443f2d2SAndrzej Pietrasiewicz * Thanks to NetChip Technologies for donating this product ID. 428443f2d2SAndrzej Pietrasiewicz * 438443f2d2SAndrzej Pietrasiewicz * DO NOT REUSE THESE IDs with any other driver!! Ever!! 448443f2d2SAndrzej Pietrasiewicz * Instead: allocate your own, using normal USB-IF procedures. 458443f2d2SAndrzej Pietrasiewicz */ 468443f2d2SAndrzej Pietrasiewicz #define FSG_VENDOR_ID 0x0525 /* NetChip */ 478443f2d2SAndrzej Pietrasiewicz #define FSG_PRODUCT_ID 0xa4a5 /* Linux-USB File-backed Storage Gadget */ 488443f2d2SAndrzej Pietrasiewicz 498443f2d2SAndrzej Pietrasiewicz #include "f_mass_storage.h" 508443f2d2SAndrzej Pietrasiewicz 518443f2d2SAndrzej Pietrasiewicz /*-------------------------------------------------------------------------*/ 528443f2d2SAndrzej Pietrasiewicz USB_GADGET_COMPOSITE_OPTIONS(); 538443f2d2SAndrzej Pietrasiewicz 548443f2d2SAndrzej Pietrasiewicz static struct usb_device_descriptor msg_device_desc = { 558443f2d2SAndrzej Pietrasiewicz .bLength = sizeof msg_device_desc, 568443f2d2SAndrzej Pietrasiewicz .bDescriptorType = USB_DT_DEVICE, 578443f2d2SAndrzej Pietrasiewicz 588443f2d2SAndrzej Pietrasiewicz .bcdUSB = cpu_to_le16(0x0200), 598443f2d2SAndrzej Pietrasiewicz .bDeviceClass = USB_CLASS_PER_INTERFACE, 608443f2d2SAndrzej Pietrasiewicz 618443f2d2SAndrzej Pietrasiewicz /* Vendor and product id can be overridden by module parameters. */ 628443f2d2SAndrzej Pietrasiewicz .idVendor = cpu_to_le16(FSG_VENDOR_ID), 638443f2d2SAndrzej Pietrasiewicz .idProduct = cpu_to_le16(FSG_PRODUCT_ID), 648443f2d2SAndrzej Pietrasiewicz .bNumConfigurations = 1, 658443f2d2SAndrzej Pietrasiewicz }; 668443f2d2SAndrzej Pietrasiewicz 678443f2d2SAndrzej Pietrasiewicz static struct usb_otg_descriptor otg_descriptor = { 688443f2d2SAndrzej Pietrasiewicz .bLength = sizeof otg_descriptor, 698443f2d2SAndrzej Pietrasiewicz .bDescriptorType = USB_DT_OTG, 708443f2d2SAndrzej Pietrasiewicz 718443f2d2SAndrzej Pietrasiewicz /* 728443f2d2SAndrzej Pietrasiewicz * REVISIT SRP-only hardware is possible, although 738443f2d2SAndrzej Pietrasiewicz * it would not be called "OTG" ... 748443f2d2SAndrzej Pietrasiewicz */ 758443f2d2SAndrzej Pietrasiewicz .bmAttributes = USB_OTG_SRP | USB_OTG_HNP, 768443f2d2SAndrzej Pietrasiewicz }; 778443f2d2SAndrzej Pietrasiewicz 788443f2d2SAndrzej Pietrasiewicz static const struct usb_descriptor_header *otg_desc[] = { 798443f2d2SAndrzej Pietrasiewicz (struct usb_descriptor_header *) &otg_descriptor, 808443f2d2SAndrzej Pietrasiewicz NULL, 818443f2d2SAndrzej Pietrasiewicz }; 828443f2d2SAndrzej Pietrasiewicz 838443f2d2SAndrzej Pietrasiewicz static struct usb_string strings_dev[] = { 848443f2d2SAndrzej Pietrasiewicz [USB_GADGET_MANUFACTURER_IDX].s = "", 858443f2d2SAndrzej Pietrasiewicz [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC, 868443f2d2SAndrzej Pietrasiewicz [USB_GADGET_SERIAL_IDX].s = "", 878443f2d2SAndrzej Pietrasiewicz { } /* end of list */ 888443f2d2SAndrzej Pietrasiewicz }; 898443f2d2SAndrzej Pietrasiewicz 908443f2d2SAndrzej Pietrasiewicz static struct usb_gadget_strings stringtab_dev = { 918443f2d2SAndrzej Pietrasiewicz .language = 0x0409, /* en-us */ 928443f2d2SAndrzej Pietrasiewicz .strings = strings_dev, 938443f2d2SAndrzej Pietrasiewicz }; 948443f2d2SAndrzej Pietrasiewicz 958443f2d2SAndrzej Pietrasiewicz static struct usb_gadget_strings *dev_strings[] = { 968443f2d2SAndrzej Pietrasiewicz &stringtab_dev, 978443f2d2SAndrzej Pietrasiewicz NULL, 988443f2d2SAndrzej Pietrasiewicz }; 998443f2d2SAndrzej Pietrasiewicz 1008443f2d2SAndrzej Pietrasiewicz static struct usb_function_instance *fi_msg; 1018443f2d2SAndrzej Pietrasiewicz static struct usb_function *f_msg; 1028443f2d2SAndrzej Pietrasiewicz 1038443f2d2SAndrzej Pietrasiewicz /****************************** Configurations ******************************/ 1048443f2d2SAndrzej Pietrasiewicz 1058443f2d2SAndrzej Pietrasiewicz static struct fsg_module_parameters mod_data = { 1068443f2d2SAndrzej Pietrasiewicz .stall = 1 1078443f2d2SAndrzej Pietrasiewicz }; 1088443f2d2SAndrzej Pietrasiewicz #ifdef CONFIG_USB_GADGET_DEBUG_FILES 1098443f2d2SAndrzej Pietrasiewicz 1108443f2d2SAndrzej Pietrasiewicz static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS; 1118443f2d2SAndrzej Pietrasiewicz 1128443f2d2SAndrzej Pietrasiewicz #else 1138443f2d2SAndrzej Pietrasiewicz 1148443f2d2SAndrzej Pietrasiewicz /* 1158443f2d2SAndrzej Pietrasiewicz * Number of buffers we will use. 1168443f2d2SAndrzej Pietrasiewicz * 2 is usually enough for good buffering pipeline 1178443f2d2SAndrzej Pietrasiewicz */ 1188443f2d2SAndrzej Pietrasiewicz #define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS 1198443f2d2SAndrzej Pietrasiewicz 1208443f2d2SAndrzej Pietrasiewicz #endif /* CONFIG_USB_GADGET_DEBUG_FILES */ 1218443f2d2SAndrzej Pietrasiewicz 1228443f2d2SAndrzej Pietrasiewicz FSG_MODULE_PARAMETERS(/* no prefix */, mod_data); 1238443f2d2SAndrzej Pietrasiewicz 1248443f2d2SAndrzej Pietrasiewicz static unsigned long msg_registered; 1258443f2d2SAndrzej Pietrasiewicz static void msg_cleanup(void); 1268443f2d2SAndrzej Pietrasiewicz 1278443f2d2SAndrzej Pietrasiewicz static int msg_thread_exits(struct fsg_common *common) 1288443f2d2SAndrzej Pietrasiewicz { 1298443f2d2SAndrzej Pietrasiewicz msg_cleanup(); 1308443f2d2SAndrzej Pietrasiewicz return 0; 1318443f2d2SAndrzej Pietrasiewicz } 1328443f2d2SAndrzej Pietrasiewicz 1338443f2d2SAndrzej Pietrasiewicz static int __init msg_do_config(struct usb_configuration *c) 1348443f2d2SAndrzej Pietrasiewicz { 1358443f2d2SAndrzej Pietrasiewicz struct fsg_opts *opts; 1368443f2d2SAndrzej Pietrasiewicz int ret; 1378443f2d2SAndrzej Pietrasiewicz 1388443f2d2SAndrzej Pietrasiewicz if (gadget_is_otg(c->cdev->gadget)) { 1398443f2d2SAndrzej Pietrasiewicz c->descriptors = otg_desc; 1408443f2d2SAndrzej Pietrasiewicz c->bmAttributes |= USB_CONFIG_ATT_WAKEUP; 1418443f2d2SAndrzej Pietrasiewicz } 1428443f2d2SAndrzej Pietrasiewicz 1438443f2d2SAndrzej Pietrasiewicz opts = fsg_opts_from_func_inst(fi_msg); 1448443f2d2SAndrzej Pietrasiewicz 1458443f2d2SAndrzej Pietrasiewicz f_msg = usb_get_function(fi_msg); 1468443f2d2SAndrzej Pietrasiewicz if (IS_ERR(f_msg)) 1478443f2d2SAndrzej Pietrasiewicz return PTR_ERR(f_msg); 1488443f2d2SAndrzej Pietrasiewicz 1498443f2d2SAndrzej Pietrasiewicz ret = fsg_common_run_thread(opts->common); 1508443f2d2SAndrzej Pietrasiewicz if (ret) 1518443f2d2SAndrzej Pietrasiewicz goto put_func; 1528443f2d2SAndrzej Pietrasiewicz 1538443f2d2SAndrzej Pietrasiewicz ret = usb_add_function(c, f_msg); 1548443f2d2SAndrzej Pietrasiewicz if (ret) 1558443f2d2SAndrzej Pietrasiewicz goto put_func; 1568443f2d2SAndrzej Pietrasiewicz 1578443f2d2SAndrzej Pietrasiewicz return 0; 1588443f2d2SAndrzej Pietrasiewicz 1598443f2d2SAndrzej Pietrasiewicz put_func: 1608443f2d2SAndrzej Pietrasiewicz usb_put_function(f_msg); 1618443f2d2SAndrzej Pietrasiewicz return ret; 1628443f2d2SAndrzej Pietrasiewicz } 1638443f2d2SAndrzej Pietrasiewicz 1648443f2d2SAndrzej Pietrasiewicz static struct usb_configuration msg_config_driver = { 1658443f2d2SAndrzej Pietrasiewicz .label = "Linux File-Backed Storage", 1668443f2d2SAndrzej Pietrasiewicz .bConfigurationValue = 1, 1678443f2d2SAndrzej Pietrasiewicz .bmAttributes = USB_CONFIG_ATT_SELFPOWER, 1688443f2d2SAndrzej Pietrasiewicz }; 1698443f2d2SAndrzej Pietrasiewicz 1708443f2d2SAndrzej Pietrasiewicz 1718443f2d2SAndrzej Pietrasiewicz /****************************** Gadget Bind ******************************/ 1728443f2d2SAndrzej Pietrasiewicz 1738443f2d2SAndrzej Pietrasiewicz static int __init msg_bind(struct usb_composite_dev *cdev) 1748443f2d2SAndrzej Pietrasiewicz { 1758443f2d2SAndrzej Pietrasiewicz static const struct fsg_operations ops = { 1768443f2d2SAndrzej Pietrasiewicz .thread_exits = msg_thread_exits, 1778443f2d2SAndrzej Pietrasiewicz }; 1788443f2d2SAndrzej Pietrasiewicz struct fsg_opts *opts; 1798443f2d2SAndrzej Pietrasiewicz struct fsg_config config; 1808443f2d2SAndrzej Pietrasiewicz int status; 1818443f2d2SAndrzej Pietrasiewicz 1828443f2d2SAndrzej Pietrasiewicz fi_msg = usb_get_function_instance("mass_storage"); 1838443f2d2SAndrzej Pietrasiewicz if (IS_ERR(fi_msg)) 1848443f2d2SAndrzej Pietrasiewicz return PTR_ERR(fi_msg); 1858443f2d2SAndrzej Pietrasiewicz 1868443f2d2SAndrzej Pietrasiewicz fsg_config_from_params(&config, &mod_data, fsg_num_buffers); 1878443f2d2SAndrzej Pietrasiewicz opts = fsg_opts_from_func_inst(fi_msg); 1888443f2d2SAndrzej Pietrasiewicz 1898443f2d2SAndrzej Pietrasiewicz opts->no_configfs = true; 1908443f2d2SAndrzej Pietrasiewicz status = fsg_common_set_num_buffers(opts->common, fsg_num_buffers); 1918443f2d2SAndrzej Pietrasiewicz if (status) 1928443f2d2SAndrzej Pietrasiewicz goto fail; 1938443f2d2SAndrzej Pietrasiewicz 1948443f2d2SAndrzej Pietrasiewicz status = fsg_common_set_nluns(opts->common, config.nluns); 1958443f2d2SAndrzej Pietrasiewicz if (status) 1968443f2d2SAndrzej Pietrasiewicz goto fail_set_nluns; 1978443f2d2SAndrzej Pietrasiewicz 1988443f2d2SAndrzej Pietrasiewicz fsg_common_set_ops(opts->common, &ops); 1998443f2d2SAndrzej Pietrasiewicz 2008443f2d2SAndrzej Pietrasiewicz status = fsg_common_set_cdev(opts->common, cdev, config.can_stall); 2018443f2d2SAndrzej Pietrasiewicz if (status) 2028443f2d2SAndrzej Pietrasiewicz goto fail_set_cdev; 2038443f2d2SAndrzej Pietrasiewicz 2048443f2d2SAndrzej Pietrasiewicz fsg_common_set_sysfs(opts->common, true); 2058443f2d2SAndrzej Pietrasiewicz status = fsg_common_create_luns(opts->common, &config); 2068443f2d2SAndrzej Pietrasiewicz if (status) 2078443f2d2SAndrzej Pietrasiewicz goto fail_set_cdev; 2088443f2d2SAndrzej Pietrasiewicz 2098443f2d2SAndrzej Pietrasiewicz fsg_common_set_inquiry_string(opts->common, config.vendor_name, 2108443f2d2SAndrzej Pietrasiewicz config.product_name); 2118443f2d2SAndrzej Pietrasiewicz 2128443f2d2SAndrzej Pietrasiewicz status = usb_string_ids_tab(cdev, strings_dev); 2138443f2d2SAndrzej Pietrasiewicz if (status < 0) 2148443f2d2SAndrzej Pietrasiewicz goto fail_string_ids; 2158443f2d2SAndrzej Pietrasiewicz msg_device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id; 2168443f2d2SAndrzej Pietrasiewicz 2178443f2d2SAndrzej Pietrasiewicz status = usb_add_config(cdev, &msg_config_driver, msg_do_config); 2188443f2d2SAndrzej Pietrasiewicz if (status < 0) 2198443f2d2SAndrzej Pietrasiewicz goto fail_string_ids; 2208443f2d2SAndrzej Pietrasiewicz 2218443f2d2SAndrzej Pietrasiewicz usb_composite_overwrite_options(cdev, &coverwrite); 2228443f2d2SAndrzej Pietrasiewicz dev_info(&cdev->gadget->dev, 2238443f2d2SAndrzej Pietrasiewicz DRIVER_DESC ", version: " DRIVER_VERSION "\n"); 2248443f2d2SAndrzej Pietrasiewicz set_bit(0, &msg_registered); 2258443f2d2SAndrzej Pietrasiewicz return 0; 2268443f2d2SAndrzej Pietrasiewicz 2278443f2d2SAndrzej Pietrasiewicz fail_string_ids: 2288443f2d2SAndrzej Pietrasiewicz fsg_common_remove_luns(opts->common); 2298443f2d2SAndrzej Pietrasiewicz fail_set_cdev: 2308443f2d2SAndrzej Pietrasiewicz fsg_common_free_luns(opts->common); 2318443f2d2SAndrzej Pietrasiewicz fail_set_nluns: 2328443f2d2SAndrzej Pietrasiewicz fsg_common_free_buffers(opts->common); 2338443f2d2SAndrzej Pietrasiewicz fail: 2348443f2d2SAndrzej Pietrasiewicz usb_put_function_instance(fi_msg); 2358443f2d2SAndrzej Pietrasiewicz return status; 2368443f2d2SAndrzej Pietrasiewicz } 2378443f2d2SAndrzej Pietrasiewicz 2388443f2d2SAndrzej Pietrasiewicz static int msg_unbind(struct usb_composite_dev *cdev) 2398443f2d2SAndrzej Pietrasiewicz { 2408443f2d2SAndrzej Pietrasiewicz if (!IS_ERR(f_msg)) 2418443f2d2SAndrzej Pietrasiewicz usb_put_function(f_msg); 2428443f2d2SAndrzej Pietrasiewicz 2438443f2d2SAndrzej Pietrasiewicz if (!IS_ERR(fi_msg)) 2448443f2d2SAndrzej Pietrasiewicz usb_put_function_instance(fi_msg); 2458443f2d2SAndrzej Pietrasiewicz 2468443f2d2SAndrzej Pietrasiewicz return 0; 2478443f2d2SAndrzej Pietrasiewicz } 2488443f2d2SAndrzej Pietrasiewicz 2498443f2d2SAndrzej Pietrasiewicz /****************************** Some noise ******************************/ 2508443f2d2SAndrzej Pietrasiewicz 2518443f2d2SAndrzej Pietrasiewicz static __refdata struct usb_composite_driver msg_driver = { 2528443f2d2SAndrzej Pietrasiewicz .name = "g_mass_storage", 2538443f2d2SAndrzej Pietrasiewicz .dev = &msg_device_desc, 2548443f2d2SAndrzej Pietrasiewicz .max_speed = USB_SPEED_SUPER, 2558443f2d2SAndrzej Pietrasiewicz .needs_serial = 1, 2568443f2d2SAndrzej Pietrasiewicz .strings = dev_strings, 2578443f2d2SAndrzej Pietrasiewicz .bind = msg_bind, 2588443f2d2SAndrzej Pietrasiewicz .unbind = msg_unbind, 2598443f2d2SAndrzej Pietrasiewicz }; 2608443f2d2SAndrzej Pietrasiewicz 2618443f2d2SAndrzej Pietrasiewicz MODULE_DESCRIPTION(DRIVER_DESC); 2628443f2d2SAndrzej Pietrasiewicz MODULE_AUTHOR("Michal Nazarewicz"); 2638443f2d2SAndrzej Pietrasiewicz MODULE_LICENSE("GPL"); 2648443f2d2SAndrzej Pietrasiewicz 2658443f2d2SAndrzej Pietrasiewicz static int __init msg_init(void) 2668443f2d2SAndrzej Pietrasiewicz { 2678443f2d2SAndrzej Pietrasiewicz return usb_composite_probe(&msg_driver); 2688443f2d2SAndrzej Pietrasiewicz } 2698443f2d2SAndrzej Pietrasiewicz module_init(msg_init); 2708443f2d2SAndrzej Pietrasiewicz 2718443f2d2SAndrzej Pietrasiewicz static void msg_cleanup(void) 2728443f2d2SAndrzej Pietrasiewicz { 2738443f2d2SAndrzej Pietrasiewicz if (test_and_clear_bit(0, &msg_registered)) 2748443f2d2SAndrzej Pietrasiewicz usb_composite_unregister(&msg_driver); 2758443f2d2SAndrzej Pietrasiewicz } 2768443f2d2SAndrzej Pietrasiewicz module_exit(msg_cleanup); 277