Commit | Line | Data |
---|---|---|
f2ebf92c BW |
1 | /* |
2 | * gmidi.c -- USB MIDI Gadget Driver | |
3 | * | |
4 | * Copyright (C) 2006 Thumtronics Pty Ltd. | |
5 | * Developed for Thumtronics by Grey Innovation | |
6 | * Ben Williamson <ben.williamson@greyinnovation.com> | |
7 | * | |
8 | * This software is distributed under the terms of the GNU General Public | |
9 | * License ("GPL") version 2, as published by the Free Software Foundation. | |
10 | * | |
11 | * This code is based in part on: | |
12 | * | |
13 | * Gadget Zero driver, Copyright (C) 2003-2004 David Brownell. | |
14 | * USB Audio driver, Copyright (C) 2002 by Takashi Iwai. | |
15 | * USB MIDI driver, Copyright (C) 2002-2005 Clemens Ladisch. | |
16 | * | |
17 | * Refer to the USB Device Class Definition for MIDI Devices: | |
18 | * http://www.usb.org/developers/devclass_docs/midi10.pdf | |
19 | */ | |
20 | ||
8c070216 | 21 | /* #define VERBOSE_DEBUG */ |
f2ebf92c | 22 | |
f2ebf92c | 23 | #include <linux/kernel.h> |
5a0e3ad6 | 24 | #include <linux/slab.h> |
f2ebf92c | 25 | #include <linux/utsname.h> |
6eb0de82 | 26 | #include <linux/module.h> |
f2ebf92c | 27 | #include <linux/device.h> |
f2ebf92c | 28 | |
f2ebf92c BW |
29 | #include <sound/core.h> |
30 | #include <sound/initval.h> | |
31 | #include <sound/rawmidi.h> | |
32 | ||
5f848137 | 33 | #include <linux/usb/ch9.h> |
9454a57a | 34 | #include <linux/usb/gadget.h> |
f2ebf92c BW |
35 | #include <linux/usb/audio.h> |
36 | #include <linux/usb/midi.h> | |
37 | ||
38 | #include "gadget_chips.h" | |
39 | ||
2672eea5 | 40 | #include "composite.c" |
2672eea5 | 41 | #include "f_midi.c" |
77f754c4 DB |
42 | |
43 | /*-------------------------------------------------------------------------*/ | |
44 | ||
f2ebf92c BW |
45 | MODULE_AUTHOR("Ben Williamson"); |
46 | MODULE_LICENSE("GPL v2"); | |
47 | ||
f2ebf92c BW |
48 | static const char shortname[] = "g_midi"; |
49 | static const char longname[] = "MIDI Gadget"; | |
50 | ||
7d16e8d3 SAS |
51 | USB_GADGET_COMPOSITE_OPTIONS(); |
52 | ||
f2ebf92c | 53 | static int index = SNDRV_DEFAULT_IDX1; |
2672eea5 | 54 | module_param(index, int, S_IRUGO); |
f2ebf92c | 55 | MODULE_PARM_DESC(index, "Index value for the USB MIDI Gadget adapter."); |
f2ebf92c | 56 | |
2672eea5 DM |
57 | static char *id = SNDRV_DEFAULT_STR1; |
58 | module_param(id, charp, S_IRUGO); | |
59 | MODULE_PARM_DESC(id, "ID string for the USB MIDI Gadget adapter."); | |
f2ebf92c | 60 | |
2672eea5 | 61 | static unsigned int buflen = 256; |
f2ebf92c | 62 | module_param(buflen, uint, S_IRUGO); |
2672eea5 | 63 | MODULE_PARM_DESC(buflen, "MIDI buffer length"); |
f2ebf92c | 64 | |
2672eea5 DM |
65 | static unsigned int qlen = 32; |
66 | module_param(qlen, uint, S_IRUGO); | |
67 | MODULE_PARM_DESC(qlen, "USB read request queue length"); | |
f2ebf92c | 68 | |
c8933c3f DM |
69 | static unsigned int in_ports = 1; |
70 | module_param(in_ports, uint, S_IRUGO); | |
71 | MODULE_PARM_DESC(in_ports, "Number of MIDI input ports"); | |
72 | ||
73 | static unsigned int out_ports = 1; | |
74 | module_param(out_ports, uint, S_IRUGO); | |
75 | MODULE_PARM_DESC(out_ports, "Number of MIDI output ports"); | |
76 | ||
f2ebf92c BW |
77 | /* Thanks to Grey Innovation for donating this product ID. |
78 | * | |
79 | * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!! | |
80 | * Instead: allocate your own, using normal USB-IF procedures. | |
81 | */ | |
82 | #define DRIVER_VENDOR_NUM 0x17b3 /* Grey Innovation */ | |
83 | #define DRIVER_PRODUCT_NUM 0x0004 /* Linux-USB "MIDI Gadget" */ | |
84 | ||
2672eea5 | 85 | /* string IDs are assigned dynamically */ |
f2ebf92c | 86 | |
2672eea5 DM |
87 | #define STRING_MANUFACTURER_IDX 0 |
88 | #define STRING_PRODUCT_IDX 1 | |
89 | #define STRING_DESCRIPTION_IDX 2 | |
f2ebf92c | 90 | |
f2ebf92c BW |
91 | static struct usb_device_descriptor device_desc = { |
92 | .bLength = USB_DT_DEVICE_SIZE, | |
93 | .bDescriptorType = USB_DT_DEVICE, | |
2672eea5 | 94 | .bcdUSB = __constant_cpu_to_le16(0x0200), |
f2ebf92c | 95 | .bDeviceClass = USB_CLASS_PER_INTERFACE, |
2672eea5 DM |
96 | .idVendor = __constant_cpu_to_le16(DRIVER_VENDOR_NUM), |
97 | .idProduct = __constant_cpu_to_le16(DRIVER_PRODUCT_NUM), | |
98 | /* .iManufacturer = DYNAMIC */ | |
99 | /* .iProduct = DYNAMIC */ | |
f2ebf92c BW |
100 | .bNumConfigurations = 1, |
101 | }; | |
102 | ||
2672eea5 DM |
103 | static struct usb_string strings_dev[] = { |
104 | [STRING_MANUFACTURER_IDX].s = "Grey Innovation", | |
105 | [STRING_PRODUCT_IDX].s = "MIDI Gadget", | |
106 | [STRING_DESCRIPTION_IDX].s = "MIDI", | |
107 | { } /* end of list */ | |
f2ebf92c BW |
108 | }; |
109 | ||
2672eea5 | 110 | static struct usb_gadget_strings stringtab_dev = { |
f2ebf92c | 111 | .language = 0x0409, /* en-us */ |
2672eea5 | 112 | .strings = strings_dev, |
f2ebf92c BW |
113 | }; |
114 | ||
2672eea5 DM |
115 | static struct usb_gadget_strings *dev_strings[] = { |
116 | &stringtab_dev, | |
117 | NULL, | |
f2ebf92c BW |
118 | }; |
119 | ||
2672eea5 | 120 | static int __exit midi_unbind(struct usb_composite_dev *dev) |
f2ebf92c | 121 | { |
f2ebf92c BW |
122 | return 0; |
123 | } | |
124 | ||
2672eea5 DM |
125 | static struct usb_configuration midi_config = { |
126 | .label = "MIDI Gadget", | |
127 | .bConfigurationValue = 1, | |
128 | /* .iConfiguration = DYNAMIC */ | |
129 | .bmAttributes = USB_CONFIG_ATT_ONE, | |
130 | .bMaxPower = CONFIG_USB_GADGET_VBUS_DRAW / 2, | |
f2ebf92c BW |
131 | }; |
132 | ||
2672eea5 | 133 | static int __init midi_bind_config(struct usb_configuration *c) |
f2ebf92c | 134 | { |
c8933c3f DM |
135 | return f_midi_bind_config(c, index, id, |
136 | in_ports, out_ports, | |
137 | buflen, qlen); | |
f2ebf92c BW |
138 | } |
139 | ||
2672eea5 | 140 | static int __init midi_bind(struct usb_composite_dev *cdev) |
f2ebf92c | 141 | { |
2672eea5 DM |
142 | struct usb_gadget *gadget = cdev->gadget; |
143 | int gcnum, status; | |
f2ebf92c | 144 | |
e1f15ccb | 145 | status = usb_string_ids_tab(cdev, strings_dev); |
2672eea5 DM |
146 | if (status < 0) |
147 | return status; | |
e1f15ccb SAS |
148 | device_desc.iManufacturer = strings_dev[STRING_MANUFACTURER_IDX].id; |
149 | device_desc.iProduct = strings_dev[STRING_PRODUCT_IDX].id; | |
150 | midi_config.iConfiguration = strings_dev[STRING_DESCRIPTION_IDX].id; | |
f2ebf92c BW |
151 | |
152 | gcnum = usb_gadget_controller_number(gadget); | |
2672eea5 | 153 | if (gcnum < 0) { |
f2ebf92c BW |
154 | /* gmidi is so simple (no altsettings) that |
155 | * it SHOULD NOT have problems with bulk-capable hardware. | |
156 | * so warn about unrecognized controllers, don't panic. | |
157 | */ | |
00274921 | 158 | pr_warning("%s: controller '%s' not recognized\n", |
2672eea5 | 159 | __func__, gadget->name); |
551509d2 | 160 | device_desc.bcdDevice = cpu_to_le16(0x9999); |
2672eea5 DM |
161 | } else { |
162 | device_desc.bcdDevice = cpu_to_le16(0x0200 + gcnum); | |
f2ebf92c BW |
163 | } |
164 | ||
2672eea5 DM |
165 | status = usb_add_config(cdev, &midi_config, midi_bind_config); |
166 | if (status < 0) | |
167 | return status; | |
7d16e8d3 | 168 | usb_composite_overwrite_options(cdev, &coverwrite); |
2672eea5 | 169 | pr_info("%s\n", longname); |
f2ebf92c | 170 | return 0; |
f2ebf92c BW |
171 | } |
172 | ||
c2ec75c2 | 173 | static __refdata struct usb_composite_driver midi_driver = { |
2672eea5 DM |
174 | .name = (char *) longname, |
175 | .dev = &device_desc, | |
176 | .strings = dev_strings, | |
177 | .max_speed = USB_SPEED_HIGH, | |
03e42bd5 | 178 | .bind = midi_bind, |
2672eea5 | 179 | .unbind = __exit_p(midi_unbind), |
f2ebf92c BW |
180 | }; |
181 | ||
2672eea5 | 182 | static int __init midi_init(void) |
f2ebf92c | 183 | { |
03e42bd5 | 184 | return usb_composite_probe(&midi_driver); |
f2ebf92c | 185 | } |
2672eea5 | 186 | module_init(midi_init); |
f2ebf92c | 187 | |
2672eea5 | 188 | static void __exit midi_cleanup(void) |
f2ebf92c | 189 | { |
2672eea5 | 190 | usb_composite_unregister(&midi_driver); |
f2ebf92c | 191 | } |
2672eea5 | 192 | module_exit(midi_cleanup); |
f2ebf92c | 193 |