blob: 27603bcbb9b99dccd86f9ac7f720e13fde4c8bd0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Inaky Perez-Gonzalez672027a2007-02-22 16:37:53 -08002 * This file holds USB constants and structures that are needed for
3 * USB device APIs. These are used by the USB device model, which is
4 * defined in chapter 9 of the USB 2.0 specification and in the
5 * Wireless USB 1.0 (spread around). Linux has several APIs in C that
6 * need these:
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * - the master/host side Linux-USB kernel driver API;
9 * - the "usbfs" user space API; and
David Brownell5da01062005-05-31 10:21:11 -070010 * - the Linux "gadget" slave/device/peripheral side driver API.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
12 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
13 * act either as a USB master/host or as a USB slave/device. That means
David Brownell5da01062005-05-31 10:21:11 -070014 * the master and slave side APIs benefit from working well together.
15 *
16 * There's also "Wireless USB", using low power short range radios for
17 * peripheral interconnection but otherwise building on the USB framework.
Inaky Perez-Gonzalez672027a2007-02-22 16:37:53 -080018 *
19 * Note all descriptors are declared '__attribute__((packed))' so that:
20 *
21 * [a] they never get padded, either internally (USB spec writers
22 * probably handled that) or externally;
23 *
24 * [b] so that accessing bigger-than-a-bytes fields will never
25 * generate bus errors on any platform, even when the location of
26 * its descriptor inside a bundle isn't "naturally aligned", and
27 *
28 * [c] for consistency, removing all doubt even when it appears to
29 * someone that the two other points are non-issues for that
30 * particular descriptor type.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#ifndef __LINUX_USB_CH9_H
33#define __LINUX_USB_CH9_H
34
David Howells5e1ddb42012-10-09 09:49:07 +010035#include <uapi/linux/usb/ch9.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Michal Nazarewicze538dfd2011-08-30 17:11:19 +020037
38/**
39 * usb_speed_string() - Returns human readable-name of the speed.
40 * @speed: The speed to return human-readable name for. If it's not
41 * any of the speeds defined in usb_device_speed enum, string for
42 * USB_SPEED_UNKNOWN will be returned.
43 */
44extern const char *usb_speed_string(enum usb_device_speed speed);
45
Felipe Balbid1e3d752013-01-24 22:29:48 +020046
47/**
48 * usb_state_string - Returns human readable name for the state.
49 * @state: The state to return a human-readable name for. If it's not
50 * any of the states devices in usb_device_state_string enum,
51 * the string UNKNOWN will be returned.
52 */
53extern const char *usb_state_string(enum usb_device_state state);
54
Robert P. J. Daydda43a02008-03-07 13:45:32 -050055#endif /* __LINUX_USB_CH9_H */