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> |
6eb0de82 | 25 | #include <linux/module.h> |
f2ebf92c | 26 | #include <linux/device.h> |
f2ebf92c | 27 | |
f2ebf92c BW |
28 | #include <sound/core.h> |
29 | #include <sound/initval.h> | |
30 | #include <sound/rawmidi.h> | |
31 | ||
5f848137 | 32 | #include <linux/usb/ch9.h> |
721e2e91 | 33 | #include <linux/usb/composite.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 | ||
32522a51 | 40 | #include "u_midi.h" |
77f754c4 DB |
41 | |
42 | /*-------------------------------------------------------------------------*/ | |
43 | ||
f2ebf92c BW |
44 | MODULE_AUTHOR("Ben Williamson"); |
45 | MODULE_LICENSE("GPL v2"); | |
46 | ||
f2ebf92c BW |
47 | static const char shortname[] = "g_midi"; |
48 | static const char longname[] = "MIDI Gadget"; | |
49 | ||
7d16e8d3 SAS |
50 | USB_GADGET_COMPOSITE_OPTIONS(); |
51 | ||
f2ebf92c | 52 | static int index = SNDRV_DEFAULT_IDX1; |
2672eea5 | 53 | module_param(index, int, S_IRUGO); |
f2ebf92c | 54 | MODULE_PARM_DESC(index, "Index value for the USB MIDI Gadget adapter."); |
f2ebf92c | 55 | |
2672eea5 DM |
56 | static char *id = SNDRV_DEFAULT_STR1; |
57 | module_param(id, charp, S_IRUGO); | |
58 | MODULE_PARM_DESC(id, "ID string for the USB MIDI Gadget adapter."); | |
f2ebf92c | 59 | |
2672eea5 | 60 | static unsigned int buflen = 256; |
f2ebf92c | 61 | module_param(buflen, uint, S_IRUGO); |
2672eea5 | 62 | MODULE_PARM_DESC(buflen, "MIDI buffer length"); |
f2ebf92c | 63 | |
2672eea5 DM |
64 | static unsigned int qlen = 32; |
65 | module_param(qlen, uint, S_IRUGO); | |
66 | MODULE_PARM_DESC(qlen, "USB read request queue length"); | |
f2ebf92c | 67 | |
c8933c3f DM |
68 | static unsigned int in_ports = 1; |
69 | module_param(in_ports, uint, S_IRUGO); | |
70 | MODULE_PARM_DESC(in_ports, "Number of MIDI input ports"); | |
71 | ||
72 | static unsigned int out_ports = 1; | |
73 | module_param(out_ports, uint, S_IRUGO); | |
74 | MODULE_PARM_DESC(out_ports, "Number of MIDI output ports"); | |
75 | ||
f2ebf92c BW |
76 | /* Thanks to Grey Innovation for donating this product ID. |
77 | * | |
78 | * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!! | |
79 | * Instead: allocate your own, using normal USB-IF procedures. | |
80 | */ | |
81 | #define DRIVER_VENDOR_NUM 0x17b3 /* Grey Innovation */ | |
82 | #define DRIVER_PRODUCT_NUM 0x0004 /* Linux-USB "MIDI Gadget" */ | |
83 | ||
2672eea5 | 84 | /* string IDs are assigned dynamically */ |
f2ebf92c | 85 | |
276e2e4f | 86 | #define STRING_DESCRIPTION_IDX USB_GADGET_FIRST_AVAIL_IDX |
f2ebf92c | 87 | |
f2ebf92c BW |
88 | static struct usb_device_descriptor device_desc = { |
89 | .bLength = USB_DT_DEVICE_SIZE, | |
90 | .bDescriptorType = USB_DT_DEVICE, | |
2672eea5 | 91 | .bcdUSB = __constant_cpu_to_le16(0x0200), |
f2ebf92c | 92 | .bDeviceClass = USB_CLASS_PER_INTERFACE, |
2672eea5 DM |
93 | .idVendor = __constant_cpu_to_le16(DRIVER_VENDOR_NUM), |
94 | .idProduct = __constant_cpu_to_le16(DRIVER_PRODUCT_NUM), | |
95 | /* .iManufacturer = DYNAMIC */ | |
96 | /* .iProduct = DYNAMIC */ | |
f2ebf92c BW |
97 | .bNumConfigurations = 1, |
98 | }; | |
99 | ||
2672eea5 | 100 | static struct usb_string strings_dev[] = { |
276e2e4f SAS |
101 | [USB_GADGET_MANUFACTURER_IDX].s = "Grey Innovation", |
102 | [USB_GADGET_PRODUCT_IDX].s = "MIDI Gadget", | |
103 | [USB_GADGET_SERIAL_IDX].s = "", | |
2672eea5 DM |
104 | [STRING_DESCRIPTION_IDX].s = "MIDI", |
105 | { } /* end of list */ | |
f2ebf92c BW |
106 | }; |
107 | ||
2672eea5 | 108 | static struct usb_gadget_strings stringtab_dev = { |
f2ebf92c | 109 | .language = 0x0409, /* en-us */ |
2672eea5 | 110 | .strings = strings_dev, |
f2ebf92c BW |
111 | }; |
112 | ||
2672eea5 DM |
113 | static struct usb_gadget_strings *dev_strings[] = { |
114 | &stringtab_dev, | |
115 | NULL, | |
f2ebf92c BW |
116 | }; |
117 | ||
f509fee8 FW |
118 | static struct usb_function_instance *fi_midi; |
119 | static struct usb_function *f_midi; | |
32522a51 | 120 | |
2672eea5 | 121 | static int __exit midi_unbind(struct usb_composite_dev *dev) |
f2ebf92c | 122 | { |
32522a51 AP |
123 | usb_put_function(f_midi); |
124 | usb_put_function_instance(fi_midi); | |
f2ebf92c BW |
125 | return 0; |
126 | } | |
127 | ||
2672eea5 DM |
128 | static struct usb_configuration midi_config = { |
129 | .label = "MIDI Gadget", | |
130 | .bConfigurationValue = 1, | |
131 | /* .iConfiguration = DYNAMIC */ | |
132 | .bmAttributes = USB_CONFIG_ATT_ONE, | |
8f900a9a | 133 | .MaxPower = CONFIG_USB_GADGET_VBUS_DRAW, |
f2ebf92c BW |
134 | }; |
135 | ||
2672eea5 | 136 | static int __init midi_bind_config(struct usb_configuration *c) |
f2ebf92c | 137 | { |
32522a51 AP |
138 | int status; |
139 | ||
140 | f_midi = usb_get_function(fi_midi); | |
141 | if (IS_ERR(f_midi)) | |
142 | return PTR_ERR(f_midi); | |
143 | ||
144 | status = usb_add_function(c, f_midi); | |
145 | if (status < 0) { | |
146 | usb_put_function(f_midi); | |
147 | return status; | |
148 | } | |
149 | ||
150 | return 0; | |
f2ebf92c BW |
151 | } |
152 | ||
2672eea5 | 153 | static int __init midi_bind(struct usb_composite_dev *cdev) |
f2ebf92c | 154 | { |
32522a51 | 155 | struct f_midi_opts *midi_opts; |
ed9cbda6 | 156 | int status; |
f2ebf92c | 157 | |
32522a51 AP |
158 | fi_midi = usb_get_function_instance("midi"); |
159 | if (IS_ERR(fi_midi)) | |
160 | return PTR_ERR(fi_midi); | |
161 | ||
162 | midi_opts = container_of(fi_midi, struct f_midi_opts, func_inst); | |
163 | midi_opts->index = index; | |
164 | midi_opts->id = id; | |
165 | midi_opts->in_ports = in_ports; | |
166 | midi_opts->out_ports = out_ports; | |
167 | midi_opts->buflen = buflen; | |
168 | midi_opts->qlen = qlen; | |
169 | ||
e1f15ccb | 170 | status = usb_string_ids_tab(cdev, strings_dev); |
2672eea5 | 171 | if (status < 0) |
32522a51 | 172 | goto put; |
276e2e4f SAS |
173 | device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id; |
174 | device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id; | |
e1f15ccb | 175 | midi_config.iConfiguration = strings_dev[STRING_DESCRIPTION_IDX].id; |
f2ebf92c | 176 | |
2672eea5 DM |
177 | status = usb_add_config(cdev, &midi_config, midi_bind_config); |
178 | if (status < 0) | |
32522a51 | 179 | goto put; |
7d16e8d3 | 180 | usb_composite_overwrite_options(cdev, &coverwrite); |
2672eea5 | 181 | pr_info("%s\n", longname); |
f2ebf92c | 182 | return 0; |
32522a51 AP |
183 | put: |
184 | usb_put_function_instance(fi_midi); | |
185 | return status; | |
f2ebf92c BW |
186 | } |
187 | ||
c2ec75c2 | 188 | static __refdata struct usb_composite_driver midi_driver = { |
2672eea5 DM |
189 | .name = (char *) longname, |
190 | .dev = &device_desc, | |
191 | .strings = dev_strings, | |
192 | .max_speed = USB_SPEED_HIGH, | |
03e42bd5 | 193 | .bind = midi_bind, |
2672eea5 | 194 | .unbind = __exit_p(midi_unbind), |
f2ebf92c BW |
195 | }; |
196 | ||
909346a8 | 197 | module_usb_composite_driver(midi_driver); |