--- 2.5.1-pre4/include/linux-dist/usb.h Sat Dec 1 13:13:58 2001 +++ 2.5.1-pre4/include/linux/usb.h Sun Dec 2 15:37:41 2001 @@ -43,31 +43,6 @@ #define USB_DIR_IN 0x80 /* - * Descriptor types - */ -#define USB_DT_DEVICE 0x01 -#define USB_DT_CONFIG 0x02 -#define USB_DT_STRING 0x03 -#define USB_DT_INTERFACE 0x04 -#define USB_DT_ENDPOINT 0x05 - -#define USB_DT_HID (USB_TYPE_CLASS | 0x01) -#define USB_DT_REPORT (USB_TYPE_CLASS | 0x02) -#define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03) -#define USB_DT_HUB (USB_TYPE_CLASS | 0x09) - -/* - * Descriptor sizes per descriptor type - */ -#define USB_DT_DEVICE_SIZE 18 -#define USB_DT_CONFIG_SIZE 9 -#define USB_DT_INTERFACE_SIZE 9 -#define USB_DT_ENDPOINT_SIZE 7 -#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ -#define USB_DT_HUB_NONVAR_SIZE 7 -#define USB_DT_HID_SIZE 9 - -/* * Endpoints */ #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ @@ -115,16 +90,6 @@ #define USB_REQ_SET_INTERFACE 0x0B #define USB_REQ_SYNCH_FRAME 0x0C -/* - * HID requests - */ -#define USB_REQ_GET_REPORT 0x01 -#define USB_REQ_GET_IDLE 0x02 -#define USB_REQ_GET_PROTOCOL 0x03 -#define USB_REQ_SET_REPORT 0x09 -#define USB_REQ_SET_IDLE 0x0A -#define USB_REQ_SET_PROTOCOL 0x0B - #ifdef __KERNEL__ @@ -162,6 +127,8 @@ * USB_ST* maps to -E* and should go away in the future */ +// FIXME 2.5 get rid of these + #define USB_ST_NOERROR 0 #define USB_ST_CRC (-EILSEQ) #define USB_ST_BITSTUFF (-EPROTO) @@ -197,18 +164,46 @@ unsigned long busmap[USB_MAXBUS / (8*sizeof(unsigned long))]; }; +struct usb_device; + +/*-------------------------------------------------------------------------*/ + /* - * This is a USB device descriptor. - * - * USB device information + * Standard USB Descriptor support. + * Devices may also have class-specific or vendor-specific descriptors. + */ + +/* + * Descriptor types ... USB 2.0 spec table 9.5 + */ +#define USB_DT_DEVICE 0x01 +#define USB_DT_CONFIG 0x02 +#define USB_DT_STRING 0x03 +#define USB_DT_INTERFACE 0x04 +#define USB_DT_ENDPOINT 0x05 +#define USB_DT_DEVICE_QUALIFIER 0x06 +#define USB_DT_OTHER_SPEED_CONFIG 0x07 +#define USB_DT_INTERFACE_POWER 0x08 + +// FIXME should be internal to hub driver +#define USB_DT_HUB (USB_TYPE_CLASS | 0x09) +#define USB_DT_HUB_NONVAR_SIZE 7 + +/* + * Descriptor sizes per descriptor type */ +#define USB_DT_DEVICE_SIZE 18 +#define USB_DT_CONFIG_SIZE 9 +#define USB_DT_INTERFACE_SIZE 9 +#define USB_DT_ENDPOINT_SIZE 7 +#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ -/* Everything but the endpoint maximums are aribtrary */ +/* most of these maximums are arbitrary */ #define USB_MAXCONFIG 8 #define USB_ALTSETTINGALLOC 4 #define USB_MAXALTSETTING 128 /* Hard limit */ #define USB_MAXINTERFACES 32 -#define USB_MAXENDPOINTS 32 +#define USB_MAXENDPOINTS 32 /* Hard limit */ /* All standard descriptors have these 2 fields in common */ struct usb_descriptor_header { @@ -216,7 +211,7 @@ __u8 bDescriptorType; } __attribute__ ((packed)); -/* Device descriptor */ +/* USB_DT_DEVICE: Device descriptor */ struct usb_device_descriptor { __u8 bLength; __u8 bDescriptorType; @@ -234,7 +229,7 @@ __u8 bNumConfigurations; } __attribute__ ((packed)); -/* Endpoint descriptor */ +/* USB_DT_ENDPOINT: Endpoint descriptor */ struct usb_endpoint_descriptor { __u8 bLength __attribute__ ((packed)); __u8 bDescriptorType __attribute__ ((packed)); @@ -245,11 +240,12 @@ __u8 bRefresh __attribute__ ((packed)); __u8 bSynchAddress __attribute__ ((packed)); + // the rest is internal to the Linux implementation unsigned char *extra; /* Extra descriptors */ int extralen; }; -/* Interface descriptor */ +/* USB_DT_INTERFACE: Interface descriptor */ struct usb_interface_descriptor { __u8 bLength __attribute__ ((packed)); __u8 bDescriptorType __attribute__ ((packed)); @@ -261,6 +257,7 @@ __u8 bInterfaceProtocol __attribute__ ((packed)); __u8 iInterface __attribute__ ((packed)); + // the rest is internal to the Linux implementation struct usb_endpoint_descriptor *endpoint; unsigned char *extra; /* Extra descriptors */ @@ -278,7 +275,13 @@ void *private_data; }; -/* Configuration descriptor information.. */ +/* USB_DT_CONFIG: Configuration descriptor information. + * + * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the + * descriptor type is different. Highspeed-capable devices can look + * different depending on what speed they're currently running. Only + * devices with a USB_DT_DEVICE_QUALIFIER have an OTHER_SPEED_CONFIG. + */ struct usb_config_descriptor { __u8 bLength __attribute__ ((packed)); __u8 bDescriptorType __attribute__ ((packed)); @@ -289,20 +292,47 @@ __u8 bmAttributes __attribute__ ((packed)); __u8 MaxPower __attribute__ ((packed)); + // the rest is internal to the Linux implementation struct usb_interface *interface; unsigned char *extra; /* Extra descriptors */ int extralen; }; -/* String descriptor */ +/* USB_DT_STRING: String descriptor */ struct usb_string_descriptor { __u8 bLength; __u8 bDescriptorType; - __u16 wData[1]; + __u16 wData[1]; /* UTF-16LE encoded */ } __attribute__ ((packed)); -struct usb_device; +/* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ +struct usb_qualifier_descriptor { + __u8 bLength; + __u8 bDescriptorType; + __u16 bcdUSB; + __u8 bDeviceClass; + __u8 bDeviceSubClass; + __u8 bDeviceProtocol; + __u8 bMaxPacketSize0; + __u8 bNumConfigurations; + __u8 bRESERVED; +} __attribute__ ((packed)); + +/* helpers for driver access to descriptors */ +extern struct usb_interface * + usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum); +extern struct usb_endpoint_descriptor * + usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum); + +int __usb_get_extra_descriptor(char *buffer, unsigned size, + unsigned char type, void **ptr); +#define usb_get_extra_descriptor(ifpoint,type,ptr)\ + __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\ + type,(void**)ptr) + + +/*-------------------------------------------------------------------------*/ /* * Device table entry for "new style" table-driven USB drivers. @@ -377,7 +407,7 @@ * device flags. * * In most cases, drivers will create a table of device IDs by using - * the USB_DEVICE() macros designed for that purpose. + * USB_DEVICE(), or similar macros designed for that purpose. * They will then export it to userspace using MODULE_DEVICE_TABLE(), * and provide it to the USB core through their usb_driver structure. * @@ -439,6 +469,8 @@ * expose information to user space regardless of where they * do (or don't) show up otherwise in the filesystem. * @id_table: USB drivers use ID table to support hotplugging. + * Export this with MODULE_DEVICE_TABLE(usb,...), or use NULL to + * say that probe() should be called for any unclaimed interfce. * * USB drivers should provide a name, probe() and disconnect() methods, * and an id_table. Other driver fields are optional. @@ -485,10 +517,17 @@ // void (*suspend)(struct usb_device *dev); // void (*resume)(struct usb_device *dev); }; - -/*----------------------------------------------------------------------------* - * New USB Structures * - *----------------------------------------------------------------------------*/ + +// use these in module_init()/module_exit() +// and don't forget MODULE_DEVICE_TABLE(usb, ...) +extern int usb_register(struct usb_driver *); +extern void usb_deregister(struct usb_driver *); + +/* -------------------------------------------------------------------------- */ + +/* + * URB support, for asynchronous request completions + */ /* * urb->transfer_flags: @@ -500,7 +539,9 @@ #define USB_ASYNC_UNLINK 0x0008 #define USB_QUEUE_BULK 0x0010 #define USB_NO_FSBR 0x0020 -#define USB_ZERO_PACKET 0x0040 // Finish bulk OUTs always with zero length packet +#define USB_ZERO_PACKET 0x0040 // Finish bulk OUTs with short packet +#define URB_NO_INTERRUPT 0x0080 // HINT: no non-error interrupt needed + // ... less overhead for QUEUE_BULK #define USB_TIMEOUT_KILLED 0x1000 // only set by HCD! typedef struct @@ -512,6 +553,7 @@ } iso_packet_descriptor_t, *piso_packet_descriptor_t; struct urb; + typedef void (*usb_complete_t)(struct urb *); /** @@ -601,6 +643,8 @@ * to poll for transfers. After the URB has been submitted, the interval * and start_frame fields reflect how the transfer was actually scheduled. * The polling interval may be more frequent than requested. + * For example, some controllers have a maximum interval of 32 microseconds, + * while others support intervals of up to 1024 microseconds. * * Isochronous URBs normally use the USB_ISO_ASAP transfer flag, telling * the host controller to schedule the transfer as soon as bandwidth @@ -634,7 +678,7 @@ * When completion callback is invoked for non-isochronous URBs, the * actual_length field tells how many bytes were transferred. * - * For interrupt and isochronous URBs, the URB provided to the calllback + * For interrupt and isochronous URBs, the URB provided to the callback * function is still "owned" by the USB core subsystem unless the status * indicates that the URB has been unlinked. Completion handlers should * not modify such URBs until they have been unlinked. @@ -772,26 +816,50 @@ (a)->timeout=g;\ } while (0) -purb_t usb_alloc_urb(int iso_packets); -void usb_free_urb (purb_t purb); -int usb_submit_urb(purb_t purb); -int usb_unlink_urb(purb_t purb); -int usb_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe, devrequest *cmd, void *data, int len, int timeout); -int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout); +extern struct urb *usb_alloc_urb(int iso_packets); +extern void usb_free_urb(struct urb *purb); +extern int usb_submit_urb(struct urb *purb); +extern int usb_unlink_urb(struct urb *purb); /*-------------------------------------------------------------------* * SYNCHRONOUS CALL SUPPORT * *-------------------------------------------------------------------*/ -struct usb_api_data -{ - wait_queue_head_t wqh; - int done; - /* void* stuff; */ /* Possible extension later. */ -}; +extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, + __u8 request, __u8 requesttype, __u16 value, __u16 index, + void *data, __u16 size, int timeout); +extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, + void *data, int len, int *actual_length, + int timeout); + +// wrappers around usb_control_msg() for the most common standard requests +extern int usb_clear_halt(struct usb_device *dev, int pipe); +extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype, + unsigned char descindex, void *buf, int size); +extern int usb_get_device_descriptor(struct usb_device *dev); +extern int usb_get_status(struct usb_device *dev, + int type, int target, void *data); +extern int usb_get_string(struct usb_device *dev, + unsigned short langid, unsigned char index, void *buf, int size); +extern int usb_string(struct usb_device *dev, int index, + char *buf, size_t size); +extern int usb_set_configuration(struct usb_device *dev, int configuration); +extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate); + +// timeouts, in seconds, used for sending/receiving control messages +// they typically complete within a few frames (msec) after they're issued +#ifdef CONFIG_USB_LONG_TIMEOUT +#define USB_CTRL_GET_TIMEOUT 4 +#else +#define USB_CTRL_GET_TIMEOUT 3 +#endif + +#define USB_CTRL_SET_TIMEOUT 3 /* -------------------------------------------------------------------------- */ +/* Host Controller Driver (HCD) support */ + struct usb_operations { int (*allocate)(struct usb_device *); int (*deallocate)(struct usb_device *); @@ -832,6 +900,60 @@ atomic_t refcnt; }; +extern struct usb_bus *usb_alloc_bus(struct usb_operations *); +extern void usb_free_bus(struct usb_bus *); +extern void usb_register_bus(struct usb_bus *); +extern void usb_deregister_bus(struct usb_bus *); + +extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb); +extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, + int bustime, int isoc); +extern void usb_release_bandwidth(struct usb_device *dev, struct urb *urb, + int isoc); +extern int usb_root_hub_string(int id, int serial, + char *type, __u8 *data, int len); + +/* + * Some USB 1.1 bandwidth allocation constants. + */ +#define BW_HOST_DELAY 1000L /* nanoseconds */ +#define BW_HUB_LS_SETUP 333L /* nanoseconds */ + /* 4 full-speed bit times (est.) */ + +#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ +#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) +#define FRAME_TIME_USECS 1000L +#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) + +#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ + /* Trying not to use worst-case bit-stuffing + of (7/6 * 8 * bytecount) = 9.33 * bytecount */ + /* bytecount = data payload byte count */ + +#define NS_TO_US(ns) ((ns + 500L) / 1000L) + /* convert & round nanoseconds to microseconds */ + + +/* -------------------------------------------------------------------------- */ + +/* Enumeration is only for the hub driver, or HCD virtual root hubs */ +extern struct usb_device *usb_alloc_dev(struct usb_device *parent, + struct usb_bus *); +extern void usb_free_dev(struct usb_device *); +extern int usb_new_device(struct usb_device *dev); +extern void usb_connect(struct usb_device *dev); +extern void usb_disconnect(struct usb_device **); + +#ifndef _LINUX_HUB_H +/* exported to hub driver ONLY to support usb_reset_device () */ +extern int usb_get_configuration(struct usb_device *dev); +extern void usb_set_maxpacket(struct usb_device *dev); +extern void usb_destroy_configuration(struct usb_device *dev); +extern int usb_set_address(struct usb_device *dev); +#endif /* _LINUX_HUB_H */ + +/* -------------------------------------------------------------------------- */ + /* This is arbitrary. * From USB 2.0 spec Table 11-13, offset 7, a hub can * have up to 255 ports. The most yet reported is 10. @@ -889,44 +1011,30 @@ struct usb_device *children[USB_MAXCHILDREN]; }; -extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum); -extern struct usb_endpoint_descriptor *usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum); - -extern int usb_register(struct usb_driver *); -extern void usb_deregister(struct usb_driver *); +/* for when layers above USB add new non-USB drivers */ extern void usb_scan_devices(void); -/* used these for multi-interface device registration */ -extern void usb_driver_claim_interface(struct usb_driver *driver, struct usb_interface *iface, void* priv); -extern int usb_interface_claimed(struct usb_interface *iface); -extern void usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface); -const struct usb_device_id *usb_match_id(struct usb_device *dev, - struct usb_interface *interface, - const struct usb_device_id *id); +/* mostly for devices emulating SCSI over USB */ +extern int usb_reset_device(struct usb_device *dev); -extern struct usb_bus *usb_alloc_bus(struct usb_operations *); -extern void usb_free_bus(struct usb_bus *); -extern void usb_register_bus(struct usb_bus *); -extern void usb_deregister_bus(struct usb_bus *); +/* for drivers using iso endpoints */ +extern int usb_get_current_frame_number (struct usb_device *usb_dev); -extern struct usb_device *usb_alloc_dev(struct usb_device *parent, struct usb_bus *); -extern void usb_free_dev(struct usb_device *); +/* drivers must track when they bind to a device's interfaces */ extern void usb_inc_dev_use(struct usb_device *); #define usb_dec_dev_use usb_free_dev -extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb); -extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc); -extern void usb_release_bandwidth(struct usb_device *dev, struct urb *urb, int isoc); - -extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype, __u16 value, __u16 index, void *data, __u16 size, int timeout); - -extern int usb_root_hub_string(int id, int serial, char *type, __u8 *data, int len); -extern void usb_connect(struct usb_device *dev); -extern void usb_disconnect(struct usb_device **); - -extern void usb_destroy_configuration(struct usb_device *dev); +/* used these for multi-interface device registration */ +extern void usb_driver_claim_interface(struct usb_driver *driver, + struct usb_interface *iface, void* priv); +extern int usb_interface_claimed(struct usb_interface *iface); +extern void usb_driver_release_interface(struct usb_driver *driver, + struct usb_interface *iface); +const struct usb_device_id *usb_match_id(struct usb_device *dev, + struct usb_interface *interface, + const struct usb_device_id *id); -int usb_get_current_frame_number (struct usb_device *usb_dev); +/* -------------------------------------------------------------------------- */ /* * Calling this entity a "pipe" is glorifying it. A USB pipe @@ -934,7 +1042,7 @@ * of the following information: * - device number (7 bits) * - endpoint number (4 bits) - * - current Data0/1 state (1 bit) + * - current Data0/1 state (1 bit) [Historical; now gone] * - direction (1 bit) * - speed (1 bit) * - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.] @@ -951,7 +1059,7 @@ * - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In]) * - device: bits 8-14 * - endpoint: bits 15-18 - * - Data0/1: bit 19 + * - Data0/1: bit 19 [Historical; now gone. ] * - speed: bit 26 (0 = Full, 1 = Low Speed) * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk) * @@ -964,6 +1072,8 @@ * like full speed devices. */ +// FIXME 2.5 get rid of usb_pipeslow(), just use dev->speed + #define PIPE_ISOCHRONOUS 0 #define PIPE_INTERRUPT 1 #define PIPE_CONTROL 2 @@ -979,7 +1089,6 @@ #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) -#define usb_pipedata(pipe) (((pipe) >> 19) & 1) #define usb_pipeslow(pipe) (((pipe) >> 26) & 1) #define usb_pipetype(pipe) (((pipe) >> 30) & 3) #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) @@ -1023,58 +1132,10 @@ #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | __default_pipe(dev)) #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | __default_pipe(dev) | USB_DIR_IN) -/* - * Send and receive control messages.. - */ -int usb_new_device(struct usb_device *dev); -int usb_reset_device(struct usb_device *dev); -int usb_set_address(struct usb_device *dev); -int usb_get_descriptor(struct usb_device *dev, unsigned char desctype, - unsigned char descindex, void *buf, int size); -int usb_get_class_descriptor(struct usb_device *dev, int ifnum, unsigned char desctype, - unsigned char descindex, void *buf, int size); -int usb_get_device_descriptor(struct usb_device *dev); -int __usb_get_extra_descriptor(char *buffer, unsigned size, unsigned char type, void **ptr); -int usb_get_status(struct usb_device *dev, int type, int target, void *data); -int usb_get_configuration(struct usb_device *dev); -int usb_get_protocol(struct usb_device *dev, int ifnum); -int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); -int usb_set_interface(struct usb_device *dev, int ifnum, int alternate); -int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id); -int usb_set_configuration(struct usb_device *dev, int configuration); -int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, - unsigned char id, void *buf, int size); -int usb_set_report(struct usb_device *dev, int ifnum, unsigned char type, - unsigned char id, void *buf, int size); -int usb_string(struct usb_device *dev, int index, char *buf, size_t size); -int usb_clear_halt(struct usb_device *dev, int pipe); -void usb_set_maxpacket(struct usb_device *dev); - -#define usb_get_extra_descriptor(ifpoint,type,ptr)\ - __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,type,(void**)ptr) - -/* - * Some USB bandwidth allocation constants. - */ -#define BW_HOST_DELAY 1000L /* nanoseconds */ -#define BW_HUB_LS_SETUP 333L /* nanoseconds */ - /* 4 full-speed bit times (est.) */ - -#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ -#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) -#define FRAME_TIME_USECS 1000L -#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) - -#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ - /* Trying not to use worst-case bit-stuffing - of (7/6 * 8 * bytecount) = 9.33 * bytecount */ - /* bytecount = data payload byte count */ - -#define NS_TO_US(ns) ((ns + 500L) / 1000L) - /* convert & round nanoseconds to microseconds */ +/* -------------------------------------------------------------------------- */ /* - * Debugging helpers.. + * Debugging and troubleshooting/diagnostic helpers. */ void usb_show_device_descriptor(struct usb_device_descriptor *); void usb_show_config_descriptor(struct usb_config_descriptor *); @@ -1088,13 +1149,17 @@ #else #define dbg(format, arg...) do {} while (0) #endif + #define err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" , ## arg) #define info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ## arg) #define warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ## arg) +/* -------------------------------------------------------------------------- */ + /* * bus and driver list + * exported only for usbdevfs (not visible outside usbcore) */ extern struct list_head usb_driver_list; --- 2.5.1-pre4/drivers/usb-dist/usb.c Sat Dec 1 13:14:06 2001 +++ 2.5.1-pre4/drivers/usb/usb.c Sun Dec 2 15:46:15 2001 @@ -106,8 +106,8 @@ * Goes through all unclaimed USB interfaces, and offers them to all * registered USB drivers through the 'probe' function. * This will automatically be called after usb_register is called. - * It is called by some of the USB subsystems after one of their subdrivers - * are registered. + * It is called by some of the subsystems layered over USB + * after one of their subdrivers are registered. */ void usb_scan_devices(void) { @@ -1198,12 +1198,14 @@ return -ENODEV; } /*-------------------------------------------------------------------* - * COMPLETION HANDLERS * + * SYNCHRONOUS CALLS * *-------------------------------------------------------------------*/ -/*-------------------------------------------------------------------* - * completion handler for compatibility wrappers (sync control/bulk) * - *-------------------------------------------------------------------*/ +struct usb_api_data { + wait_queue_head_t wqh; + int done; +}; + static void usb_api_blocking_completion(urb_t *urb) { struct usb_api_data *awd = (struct usb_api_data *)urb->context; @@ -1213,10 +1215,6 @@ wake_up(&awd->wqh); } -/*-------------------------------------------------------------------* - * SYNCHRONOUS CALLS * - *-------------------------------------------------------------------*/ - // Starts urb and waits for completion or timeout static int usb_start_wait_urb(urb_t *urb, int timeout, int* actual_length) { @@ -1723,7 +1721,8 @@ return size; } -// usbcore-internal: enumeration/hub only!! +// hub-only!! ... and only exported for reset/reinit path. +// otherwise used internally on disconnect/destroy path void usb_destroy_configuration(struct usb_device *dev) { int c, i, j, k; @@ -1955,18 +1954,14 @@ * These are the actual routines to send * and receive control messages. */ -#ifdef CONFIG_USB_LONG_TIMEOUT -#define GET_TIMEOUT 4 -#else -#define GET_TIMEOUT 3 -#endif -#define SET_TIMEOUT 3 -// hub driver only!!! for enumeration +// hub-only!! ... and only exported for reset/reinit path. +// otherwise used internally, for usb_new_device() int usb_set_address(struct usb_device *dev) { return usb_control_msg(dev, usb_snddefctrl(dev), USB_REQ_SET_ADDRESS, - 0, dev->devnum, 0, NULL, 0, HZ * GET_TIMEOUT); + // FIXME USB_CTRL_SET_TIMEOUT + 0, dev->devnum, 0, NULL, 0, HZ * USB_CTRL_GET_TIMEOUT); } /** @@ -1984,7 +1979,7 @@ * Configuration descriptors (USB_DT_CONFIG) are part of the device * structure, at least for the current configuration. * In addition to a number of USB-standard descriptors, some - * devices also use vendor-specific descriptors. + * devices also use class-specific or vendor-specific descriptors. * * This call is synchronous, and may not be used in an interrupt context. * @@ -1999,24 +1994,17 @@ memset(buf,0,size); // Make sure we parse really received data while (i--) { + /* retries if the returned length was 0; flakey device */ if ((result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), - USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, - (type << 8) + index, 0, buf, size, HZ * GET_TIMEOUT)) > 0 || - result == -EPIPE) - break; /* retry if the returned length was 0; flaky device */ + USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, + (type << 8) + index, 0, buf, size, + HZ * USB_CTRL_GET_TIMEOUT)) > 0 + || result == -EPIPE) + break; } return result; } -// FIXME Doesn't use USB_DT_CLASS ... but hid-core.c expects it this way -int usb_get_class_descriptor(struct usb_device *dev, int ifnum, - unsigned char type, unsigned char id, void *buf, int size) -{ - return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), - USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN, - (type << 8) + id, ifnum, buf, size, HZ * GET_TIMEOUT); -} - /** * usb_get_string - gets a string descriptor * @dev: the device whose string descriptor is being retrieved @@ -2042,7 +2030,8 @@ { return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, - (USB_DT_STRING << 8) + index, langid, buf, size, HZ * GET_TIMEOUT); + (USB_DT_STRING << 8) + index, langid, buf, size, + HZ * USB_CTRL_GET_TIMEOUT); } /** @@ -2100,40 +2089,13 @@ int usb_get_status(struct usb_device *dev, int type, int target, void *data) { return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), - USB_REQ_GET_STATUS, USB_DIR_IN | type, 0, target, data, 2, HZ * GET_TIMEOUT); + USB_REQ_GET_STATUS, USB_DIR_IN | type, 0, target, data, 2, + HZ * USB_CTRL_GET_TIMEOUT); } -// FIXME hid-specific !! DOES NOT BELONG HERE -int usb_get_protocol(struct usb_device *dev, int ifnum) -{ - unsigned char type; - int ret; - - if ((ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), - USB_REQ_GET_PROTOCOL, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, - 0, ifnum, &type, 1, HZ * GET_TIMEOUT)) < 0) - return ret; - return type; -} - -// FIXME hid-specific !! DOES NOT BELONG HERE -int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol) -{ - return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), - USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE, - protocol, ifnum, NULL, 0, HZ * SET_TIMEOUT); -} - -// FIXME hid-specific !! DOES NOT BELONG HERE -int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id) -{ - return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), - USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, - (duration << 8) | report_id, ifnum, NULL, 0, HZ * SET_TIMEOUT); -} - -// hub-only!! +// hub-only!! ... and only exported for reset/reinit path. +// otherwise used internally, for config/altsetting reconfig. void usb_set_maxpacket(struct usb_device *dev) { int i, b; @@ -2197,7 +2159,8 @@ */ result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), - USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, HZ * SET_TIMEOUT); + USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, + HZ * USB_CTRL_SET_TIMEOUT); /* don't clear if failed */ if (result < 0) @@ -2211,7 +2174,8 @@ result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), USB_REQ_GET_STATUS, USB_DIR_IN | USB_RECIP_ENDPOINT, 0, endp, - buffer, sizeof(status), HZ * SET_TIMEOUT); + // FIXME USB_CTRL_GET_TIMEOUT, yes? why not usb_get_status() ? + buffer, sizeof(status), HZ * USB_CTRL_SET_TIMEOUT); memcpy(&status, buffer, sizeof(status)); kfree(buffer); @@ -2327,7 +2291,8 @@ } if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), - USB_REQ_SET_CONFIGURATION, 0, configuration, 0, NULL, 0, HZ * SET_TIMEOUT)) < 0) + USB_REQ_SET_CONFIGURATION, 0, configuration, 0, + NULL, 0, HZ * USB_CTRL_SET_TIMEOUT)) < 0) return ret; dev->actconfig = cp; @@ -2338,23 +2303,8 @@ return 0; } -// FIXME hid-specific !! DOES NOT BELONG HERE -int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size) -{ - return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), - USB_REQ_GET_REPORT, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, - (type << 8) + id, ifnum, buf, size, HZ * GET_TIMEOUT); -} - -// FIXME hid-specific !! DOES NOT BELONG HERE -int usb_set_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size) -{ - return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), - USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, - (type << 8) + id, ifnum, buf, size, HZ); -} - -// hub driver only !! +// hub-only!! ... and only in reset path, or usb_new_device() +// (used by real hubs and virtual root hubs) int usb_get_configuration(struct usb_device *dev) { int result; @@ -2761,33 +2711,28 @@ EXPORT_SYMBOL(usb_claim_bandwidth); EXPORT_SYMBOL(usb_release_bandwidth); -EXPORT_SYMBOL(usb_set_address); -EXPORT_SYMBOL(usb_get_descriptor); -EXPORT_SYMBOL(usb_get_class_descriptor); EXPORT_SYMBOL(__usb_get_extra_descriptor); -EXPORT_SYMBOL(usb_get_device_descriptor); -EXPORT_SYMBOL(usb_get_string); -EXPORT_SYMBOL(usb_string); -EXPORT_SYMBOL(usb_get_protocol); -EXPORT_SYMBOL(usb_set_protocol); -EXPORT_SYMBOL(usb_get_report); -EXPORT_SYMBOL(usb_set_report); -EXPORT_SYMBOL(usb_set_idle); -EXPORT_SYMBOL(usb_clear_halt); -EXPORT_SYMBOL(usb_set_interface); -EXPORT_SYMBOL(usb_get_configuration); -EXPORT_SYMBOL(usb_set_configuration); -EXPORT_SYMBOL(usb_get_status); EXPORT_SYMBOL(usb_get_current_frame_number); +// asynchronous request completion model EXPORT_SYMBOL(usb_alloc_urb); EXPORT_SYMBOL(usb_free_urb); EXPORT_SYMBOL(usb_submit_urb); EXPORT_SYMBOL(usb_unlink_urb); +// synchronous request completion model EXPORT_SYMBOL(usb_control_msg); EXPORT_SYMBOL(usb_bulk_msg); +// synchronous control message convenience routines +EXPORT_SYMBOL(usb_get_descriptor); +EXPORT_SYMBOL(usb_get_device_descriptor); +EXPORT_SYMBOL(usb_get_status); +EXPORT_SYMBOL(usb_get_string); +EXPORT_SYMBOL(usb_string); +EXPORT_SYMBOL(usb_clear_halt); +EXPORT_SYMBOL(usb_set_configuration); +EXPORT_SYMBOL(usb_set_interface); EXPORT_SYMBOL(usb_devfs_handle); MODULE_LICENSE("GPL"); --- 2.5.1-pre4/drivers/usb-dist/hid.h Sat Dec 1 13:14:06 2001 +++ 2.5.1-pre4/drivers/usb/hid.h Sun Dec 2 15:46:42 2001 @@ -30,6 +30,88 @@ * Vojtech Pavlik, Ucitelska 1576, Prague 8, 182 00 Czech Republic */ +/* + * HID class requests + */ +#define HID_REQ_GET_REPORT 0x01 +#define HID_REQ_GET_IDLE 0x02 +#define HID_REQ_GET_PROTOCOL 0x03 +#define HID_REQ_SET_REPORT 0x09 +#define HID_REQ_SET_IDLE 0x0A +#define HID_REQ_SET_PROTOCOL 0x0B + +/* + * HID class descriptor types + */ +#define HID_DT_HID (USB_TYPE_CLASS | 0x01) +#define HID_DT_REPORT (USB_TYPE_CLASS | 0x02) +#define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03) + +/* + * Utilities for class control messaging + */ +static inline int +hid_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id) +{ + return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), + HID_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, + (duration << 8) | report_id, ifnum, NULL, 0, + HZ * USB_CTRL_SET_TIMEOUT); +} + +static inline int +hid_get_protocol(struct usb_device *dev, int ifnum) +{ + unsigned char type; + int ret; + + if ((ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), + HID_REQ_GET_PROTOCOL, + USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, + 0, ifnum, &type, 1, + HZ * USB_CTRL_GET_TIMEOUT)) < 0) + return ret; + + return type; +} + +static inline int +hid_set_protocol(struct usb_device *dev, int ifnum, int protocol) +{ + return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), + HID_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE, + protocol, ifnum, NULL, 0, + HZ * USB_CTRL_SET_TIMEOUT); +} + +static inline int +hid_get_report(struct usb_device *dev, int ifnum, unsigned char type, + unsigned char id, void *buf, int size) +{ + return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), + HID_REQ_GET_REPORT, + USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, + (type << 8) + id, ifnum, buf, size, + HZ * USB_CTRL_GET_TIMEOUT); +} + +static inline int +hid_set_report(struct usb_device *dev, int ifnum, unsigned char type, + unsigned char id, void *buf, int size) +{ + return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), + HID_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, + (type << 8) + id, ifnum, buf, size, HZ); + // FIXME USB_CTRL_SET_TIMEOUT +} + + +/* + * "Boot Protocol" keyboard/mouse drivers use don't use all of HID; + * they're a lot smaller but can't support all the device features. + */ +#ifndef _HID_BOOT_PROTOCOL + #include #include #include @@ -359,9 +441,7 @@ #else #define hid_dump_input(a,b) do { } while (0) #define hid_dump_device(c) do { } while (0) -#endif - -#endif +#endif /* DEBUG */ #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || ( a == 0x000c0001)) @@ -372,3 +452,8 @@ void hid_write_report(struct hid_device *, struct hid_report *); void hid_read_report(struct hid_device *, struct hid_report *); void hid_init_reports(struct hid_device *hid); + +#endif /* !_HID_BOOT_PROTOCOL */ + +#endif /* !__HID_H */ + --- 2.5.1-pre4/drivers/usb-dist/hid-core.c Sat Dec 1 13:14:07 2001 +++ 2.5.1-pre4/drivers/usb/hid-core.c Sun Dec 2 15:48:02 2001 @@ -897,7 +897,7 @@ u8 data[len]; int read; - if ((read = usb_get_report(hid->dev, hid->ifnum, report->type + 1, report->id, data, len)) != len) { + if ((read = hid_get_report(hid->dev, hid->ifnum, report->type + 1, report->id, data, len)) != len) { dbg("reading report type %d id %d failed len %d read %d", report->type + 1, report->id, len, read); return; } @@ -1064,7 +1064,7 @@ list = report_enum->report_list.next; while (list != &report_enum->report_list) { report = (struct hid_report *) list; - usb_set_idle(hid->dev, hid->ifnum, 0, report->id); + hid_set_idle(hid->dev, hid->ifnum, 0, report->id); hid_read_report(hid, report); list = list->next; } @@ -1089,6 +1089,16 @@ { 0, 0 } }; +static int get_class_descriptor(struct usb_device *dev, int ifnum, + unsigned char type, void *buf, int size) +{ + return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), + USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN, + (type << 8), ifnum, buf, size, + HZ * USB_CTRL_GET_TIMEOUT); +} + + static struct hid_device *usb_hid_configure(struct usb_device *dev, int ifnum) { struct usb_interface_descriptor *interface = dev->actconfig->interface[ifnum].altsetting + 0; @@ -1102,14 +1112,14 @@ if ((hid_blacklist[n].idVendor == dev->descriptor.idVendor) && (hid_blacklist[n].idProduct == dev->descriptor.idProduct)) return NULL; - if (usb_get_extra_descriptor(interface, USB_DT_HID, &hdesc) && ((!interface->bNumEndpoints) || - usb_get_extra_descriptor(&interface->endpoint[0], USB_DT_HID, &hdesc))) { + if (usb_get_extra_descriptor(interface, HID_DT_HID, &hdesc) && ((!interface->bNumEndpoints) || + usb_get_extra_descriptor(&interface->endpoint[0], HID_DT_HID, &hdesc))) { dbg("class descriptor not present\n"); return NULL; } for (n = 0; n < hdesc->bNumDescriptors; n++) - if (hdesc->desc[n].bDescriptorType == USB_DT_REPORT) + if (hdesc->desc[n].bDescriptorType == HID_DT_REPORT) rsize = le16_to_cpu(hdesc->desc[n].wDescriptorLength); if (!rsize || rsize > HID_MAX_DESCRIPTOR_SIZE) { @@ -1120,7 +1130,7 @@ { __u8 rdesc[rsize]; - if ((n = usb_get_class_descriptor(dev, interface->bInterfaceNumber, USB_DT_REPORT, 0, rdesc, rsize)) < 0) { + if ((n = get_class_descriptor(dev, interface->bInterfaceNumber, HID_DT_REPORT, rdesc, rsize)) < 0) { dbg("reading report descriptor failed"); return NULL; } @@ -1170,7 +1180,7 @@ for (n = 0; n < HID_CONTROL_FIFO_SIZE; n++) { hid->out[n].dr.requesttype = USB_TYPE_CLASS | USB_RECIP_INTERFACE; - hid->out[n].dr.request = USB_REQ_SET_REPORT; + hid->out[n].dr.request = HID_REQ_SET_REPORT; hid->out[n].dr.index = cpu_to_le16(hid->ifnum); } @@ -1198,7 +1208,7 @@ #if 0 if (interface->bInterfaceSubClass == 1) - usb_set_protocol(dev, hid->ifnum, 1); + hid_set_protocol(dev, hid->ifnum, 1); #endif return hid; --- 2.5.1-pre4/drivers/usb-dist/usbkbd.c Sat Dec 1 13:14:06 2001 +++ 2.5.1-pre4/drivers/usb/usbkbd.c Sun Dec 2 15:48:24 2001 @@ -35,6 +35,9 @@ #include #include +#define _HID_BOOT_PROTOCOL +#include "hid.h" + /* * Version Information */ @@ -192,8 +195,8 @@ pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress); maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe)); - usb_set_protocol(dev, interface->bInterfaceNumber, 0); - usb_set_idle(dev, interface->bInterfaceNumber, 0, 0); + hid_set_protocol(dev, interface->bInterfaceNumber, 0); + hid_set_idle(dev, interface->bInterfaceNumber, 0, 0); if (!(kbd = kmalloc(sizeof(struct usb_kbd), GFP_KERNEL))) return NULL; memset(kbd, 0, sizeof(struct usb_kbd)); @@ -216,7 +219,7 @@ usb_kbd_irq, kbd, endpoint->bInterval); kbd->dr.requesttype = USB_TYPE_CLASS | USB_RECIP_INTERFACE; - kbd->dr.request = USB_REQ_SET_REPORT; + kbd->dr.request = HID_REQ_SET_REPORT; kbd->dr.value = 0x200; kbd->dr.index = interface->bInterfaceNumber; kbd->dr.length = 1; --- 2.5.1-pre4/drivers/usb-dist/usbmouse.c Sat Dec 1 13:14:06 2001 +++ 2.5.1-pre4/drivers/usb/usbmouse.c Sun Dec 2 15:48:33 2001 @@ -35,6 +35,9 @@ #include #include +#define _HID_BOOT_PROTOCOL +#include "hid.h" + /* * Version Information */ @@ -118,7 +121,7 @@ pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress); maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe)); - usb_set_idle(dev, interface->bInterfaceNumber, 0, 0); + hid_set_idle(dev, interface->bInterfaceNumber, 0, 0); if (!(mouse = kmalloc(sizeof(struct usb_mouse), GFP_KERNEL))) return NULL; memset(mouse, 0, sizeof(struct usb_mouse)); --- 2.5.1-pre4/drivers/usb-dist/kaweth.c Sat Dec 1 13:14:07 2001 +++ 2.5.1-pre4/drivers/usb/kaweth.c Sun Dec 2 15:48:40 2001 @@ -944,6 +944,13 @@ } +// FIXME this completion stuff is a modified clone of +// an OLD version of some stuff in usb.c ... +struct usb_api_data { + wait_queue_head_t wqh; + int done; +}; + /*-------------------------------------------------------------------* * completion handler for compatibility wrappers (sync control/bulk) * *-------------------------------------------------------------------*/