OSCL-LXR |
|
|
|
|||
0001 // SPDX-License-Identifier: GPL-2.0 0002 /* 0003 * <linux/usb/gadget.h> 0004 * 0005 * We call the USB code inside a Linux-based peripheral device a "gadget" 0006 * driver, except for the hardware-specific bus glue. One USB host can 0007 * talk to many USB gadgets, but the gadgets are only able to communicate 0008 * to one host. 0009 * 0010 * 0011 * (C) Copyright 2002-2004 by David Brownell 0012 * All Rights Reserved. 0013 */ 0014 0015 #ifndef __LINUX_USB_GADGET_H 0016 #define __LINUX_USB_GADGET_H 0017 0018 #include <linux/device.h> 0019 #include <linux/errno.h> 0020 #include <linux/init.h> 0021 #include <linux/list.h> 0022 #include <linux/slab.h> 0023 #include <linux/scatterlist.h> 0024 #include <linux/types.h> 0025 #include <linux/workqueue.h> 0026 #include <linux/usb/ch9.h> 0027 0028 #define UDC_TRACE_STR_MAX 512 0029 0030 struct usb_ep; 0031 0032 /** 0033 * struct usb_request - describes one i/o request 0034 * @buf: Buffer used for data. Always provide this; some controllers 0035 * only use PIO, or don't use DMA for some endpoints. 0036 * @dma: DMA address corresponding to 'buf'. If you don't set this 0037 * field, and the usb controller needs one, it is responsible 0038 * for mapping and unmapping the buffer. 0039 * @sg: a scatterlist for SG-capable controllers. 0040 * @num_sgs: number of SG entries 0041 * @num_mapped_sgs: number of SG entries mapped to DMA (internal) 0042 * @length: Length of that data 0043 * @stream_id: The stream id, when USB3.0 bulk streams are being used 0044 * @is_last: Indicates if this is the last request of a stream_id before 0045 * switching to a different stream (required for DWC3 controllers). 0046 * @no_interrupt: If true, hints that no completion irq is needed. 0047 * Helpful sometimes with deep request queues that are handled 0048 * directly by DMA controllers. 0049 * @zero: If true, when writing data, makes the last packet be "short" 0050 * by adding a zero length packet as needed; 0051 * @short_not_ok: When reading data, makes short packets be 0052 * treated as errors (queue stops advancing till cleanup). 0053 * @dma_mapped: Indicates if request has been mapped to DMA (internal) 0054 * @complete: Function called when request completes, so this request and 0055 * its buffer may be re-used. The function will always be called with 0056 * interrupts disabled, and it must not sleep. 0057 * Reads terminate with a short packet, or when the buffer fills, 0058 * whichever comes first. When writes terminate, some data bytes 0059 * will usually still be in flight (often in a hardware fifo). 0060 * Errors (for reads or writes) stop the queue from advancing 0061 * until the completion function returns, so that any transfers 0062 * invalidated by the error may first be dequeued. 0063 * @context: For use by the completion callback 0064 * @list: For use by the gadget driver. 0065 * @frame_number: Reports the interval number in (micro)frame in which the 0066 * isochronous transfer was transmitted or received. 0067 * @status: Reports completion code, zero or a negative errno. 0068 * Normally, faults block the transfer queue from advancing until 0069 * the completion callback returns. 0070 * Code "-ESHUTDOWN" indicates completion caused by device disconnect, 0071 * or when the driver disabled the endpoint. 0072 * @actual: Reports bytes transferred to/from the buffer. For reads (OUT 0073 * transfers) this may be less than the requested length. If the 0074 * short_not_ok flag is set, short reads are treated as errors 0075 * even when status otherwise indicates successful completion. 0076 * Note that for writes (IN transfers) some data bytes may still 0077 * reside in a device-side FIFO when the request is reported as 0078 * complete. 0079 * 0080 * These are allocated/freed through the endpoint they're used with. The 0081 * hardware's driver can add extra per-request data to the memory it returns, 0082 * which often avoids separate memory allocations (potential failures), 0083 * later when the request is queued. 0084 * 0085 * Request flags affect request handling, such as whether a zero length 0086 * packet is written (the "zero" flag), whether a short read should be 0087 * treated as an error (blocking request queue advance, the "short_not_ok" 0088 * flag), or hinting that an interrupt is not required (the "no_interrupt" 0089 * flag, for use with deep request queues). 0090 * 0091 * Bulk endpoints can use any size buffers, and can also be used for interrupt 0092 * transfers. interrupt-only endpoints can be much less functional. 0093 * 0094 * NOTE: this is analogous to 'struct urb' on the host side, except that 0095 * it's thinner and promotes more pre-allocation. 0096 */ 0097 0098 struct usb_request { 0099 void *buf; 0100 unsigned length; 0101 dma_addr_t dma; 0102 0103 struct scatterlist *sg; 0104 unsigned num_sgs; 0105 unsigned num_mapped_sgs; 0106 0107 unsigned stream_id:16; 0108 unsigned is_last:1; 0109 unsigned no_interrupt:1; 0110 unsigned zero:1; 0111 unsigned short_not_ok:1; 0112 unsigned dma_mapped:1; 0113 0114 void (*complete)(struct usb_ep *ep, 0115 struct usb_request *req); 0116 void *context; 0117 struct list_head list; 0118 0119 unsigned frame_number; /* ISO ONLY */ 0120 0121 int status; 0122 unsigned actual; 0123 }; 0124 0125 /*-------------------------------------------------------------------------*/ 0126 0127 /* endpoint-specific parts of the api to the usb controller hardware. 0128 * unlike the urb model, (de)multiplexing layers are not required. 0129 * (so this api could slash overhead if used on the host side...) 0130 * 0131 * note that device side usb controllers commonly differ in how many 0132 * endpoints they support, as well as their capabilities. 0133 */ 0134 struct usb_ep_ops { 0135 int (*enable) (struct usb_ep *ep, 0136 const struct usb_endpoint_descriptor *desc); 0137 int (*disable) (struct usb_ep *ep); 0138 void (*dispose) (struct usb_ep *ep); 0139 0140 struct usb_request *(*alloc_request) (struct usb_ep *ep, 0141 gfp_t gfp_flags); 0142 void (*free_request) (struct usb_ep *ep, struct usb_request *req); 0143 0144 int (*queue) (struct usb_ep *ep, struct usb_request *req, 0145 gfp_t gfp_flags); 0146 int (*dequeue) (struct usb_ep *ep, struct usb_request *req); 0147 0148 int (*set_halt) (struct usb_ep *ep, int value); 0149 int (*set_wedge) (struct usb_ep *ep); 0150 0151 int (*fifo_status) (struct usb_ep *ep); 0152 void (*fifo_flush) (struct usb_ep *ep); 0153 }; 0154 0155 /** 0156 * struct usb_ep_caps - endpoint capabilities description 0157 * @type_control:Endpoint supports control type (reserved for ep0). 0158 * @type_iso:Endpoint supports isochronous transfers. 0159 * @type_bulk:Endpoint supports bulk transfers. 0160 * @type_int:Endpoint supports interrupt transfers. 0161 * @dir_in:Endpoint supports IN direction. 0162 * @dir_out:Endpoint supports OUT direction. 0163 */ 0164 struct usb_ep_caps { 0165 unsigned type_control:1; 0166 unsigned type_iso:1; 0167 unsigned type_bulk:1; 0168 unsigned type_int:1; 0169 unsigned dir_in:1; 0170 unsigned dir_out:1; 0171 }; 0172 0173 #define USB_EP_CAPS_TYPE_CONTROL 0x01 0174 #define USB_EP_CAPS_TYPE_ISO 0x02 0175 #define USB_EP_CAPS_TYPE_BULK 0x04 0176 #define USB_EP_CAPS_TYPE_INT 0x08 0177 #define USB_EP_CAPS_TYPE_ALL \ 0178 (USB_EP_CAPS_TYPE_ISO | USB_EP_CAPS_TYPE_BULK | USB_EP_CAPS_TYPE_INT) 0179 #define USB_EP_CAPS_DIR_IN 0x01 0180 #define USB_EP_CAPS_DIR_OUT 0x02 0181 #define USB_EP_CAPS_DIR_ALL (USB_EP_CAPS_DIR_IN | USB_EP_CAPS_DIR_OUT) 0182 0183 #define USB_EP_CAPS(_type, _dir) \ 0184 { \ 0185 .type_control = !!(_type & USB_EP_CAPS_TYPE_CONTROL), \ 0186 .type_iso = !!(_type & USB_EP_CAPS_TYPE_ISO), \ 0187 .type_bulk = !!(_type & USB_EP_CAPS_TYPE_BULK), \ 0188 .type_int = !!(_type & USB_EP_CAPS_TYPE_INT), \ 0189 .dir_in = !!(_dir & USB_EP_CAPS_DIR_IN), \ 0190 .dir_out = !!(_dir & USB_EP_CAPS_DIR_OUT), \ 0191 } 0192 0193 /** 0194 * struct usb_ep - device side representation of USB endpoint 0195 * @name:identifier for the endpoint, such as "ep-a" or "ep9in-bulk" 0196 * @ops: Function pointers used to access hardware-specific operations. 0197 * @ep_list:the gadget's ep_list holds all of its endpoints 0198 * @caps:The structure describing types and directions supported by endpoint. 0199 * @enabled: The current endpoint enabled/disabled state. 0200 * @claimed: True if this endpoint is claimed by a function. 0201 * @maxpacket:The maximum packet size used on this endpoint. The initial 0202 * value can sometimes be reduced (hardware allowing), according to 0203 * the endpoint descriptor used to configure the endpoint. 0204 * @maxpacket_limit:The maximum packet size value which can be handled by this 0205 * endpoint. It's set once by UDC driver when endpoint is initialized, and 0206 * should not be changed. Should not be confused with maxpacket. 0207 * @max_streams: The maximum number of streams supported 0208 * by this EP (0 - 16, actual number is 2^n) 0209 * @mult: multiplier, 'mult' value for SS Isoc EPs 0210 * @maxburst: the maximum number of bursts supported by this EP (for usb3) 0211 * @driver_data:for use by the gadget driver. 0212 * @address: used to identify the endpoint when finding descriptor that 0213 * matches connection speed 0214 * @desc: endpoint descriptor. This pointer is set before the endpoint is 0215 * enabled and remains valid until the endpoint is disabled. 0216 * @comp_desc: In case of SuperSpeed support, this is the endpoint companion 0217 * descriptor that is used to configure the endpoint 0218 * 0219 * the bus controller driver lists all the general purpose endpoints in 0220 * gadget->ep_list. the control endpoint (gadget->ep0) is not in that list, 0221 * and is accessed only in response to a driver setup() callback. 0222 */ 0223 0224 struct usb_ep { 0225 void *driver_data; 0226 0227 const char *name; 0228 const struct usb_ep_ops *ops; 0229 struct list_head ep_list; 0230 struct usb_ep_caps caps; 0231 bool claimed; 0232 bool enabled; 0233 unsigned maxpacket:16; 0234 unsigned maxpacket_limit:16; 0235 unsigned max_streams:16; 0236 unsigned mult:2; 0237 unsigned maxburst:5; 0238 u8 address; 0239 const struct usb_endpoint_descriptor *desc; 0240 const struct usb_ss_ep_comp_descriptor *comp_desc; 0241 }; 0242 0243 /*-------------------------------------------------------------------------*/ 0244 0245 #if IS_ENABLED(CONFIG_USB_GADGET) 0246 void usb_ep_set_maxpacket_limit(struct usb_ep *ep, unsigned maxpacket_limit); 0247 int usb_ep_enable(struct usb_ep *ep); 0248 int usb_ep_disable(struct usb_ep *ep); 0249 struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, gfp_t gfp_flags); 0250 void usb_ep_free_request(struct usb_ep *ep, struct usb_request *req); 0251 int usb_ep_queue(struct usb_ep *ep, struct usb_request *req, gfp_t gfp_flags); 0252 int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req); 0253 int usb_ep_set_halt(struct usb_ep *ep); 0254 int usb_ep_clear_halt(struct usb_ep *ep); 0255 int usb_ep_set_wedge(struct usb_ep *ep); 0256 int usb_ep_fifo_status(struct usb_ep *ep); 0257 void usb_ep_fifo_flush(struct usb_ep *ep); 0258 #else 0259 static inline void usb_ep_set_maxpacket_limit(struct usb_ep *ep, 0260 unsigned maxpacket_limit) 0261 { } 0262 static inline int usb_ep_enable(struct usb_ep *ep) 0263 { return 0; } 0264 static inline int usb_ep_disable(struct usb_ep *ep) 0265 { return 0; } 0266 static inline struct usb_request *usb_ep_alloc_request(struct usb_ep *ep, 0267 gfp_t gfp_flags) 0268 { return NULL; } 0269 static inline void usb_ep_free_request(struct usb_ep *ep, 0270 struct usb_request *req) 0271 { } 0272 static inline int usb_ep_queue(struct usb_ep *ep, struct usb_request *req, 0273 gfp_t gfp_flags) 0274 { return 0; } 0275 static inline int usb_ep_dequeue(struct usb_ep *ep, struct usb_request *req) 0276 { return 0; } 0277 static inline int usb_ep_set_halt(struct usb_ep *ep) 0278 { return 0; } 0279 static inline int usb_ep_clear_halt(struct usb_ep *ep) 0280 { return 0; } 0281 static inline int usb_ep_set_wedge(struct usb_ep *ep) 0282 { return 0; } 0283 static inline int usb_ep_fifo_status(struct usb_ep *ep) 0284 { return 0; } 0285 static inline void usb_ep_fifo_flush(struct usb_ep *ep) 0286 { } 0287 #endif /* USB_GADGET */ 0288 0289 /*-------------------------------------------------------------------------*/ 0290 0291 struct usb_dcd_config_params { 0292 __u8 bU1devExitLat; /* U1 Device exit Latency */ 0293 #define USB_DEFAULT_U1_DEV_EXIT_LAT 0x01 /* Less then 1 microsec */ 0294 __le16 bU2DevExitLat; /* U2 Device exit Latency */ 0295 #define USB_DEFAULT_U2_DEV_EXIT_LAT 0x1F4 /* Less then 500 microsec */ 0296 __u8 besl_baseline; /* Recommended baseline BESL (0-15) */ 0297 __u8 besl_deep; /* Recommended deep BESL (0-15) */ 0298 #define USB_DEFAULT_BESL_UNSPECIFIED 0xFF /* No recommended value */ 0299 }; 0300 0301 0302 struct usb_gadget; 0303 struct usb_gadget_driver; 0304 struct usb_udc; 0305 0306 /* the rest of the api to the controller hardware: device operations, 0307 * which don't involve endpoints (or i/o). 0308 */ 0309 struct usb_gadget_ops { 0310 int (*get_frame)(struct usb_gadget *); 0311 int (*wakeup)(struct usb_gadget *); 0312 int (*set_selfpowered) (struct usb_gadget *, int is_selfpowered); 0313 int (*vbus_session) (struct usb_gadget *, int is_active); 0314 int (*vbus_draw) (struct usb_gadget *, unsigned mA); 0315 int (*pullup) (struct usb_gadget *, int is_on); 0316 int (*ioctl)(struct usb_gadget *, 0317 unsigned code, unsigned long param); 0318 void (*get_config_params)(struct usb_gadget *, 0319 struct usb_dcd_config_params *); 0320 int (*udc_start)(struct usb_gadget *, 0321 struct usb_gadget_driver *); 0322 int (*udc_stop)(struct usb_gadget *); 0323 void (*udc_set_speed)(struct usb_gadget *, enum usb_device_speed); 0324 void (*udc_set_ssp_rate)(struct usb_gadget *gadget, 0325 enum usb_ssp_rate rate); 0326 void (*udc_async_callbacks)(struct usb_gadget *gadget, bool enable); 0327 struct usb_ep *(*match_ep)(struct usb_gadget *, 0328 struct usb_endpoint_descriptor *, 0329 struct usb_ss_ep_comp_descriptor *); 0330 int (*check_config)(struct usb_gadget *gadget); 0331 }; 0332 0333 /** 0334 * struct usb_gadget - represents a usb device 0335 * @work: (internal use) Workqueue to be used for sysfs_notify() 0336 * @udc: struct usb_udc pointer for this gadget 0337 * @ops: Function pointers used to access hardware-specific operations. 0338 * @ep0: Endpoint zero, used when reading or writing responses to 0339 * driver setup() requests 0340 * @ep_list: List of other endpoints supported by the device. 0341 * @speed: Speed of current connection to USB host. 0342 * @max_speed: Maximal speed the UDC can handle. UDC must support this 0343 * and all slower speeds. 0344 * @ssp_rate: Current connected SuperSpeed Plus signaling rate and lane count. 0345 * @max_ssp_rate: Maximum SuperSpeed Plus signaling rate and lane count the UDC 0346 * can handle. The UDC must support this and all slower speeds and lower 0347 * number of lanes. 0348 * @state: the state we are now (attached, suspended, configured, etc) 0349 * @name: Identifies the controller hardware type. Used in diagnostics 0350 * and sometimes configuration. 0351 * @dev: Driver model state for this abstract device. 0352 * @isoch_delay: value from Set Isoch Delay request. Only valid on SS/SSP 0353 * @out_epnum: last used out ep number 0354 * @in_epnum: last used in ep number 0355 * @mA: last set mA value 0356 * @otg_caps: OTG capabilities of this gadget. 0357 * @sg_supported: true if we can handle scatter-gather 0358 * @is_otg: True if the USB device port uses a Mini-AB jack, so that the 0359 * gadget driver must provide a USB OTG descriptor. 0360 * @is_a_peripheral: False unless is_otg, the "A" end of a USB cable 0361 * is in the Mini-AB jack, and HNP has been used to switch roles 0362 * so that the "A" device currently acts as A-Peripheral, not A-Host. 0363 * @a_hnp_support: OTG device feature flag, indicating that the A-Host 0364 * supports HNP at this port. 0365 * @a_alt_hnp_support: OTG device feature flag, indicating that the A-Host 0366 * only supports HNP on a different root port. 0367 * @b_hnp_enable: OTG device feature flag, indicating that the A-Host 0368 * enabled HNP support. 0369 * @hnp_polling_support: OTG device feature flag, indicating if the OTG device 0370 * in peripheral mode can support HNP polling. 0371 * @host_request_flag: OTG device feature flag, indicating if A-Peripheral 0372 * or B-Peripheral wants to take host role. 0373 * @quirk_ep_out_aligned_size: epout requires buffer size to be aligned to 0374 * MaxPacketSize. 0375 * @quirk_altset_not_supp: UDC controller doesn't support alt settings. 0376 * @quirk_stall_not_supp: UDC controller doesn't support stalling. 0377 * @quirk_zlp_not_supp: UDC controller doesn't support ZLP. 0378 * @quirk_avoids_skb_reserve: udc/platform wants to avoid skb_reserve() in 0379 * u_ether.c to improve performance. 0380 * @is_selfpowered: if the gadget is self-powered. 0381 * @deactivated: True if gadget is deactivated - in deactivated state it cannot 0382 * be connected. 0383 * @connected: True if gadget is connected. 0384 * @lpm_capable: If the gadget max_speed is FULL or HIGH, this flag 0385 * indicates that it supports LPM as per the LPM ECN & errata. 0386 * @irq: the interrupt number for device controller. 0387 * @id_number: a unique ID number for ensuring that gadget names are distinct 0388 * 0389 * Gadgets have a mostly-portable "gadget driver" implementing device 0390 * functions, handling all usb configurations and interfaces. Gadget 0391 * drivers talk to hardware-specific code indirectly, through ops vectors. 0392 * That insulates the gadget driver from hardware details, and packages 0393 * the hardware endpoints through generic i/o queues. The "usb_gadget" 0394 * and "usb_ep" interfaces provide that insulation from the hardware. 0395 * 0396 * Except for the driver data, all fields in this structure are 0397 * read-only to the gadget driver. That driver data is part of the 0398 * "driver model" infrastructure in 2.6 (and later) kernels, and for 0399 * earlier systems is grouped in a similar structure that's not known 0400 * to the rest of the kernel. 0401 * 0402 * Values of the three OTG device feature flags are updated before the 0403 * setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before 0404 * driver suspend() calls. They are valid only when is_otg, and when the 0405 * device is acting as a B-Peripheral (so is_a_peripheral is false). 0406 */ 0407 struct usb_gadget { 0408 struct work_struct work; 0409 struct usb_udc *udc; 0410 /* readonly to gadget driver */ 0411 const struct usb_gadget_ops *ops; 0412 struct usb_ep *ep0; 0413 struct list_head ep_list; /* of usb_ep */ 0414 enum usb_device_speed speed; 0415 enum usb_device_speed max_speed; 0416 0417 /* USB SuperSpeed Plus only */ 0418 enum usb_ssp_rate ssp_rate; 0419 enum usb_ssp_rate max_ssp_rate; 0420 0421 enum usb_device_state state; 0422 const char *name; 0423 struct device dev; 0424 unsigned isoch_delay; 0425 unsigned out_epnum; 0426 unsigned in_epnum; 0427 unsigned mA; 0428 struct usb_otg_caps *otg_caps; 0429 0430 unsigned sg_supported:1; 0431 unsigned is_otg:1; 0432 unsigned is_a_peripheral:1; 0433 unsigned b_hnp_enable:1; 0434 unsigned a_hnp_support:1; 0435 unsigned a_alt_hnp_support:1; 0436 unsigned hnp_polling_support:1; 0437 unsigned host_request_flag:1; 0438 unsigned quirk_ep_out_aligned_size:1; 0439 unsigned quirk_altset_not_supp:1; 0440 unsigned quirk_stall_not_supp:1; 0441 unsigned quirk_zlp_not_supp:1; 0442 unsigned quirk_avoids_skb_reserve:1; 0443 unsigned is_selfpowered:1; 0444 unsigned deactivated:1; 0445 unsigned connected:1; 0446 unsigned lpm_capable:1; 0447 int irq; 0448 int id_number; 0449 }; 0450 #define work_to_gadget(w) (container_of((w), struct usb_gadget, work)) 0451 0452 /* Interface to the device model */ 0453 static inline void set_gadget_data(struct usb_gadget *gadget, void *data) 0454 { dev_set_drvdata(&gadget->dev, data); } 0455 static inline void *get_gadget_data(struct usb_gadget *gadget) 0456 { return dev_get_drvdata(&gadget->dev); } 0457 static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev) 0458 { 0459 return container_of(dev, struct usb_gadget, dev); 0460 } 0461 static inline struct usb_gadget *usb_get_gadget(struct usb_gadget *gadget) 0462 { 0463 get_device(&gadget->dev); 0464 return gadget; 0465 } 0466 static inline void usb_put_gadget(struct usb_gadget *gadget) 0467 { 0468 put_device(&gadget->dev); 0469 } 0470 extern void usb_initialize_gadget(struct device *parent, 0471 struct usb_gadget *gadget, void (*release)(struct device *dev)); 0472 extern int usb_add_gadget(struct usb_gadget *gadget); 0473 extern void usb_del_gadget(struct usb_gadget *gadget); 0474 0475 /* Legacy device-model interface */ 0476 extern int usb_add_gadget_udc_release(struct device *parent, 0477 struct usb_gadget *gadget, void (*release)(struct device *dev)); 0478 extern int usb_add_gadget_udc(struct device *parent, struct usb_gadget *gadget); 0479 extern void usb_del_gadget_udc(struct usb_gadget *gadget); 0480 extern char *usb_get_gadget_udc_name(void); 0481 0482 /* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */ 0483 #define gadget_for_each_ep(tmp, gadget) \ 0484 list_for_each_entry(tmp, &(gadget)->ep_list, ep_list) 0485 0486 /** 0487 * usb_ep_align - returns @len aligned to ep's maxpacketsize. 0488 * @ep: the endpoint whose maxpacketsize is used to align @len 0489 * @len: buffer size's length to align to @ep's maxpacketsize 0490 * 0491 * This helper is used to align buffer's size to an ep's maxpacketsize. 0492 */ 0493 static inline size_t usb_ep_align(struct usb_ep *ep, size_t len) 0494 { 0495 int max_packet_size = (size_t)usb_endpoint_maxp(ep->desc); 0496 0497 return round_up(len, max_packet_size); 0498 } 0499 0500 /** 0501 * usb_ep_align_maybe - returns @len aligned to ep's maxpacketsize if gadget 0502 * requires quirk_ep_out_aligned_size, otherwise returns len. 0503 * @g: controller to check for quirk 0504 * @ep: the endpoint whose maxpacketsize is used to align @len 0505 * @len: buffer size's length to align to @ep's maxpacketsize 0506 * 0507 * This helper is used in case it's required for any reason to check and maybe 0508 * align buffer's size to an ep's maxpacketsize. 0509 */ 0510 static inline size_t 0511 usb_ep_align_maybe(struct usb_gadget *g, struct usb_ep *ep, size_t len) 0512 { 0513 return g->quirk_ep_out_aligned_size ? usb_ep_align(ep, len) : len; 0514 } 0515 0516 /** 0517 * gadget_is_altset_supported - return true iff the hardware supports 0518 * altsettings 0519 * @g: controller to check for quirk 0520 */ 0521 static inline int gadget_is_altset_supported(struct usb_gadget *g) 0522 { 0523 return !g->quirk_altset_not_supp; 0524 } 0525 0526 /** 0527 * gadget_is_stall_supported - return true iff the hardware supports stalling 0528 * @g: controller to check for quirk 0529 */ 0530 static inline int gadget_is_stall_supported(struct usb_gadget *g) 0531 { 0532 return !g->quirk_stall_not_supp; 0533 } 0534 0535 /** 0536 * gadget_is_zlp_supported - return true iff the hardware supports zlp 0537 * @g: controller to check for quirk 0538 */ 0539 static inline int gadget_is_zlp_supported(struct usb_gadget *g) 0540 { 0541 return !g->quirk_zlp_not_supp; 0542 } 0543 0544 /** 0545 * gadget_avoids_skb_reserve - return true iff the hardware would like to avoid 0546 * skb_reserve to improve performance. 0547 * @g: controller to check for quirk 0548 */ 0549 static inline int gadget_avoids_skb_reserve(struct usb_gadget *g) 0550 { 0551 return g->quirk_avoids_skb_reserve; 0552 } 0553 0554 /** 0555 * gadget_is_dualspeed - return true iff the hardware handles high speed 0556 * @g: controller that might support both high and full speeds 0557 */ 0558 static inline int gadget_is_dualspeed(struct usb_gadget *g) 0559 { 0560 return g->max_speed >= USB_SPEED_HIGH; 0561 } 0562 0563 /** 0564 * gadget_is_superspeed() - return true if the hardware handles superspeed 0565 * @g: controller that might support superspeed 0566 */ 0567 static inline int gadget_is_superspeed(struct usb_gadget *g) 0568 { 0569 return g->max_speed >= USB_SPEED_SUPER; 0570 } 0571 0572 /** 0573 * gadget_is_superspeed_plus() - return true if the hardware handles 0574 * superspeed plus 0575 * @g: controller that might support superspeed plus 0576 */ 0577 static inline int gadget_is_superspeed_plus(struct usb_gadget *g) 0578 { 0579 return g->max_speed >= USB_SPEED_SUPER_PLUS; 0580 } 0581 0582 /** 0583 * gadget_is_otg - return true iff the hardware is OTG-ready 0584 * @g: controller that might have a Mini-AB connector 0585 * 0586 * This is a runtime test, since kernels with a USB-OTG stack sometimes 0587 * run on boards which only have a Mini-B (or Mini-A) connector. 0588 */ 0589 static inline int gadget_is_otg(struct usb_gadget *g) 0590 { 0591 #ifdef CONFIG_USB_OTG 0592 return g->is_otg; 0593 #else 0594 return 0; 0595 #endif 0596 } 0597 0598 /*-------------------------------------------------------------------------*/ 0599 0600 #if IS_ENABLED(CONFIG_USB_GADGET) 0601 int usb_gadget_frame_number(struct usb_gadget *gadget); 0602 int usb_gadget_wakeup(struct usb_gadget *gadget); 0603 int usb_gadget_set_selfpowered(struct usb_gadget *gadget); 0604 int usb_gadget_clear_selfpowered(struct usb_gadget *gadget); 0605 int usb_gadget_vbus_connect(struct usb_gadget *gadget); 0606 int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA); 0607 int usb_gadget_vbus_disconnect(struct usb_gadget *gadget); 0608 int usb_gadget_connect(struct usb_gadget *gadget); 0609 int usb_gadget_disconnect(struct usb_gadget *gadget); 0610 int usb_gadget_deactivate(struct usb_gadget *gadget); 0611 int usb_gadget_activate(struct usb_gadget *gadget); 0612 int usb_gadget_check_config(struct usb_gadget *gadget); 0613 #else 0614 static inline int usb_gadget_frame_number(struct usb_gadget *gadget) 0615 { return 0; } 0616 static inline int usb_gadget_wakeup(struct usb_gadget *gadget) 0617 { return 0; } 0618 static inline int usb_gadget_set_selfpowered(struct usb_gadget *gadget) 0619 { return 0; } 0620 static inline int usb_gadget_clear_selfpowered(struct usb_gadget *gadget) 0621 { return 0; } 0622 static inline int usb_gadget_vbus_connect(struct usb_gadget *gadget) 0623 { return 0; } 0624 static inline int usb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA) 0625 { return 0; } 0626 static inline int usb_gadget_vbus_disconnect(struct usb_gadget *gadget) 0627 { return 0; } 0628 static inline int usb_gadget_connect(struct usb_gadget *gadget) 0629 { return 0; } 0630 static inline int usb_gadget_disconnect(struct usb_gadget *gadget) 0631 { return 0; } 0632 static inline int usb_gadget_deactivate(struct usb_gadget *gadget) 0633 { return 0; } 0634 static inline int usb_gadget_activate(struct usb_gadget *gadget) 0635 { return 0; } 0636 static inline int usb_gadget_check_config(struct usb_gadget *gadget) 0637 { return 0; } 0638 #endif /* CONFIG_USB_GADGET */ 0639 0640 /*-------------------------------------------------------------------------*/ 0641 0642 /** 0643 * struct usb_gadget_driver - driver for usb gadget devices 0644 * @function: String describing the gadget's function 0645 * @max_speed: Highest speed the driver handles. 0646 * @setup: Invoked for ep0 control requests that aren't handled by 0647 * the hardware level driver. Most calls must be handled by 0648 * the gadget driver, including descriptor and configuration 0649 * management. The 16 bit members of the setup data are in 0650 * USB byte order. Called in_interrupt; this may not sleep. Driver 0651 * queues a response to ep0, or returns negative to stall. 0652 * @disconnect: Invoked after all transfers have been stopped, 0653 * when the host is disconnected. May be called in_interrupt; this 0654 * may not sleep. Some devices can't detect disconnect, so this might 0655 * not be called except as part of controller shutdown. 0656 * @bind: the driver's bind callback 0657 * @unbind: Invoked when the driver is unbound from a gadget, 0658 * usually from rmmod (after a disconnect is reported). 0659 * Called in a context that permits sleeping. 0660 * @suspend: Invoked on USB suspend. May be called in_interrupt. 0661 * @resume: Invoked on USB resume. May be called in_interrupt. 0662 * @reset: Invoked on USB bus reset. It is mandatory for all gadget drivers 0663 * and should be called in_interrupt. 0664 * @driver: Driver model state for this driver. 0665 * @udc_name: A name of UDC this driver should be bound to. If udc_name is NULL, 0666 * this driver will be bound to any available UDC. 0667 * @match_existing_only: If udc is not found, return an error and fail 0668 * the driver registration 0669 * @is_bound: Allow a driver to be bound to only one gadget 0670 * 0671 * Devices are disabled till a gadget driver successfully bind()s, which 0672 * means the driver will handle setup() requests needed to enumerate (and 0673 * meet "chapter 9" requirements) then do some useful work. 0674 * 0675 * If gadget->is_otg is true, the gadget driver must provide an OTG 0676 * descriptor during enumeration, or else fail the bind() call. In such 0677 * cases, no USB traffic may flow until both bind() returns without 0678 * having called usb_gadget_disconnect(), and the USB host stack has 0679 * initialized. 0680 * 0681 * Drivers use hardware-specific knowledge to configure the usb hardware. 0682 * endpoint addressing is only one of several hardware characteristics that 0683 * are in descriptors the ep0 implementation returns from setup() calls. 0684 * 0685 * Except for ep0 implementation, most driver code shouldn't need change to 0686 * run on top of different usb controllers. It'll use endpoints set up by 0687 * that ep0 implementation. 0688 * 0689 * The usb controller driver handles a few standard usb requests. Those 0690 * include set_address, and feature flags for devices, interfaces, and 0691 * endpoints (the get_status, set_feature, and clear_feature requests). 0692 * 0693 * Accordingly, the driver's setup() callback must always implement all 0694 * get_descriptor requests, returning at least a device descriptor and 0695 * a configuration descriptor. Drivers must make sure the endpoint 0696 * descriptors match any hardware constraints. Some hardware also constrains 0697 * other descriptors. (The pxa250 allows only configurations 1, 2, or 3). 0698 * 0699 * The driver's setup() callback must also implement set_configuration, 0700 * and should also implement set_interface, get_configuration, and 0701 * get_interface. Setting a configuration (or interface) is where 0702 * endpoints should be activated or (config 0) shut down. 0703 * 0704 * (Note that only the default control endpoint is supported. Neither 0705 * hosts nor devices generally support control traffic except to ep0.) 0706 * 0707 * Most devices will ignore USB suspend/resume operations, and so will 0708 * not provide those callbacks. However, some may need to change modes 0709 * when the host is not longer directing those activities. For example, 0710 * local controls (buttons, dials, etc) may need to be re-enabled since 0711 * the (remote) host can't do that any longer; or an error state might 0712 * be cleared, to make the device behave identically whether or not 0713 * power is maintained. 0714 */ 0715 struct usb_gadget_driver { 0716 char *function; 0717 enum usb_device_speed max_speed; 0718 int (*bind)(struct usb_gadget *gadget, 0719 struct usb_gadget_driver *driver); 0720 void (*unbind)(struct usb_gadget *); 0721 int (*setup)(struct usb_gadget *, 0722 const struct usb_ctrlrequest *); 0723 void (*disconnect)(struct usb_gadget *); 0724 void (*suspend)(struct usb_gadget *); 0725 void (*resume)(struct usb_gadget *); 0726 void (*reset)(struct usb_gadget *); 0727 0728 /* FIXME support safe rmmod */ 0729 struct device_driver driver; 0730 0731 char *udc_name; 0732 unsigned match_existing_only:1; 0733 bool is_bound:1; 0734 }; 0735 0736 0737 0738 /*-------------------------------------------------------------------------*/ 0739 0740 /* driver modules register and unregister, as usual. 0741 * these calls must be made in a context that can sleep. 0742 * 0743 * A gadget driver can be bound to only one gadget at a time. 0744 */ 0745 0746 /** 0747 * usb_gadget_register_driver_owner - register a gadget driver 0748 * @driver: the driver being registered 0749 * @owner: the driver module 0750 * @mod_name: the driver module's build name 0751 * Context: can sleep 0752 * 0753 * Call this in your gadget driver's module initialization function, 0754 * to tell the underlying UDC controller driver about your driver. 0755 * The @bind() function will be called to bind it to a gadget before this 0756 * registration call returns. It's expected that the @bind() function will 0757 * be in init sections. 0758 * 0759 * Use the macro defined below instead of calling this directly. 0760 */ 0761 int usb_gadget_register_driver_owner(struct usb_gadget_driver *driver, 0762 struct module *owner, const char *mod_name); 0763 0764 /* use a define to avoid include chaining to get THIS_MODULE & friends */ 0765 #define usb_gadget_register_driver(driver) \ 0766 usb_gadget_register_driver_owner(driver, THIS_MODULE, KBUILD_MODNAME) 0767 0768 /** 0769 * usb_gadget_unregister_driver - unregister a gadget driver 0770 * @driver:the driver being unregistered 0771 * Context: can sleep 0772 * 0773 * Call this in your gadget driver's module cleanup function, 0774 * to tell the underlying usb controller that your driver is 0775 * going away. If the controller is connected to a USB host, 0776 * it will first disconnect(). The driver is also requested 0777 * to unbind() and clean up any device state, before this procedure 0778 * finally returns. It's expected that the unbind() functions 0779 * will be in exit sections, so may not be linked in some kernels. 0780 */ 0781 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver); 0782 0783 /*-------------------------------------------------------------------------*/ 0784 0785 /* utility to simplify dealing with string descriptors */ 0786 0787 /** 0788 * struct usb_string - wraps a C string and its USB id 0789 * @id:the (nonzero) ID for this string 0790 * @s:the string, in UTF-8 encoding 0791 * 0792 * If you're using usb_gadget_get_string(), use this to wrap a string 0793 * together with its ID. 0794 */ 0795 struct usb_string { 0796 u8 id; 0797 const char *s; 0798 }; 0799 0800 /** 0801 * struct usb_gadget_strings - a set of USB strings in a given language 0802 * @language:identifies the strings' language (0x0409 for en-us) 0803 * @strings:array of strings with their ids 0804 * 0805 * If you're using usb_gadget_get_string(), use this to wrap all the 0806 * strings for a given language. 0807 */ 0808 struct usb_gadget_strings { 0809 u16 language; /* 0x0409 for en-us */ 0810 struct usb_string *strings; 0811 }; 0812 0813 struct usb_gadget_string_container { 0814 struct list_head list; 0815 u8 *stash[]; 0816 }; 0817 0818 /* put descriptor for string with that id into buf (buflen >= 256) */ 0819 int usb_gadget_get_string(const struct usb_gadget_strings *table, int id, u8 *buf); 0820 0821 /* check if the given language identifier is valid */ 0822 bool usb_validate_langid(u16 langid); 0823 0824 /*-------------------------------------------------------------------------*/ 0825 0826 /* utility to simplify managing config descriptors */ 0827 0828 /* write vector of descriptors into buffer */ 0829 int usb_descriptor_fillbuf(void *, unsigned, 0830 const struct usb_descriptor_header **); 0831 0832 /* build config descriptor from single descriptor vector */ 0833 int usb_gadget_config_buf(const struct usb_config_descriptor *config, 0834 void *buf, unsigned buflen, const struct usb_descriptor_header **desc); 0835 0836 /* copy a NULL-terminated vector of descriptors */ 0837 struct usb_descriptor_header **usb_copy_descriptors( 0838 struct usb_descriptor_header **); 0839 0840 /** 0841 * usb_free_descriptors - free descriptors returned by usb_copy_descriptors() 0842 * @v: vector of descriptors 0843 */ 0844 static inline void usb_free_descriptors(struct usb_descriptor_header **v) 0845 { 0846 kfree(v); 0847 } 0848 0849 struct usb_function; 0850 int usb_assign_descriptors(struct usb_function *f, 0851 struct usb_descriptor_header **fs, 0852 struct usb_descriptor_header **hs, 0853 struct usb_descriptor_header **ss, 0854 struct usb_descriptor_header **ssp); 0855 void usb_free_all_descriptors(struct usb_function *f); 0856 0857 struct usb_descriptor_header *usb_otg_descriptor_alloc( 0858 struct usb_gadget *gadget); 0859 int usb_otg_descriptor_init(struct usb_gadget *gadget, 0860 struct usb_descriptor_header *otg_desc); 0861 /*-------------------------------------------------------------------------*/ 0862 0863 /* utility to simplify map/unmap of usb_requests to/from DMA */ 0864 0865 #ifdef CONFIG_HAS_DMA 0866 extern int usb_gadget_map_request_by_dev(struct device *dev, 0867 struct usb_request *req, int is_in); 0868 extern int usb_gadget_map_request(struct usb_gadget *gadget, 0869 struct usb_request *req, int is_in); 0870 0871 extern void usb_gadget_unmap_request_by_dev(struct device *dev, 0872 struct usb_request *req, int is_in); 0873 extern void usb_gadget_unmap_request(struct usb_gadget *gadget, 0874 struct usb_request *req, int is_in); 0875 #else /* !CONFIG_HAS_DMA */ 0876 static inline int usb_gadget_map_request_by_dev(struct device *dev, 0877 struct usb_request *req, int is_in) { return -ENOSYS; } 0878 static inline int usb_gadget_map_request(struct usb_gadget *gadget, 0879 struct usb_request *req, int is_in) { return -ENOSYS; } 0880 0881 static inline void usb_gadget_unmap_request_by_dev(struct device *dev, 0882 struct usb_request *req, int is_in) { } 0883 static inline void usb_gadget_unmap_request(struct usb_gadget *gadget, 0884 struct usb_request *req, int is_in) { } 0885 #endif /* !CONFIG_HAS_DMA */ 0886 0887 /*-------------------------------------------------------------------------*/ 0888 0889 /* utility to set gadget state properly */ 0890 0891 extern void usb_gadget_set_state(struct usb_gadget *gadget, 0892 enum usb_device_state state); 0893 0894 /*-------------------------------------------------------------------------*/ 0895 0896 /* utility to tell udc core that the bus reset occurs */ 0897 extern void usb_gadget_udc_reset(struct usb_gadget *gadget, 0898 struct usb_gadget_driver *driver); 0899 0900 /*-------------------------------------------------------------------------*/ 0901 0902 /* utility to give requests back to the gadget layer */ 0903 0904 extern void usb_gadget_giveback_request(struct usb_ep *ep, 0905 struct usb_request *req); 0906 0907 /*-------------------------------------------------------------------------*/ 0908 0909 /* utility to find endpoint by name */ 0910 0911 extern struct usb_ep *gadget_find_ep_by_name(struct usb_gadget *g, 0912 const char *name); 0913 0914 /*-------------------------------------------------------------------------*/ 0915 0916 /* utility to check if endpoint caps match descriptor needs */ 0917 0918 extern int usb_gadget_ep_match_desc(struct usb_gadget *gadget, 0919 struct usb_ep *ep, struct usb_endpoint_descriptor *desc, 0920 struct usb_ss_ep_comp_descriptor *ep_comp); 0921 0922 /*-------------------------------------------------------------------------*/ 0923 0924 /* utility to update vbus status for udc core, it may be scheduled */ 0925 extern void usb_udc_vbus_handler(struct usb_gadget *gadget, bool status); 0926 0927 /*-------------------------------------------------------------------------*/ 0928 0929 /* utility wrapping a simple endpoint selection policy */ 0930 0931 extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *, 0932 struct usb_endpoint_descriptor *); 0933 0934 0935 extern struct usb_ep *usb_ep_autoconfig_ss(struct usb_gadget *, 0936 struct usb_endpoint_descriptor *, 0937 struct usb_ss_ep_comp_descriptor *); 0938 0939 extern void usb_ep_autoconfig_release(struct usb_ep *); 0940 0941 extern void usb_ep_autoconfig_reset(struct usb_gadget *); 0942 0943 #endif /* __LINUX_USB_GADGET_H */
| [ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
|
This page was automatically generated by the 2.1.0 LXR engine. The LXR team |
|