blob: ea45f265ec05221bc18b0ad687a15e721f53ed44 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Filesystem based user-mode API to USB Gadget controller hardware
3 *
David Brownella5262dc2007-05-14 19:36:41 -07004 * Other than ep0 operations, most things are done by read() and write()
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * on endpoint files found in one directory. They are configured by
6 * writing descriptors, and then may be used for normal stream style
7 * i/o requests. When ep0 is configured, the device can enumerate;
David Brownella5262dc2007-05-14 19:36:41 -07008 * when it's closed, the device disconnects from usb. Operations on
9 * ep0 require ioctl() operations.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 *
11 * Configuration and device descriptors get written to /dev/gadget/$CHIP,
12 * which may then be used to read usb_gadgetfs_event structs. The driver
13 * may activate endpoints as it handles SET_CONFIGURATION setup events,
14 * or earlier; writing endpoint descriptors to /dev/gadget/$ENDPOINT
15 * then performing data transfers by reading or writing.
16 */
17
Robert P. J. Daydda43a02008-03-07 13:45:32 -050018#ifndef __LINUX_USB_GADGETFS_H
19#define __LINUX_USB_GADGETFS_H
20
21#include <asm/types.h>
22#include <asm/ioctl.h>
23
24#include <linux/usb/ch9.h>
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/*
David Brownella5262dc2007-05-14 19:36:41 -070027 * Events are delivered on the ep0 file descriptor, when the user mode driver
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * reads from this file descriptor after writing the descriptors. Don't
David Brownella5262dc2007-05-14 19:36:41 -070029 * stop polling this descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 */
31
32enum usb_gadgetfs_event_type {
33 GADGETFS_NOP = 0,
34
35 GADGETFS_CONNECT,
36 GADGETFS_DISCONNECT,
37 GADGETFS_SETUP,
38 GADGETFS_SUSPEND,
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080039 /* and likely more ! */
Linus Torvalds1da177e2005-04-16 15:20:36 -070040};
41
David Brownella5262dc2007-05-14 19:36:41 -070042/* NOTE: this structure must stay the same size and layout on
43 * both 32-bit and 64-bit kernels.
44 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045struct usb_gadgetfs_event {
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 union {
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080047 /* NOP, DISCONNECT, SUSPEND: nothing
48 * ... some hardware can't report disconnection
49 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080051 /* CONNECT: just the speed */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 enum usb_device_speed speed;
53
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080054 /* SETUP: packet; DATA phase i/o precedes next event
55 *(setup.bmRequestType & USB_DIR_IN) flags direction
56 * ... includes SET_CONFIGURATION, SET_INTERFACE
57 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct usb_ctrlrequest setup;
59 } u;
David Brownella5262dc2007-05-14 19:36:41 -070060 enum usb_gadgetfs_event_type type;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061};
62
63
Craig W. Nadler25a010c2007-11-11 15:00:15 -080064/* The 'g' code is also used by printer gadget ioctl requests.
65 * Don't add any colliding codes to either driver, and keep
66 * them in unique ranges (size 0x20 for now).
67 */
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/* endpoint ioctls */
70
71/* IN transfers may be reported to the gadget driver as complete
David Brownella5262dc2007-05-14 19:36:41 -070072 * when the fifo is loaded, before the host reads the data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * OUT transfers may be reported to the host's "client" driver as
David Brownella5262dc2007-05-14 19:36:41 -070074 * complete when they're sitting in the FIFO unread.
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * THIS returns how many bytes are "unclaimed" in the endpoint fifo
76 * (needed for precise fault handling, when the hardware allows it)
77 */
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080078#define GADGETFS_FIFO_STATUS _IO('g', 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80/* discards any unclaimed data in the fifo. */
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080081#define GADGETFS_FIFO_FLUSH _IO('g', 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/* resets endpoint halt+toggle; used to implement set_interface.
84 * some hardware (like pxa2xx) can't support this.
85 */
Greg Kroah-Hartman41dceed2008-01-30 15:21:33 -080086#define GADGETFS_CLEAR_HALT _IO('g', 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
David Brownella5262dc2007-05-14 19:36:41 -070088#endif /* __LINUX_USB_GADGETFS_H */