1ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#ifndef __LINUX_FUNCTIONFS_H__ 2ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define __LINUX_FUNCTIONFS_H__ 1 3ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 4ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 5ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#include <linux/types.h> 6ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#include <linux/ioctl.h> 7ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 8ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#include <linux/usb/ch9.h> 9ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 10ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 11ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczenum { 12ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_DESCRIPTORS_MAGIC = 1, 13ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_STRINGS_MAGIC = 2 14ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz}; 15ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 16ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 17ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#ifndef __KERNEL__ 18ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 19ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* Descriptor of an non-audio endpoint */ 20ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_endpoint_descriptor_no_audio { 21ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 bLength; 22ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 bDescriptorType; 23ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 24ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 bEndpointAddress; 25ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 bmAttributes; 26ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le16 wMaxPacketSize; 27ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 bInterval; 28ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz} __attribute__((packed)); 29ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 30ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 31ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 32ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * All numbers must be in little endian order. 33ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 34ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 35ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_functionfs_descs_head { 36ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 magic; 37ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 length; 38ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 fs_count; 39ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 hs_count; 40ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz} __attribute__((packed)); 41ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 42ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 43ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * Descriptors format: 44ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 45ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | off | name | type | description | 46ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * |-----+-----------+--------------+--------------------------------------| 47ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 0 | magic | LE32 | FUNCTIONFS_{FS,HS}_DESCRIPTORS_MAGIC | 4825985edcedea6396277003854657b5f3cb31a628Lucas De Marchi * | 4 | length | LE32 | length of the whole data chunk | 49ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 8 | fs_count | LE32 | number of full-speed descriptors | 50ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 12 | hs_count | LE32 | number of high-speed descriptors | 51ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 16 | fs_descrs | Descriptor[] | list of full-speed descriptors | 52ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | | hs_descrs | Descriptor[] | list of high-speed descriptors | 53ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 54ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * descs are just valid USB descriptors and have the following format: 55ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 56ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | off | name | type | description | 57ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * |-----+-----------------+------+--------------------------| 58ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 0 | bLength | U8 | length of the descriptor | 59ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 1 | bDescriptorType | U8 | descriptor type | 60ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 2 | payload | | descriptor's payload | 61ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 62ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 63ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_functionfs_strings_head { 64ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 magic; 65ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 length; 66ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 str_count; 67ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __le32 lang_count; 68ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz} __attribute__((packed)); 69ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 70ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 71ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * Strings format: 72ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 73ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | off | name | type | description | 74ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * |-----+------------+-----------------------+----------------------------| 75ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 0 | magic | LE32 | FUNCTIONFS_STRINGS_MAGIC | 76ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 4 | length | LE32 | length of the data chunk | 77ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 8 | str_count | LE32 | number of strings | 78ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 12 | lang_count | LE32 | number of languages | 79ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 16 | stringtab | StringTab[lang_count] | table of strings per lang | 80ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 81ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * For each language there is one stringtab entry (ie. there are lang_count 82ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * stringtab entires). Each StringTab has following format: 83ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 84ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | off | name | type | description | 85ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * |-----+---------+-------------------+------------------------------------| 86ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 0 | lang | LE16 | language code | 87ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * | 2 | strings | String[str_count] | array of strings in given language | 88ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * 8925985edcedea6396277003854657b5f3cb31a628Lucas De Marchi * For each string there is one strings entry (ie. there are str_count 90ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * string entries). Each String is a NUL terminated string encoded in 91ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * UTF-8. 92ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 93ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 94ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#endif 95ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 96ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 97ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 98ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * Events are delivered on the ep0 file descriptor, when the user mode driver 99ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * reads from this file descriptor after writing the descriptors. Don't 100ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * stop polling this descriptor. 101ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 102ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 103ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczenum usb_functionfs_event_type { 104ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_BIND, 105ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_UNBIND, 106ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 107ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_ENABLE, 108ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_DISABLE, 109ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 110ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_SETUP, 111ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 112ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_SUSPEND, 113ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz FUNCTIONFS_RESUME 114ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz}; 115ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 116ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* NOTE: this structure must stay the same size and layout on 117ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * both 32-bit and 64-bit kernels. 118ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 119ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_functionfs_event { 120ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz union { 121ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz /* SETUP: packet; DATA phase i/o precedes next event 122ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz *(setup.bmRequestType & USB_DIR_IN) flags direction */ 123ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz struct usb_ctrlrequest setup; 124ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz } __attribute__((packed)) u; 125ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 126ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz /* enum usb_functionfs_event_type */ 127ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 type; 128ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __u8 _pad[3]; 129ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz} __attribute__((packed)); 130ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 131ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 132ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* Endpoint ioctls */ 133ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* The same as in gadgetfs */ 134ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 135ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* IN transfers may be reported to the gadget driver as complete 136ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * when the fifo is loaded, before the host reads the data; 137ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * OUT transfers may be reported to the host's "client" driver as 138ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * complete when they're sitting in the FIFO unread. 139ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * THIS returns how many bytes are "unclaimed" in the endpoint fifo 140ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * (needed for precise fault handling, when the hardware allows it) 141ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 142ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define FUNCTIONFS_FIFO_STATUS _IO('g', 1) 143ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 144ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* discards any unclaimed data in the fifo. */ 145ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define FUNCTIONFS_FIFO_FLUSH _IO('g', 2) 146ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 147ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* resets endpoint halt+toggle; used to implement set_interface. 148ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * some hardware (like pxa2xx) can't support this. 149ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 150ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define FUNCTIONFS_CLEAR_HALT _IO('g', 3) 151ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 152ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* Specific for functionfs */ 153ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 154ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 155ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * Returns reverse mapping of an interface. Called on EP0. If there 156ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * is no such interface returns -EDOM. If function is not active 157ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * returns -ENODEV. 158ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 159ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define FUNCTIONFS_INTERFACE_REVMAP _IO('g', 128) 160ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 161ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz/* 162ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * Returns real bEndpointAddress of an endpoint. If function is not 163ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz * active returns -ENODEV. 164ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz */ 165ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#define FUNCTIONFS_ENDPOINT_REVMAP _IO('g', 129) 166ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 167ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 168ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#ifdef __KERNEL__ 169ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 170ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct ffs_data; 171ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_composite_dev; 172ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstruct usb_configuration; 173ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 174ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 175ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic int functionfs_init(void) __attribute__((warn_unused_result)); 176ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic void functionfs_cleanup(void); 177ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 178ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic int functionfs_bind(struct ffs_data *ffs, struct usb_composite_dev *cdev) 179ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((warn_unused_result, nonnull)); 180ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic void functionfs_unbind(struct ffs_data *ffs) 181ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((nonnull)); 182ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 1837898aee1dacbb246fee958f0a6102320b61768d9Michal Nazarewiczstatic int functionfs_bind_config(struct usb_composite_dev *cdev, 1847898aee1dacbb246fee958f0a6102320b61768d9Michal Nazarewicz struct usb_configuration *c, 1857898aee1dacbb246fee958f0a6102320b61768d9Michal Nazarewicz struct ffs_data *ffs) 186ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((warn_unused_result, nonnull)); 187ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 188ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 189ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic int functionfs_ready_callback(struct ffs_data *ffs) 190ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((warn_unused_result, nonnull)); 191ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic void functionfs_closed_callback(struct ffs_data *ffs) 192ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((nonnull)); 193ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewiczstatic int functionfs_check_dev_callback(const char *dev_name) 194ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz __attribute__((warn_unused_result, nonnull)); 195ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 196ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 197ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#endif 198ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz 199ddf8abd2599491cbad959c700b90ba72a5dce8d0Michal Nazarewicz#endif 200