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