Blame view
include/usb.h
29.9 KB
012771d88 Initial revision |
1 2 3 4 |
/* * (C) Copyright 2001 * Denis Peter, MPL AG Switzerland * |
de31213fb dm: usb: Add a uc... |
5 6 7 |
* Adapted for U-Boot driver model * (C) Copyright 2015 Google, Inc * |
1a4596601 Add GPL-2.0+ SPDX... |
8 |
* SPDX-License-Identifier: GPL-2.0+ |
012771d88 Initial revision |
9 10 11 12 13 |
* Note: Part of this code has been derived from linux * */ #ifndef _USB_H_ #define _USB_H_ |
de31213fb dm: usb: Add a uc... |
14 |
#include <fdtdec.h> |
012771d88 Initial revision |
15 |
#include <usb_defs.h> |
c60795f41 usb: use linux/us... |
16 |
#include <linux/usb/ch9.h> |
a8c2ebcf0 usb: include <asm... |
17 18 |
#include <asm/cache.h> #include <part.h> |
012771d88 Initial revision |
19 |
|
71c5de4f4 ehci-hcd.c, musb_... |
20 21 22 23 24 25 26 27 28 |
/* * The EHCI spec says that we must align to at least 32 bytes. However, * some platforms require larger alignment. */ #if ARCH_DMA_MINALIGN > 32 #define USB_DMA_MINALIGN ARCH_DMA_MINALIGN #else #define USB_DMA_MINALIGN 32 #endif |
012771d88 Initial revision |
29 |
/* Everything is aribtrary */ |
5cf91d6bd * Modify KUP4X bo... |
30 31 |
#define USB_ALTSETTINGALLOC 4 #define USB_MAXALTSETTING 128 /* Hard limit */ |
012771d88 Initial revision |
32 |
|
5cf91d6bd * Modify KUP4X bo... |
33 34 35 36 37 38 |
#define USB_MAX_DEVICE 32 #define USB_MAXCONFIG 8 #define USB_MAXINTERFACES 8 #define USB_MAXENDPOINTS 16 #define USB_MAXCHILDREN 8 /* This is arbitrary */ #define USB_MAX_HUB 16 |
012771d88 Initial revision |
39 40 |
#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */ |
96820a358 Fix EHCI usb subm... |
41 42 43 44 |
/* * This is the timeout to allow for submitting an urb in ms. We allow more * time for a BULK device to react - some are slow. */ |
80b350a7a usb: increase non... |
45 |
#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000) |
96820a358 Fix EHCI usb subm... |
46 |
|
012771d88 Initial revision |
47 48 |
/* device request (setup) */ struct devrequest { |
b12242ace usb: Convert prot... |
49 50 51 52 53 |
__u8 requesttype; __u8 request; __le16 value; __le16 index; __le16 length; |
012771d88 Initial revision |
54 |
} __attribute__ ((packed)); |
8f8bd565f USB Consolidate d... |
55 56 57 |
/* Interface */ struct usb_interface { struct usb_interface_descriptor desc; |
de39f8c19 USB style patch, ... |
58 |
|
b12242ace usb: Convert prot... |
59 60 61 |
__u8 no_of_ep; __u8 num_altsetting; __u8 act_altsetting; |
de39f8c19 USB style patch, ... |
62 |
|
012771d88 Initial revision |
63 |
struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS]; |
6497c6670 USB: SS: Add supp... |
64 65 66 67 68 69 |
/* * Super Speed Device will have Super Speed Endpoint * Companion Descriptor (section 9.6.7 of usb 3.0 spec) * Revision 1.0 June 6th 2011 */ struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS]; |
012771d88 Initial revision |
70 |
} __attribute__ ((packed)); |
8f8bd565f USB Consolidate d... |
71 72 |
/* Configuration information.. */ struct usb_config { |
c60795f41 usb: use linux/us... |
73 |
struct usb_config_descriptor desc; |
de39f8c19 USB style patch, ... |
74 |
|
b12242ace usb: Convert prot... |
75 |
__u8 no_of_if; /* number of interfaces */ |
8f8bd565f USB Consolidate d... |
76 |
struct usb_interface if_desc[USB_MAXINTERFACES]; |
012771d88 Initial revision |
77 |
} __attribute__ ((packed)); |
488672084 fix USB initialis... |
78 79 80 81 82 83 84 |
enum { /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */ PACKET_SIZE_8 = 0, PACKET_SIZE_16 = 1, PACKET_SIZE_32 = 2, PACKET_SIZE_64 = 3, }; |
012771d88 Initial revision |
85 |
|
de31213fb dm: usb: Add a uc... |
86 87 88 89 90 91 92 93 94 95 96 97 98 |
/** * struct usb_device - information about a USB device * * With driver model both UCLASS_USB (the USB controllers) and UCLASS_USB_HUB * (the hubs) have this as parent data. Hubs are children of controllers or * other hubs and there is always a single root hub for each controller. * Therefore struct usb_device can always be accessed with * dev_get_parentdata(dev), where dev is a USB device. * * Pointers exist for obtaining both the device (could be any uclass) and * controller (UCLASS_USB) from this structure. The controller does not have * a struct usb_device since it is not a device. */ |
012771d88 Initial revision |
99 |
struct usb_device { |
de39f8c19 USB style patch, ... |
100 |
int devnum; /* Device number on USB bus */ |
3e126484d Prepare USB layer... |
101 |
int speed; /* full/low/high */ |
de39f8c19 USB style patch, ... |
102 103 104 |
char mf[32]; /* manufacturer */ char prod[32]; /* product */ char serial[32]; /* serial number */ |
012771d88 Initial revision |
105 |
|
488672084 fix USB initialis... |
106 107 108 109 |
/* Maximum packet size; one of: PACKET_SIZE_* */ int maxpacketsize; /* one bit for each endpoint ([0] = IN, [1] = OUT) */ unsigned int toggle[2]; |
de39f8c19 USB style patch, ... |
110 111 112 |
/* endpoint halts; one bit per endpoint # & direction; * [0] = IN, [1] = OUT */ |
488672084 fix USB initialis... |
113 |
unsigned int halted[2]; |
012771d88 Initial revision |
114 115 116 117 |
int epmaxpacketin[16]; /* INput endpoint specific maximums */ int epmaxpacketout[16]; /* OUTput endpoint specific maximums */ int configno; /* selected config number */ |
f57661394 USB: Align buffer... |
118 119 120 |
/* Device Descriptor */ struct usb_device_descriptor descriptor __attribute__((aligned(ARCH_DMA_MINALIGN))); |
8f8bd565f USB Consolidate d... |
121 |
struct usb_config config; /* config descriptor */ |
012771d88 Initial revision |
122 123 124 125 126 |
int have_langid; /* whether string_langid is valid yet */ int string_langid; /* language ID for strings */ int (*irq_handle)(struct usb_device *dev); unsigned long irq_status; |
5cf91d6bd * Modify KUP4X bo... |
127 |
int irq_act_len; /* transfered bytes */ |
012771d88 Initial revision |
128 129 130 131 132 133 |
void *privptr; /* * Child devices - if this is a hub device * Each instance needs its own set of data structures. */ unsigned long status; |
904f2a83a musb-new: Add int... |
134 |
unsigned long int_pending; /* 1 bit per ep, used by int_queue */ |
012771d88 Initial revision |
135 136 |
int act_len; /* transfered bytes */ int maxchild; /* Number of ports if hub */ |
de31213fb dm: usb: Add a uc... |
137 138 139 |
int portnr; /* Port number, 1=first */ #ifndef CONFIG_DM_USB /* parent hub, or NULL if this is the root hub */ |
012771d88 Initial revision |
140 141 |
struct usb_device *parent; struct usb_device *children[USB_MAXCHILDREN]; |
c7e3b2b58 usb: lowlevel int... |
142 |
void *controller; /* hardware controller private data */ |
de31213fb dm: usb: Add a uc... |
143 |
#endif |
5853e1335 USB: xHCI: Add st... |
144 145 |
/* slot_id - for xHCI enabled devices */ unsigned int slot_id; |
de31213fb dm: usb: Add a uc... |
146 147 148 149 |
#ifdef CONFIG_DM_USB struct udevice *dev; /* Pointer to associated device */ struct udevice *controller_dev; /* Pointer to associated controller */ #endif |
012771d88 Initial revision |
150 |
}; |
8460b89a6 usb: Make pollabl... |
151 |
struct int_queue; |
bba679144 usb: rename board... |
152 153 154 155 156 157 158 159 160 |
/* * You can initialize platform's USB host or device * ports by passing this enum as an argument to * board_usb_init(). */ enum usb_init_type { USB_INIT_HOST, USB_INIT_DEVICE }; |
012771d88 Initial revision |
161 162 163 |
/********************************************************************** * this is how the lowlevel part communicate with the outer world */ |
822af351a Support for the P... |
164 |
#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \ |
51ab142b8 [PATCH] This patc... |
165 |
defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \ |
3e126484d Prepare USB layer... |
166 |
defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \ |
f298e4b6d OMAP3 Add usb dev... |
167 |
defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \ |
e608f221c usb: musb: add su... |
168 |
defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \ |
37931f02c musb-new: dsps ba... |
169 |
defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \ |
673a524b6 musb-new: omap2pl... |
170 |
defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \ |
28a15ef7f musb-new: Add sun... |
171 |
defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_MUSB_SUNXI) || \ |
019808f97 dm: usb: sandbox:... |
172 173 |
defined(CONFIG_USB_XHCI) || defined(CONFIG_USB_DWC2) || \ defined(CONFIG_USB_EMUL) |
822af351a Support for the P... |
174 |
|
06d513ecb usb: add enum usb... |
175 |
int usb_lowlevel_init(int index, enum usb_init_type init, void **controller); |
c7e3b2b58 usb: lowlevel int... |
176 |
int usb_lowlevel_stop(int index); |
de31213fb dm: usb: Add a uc... |
177 178 179 |
#if defined(CONFIG_MUSB_HOST) || defined(CONFIG_DM_USB) int usb_reset_root_port(void); |
90cdc1039 musb-new: Fix res... |
180 181 182 |
#else #define usb_reset_root_port() #endif |
c7e3b2b58 usb: lowlevel int... |
183 |
|
de39f8c19 USB style patch, ... |
184 185 |
int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer, int transfer_len); |
012771d88 Initial revision |
186 |
int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, |
de39f8c19 USB style patch, ... |
187 |
int transfer_len, struct devrequest *setup); |
012771d88 Initial revision |
188 189 |
int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, int transfer_len, int interval); |
904f2a83a musb-new: Add int... |
190 |
#if defined CONFIG_USB_EHCI || defined CONFIG_MUSB_HOST |
8460b89a6 usb: Make pollabl... |
191 |
struct int_queue *create_int_queue(struct usb_device *dev, unsigned long pipe, |
8bb6c1d1e usb: Add an inter... |
192 |
int queuesize, int elementsize, void *buffer, int interval); |
8460b89a6 usb: Make pollabl... |
193 194 195 |
int destroy_int_queue(struct usb_device *dev, struct int_queue *queue); void *poll_int_queue(struct usb_device *dev, struct int_queue *queue); #endif |
012771d88 Initial revision |
196 |
/* Defines */ |
de39f8c19 USB style patch, ... |
197 198 |
#define USB_UHCI_VEND_ID 0x8086 #define USB_UHCI_DEV_ID 0x7112 |
012771d88 Initial revision |
199 |
|
e5f24753c usb.h: Add udc_di... |
200 201 202 203 204 205 206 207 208 209 |
/* * PXA25x can only act as USB device. There are drivers * which works with USB CDC gadgets implementations. * Some of them have common routines which can be used * in boards init functions e.g. udc_disconnect() used for * forced device disconnection from host. */ #elif defined(CONFIG_USB_GADGET_PXA2XX) extern void udc_disconnect(void); |
012771d88 Initial revision |
210 |
#endif |
16297cfb2 usb: new board-sp... |
211 |
/* |
16297cfb2 usb: new board-sp... |
212 213 214 215 216 217 |
* board-specific hardware initialization, called by * usb drivers and u-boot commands * * @param index USB controller number * @param init initializes controller as USB host or device */ |
bba679144 usb: rename board... |
218 |
int board_usb_init(int index, enum usb_init_type init); |
16297cfb2 usb: new board-sp... |
219 220 221 222 223 224 |
/* * can be used to clean up after failed USB initialization attempt * vide: board_usb_init() * * @param index USB controller number for selective cleanup |
bba679144 usb: rename board... |
225 |
* @param init usb_init_type passed to board_usb_init() |
16297cfb2 usb: new board-sp... |
226 |
*/ |
bba679144 usb: rename board... |
227 |
int board_usb_cleanup(int index, enum usb_init_type init); |
16297cfb2 usb: new board-sp... |
228 |
|
012771d88 Initial revision |
229 230 231 232 233 |
#ifdef CONFIG_USB_STORAGE #define USB_MAX_STOR_DEV 5 block_dev_desc_t *usb_stor_get_dev(int index); int usb_stor_scan(int mode); |
e813eae3b Fix compilation e... |
234 |
int usb_stor_info(void); |
012771d88 Initial revision |
235 236 |
#endif |
89d48367e Add USB host ethe... |
237 238 239 240 241 242 |
#ifdef CONFIG_USB_HOST_ETHER #define USB_MAX_ETH_DEV 5 int usb_host_eth_scan(int mode); #endif |
012771d88 Initial revision |
243 244 245 |
#ifdef CONFIG_USB_KEYBOARD int drv_usb_kbd_init(void); |
8a8a2257e usb: kbd: Allow "... |
246 |
int usb_kbd_deregister(int force); |
012771d88 Initial revision |
247 248 249 250 251 252 253 254 |
#endif /* routines */ int usb_init(void); /* initialize the USB Controller */ int usb_stop(void); /* stop the USB Controller */ int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); |
de39f8c19 USB style patch, ... |
255 256 |
int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id); |
012771d88 Initial revision |
257 258 259 260 261 262 263 |
int usb_control_msg(struct usb_device *dev, unsigned int pipe, unsigned char request, unsigned char requesttype, unsigned short value, unsigned short index, void *data, unsigned short size, int timeout); int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout); int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, |
de39f8c19 USB style patch, ... |
264 |
void *buffer, int transfer_len, int interval); |
89d48367e Add USB host ethe... |
265 |
int usb_disable_asynch(int disable); |
de39f8c19 USB style patch, ... |
266 |
int usb_maxpacket(struct usb_device *dev, unsigned long pipe); |
de39f8c19 USB style patch, ... |
267 268 269 270 |
int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer, int cfgno); int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size); |
012771d88 Initial revision |
271 |
int usb_get_class_descriptor(struct usb_device *dev, int ifnum, |
de39f8c19 USB style patch, ... |
272 273 |
unsigned char type, unsigned char id, void *buf, int size); |
012771d88 Initial revision |
274 275 276 277 278 |
int usb_clear_halt(struct usb_device *dev, int pipe); int usb_string(struct usb_device *dev, int index, char *buf, size_t size); int usb_set_interface(struct usb_device *dev, int interface, int alternate); /* big endian -> little endian conversion */ |
149dded2b * Add support for... |
279 |
/* some CPUs are already little endian e.g. the ARM920T */ |
ae3b770e4 Fix some endianne... |
280 |
#define __swap_16(x) \ |
3f85ce278 * CVS add missing... |
281 282 |
({ unsigned short x_ = (unsigned short)x; \ (unsigned short)( \ |
de39f8c19 USB style patch, ... |
283 |
((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \ |
3f85ce278 * CVS add missing... |
284 |
}) |
ae3b770e4 Fix some endianne... |
285 |
#define __swap_32(x) \ |
3f85ce278 * CVS add missing... |
286 287 288 |
({ unsigned long x_ = (unsigned long)x; \ (unsigned long)( \ ((x_ & 0x000000FFUL) << 24) | \ |
5cf91d6bd * Modify KUP4X bo... |
289 290 |
((x_ & 0x0000FF00UL) << 8) | \ ((x_ & 0x00FF0000UL) >> 8) | \ |
de39f8c19 USB style patch, ... |
291 |
((x_ & 0xFF000000UL) >> 24)); \ |
3f85ce278 * CVS add missing... |
292 |
}) |
ae3b770e4 Fix some endianne... |
293 |
|
c7d703f3f usb.h: use standa... |
294 |
#ifdef __LITTLE_ENDIAN |
ae3b770e4 Fix some endianne... |
295 296 297 298 299 |
# define swap_16(x) (x) # define swap_32(x) (x) #else # define swap_16(x) __swap_16(x) # define swap_32(x) __swap_32(x) |
c7d703f3f usb.h: use standa... |
300 |
#endif |
012771d88 Initial revision |
301 302 303 304 305 306 307 308 309 |
/* * Calling this entity a "pipe" is glorifying it. A USB pipe * is something embarrassingly simple: it basically consists * of the following information: * - device number (7 bits) * - endpoint number (4 bits) * - current Data0/1 state (1 bit) * - direction (1 bit) |
3e126484d Prepare USB layer... |
310 |
* - speed (2 bits) |
012771d88 Initial revision |
311 312 313 314 315 316 317 318 319 320 321 |
* - max packet size (2 bits: 8, 16, 32 or 64) * - pipe type (2 bits: control, interrupt, bulk, isochronous) * * That's 18 bits. Really. Nothing more. And the USB people have * documented these eighteen bits as some kind of glorious * virtual data structure. * * Let's not fall in that trap. We'll just encode it as a simple * unsigned int. The encoding is: * * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) |
de39f8c19 USB style patch, ... |
322 323 |
* - direction: bit 7 (0 = Host-to-Device [Out], * (1 = Device-to-Host [In]) |
012771d88 Initial revision |
324 325 326 |
* - device: bits 8-14 * - endpoint: bits 15-18 * - Data0/1: bit 19 |
de39f8c19 USB style patch, ... |
327 328 |
* - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, * 10 = control, 11 = bulk) |
012771d88 Initial revision |
329 330 331 332 333 334 335 336 |
* * Why? Because it's arbitrary, and whatever encoding we select is really * up to us. This one happens to share a lot of bit positions with the UHCI * specification, so that much of the uhci driver can just mask the bits * appropriately. */ /* Create various pipes... */ #define create_pipe(dev,endpoint) \ |
d0fe1128c USB: fix create_p... |
337 |
(((dev)->devnum << 8) | ((endpoint) << 15) | \ |
c60795f41 usb: use linux/us... |
338 |
(dev)->maxpacketsize) |
3e126484d Prepare USB layer... |
339 |
#define default_pipe(dev) ((dev)->speed << 26) |
de39f8c19 USB style patch, ... |
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ create_pipe(dev, endpoint)) #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ create_pipe(dev, endpoint) | \ USB_DIR_IN) #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ create_pipe(dev, endpoint)) #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ create_pipe(dev, endpoint) | \ USB_DIR_IN) #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ create_pipe(dev, endpoint)) #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ create_pipe(dev, endpoint) | \ USB_DIR_IN) #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ create_pipe(dev, endpoint)) #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ create_pipe(dev, endpoint) | \ USB_DIR_IN) #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \ default_pipe(dev)) #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \ default_pipe(dev) | \ USB_DIR_IN) |
012771d88 Initial revision |
366 367 368 |
/* The D0/D1 toggle bits */ #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) |
5cf91d6bd * Modify KUP4X bo... |
369 |
#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) |
de39f8c19 USB style patch, ... |
370 371 372 |
#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \ ((dev)->toggle[out] & \ ~(1 << ep)) | ((bit) << ep)) |
012771d88 Initial revision |
373 374 375 376 377 378 |
/* Endpoint halt control/status */ #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) |
de39f8c19 USB style patch, ... |
379 380 |
#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \ USB_PID_OUT) |
012771d88 Initial revision |
381 382 383 384 385 386 387 |
#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) #define usb_pipein(pipe) (((pipe) >> 7) & 1) #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) |
012771d88 Initial revision |
388 389 390 391 392 |
#define usb_pipetype(pipe) (((pipe) >> 30) & 3) #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) |
5853e1335 USB: xHCI: Add st... |
393 394 395 396 |
#define usb_pipe_ep_index(pipe) \ usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \ ((usb_pipeendpoint(pipe) * 2) - \ (usb_pipein(pipe) ? 0 : 1)) |
012771d88 Initial revision |
397 |
|
0566e2403 dm: usb: Allow US... |
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
/** * struct usb_device_id - identifies USB devices for probing and hotplugging * @match_flags: Bit mask controlling which of the other fields are used to * match against new devices. Any field except for driver_info may be * used, although some only make sense in conjunction with other fields. * This is usually set by a USB_DEVICE_*() macro, which sets all * other fields in this structure except for driver_info. * @idVendor: USB vendor ID for a device; numbers are assigned * by the USB forum to its members. * @idProduct: Vendor-assigned product ID. * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers. * This is also used to identify individual product versions, for * a range consisting of a single device. * @bcdDevice_hi: High end of version number range. The range of product * versions is inclusive. * @bDeviceClass: Class of device; numbers are assigned * by the USB forum. Products may choose to implement classes, * or be vendor-specific. Device classes specify behavior of all * the interfaces on a device. * @bDeviceSubClass: Subclass of device; associated with bDeviceClass. * @bDeviceProtocol: Protocol of device; associated with bDeviceClass. * @bInterfaceClass: Class of interface; numbers are assigned * by the USB forum. Products may choose to implement classes, * or be vendor-specific. Interface classes specify behavior only * of a given interface; other interfaces may support other classes. * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass. * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass. * @bInterfaceNumber: Number of interface; composite devices may use * fixed interface numbers to differentiate between vendor-specific * interfaces. * @driver_info: Holds information used by the driver. Usually it holds * a pointer to a descriptor understood by the driver, or perhaps * device flags. * * In most cases, drivers will create a table of device IDs by using * 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. * * See the usb_match_id() function for information about how matches are * performed. Briefly, you will normally use one of several macros to help * construct these entries. Each entry you provide will either identify * one or more specific products, or will identify a class of products * which have agreed to behave the same. You should put the more specific * matches towards the beginning of your table, so that driver_info can * record quirks of specific products. */ struct usb_device_id { /* which fields to match against? */ u16 match_flags; /* Used for product specific matches; range is inclusive */ u16 idVendor; u16 idProduct; u16 bcdDevice_lo; u16 bcdDevice_hi; /* Used for device class matches */ u8 bDeviceClass; u8 bDeviceSubClass; u8 bDeviceProtocol; /* Used for interface class matches */ u8 bInterfaceClass; u8 bInterfaceSubClass; u8 bInterfaceProtocol; /* Used for vendor-specific interface matches */ u8 bInterfaceNumber; /* not matched against */ ulong driver_info; }; /* Some useful macros to use to create struct usb_device_id */ #define USB_DEVICE_ID_MATCH_VENDOR 0x0001 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200 #define USB_DEVICE_ID_MATCH_INT_NUMBER 0x0400 /* Match anything, indicates this is a valid entry even if everything is 0 */ #define USB_DEVICE_ID_MATCH_NONE 0x0800 #define USB_DEVICE_ID_MATCH_ALL 0x07ff /** * struct usb_driver_entry - Matches a driver to its usb_device_ids * @compatible: Compatible string * @data: Data for this compatible string */ struct usb_driver_entry { struct driver *driver; const struct usb_device_id *match; }; #define USB_DEVICE(__name, __match) \ ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\ .driver = llsym(struct driver, __name, driver), \ .match = __match, \ } |
012771d88 Initial revision |
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
/************************************************************************* * Hub Stuff */ struct usb_port_status { unsigned short wPortStatus; unsigned short wPortChange; } __attribute__ ((packed)); struct usb_hub_status { unsigned short wHubStatus; unsigned short wHubChange; } __attribute__ ((packed)); /* Hub descriptor */ struct usb_hub_descriptor { unsigned char bLength; unsigned char bDescriptorType; unsigned char bNbrPorts; unsigned short wHubCharacteristics; unsigned char bPwrOn2PwrGood; unsigned char bHubContrCurrent; unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; |
de39f8c19 USB style patch, ... |
528 |
/* DeviceRemovable and PortPwrCtrlMask want to be variable-length |
012771d88 Initial revision |
529 530 531 532 533 534 535 536 |
bitmaps that hold max 255 entries. (bit0 is ignored) */ } __attribute__ ((packed)); struct usb_hub_device { struct usb_device *pusb_dev; struct usb_hub_descriptor desc; }; |
de31213fb dm: usb: Add a uc... |
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 |
#ifdef CONFIG_DM_USB /** * struct usb_platdata - Platform data about a USB controller * * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev) */ struct usb_platdata { enum usb_init_type init_type; }; /** * struct usb_dev_platdata - Platform data about a USB device * * Given a USB device dev this structure is dev_get_parent_platdata(dev). * This is used by sandbox to provide emulation data also. * * @id: ID used to match this device * @speed: Stores the speed associated with a USB device * @devnum: Device address on the USB bus * @slot_id: USB3 slot ID, which is separate from the device address * @portnr: Port number of this device on its parent hub, numbered from 1 * (0 mean this device is the root hub) * @strings: List of descriptor strings (for sandbox emulation purposes) * @desc_list: List of descriptors (for sandbox emulation purposes) */ struct usb_dev_platdata { struct usb_device_id id; enum usb_device_speed speed; int devnum; int slot_id; int portnr; /* Hub port number, 1..n */ #ifdef CONFIG_SANDBOX struct usb_string *strings; /* NULL-terminated list of descriptor pointers */ struct usb_generic_descriptor **desc_list; #endif int configno; }; /** * struct usb_bus_priv - information about the USB controller * * Given a USB controller (UCLASS_USB) 'dev', this is * dev_get_uclass_priv(dev). * * @next_addr: Next device address to allocate minus 1. Incremented by 1 * each time a new device address is set, so this holds the * number of devices on the bus * @desc_before_addr: true if we can read a device descriptor before it * has been assigned an address. For XHCI this is not possible * so this will be false. */ struct usb_bus_priv { int next_addr; bool desc_before_addr; }; /** * struct dm_usb_ops - USB controller operations * * This defines the operations supoorted on a USB controller. Common * arguments are: * * @bus: USB bus (i.e. controller), which is in UCLASS_USB. * @udev: USB device parent data. Controllers are not expected to need * this, since the device address on the bus is encoded in @pipe. * It is used for sandbox, and can be handy for debugging and * logging. * @pipe: An assortment of bitfields which provide address and packet * type information. See create_pipe() above for encoding * details * @buffer: A buffer to use for sending/receiving. This should be * DMA-aligned. * @length: Buffer length in bytes */ struct dm_usb_ops { /** * control() - Send a control message * * Most parameters are as above. * * @setup: Additional setup information required by the message */ int (*control)(struct udevice *bus, struct usb_device *udev, unsigned long pipe, void *buffer, int length, struct devrequest *setup); /** * bulk() - Send a bulk message * * Parameters are as above. */ int (*bulk)(struct udevice *bus, struct usb_device *udev, unsigned long pipe, void *buffer, int length); /** * interrupt() - Send an interrupt message * * Most parameters are as above. * * @interval: Interrupt interval */ int (*interrupt)(struct udevice *bus, struct usb_device *udev, unsigned long pipe, void *buffer, int length, int interval); /** * alloc_device() - Allocate a new device context (XHCI) * * Before sending packets to a new device on an XHCI bus, a device * context must be created. If this method is not NULL it will be * called before the device is enumerated (even before its descriptor * is read). This should be NULL for EHCI, which does not need this. */ int (*alloc_device)(struct udevice *bus, struct usb_device *udev); }; #define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) #define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) #ifdef CONFIG_MUSB_HOST int usb_reset_root_port(void); #endif /** * usb_get_dev_index() - look up a device index number * * Look up devices using their index number (starting at 0). This works since * in U-Boot device addresses are allocated starting at 1 with no gaps. * * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified * to work better with driver model. * * @bus: USB bus to check * @index: Index number of device to find (0=first). This is just the * device address less 1. */ struct usb_device *usb_get_dev_index(struct udevice *bus, int index); /** * usb_legacy_port_reset() - Legacy function to reset a hub port * * @hub: Hub device * @portnr: Port number (1=first) */ int usb_legacy_port_reset(struct usb_device *hub, int portnr); /** * usb_setup_device() - set up a device ready for use * * @dev: USB device pointer. This need not be a real device - it is * common for it to just be a local variable with its ->dev * member (i.e. @dev->dev) set to the parent device * @do_read: true to read the device descriptor before an address is set * (should be false for XHCI buses, true otherwise) * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB) * @portnr: Port number on hub (1=first) or 0 for none * @return 0 if OK, -ve on error */ int usb_setup_device(struct usb_device *dev, bool do_read, struct usb_device *parent, int portnr); /** * usb_hub_scan() - Scan a hub and find its devices * * @hub: Hub device to scan */ int usb_hub_scan(struct udevice *hub); /** * usb_scan_device() - Scan a device on a bus * * Scan a device on a bus. It has already been detected and is ready to * be enumerated. This may be either the root hub (@parent is a bus) or a * normal device (@parent is a hub) * * @parent: Parent device * @port: Hub port number (numbered from 1) * @speed: USB speed to use for this device * @devp: Returns pointer to device if all is well * @return 0 if OK, -ve on error */ int usb_scan_device(struct udevice *parent, int port, enum usb_device_speed speed, struct udevice **devp); /** * usb_get_bus() - Find the bus for a device * * Search up through parents to find the bus this device is connected to. This * will be a device with uclass UCLASS_USB. * * @dev: Device to check * @busp: Returns bus, or NULL if not found * @return 0 if OK, -EXDEV is somehow this bus does not have a controller (this * indicates a critical error in the USB stack */ int usb_get_bus(struct udevice *dev, struct udevice **busp); /** * usb_select_config() - Set up a device ready for use * * This function assumes that the device already has an address and a driver * bound, and is ready to be set up. * * This re-reads the device and configuration descriptors and sets the * configuration * * @dev: Device to set up */ int usb_select_config(struct usb_device *dev); /** * usb_child_pre_probe() - Pre-probe function for USB devices * * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the * device from the saved platform data and calls usb_select_config() to * finish set up. * * Once this is done, the device's normal driver can take over, knowing the * device is accessible on the USB bus. * * This function is for use only by the internal USB stack. * * @dev: Device to set up */ int usb_child_pre_probe(struct udevice *dev); struct ehci_ctrl; /** * usb_setup_ehci_gadget() - Set up a USB device as a gadget * * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model * * This provides a way to tell a controller to start up as a USB device * instead of as a host. It is untested. */ int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp); /** * usb_stor_reset() - Prepare to scan USB storage devices * * Empty the list of USB storage devices in preparation for scanning them. * This must be called before a USB scan. */ void usb_stor_reset(void); #else /* !CONFIG_DM_USB */ struct usb_device *usb_get_dev_index(int index); #endif bool usb_device_has_child_on_port(struct usb_device *parent, int port); |
23faf2bc9 USB: Separate out... |
788 789 |
int usb_hub_probe(struct usb_device *dev, int ifnum); void usb_hub_reset(void); |
862e75c0d dm: usb: Refactor... |
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 |
/** * legacy_hub_port_reset() - reset a port given its usb_device pointer * * Reset a hub port and see if a device is present on that port, providing * sufficient time for it to show itself. The port status is returned. * * With driver model this moves to hub_port_reset() and is passed a struct * udevice. * * @dev: USB device to reset * @port: Port number to reset (note ports are numbered from 0 here) * @portstat: Returns port status */ int legacy_hub_port_reset(struct usb_device *dev, int port, |
23faf2bc9 USB: Separate out... |
805 |
unsigned short *portstat); |
862e75c0d dm: usb: Refactor... |
806 |
int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat); |
79b588872 dm: usb: Adjust u... |
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 |
/** * usb_alloc_new_device() - Allocate a new device * * @devp: returns a pointer of a new device structure. With driver model this * is a device pointer, but with legacy USB this pointer is * driver-specific. * @return 0 if OK, -ENOSPC if we have found out of room for new devices */ int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp); /** * usb_free_device() - Free a partially-inited device * * This is an internal function. It is used to reverse the action of * usb_alloc_new_device() when we hit a problem during init. */ void usb_free_device(struct udevice *controller); |
c7e3b2b58 usb: lowlevel int... |
824 |
|
23faf2bc9 USB: Separate out... |
825 |
int usb_new_device(struct usb_device *dev); |
79b588872 dm: usb: Adjust u... |
826 |
|
5853e1335 USB: xHCI: Add st... |
827 |
int usb_alloc_device(struct usb_device *dev); |
23faf2bc9 USB: Separate out... |
828 |
|
019808f97 dm: usb: sandbox:... |
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 |
/** * usb_emul_setup_device() - Set up a new USB device emulation * * This is normally called when a new emulation device is bound. It tells * the USB emulation uclass about the features of the emulator. * * @dev: Emulation device * @maxpacketsize: Maximum packet size (e.g. PACKET_SIZE_64) * @strings: List of USB string descriptors, terminated by a NULL * entry * @desc_list: List of points or USB descriptors, terminated by NULL. * The first entry must be struct usb_device_descriptor, * and others follow on after that. * @return 0 if OK, -ve on error */ int usb_emul_setup_device(struct udevice *dev, int maxpacketsize, struct usb_string *strings, void **desc_list); /** * usb_emul_control() - Send a control packet to an emulator * * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters * @return 0 if OK, -ve on error */ int usb_emul_control(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length, struct devrequest *setup); /** * usb_emul_bulk() - Send a bulk packet to an emulator * * @emul: Emulator device * @udev: USB device (which the emulator is causing to appear) * See struct dm_usb_ops for details on other parameters * @return 0 if OK, -ve on error */ int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, unsigned long pipe, void *buffer, int length); /** * usb_emul_find() - Find an emulator for a particular device * * Check @pipe to find a device number on bus @bus and return it. * * @bus: USB bus (controller) * @pipe: Describes pipe being used, and includes the device number * @emulp: Returns pointer to emulator, or NULL if not found * @return 0 if found, -ve on error */ int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp); /** * usb_emul_reset() - Reset all emulators ready for use * * Clear out any address information in the emulators and make then ready for * a new USB scan */ void usb_emul_reset(struct udevice *dev); |
012771d88 Initial revision |
889 |
#endif /*_USB_H_ */ |