2 * epautoconf.c -- endpoint autoconfiguration for usb gadget drivers
4 * Copyright (C) 2004 David Brownell
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Ported to U-boot by: Thomas Smits <ts.smits@gmail.com> and
21 * Remy Bohmer <linux@bohmer.net>
25 #include <linux/usb/ch9.h>
26 #include <asm/errno.h>
27 #include <linux/usb/gadget.h>
28 #include "gadget_chips.h"
30 #define isdigit(c) ('0' <= (c) && (c) <= '9')
32 /* we must assign addresses for configurable endpoints (like net2280) */
33 static unsigned epnum;
35 // #define MANY_ENDPOINTS
37 /* more than 15 configurable endpoints */
38 static unsigned in_epnum;
43 * This should work with endpoints from controller drivers sharing the
44 * same endpoint naming convention. By example:
46 * - ep1, ep2, ... address is fixed, not direction or type
47 * - ep1in, ep2out, ... address and direction are fixed, not type
48 * - ep1-bulk, ep2-bulk, ... address and type are fixed, not direction
49 * - ep1in-bulk, ep2out-iso, ... all three are fixed
50 * - ep-* ... no functionality restrictions
52 * Type suffixes are "-bulk", "-iso", or "-int". Numbers are decimal.
53 * Less common restrictions are implied by gadget_is_*().
55 * NOTE: each endpoint is unidirectional, as specified by its USB
56 * descriptor; and isn't specific to a configuration or altsetting.
60 struct usb_gadget *gadget,
62 struct usb_endpoint_descriptor *desc
69 /* endpoint already claimed? */
70 if (NULL != ep->driver_data)
73 /* only support ep0 for portable CONTROL traffic */
74 type = desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
75 if (USB_ENDPOINT_XFER_CONTROL == type)
78 /* some other naming convention */
79 if ('e' != ep->name[0])
82 /* type-restriction: "-iso", "-bulk", or "-int".
83 * direction-restriction: "in", "out".
85 if ('-' != ep->name[2]) {
86 tmp = strrchr (ep->name, '-');
89 case USB_ENDPOINT_XFER_INT:
90 /* bulk endpoints handle interrupt transfers,
91 * except the toggle-quirky iso-synch kind
93 if ('s' == tmp[2]) // == "-iso"
95 /* for now, avoid PXA "interrupt-in";
96 * it's documented as never using DATA1.
98 if (gadget_is_pxa (gadget)
102 case USB_ENDPOINT_XFER_BULK:
103 if ('b' != tmp[1]) // != "-bulk"
106 case USB_ENDPOINT_XFER_ISOC:
107 if ('s' != tmp[2]) // != "-iso"
111 tmp = ep->name + strlen (ep->name);
114 /* direction-restriction: "..in-..", "out-.." */
116 if (!isdigit (*tmp)) {
117 if (desc->bEndpointAddress & USB_DIR_IN) {
127 /* endpoint maxpacket size is an input parameter, except for bulk
128 * where it's an output parameter representing the full speed limit.
129 * the usb spec fixes high speed bulk maxpacket at 512 bytes.
131 max = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
133 case USB_ENDPOINT_XFER_INT:
134 /* INT: limit 64 bytes full speed, 1024 high speed */
135 if (!gadget->is_dualspeed && max > 64)
139 case USB_ENDPOINT_XFER_ISOC:
140 /* ISO: limit 1023 bytes full speed, 1024 high speed */
141 if (ep->maxpacket < max)
143 if (!gadget->is_dualspeed && max > 1023)
146 /* BOTH: "high bandwidth" works only at high speed */
147 if ((desc->wMaxPacketSize & __constant_cpu_to_le16(3<<11))) {
148 if (!gadget->is_dualspeed)
150 /* configure your hardware with enough buffering!! */
158 if (isdigit (ep->name [2])) {
159 u8 num = simple_strtoul (&ep->name [2], NULL, 10);
160 desc->bEndpointAddress |= num;
161 #ifdef MANY_ENDPOINTS
162 } else if (desc->bEndpointAddress & USB_DIR_IN) {
165 desc->bEndpointAddress = USB_DIR_IN | in_epnum;
170 desc->bEndpointAddress |= epnum;
173 /* report (variable) full speed bulk maxpacket */
174 if (USB_ENDPOINT_XFER_BULK == type) {
175 int size = ep->maxpacket;
177 /* min() doesn't work on bitfields with gcc-3.5 */
180 desc->wMaxPacketSize = cpu_to_le16(size);
185 static struct usb_ep *
186 find_ep (struct usb_gadget *gadget, const char *name)
190 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
191 if (0 == strcmp (ep->name, name))
198 * usb_ep_autoconfig - choose an endpoint matching the descriptor
199 * @gadget: The device to which the endpoint must belong.
200 * @desc: Endpoint descriptor, with endpoint direction and transfer mode
201 * initialized. For periodic transfers, the maximum packet
202 * size must also be initialized. This is modified on success.
204 * By choosing an endpoint to use with the specified descriptor, this
205 * routine simplifies writing gadget drivers that work with multiple
206 * USB device controllers. The endpoint would be passed later to
207 * usb_ep_enable(), along with some descriptor.
209 * That second descriptor won't always be the same as the first one.
210 * For example, isochronous endpoints can be autoconfigured for high
211 * bandwidth, and then used in several lower bandwidth altsettings.
212 * Also, high and full speed descriptors will be different.
214 * Be sure to examine and test the results of autoconfiguration on your
215 * hardware. This code may not make the best choices about how to use the
216 * USB controller, and it can't know all the restrictions that may apply.
217 * Some combinations of driver and hardware won't be able to autoconfigure.
219 * On success, this returns an un-claimed usb_ep, and modifies the endpoint
220 * descriptor bEndpointAddress. For bulk endpoints, the wMaxPacket value
221 * is initialized as if the endpoint were used at full speed. To prevent
222 * the endpoint from being returned by a later autoconfig call, claim it
223 * by assigning ep->driver_data to some non-null value.
225 * On failure, this returns a null endpoint descriptor.
227 struct usb_ep * usb_ep_autoconfig (
228 struct usb_gadget *gadget,
229 struct usb_endpoint_descriptor *desc
235 type = desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
237 /* First, apply chip-specific "best usage" knowledge.
238 * This might make a good usb_gadget_ops hook ...
240 if (gadget_is_net2280 (gadget) && type == USB_ENDPOINT_XFER_INT) {
241 /* ep-e, ep-f are PIO with only 64 byte fifos */
242 ep = find_ep (gadget, "ep-e");
243 if (ep && ep_matches (gadget, ep, desc))
245 ep = find_ep (gadget, "ep-f");
246 if (ep && ep_matches (gadget, ep, desc))
249 } else if (gadget_is_goku (gadget)) {
250 if (USB_ENDPOINT_XFER_INT == type) {
251 /* single buffering is enough */
252 ep = find_ep (gadget, "ep3-bulk");
253 if (ep && ep_matches (gadget, ep, desc))
255 } else if (USB_ENDPOINT_XFER_BULK == type
256 && (USB_DIR_IN & desc->bEndpointAddress)) {
257 /* DMA may be available */
258 ep = find_ep (gadget, "ep2-bulk");
259 if (ep && ep_matches (gadget, ep, desc))
263 } else if (gadget_is_sh (gadget) && USB_ENDPOINT_XFER_INT == type) {
264 /* single buffering is enough; maybe 8 byte fifo is too */
265 ep = find_ep (gadget, "ep3in-bulk");
266 if (ep && ep_matches (gadget, ep, desc))
269 } else if (gadget_is_mq11xx (gadget) && USB_ENDPOINT_XFER_INT == type) {
270 ep = find_ep (gadget, "ep1-bulk");
271 if (ep && ep_matches (gadget, ep, desc))
275 /* Second, look at endpoints until an unclaimed one looks usable */
276 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
277 if (ep_matches (gadget, ep, desc))
286 * usb_ep_autoconfig_reset - reset endpoint autoconfig state
287 * @gadget: device for which autoconfig state will be reset
289 * Use this for devices where one configuration may need to assign
290 * endpoint resources very differently from the next one. It clears
291 * state such as ep->driver_data and the record of assigned endpoints
292 * used by usb_ep_autoconfig().
294 void usb_ep_autoconfig_reset (struct usb_gadget *gadget)
298 list_for_each_entry (ep, &gadget->ep_list, ep_list) {
299 ep->driver_data = NULL;
301 #ifdef MANY_ENDPOINTS