3 * Gerry Hamel, geh@ti.com, Texas Instruments
6 * linux/drivers/usbd/usbd.c.c - USB Device Core Layer
8 * Copyright (c) 2000, 2001, 2002 Lineo
9 * Copyright (c) 2001 Hewlett Packard
12 * Stuart Lynne <sl@lineo.com>,
13 * Tom Rushworth <tbr@lineo.com>,
14 * Bruce Balden <balden@lineo.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
35 #define MAX_INTERFACES 2
40 /* Global variables ************************************************************************** */
42 struct usb_string_descriptor
**usb_strings
;
46 extern struct usb_function_driver ep0_driver
;
48 int registered_functions
;
49 int registered_devices
;
51 char *usbd_device_events
[] = {
55 "DEVICE_HUB_CONFIGURED",
57 "DEVICE_ADDRESS_ASSIGNED",
59 "DEVICE_SET_INTERFACE",
61 "DEVICE_CLEAR_FEATURE",
62 "DEVICE_DE_CONFIGURED",
63 "DEVICE_BUS_INACTIVE",
64 "DEVICE_BUS_ACTIVITY",
65 "DEVICE_POWER_INTERRUPTION",
68 "DEVICE_FUNCTION_PRIVATE",
71 char *usbd_device_states
[] = {
82 char *usbd_device_requests
[] = {
84 "CLEAR FEATURE", /* 1 */
86 "SET FEATURE", /* 3 */
88 "SET ADDRESS", /* 5 */
89 "GET DESCRIPTOR", /* 6 */
90 "SET DESCRIPTOR", /* 7 */
91 "GET CONFIGURATION", /* 8 */
92 "SET CONFIGURATION", /* 9 */
93 "GET INTERFACE", /* 10 */
94 "SET INTERFACE", /* 11 */
95 "SYNC FRAME", /* 12 */
98 char *usbd_device_descriptors
[] = {
105 "DEVICE QUALIFIER", /* 6 */
106 "OTHER SPEED", /* 7 */
107 "INTERFACE POWER", /* 8 */
110 char *usbd_device_status
[] = {
118 /* Descriptor support functions ************************************************************** */
122 * usbd_get_string - find and return a string descriptor
123 * @index: string index to return
125 * Find an indexed string and return a pointer to a it.
127 struct usb_string_descriptor
*usbd_get_string (__u8 index
)
129 if (index
>= maxstrings
) {
132 return usb_strings
[index
];
136 /* Access to device descriptor functions ***************************************************** */
140 * usbd_device_configuration_instance - find a configuration instance for this device
142 * @configuration: index to configuration, 0 - N-1
144 * Get specifed device configuration. Index should be bConfigurationValue-1.
146 static struct usb_configuration_instance
*usbd_device_configuration_instance (struct usb_device_instance
*device
,
147 unsigned int port
, unsigned int configuration
)
150 configuration
= configuration
? configuration
- 1 : 0;
152 if (configuration
>= device
->configurations
) {
155 return device
->configuration_instance_array
+ configuration
;
160 * usbd_device_interface_instance
162 * @configuration: index to configuration, 0 - N-1
163 * @interface: index to interface
165 * Return the specified interface descriptor for the specified device.
167 struct usb_interface_instance
*usbd_device_interface_instance (struct usb_device_instance
*device
, int port
, int configuration
, int interface
)
169 struct usb_configuration_instance
*configuration_instance
;
171 if ((configuration_instance
= usbd_device_configuration_instance (device
, port
, configuration
)) == NULL
) {
174 if (interface
>= configuration_instance
->interfaces
) {
177 return configuration_instance
->interface_instance_array
+ interface
;
181 * usbd_device_alternate_descriptor_list
183 * @configuration: index to configuration, 0 - N-1
184 * @interface: index to interface
185 * @alternate: alternate setting
187 * Return the specified alternate descriptor for the specified device.
189 struct usb_alternate_instance
*usbd_device_alternate_instance (struct usb_device_instance
*device
, int port
, int configuration
, int interface
, int alternate
)
191 struct usb_interface_instance
*interface_instance
;
193 if ((interface_instance
= usbd_device_interface_instance (device
, port
, configuration
, interface
)) == NULL
) {
197 if (alternate
>= interface_instance
->alternates
) {
201 return interface_instance
->alternates_instance_array
+ alternate
;
206 * usbd_device_device_descriptor
207 * @device: which device
208 * @configuration: index to configuration, 0 - N-1
211 * Return the specified configuration descriptor for the specified device.
213 struct usb_device_descriptor
*usbd_device_device_descriptor (struct usb_device_instance
*device
, int port
)
215 return (device
->device_descriptor
);
220 * usbd_device_configuration_descriptor
221 * @device: which device
223 * @configuration: index to configuration, 0 - N-1
225 * Return the specified configuration descriptor for the specified device.
227 struct usb_configuration_descriptor
*usbd_device_configuration_descriptor (struct
229 *device
, int port
, int configuration
)
231 struct usb_configuration_instance
*configuration_instance
;
232 if (!(configuration_instance
= usbd_device_configuration_instance (device
, port
, configuration
))) {
235 return (configuration_instance
->configuration_descriptor
);
240 * usbd_device_interface_descriptor
241 * @device: which device
243 * @configuration: index to configuration, 0 - N-1
244 * @interface: index to interface
245 * @alternate: alternate setting
247 * Return the specified interface descriptor for the specified device.
249 struct usb_interface_descriptor
*usbd_device_interface_descriptor (struct usb_device_instance
250 *device
, int port
, int configuration
, int interface
, int alternate
)
252 struct usb_interface_instance
*interface_instance
;
253 if (!(interface_instance
= usbd_device_interface_instance (device
, port
, configuration
, interface
))) {
256 if ((alternate
< 0) || (alternate
>= interface_instance
->alternates
)) {
259 return (interface_instance
->alternates_instance_array
[alternate
].interface_descriptor
);
263 * usbd_device_endpoint_descriptor_index
264 * @device: which device
266 * @configuration: index to configuration, 0 - N-1
267 * @interface: index to interface
268 * @alternate: index setting
269 * @index: which index
271 * Return the specified endpoint descriptor for the specified device.
273 struct usb_endpoint_descriptor
*usbd_device_endpoint_descriptor_index (struct usb_device_instance
274 *device
, int port
, int configuration
, int interface
, int alternate
, int index
)
276 struct usb_alternate_instance
*alternate_instance
;
278 if (!(alternate_instance
= usbd_device_alternate_instance (device
, port
, configuration
, interface
, alternate
))) {
281 if (index
>= alternate_instance
->endpoints
) {
284 return *(alternate_instance
->endpoints_descriptor_array
+ index
);
289 * usbd_device_endpoint_transfersize
290 * @device: which device
292 * @configuration: index to configuration, 0 - N-1
293 * @interface: index to interface
294 * @index: which index
296 * Return the specified endpoint transfer size;
298 int usbd_device_endpoint_transfersize (struct usb_device_instance
*device
, int port
, int configuration
, int interface
, int alternate
, int index
)
300 struct usb_alternate_instance
*alternate_instance
;
302 if (!(alternate_instance
= usbd_device_alternate_instance (device
, port
, configuration
, interface
, alternate
))) {
305 if (index
>= alternate_instance
->endpoints
) {
308 return *(alternate_instance
->endpoint_transfersize_array
+ index
);
313 * usbd_device_endpoint_descriptor
314 * @device: which device
316 * @configuration: index to configuration, 0 - N-1
317 * @interface: index to interface
318 * @alternate: alternate setting
319 * @endpoint: which endpoint
321 * Return the specified endpoint descriptor for the specified device.
323 struct usb_endpoint_descriptor
*usbd_device_endpoint_descriptor (struct usb_device_instance
*device
, int port
, int configuration
, int interface
, int alternate
, int endpoint
)
325 struct usb_endpoint_descriptor
*endpoint_descriptor
;
328 for (i
= 0; !(endpoint_descriptor
= usbd_device_endpoint_descriptor_index (device
, port
, configuration
, interface
, alternate
, i
)); i
++) {
329 if (endpoint_descriptor
->bEndpointAddress
== endpoint
) {
330 return endpoint_descriptor
;
337 * usbd_endpoint_halted
338 * @device: point to struct usb_device_instance
339 * @endpoint: endpoint to check
341 * Return non-zero if endpoint is halted.
343 int usbd_endpoint_halted (struct usb_device_instance
*device
, int endpoint
)
345 return (device
->status
== USB_STATUS_HALT
);
350 * usbd_rcv_complete - complete a receive
355 * Called from rcv interrupt to complete.
357 void usbd_rcv_complete(struct usb_endpoint_instance
*endpoint
, int len
, int urb_bad
)
362 /*usbdbg("len: %d urb: %p\n", len, endpoint->rcv_urb); */
364 /* if we had an urb then update actual_length, dispatch if neccessary */
365 if ((rcv_urb
= endpoint
->rcv_urb
)) {
367 /*usbdbg("actual: %d buffer: %d\n", */
368 /*rcv_urb->actual_length, rcv_urb->buffer_length); */
370 /* check the urb is ok, are we adding data less than the packetsize */
371 if (!urb_bad
&& (len
<= endpoint
->rcv_packetSize
)) {
372 /*usbdbg("updating actual_length by %d\n",len); */
374 /* increment the received data size */
375 rcv_urb
->actual_length
+= len
;
378 usberr(" RECV_ERROR actual: %d buffer: %d urb_bad: %d\n",
379 rcv_urb
->actual_length
, rcv_urb
->buffer_length
, urb_bad
);
381 rcv_urb
->actual_length
= 0;
382 rcv_urb
->status
= RECV_ERROR
;
385 usberr("no rcv_urb!");
388 usberr("no endpoint!");
394 * usbd_tx_complete - complete a transmit
398 * Called from tx interrupt to complete.
400 void usbd_tx_complete (struct usb_endpoint_instance
*endpoint
)
405 /* if we have a tx_urb advance or reset, finish if complete */
406 if ((tx_urb
= endpoint
->tx_urb
)) {
407 int sent
= endpoint
->last
;
408 endpoint
->sent
+= sent
;
409 endpoint
->last
-= sent
;
411 if( (endpoint
->tx_urb
->actual_length
- endpoint
->sent
) <= 0 ) {
412 tx_urb
->actual_length
= 0;
416 /* Remove from active, save for re-use */
418 urb_append(&endpoint
->done
, tx_urb
);
419 /*usbdbg("done->next %p, tx_urb %p, done %p", */
420 /* endpoint->done.next, tx_urb, &endpoint->done); */
422 endpoint
->tx_urb
= first_urb_detached(&endpoint
->tx
);
423 if( endpoint
->tx_urb
) {
424 endpoint
->tx_queue
--;
425 usbdbg("got urb from tx list");
427 if( !endpoint
->tx_urb
) {
428 /*usbdbg("taking urb from done list"); */
429 endpoint
->tx_urb
= first_urb_detached(&endpoint
->done
);
431 if( !endpoint
->tx_urb
) {
432 usbdbg("allocating new urb for tx_urb");
433 endpoint
->tx_urb
= usbd_alloc_urb(tx_urb
->device
, endpoint
);
440 /* URB linked list functions ***************************************************** */
443 * Initialize an urb_link to be a single element list.
444 * If the urb_link is being used as a distinguished list head
445 * the list is empty when the head is the only link in the list.
447 void urb_link_init (urb_link
* ul
)
450 ul
->prev
= ul
->next
= ul
;
455 * Detach an urb_link from a list, and set it
456 * up as a single element list, so no dangling
457 * pointers can be followed, and so it can be
458 * joined to another list if so desired.
460 void urb_detach (struct urb
*urb
)
463 urb_link
*ul
= &urb
->link
;
464 ul
->next
->prev
= ul
->prev
;
465 ul
->prev
->next
= ul
->next
;
471 * Return the first urb_link in a list with a distinguished
472 * head "hd", or NULL if the list is empty. This will also
473 * work as a predicate, returning NULL if empty, and non-NULL
476 urb_link
*first_urb_link (urb_link
* hd
)
479 if (NULL
!= hd
&& NULL
!= (nx
= hd
->next
) && nx
!= hd
) {
480 /* There is at least one element in the list */
481 /* (besides the distinguished head). */
484 /* The list is empty */
489 * Return the first urb in a list with a distinguished
490 * head "hd", or NULL if the list is empty.
492 struct urb
*first_urb (urb_link
* hd
)
495 if (NULL
== (nx
= first_urb_link (hd
))) {
496 /* The list is empty */
499 return (p2surround (struct urb
, link
, nx
));
503 * Detach and return the first urb in a list with a distinguished
504 * head "hd", or NULL if the list is empty.
507 struct urb
*first_urb_detached (urb_link
* hd
)
510 if ((urb
= first_urb (hd
))) {
518 * Append an urb_link (or a whole list of
519 * urb_links) to the tail of another list
522 void urb_append (urb_link
* hd
, struct urb
*urb
)
525 urb_link
*new = &urb
->link
;
527 /* This allows the new urb to be a list of urbs, */
528 /* with new pointing at the first, but the link */
529 /* must be initialized. */
530 /* Order is important here... */
531 urb_link
*pul
= hd
->prev
;
532 new->prev
->next
= hd
;
533 hd
->prev
= new->prev
;
539 /* URB create/destroy functions ***************************************************** */
542 * usbd_alloc_urb - allocate an URB appropriate for specified endpoint
543 * @device: device instance
544 * @endpoint: endpoint
546 * Allocate an urb structure. The usb device urb structure is used to
547 * contain all data associated with a transfer, including a setup packet for
550 * NOTE: endpoint_address MUST contain a direction flag.
552 struct urb
*usbd_alloc_urb (struct usb_device_instance
*device
, struct usb_endpoint_instance
*endpoint
)
556 if( !(urb
= (struct urb
*)malloc(sizeof(struct urb
))) ) {
557 usberr(" F A T A L: malloc(%u) FAILED!!!!", sizeof(struct urb
));
561 /* Fill in known fields */
562 memset(urb
, 0, sizeof(struct urb
));
563 urb
->endpoint
= endpoint
;
564 urb
->device
= device
;
565 urb
->buffer
= (u8
*)urb
->buffer_data
;
566 urb
->buffer_length
= sizeof(urb
->buffer_data
);
568 urb_link_init (&urb
->link
);
574 * usbd_dealloc_urb - deallocate an URB and associated buffer
575 * @urb: pointer to an urb structure
577 * Deallocate an urb structure and associated data.
579 void usbd_dealloc_urb (struct urb
*urb
)
586 /* Event signaling functions ***************************************************** */
589 * usbd_device_event - called to respond to various usb events
590 * @device: pointer to struct device
591 * @event: event to respond to
593 * Used by a Bus driver to indicate an event.
595 void usbd_device_event_irq (struct usb_device_instance
*device
, usb_device_event_t event
, int data
)
597 usb_device_state_t state
;
599 if (!device
|| !device
->bus
) {
600 usberr("(%p,%d) NULL device or device->bus", device
, event
);
604 state
= device
->device_state
;
606 usbinfo("%s", usbd_device_events
[event
]);
612 device
->device_state
= STATE_INIT
;
616 device
->device_state
= STATE_ATTACHED
;
619 case DEVICE_HUB_CONFIGURED
:
620 device
->device_state
= STATE_POWERED
;
624 device
->device_state
= STATE_DEFAULT
;
628 case DEVICE_ADDRESS_ASSIGNED
:
629 device
->device_state
= STATE_ADDRESSED
;
632 case DEVICE_CONFIGURED
:
633 device
->device_state
= STATE_CONFIGURED
;
636 case DEVICE_DE_CONFIGURED
:
637 device
->device_state
= STATE_ADDRESSED
;
640 case DEVICE_BUS_INACTIVE
:
641 if (device
->status
!= USBD_CLOSING
) {
642 device
->status
= USBD_SUSPENDED
;
645 case DEVICE_BUS_ACTIVITY
:
646 if (device
->status
!= USBD_CLOSING
) {
647 device
->status
= USBD_OK
;
651 case DEVICE_SET_INTERFACE
:
653 case DEVICE_SET_FEATURE
:
655 case DEVICE_CLEAR_FEATURE
:
658 case DEVICE_POWER_INTERRUPTION
:
659 device
->device_state
= STATE_POWERED
;
661 case DEVICE_HUB_RESET
:
662 device
->device_state
= STATE_ATTACHED
;
665 device
->device_state
= STATE_UNKNOWN
;
668 case DEVICE_FUNCTION_PRIVATE
:
672 usbdbg("event %d - not handled",event
);
675 /*usbdbg("%s event: %d oldstate: %d newstate: %d status: %d address: %d",
676 device->name, event, state,
677 device->device_state, device->status, device->address); */
679 /* tell the bus interface driver */
680 if( device
->event
) {
681 /* usbdbg("calling device->event"); */
682 device
->event(device
, event
, data
);