3 * Gerry Hamel, geh@ti.com, Texas Instruments
6 * Bryan O'Donoghue, deckard@CodeHermit.ie
9 * linux/drivers/usbd/ep0.c
11 * Copyright (c) 2000, 2001, 2002 Lineo
12 * Copyright (c) 2001 Hewlett Packard
15 * Stuart Lynne <sl@lineo.com>,
16 * Tom Rushworth <tbr@lineo.com>,
17 * Bruce Balden <balden@lineo.com>
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
36 * This is the builtin ep0 control function. It implements all required functionality
37 * for responding to control requests (SETUP packets).
41 * Currently we do not pass any SETUP packets (or other) to the configured
42 * function driver. This may need to change.
46 * As alluded to above, a simple callback cdc_recv_setup has been implemented
47 * in the usb_device data structure to facilicate passing
48 * Common Device Class packets to a function driver.
54 #include <usbdevice.h>
57 #define dbg_ep0(lvl,fmt,args...) serial_printf("[%s] %s:%d: "fmt"\n",__FILE__,__FUNCTION__,__LINE__,##args)
59 #define dbg_ep0(lvl,fmt,args...)
62 /* EP0 Configuration Set ********************************************************************* */
66 * ep0_get_status - fill in URB data with appropriate status
73 static int ep0_get_status (struct usb_device_instance *device,
74 struct urb *urb, int index, int requesttype)
78 urb->actual_length = 2;
79 cp = (char*)urb->buffer;
82 switch (requesttype) {
83 case USB_REQ_RECIPIENT_DEVICE:
84 cp[0] = USB_STATUS_SELFPOWERED;
86 case USB_REQ_RECIPIENT_INTERFACE:
88 case USB_REQ_RECIPIENT_ENDPOINT:
89 cp[0] = usbd_endpoint_halted (device, index);
91 case USB_REQ_RECIPIENT_OTHER:
92 urb->actual_length = 0;
96 dbg_ep0 (2, "%02x %02x", cp[0], cp[1]);
106 * Set a single byte value in the urb send buffer. Return non-zero to signal
109 static int ep0_get_one (struct usb_device_instance *device, struct urb *urb,
112 urb->actual_length = 1; /* XXX 2? */
113 ((char *) urb->buffer)[0] = result;
119 * @urb: pointer to urb
120 * @data: pointer to configuration data
121 * @length: length of data
123 * Copy configuration data to urb transfer buffer if there is room for it.
125 void copy_config (struct urb *urb, void *data, int max_length,
131 /*dbg_ep0(3, "-> actual: %d buf: %d max_buf: %d max_length: %d data: %p", */
132 /* urb->actual_length, urb->buffer_length, max_buf, max_length, data); */
135 dbg_ep0 (1, "data is NULL");
140 if (length > max_length) {
141 dbg_ep0 (1, "length: %d >= max_length: %d", length,
145 /*dbg_ep0(1, " actual: %d buf: %d max_buf: %d max_length: %d length: %d", */
146 /* urb->actual_length, urb->buffer_length, max_buf, max_length, length); */
149 /*urb->buffer_length */ max_buf - urb->actual_length) <= 0) {
152 /*dbg_ep0(1, "actual: %d buf: %d max_buf: %d length: %d available: %d", */
153 /* urb->actual_length, urb->buffer_length, max_buf, length, available); */
155 if (length > available) {
158 /*dbg_ep0(1, "actual: %d buf: %d max_buf: %d length: %d available: %d", */
159 /* urb->actual_length, urb->buffer_length, max_buf, length, available); */
161 memcpy (urb->buffer + urb->actual_length, data, length);
162 urb->actual_length += length;
165 "copy_config: <- actual: %d buf: %d max_buf: %d max_length: %d available: %d",
166 urb->actual_length, urb->buffer_length, max_buf, max_length,
178 * Called by ep0_rx_process for a get descriptor device command. Determine what
179 * descriptor is being requested, copy to send buffer. Return zero if ok to send,
180 * return non-zero to signal a request error.
182 static int ep0_get_descriptor (struct usb_device_instance *device,
183 struct urb *urb, int max, int descriptor_type,
186 int port = 0; /* XXX compound device */
188 /*dbg_ep0(3, "max: %x type: %x index: %x", max, descriptor_type, index); */
190 if (!urb || !urb->buffer || !urb->buffer_length
191 || (urb->buffer_length < 255)) {
192 dbg_ep0 (2, "invalid urb %p", urb);
197 urb->actual_length = 0;
199 dbg_ep0 (2, "%s", USBD_DEVICE_DESCRIPTORS (descriptor_type));
201 switch (descriptor_type) {
202 case USB_DESCRIPTOR_TYPE_DEVICE:
204 struct usb_device_descriptor *device_descriptor;
207 usbd_device_device_descriptor (device, port))) {
210 /* copy descriptor for this device */
211 copy_config (urb, device_descriptor,
212 sizeof (struct usb_device_descriptor),
215 /* correct the correct control endpoint 0 max packet size into the descriptor */
217 (struct usb_device_descriptor *) urb->buffer;
220 dbg_ep0(3, "copied device configuration, actual_length: 0x%x", urb->actual_length);
223 case USB_DESCRIPTOR_TYPE_CONFIGURATION:
225 struct usb_configuration_descriptor
226 *configuration_descriptor;
227 struct usb_device_descriptor *device_descriptor;
230 usbd_device_device_descriptor (device, port))) {
233 /*dbg_ep0(2, "%d %d", index, device_descriptor->bNumConfigurations); */
234 if (index >= device_descriptor->bNumConfigurations) {
235 dbg_ep0 (0, "index too large: %d >= %d", index,
242 (configuration_descriptor =
243 usbd_device_configuration_descriptor (device,
247 "usbd_device_configuration_descriptor failed: %d",
251 dbg_ep0(0, "attempt to copy %d bytes to urb\n",cpu_to_le16(configuration_descriptor->wTotalLength));
252 copy_config (urb, configuration_descriptor,
254 cpu_to_le16(configuration_descriptor->wTotalLength),
260 case USB_DESCRIPTOR_TYPE_STRING:
262 struct usb_string_descriptor *string_descriptor;
263 if (!(string_descriptor = usbd_get_string (index))) {
264 serial_printf("Invalid string index %d\n", index);
267 dbg_ep0(3, "string_descriptor: %p length %d", string_descriptor, string_descriptor->bLength);
268 copy_config (urb, string_descriptor, string_descriptor->bLength, max);
271 case USB_DESCRIPTOR_TYPE_INTERFACE:
272 serial_printf("USB_DESCRIPTOR_TYPE_INTERFACE - error not implemented\n");
274 case USB_DESCRIPTOR_TYPE_ENDPOINT:
275 serial_printf("USB_DESCRIPTOR_TYPE_ENDPOINT - error not implemented\n");
277 case USB_DESCRIPTOR_TYPE_HID:
279 serial_printf("USB_DESCRIPTOR_TYPE_HID - error not implemented\n");
280 return -1; /* unsupported at this time */
283 le16_to_cpu (urb->device_request.wIndex);
284 int bAlternateSetting = 0;
286 struct usb_class_descriptor *class_descriptor;
288 if (!(class_descriptor =
289 usbd_device_class_descriptor_index (device,
294 || class_descriptor->descriptor.hid.bDescriptorType != USB_DT_HID) {
295 dbg_ep0 (3, "[%d] interface is not HID",
299 /* copy descriptor for this class */
300 copy_config (urb, class_descriptor,
301 class_descriptor->descriptor.hid.bLength,
306 case USB_DESCRIPTOR_TYPE_REPORT:
308 serial_printf("USB_DESCRIPTOR_TYPE_REPORT - error not implemented\n");
309 return -1; /* unsupported at this time */
312 le16_to_cpu (urb->device_request.wIndex);
313 int bAlternateSetting = 0;
315 struct usb_class_report_descriptor *report_descriptor;
317 if (!(report_descriptor =
318 usbd_device_class_report_descriptor_index
319 (device, port, 0, bNumInterface,
320 bAlternateSetting, class))
321 || report_descriptor->bDescriptorType !=
323 dbg_ep0 (3, "[%d] descriptor is not REPORT",
327 /* copy report descriptor for this class */
328 /*copy_config(urb, &report_descriptor->bData[0], report_descriptor->wLength, max); */
329 if (max - urb->actual_length > 0) {
331 MIN (report_descriptor->wLength,
332 max - urb->actual_length);
333 memcpy (urb->buffer + urb->actual_length,
334 &report_descriptor->bData[0], length);
335 urb->actual_length += length;
340 case USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER:
341 #if defined(CONFIG_USBD_HS)
343 struct usb_qualifier_descriptor *qualifier_descriptor =
344 device->qualifier_descriptor;
346 if (!qualifier_descriptor)
349 /* copy descriptor for this device */
350 copy_config(urb, qualifier_descriptor,
351 sizeof(struct usb_qualifier_descriptor),
355 dbg_ep0(3, "copied qualifier descriptor, actual_length: 0x%x",
367 dbg_ep0 (1, "urb: buffer: %p buffer_length: %2d actual_length: %2d tx_packetSize: %2d",
368 urb->buffer, urb->buffer_length, urb->actual_length,
369 device->bus->endpoint_array[0].tx_packetSize);
371 if ((urb->actual_length < max) && !(urb->actual_length % device->bus->endpoint_array[0].tx_packetSize)) {
372 dbg_ep0(0, "adding null byte");
373 urb->buffer[urb->actual_length++] = 0;
374 dbg_ep0(0, "urb: buffer_length: %2d actual_length: %2d packet size: %2d",
375 urb->buffer_length, urb->actual_length device->bus->endpoint_array[0].tx_packetSize);
383 * ep0_recv_setup - called to indicate URB has been received
384 * @urb: pointer to struct urb
386 * Check if this is a setup packet, process the device request, put results
387 * back into the urb and return zero or non-zero to indicate success (DATA)
388 * or failure (STALL).
391 int ep0_recv_setup (struct urb *urb)
393 /*struct usb_device_request *request = urb->buffer; */
394 /*struct usb_device_instance *device = urb->device; */
396 struct usb_device_request *request;
397 struct usb_device_instance *device;
400 dbg_ep0 (0, "entering ep0_recv_setup()");
401 if (!urb || !urb->device) {
402 dbg_ep0 (3, "invalid URB %p", urb);
406 request = &urb->device_request;
407 device = urb->device;
409 dbg_ep0 (3, "urb: %p device: %p", urb, urb->device);
412 /*dbg_ep0(2, "- - - - - - - - - -"); */
415 "bmRequestType:%02x bRequest:%02x wValue:%04x wIndex:%04x wLength:%04x %s",
416 request->bmRequestType, request->bRequest,
417 le16_to_cpu (request->wValue), le16_to_cpu (request->wIndex),
418 le16_to_cpu (request->wLength),
419 USBD_DEVICE_REQUESTS (request->bRequest));
421 /* handle USB Standard Request (c.f. USB Spec table 9-2) */
422 if ((request->bmRequestType & USB_REQ_TYPE_MASK) != 0) {
423 if(device->device_state <= STATE_CONFIGURED){
424 /* Attempt to handle a CDC specific request if we are
425 * in the configured state.
427 return device->cdc_recv_setup(request,urb);
429 dbg_ep0 (1, "non standard request: %x",
430 request->bmRequestType & USB_REQ_TYPE_MASK);
431 return -1; /* Stall here */
434 switch (device->device_state) {
438 /* It actually is important to allow requests in these states,
439 * Windows will request descriptors before assigning an
440 * address to the client.
443 /*dbg_ep0 (1, "request %s not allowed in this state: %s", */
444 /* USBD_DEVICE_REQUESTS(request->bRequest), */
445 /* usbd_device_states[device->device_state]); */
451 switch (request->bRequest) {
452 case USB_REQ_GET_STATUS:
453 case USB_REQ_GET_INTERFACE:
454 case USB_REQ_SYNCH_FRAME: /* XXX should never see this (?) */
455 case USB_REQ_CLEAR_FEATURE:
456 case USB_REQ_SET_FEATURE:
457 case USB_REQ_SET_DESCRIPTOR:
458 /* case USB_REQ_SET_CONFIGURATION: */
459 case USB_REQ_SET_INTERFACE:
461 "request %s not allowed in DEFAULT state: %s",
462 USBD_DEVICE_REQUESTS (request->bRequest),
463 usbd_device_states[device->device_state]);
466 case USB_REQ_SET_CONFIGURATION:
467 case USB_REQ_SET_ADDRESS:
468 case USB_REQ_GET_DESCRIPTOR:
469 case USB_REQ_GET_CONFIGURATION:
472 case STATE_ADDRESSED:
473 case STATE_CONFIGURED:
476 dbg_ep0 (1, "request %s not allowed in UNKNOWN state: %s",
477 USBD_DEVICE_REQUESTS (request->bRequest),
478 usbd_device_states[device->device_state]);
482 /* handle all requests that return data (direction bit set on bm RequestType) */
483 if ((request->bmRequestType & USB_REQ_DIRECTION_MASK)) {
485 dbg_ep0 (3, "Device-to-Host");
487 switch (request->bRequest) {
489 case USB_REQ_GET_STATUS:
490 return ep0_get_status (device, urb, request->wIndex,
491 request->bmRequestType &
492 USB_REQ_RECIPIENT_MASK);
494 case USB_REQ_GET_DESCRIPTOR:
495 return ep0_get_descriptor (device, urb,
496 le16_to_cpu (request->wLength),
497 le16_to_cpu (request->wValue) >> 8,
498 le16_to_cpu (request->wValue) & 0xff);
500 case USB_REQ_GET_CONFIGURATION:
501 serial_printf("get config %d\n", device->configuration);
502 return ep0_get_one (device, urb,
503 device->configuration);
505 case USB_REQ_GET_INTERFACE:
506 return ep0_get_one (device, urb, device->alternate);
508 case USB_REQ_SYNCH_FRAME: /* XXX should never see this (?) */
511 case USB_REQ_CLEAR_FEATURE:
512 case USB_REQ_SET_FEATURE:
513 case USB_REQ_SET_ADDRESS:
514 case USB_REQ_SET_DESCRIPTOR:
515 case USB_REQ_SET_CONFIGURATION:
516 case USB_REQ_SET_INTERFACE:
520 /* handle the requests that do not return data */
524 /*dbg_ep0(3, "Host-to-Device"); */
525 switch (request->bRequest) {
527 case USB_REQ_CLEAR_FEATURE:
528 case USB_REQ_SET_FEATURE:
529 dbg_ep0 (0, "Host-to-Device");
531 bmRequestType & USB_REQ_RECIPIENT_MASK) {
532 case USB_REQ_RECIPIENT_DEVICE:
533 /* XXX DEVICE_REMOTE_WAKEUP or TEST_MODE would be added here */
534 /* XXX fall through for now as we do not support either */
535 case USB_REQ_RECIPIENT_INTERFACE:
536 case USB_REQ_RECIPIENT_OTHER:
537 dbg_ep0 (0, "request %s not",
538 USBD_DEVICE_REQUESTS (request->bRequest));
542 case USB_REQ_RECIPIENT_ENDPOINT:
543 dbg_ep0 (0, "ENDPOINT: %x", le16_to_cpu (request->wValue));
544 if (le16_to_cpu (request->wValue) == USB_ENDPOINT_HALT) {
545 /*return usbd_device_feature (device, le16_to_cpu (request->wIndex), */
546 /* request->bRequest == USB_REQ_SET_FEATURE); */
547 /* NEED TO IMPLEMENT THIS!!! */
550 dbg_ep0 (1, "request %s bad wValue: %04x",
553 le16_to_cpu (request->wValue));
558 case USB_REQ_SET_ADDRESS:
559 /* check if this is a re-address, reset first if it is (this shouldn't be possible) */
560 if (device->device_state != STATE_DEFAULT) {
561 dbg_ep0 (1, "set_address: %02x state: %s",
562 le16_to_cpu (request->wValue),
563 usbd_device_states[device->device_state]);
566 address = le16_to_cpu (request->wValue);
567 if ((address & 0x7f) != address) {
568 dbg_ep0 (1, "invalid address %04x %04x",
569 address, address & 0x7f);
572 device->address = address;
574 /*dbg_ep0(2, "address: %d %d %d", */
575 /* request->wValue, le16_to_cpu(request->wValue), device->address); */
579 case USB_REQ_SET_DESCRIPTOR: /* XXX should we support this? */
580 dbg_ep0 (0, "set descriptor: NOT SUPPORTED");
583 case USB_REQ_SET_CONFIGURATION:
584 /* c.f. 9.4.7 - the top half of wValue is reserved */
585 device->configuration = le16_to_cpu(request->wValue) & 0xff;
587 /* reset interface and alternate settings */
588 device->interface = device->alternate = 0;
590 /*dbg_ep0(2, "set configuration: %d", device->configuration); */
591 /*serial_printf("DEVICE_CONFIGURED.. event?\n"); */
594 case USB_REQ_SET_INTERFACE:
595 device->interface = le16_to_cpu (request->wIndex);
596 device->alternate = le16_to_cpu (request->wValue);
597 /*dbg_ep0(2, "set interface: %d alternate: %d", device->interface, device->alternate); */
598 serial_printf ("DEVICE_SET_INTERFACE.. event?\n");
601 case USB_REQ_GET_STATUS:
602 case USB_REQ_GET_DESCRIPTOR:
603 case USB_REQ_GET_CONFIGURATION:
604 case USB_REQ_GET_INTERFACE:
605 case USB_REQ_SYNCH_FRAME: /* XXX should never see this (?) */