Merge branch 'master' of git://git.denx.de/u-boot-arm
[kernel/u-boot.git] / include / usb.h
1 /*
2  * (C) Copyright 2001
3  * Denis Peter, MPL AG Switzerland
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  * Note: Part of this code has been derived from linux
7  *
8  */
9 #ifndef _USB_H_
10 #define _USB_H_
11
12 #include <usb_defs.h>
13 #include <linux/usb/ch9.h>
14
15 /*
16  * The EHCI spec says that we must align to at least 32 bytes.  However,
17  * some platforms require larger alignment.
18  */
19 #if ARCH_DMA_MINALIGN > 32
20 #define USB_DMA_MINALIGN        ARCH_DMA_MINALIGN
21 #else
22 #define USB_DMA_MINALIGN        32
23 #endif
24
25 /* Everything is aribtrary */
26 #define USB_ALTSETTINGALLOC             4
27 #define USB_MAXALTSETTING               128     /* Hard limit */
28
29 #define USB_MAX_DEVICE                  32
30 #define USB_MAXCONFIG                   8
31 #define USB_MAXINTERFACES               8
32 #define USB_MAXENDPOINTS                16
33 #define USB_MAXCHILDREN                 8       /* This is arbitrary */
34 #define USB_MAX_HUB                     16
35
36 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
37
38 /*
39  * This is the timeout to allow for submitting an urb in ms. We allow more
40  * time for a BULK device to react - some are slow.
41  */
42 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
43
44 /* device request (setup) */
45 struct devrequest {
46         unsigned char   requesttype;
47         unsigned char   request;
48         unsigned short  value;
49         unsigned short  index;
50         unsigned short  length;
51 } __attribute__ ((packed));
52
53 /* Interface */
54 struct usb_interface {
55         struct usb_interface_descriptor desc;
56
57         unsigned char   no_of_ep;
58         unsigned char   num_altsetting;
59         unsigned char   act_altsetting;
60
61         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
62         /*
63          * Super Speed Device will have Super Speed Endpoint
64          * Companion Descriptor  (section 9.6.7 of usb 3.0 spec)
65          * Revision 1.0 June 6th 2011
66          */
67         struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
68 } __attribute__ ((packed));
69
70 /* Configuration information.. */
71 struct usb_config {
72         struct usb_config_descriptor desc;
73
74         unsigned char   no_of_if;       /* number of interfaces */
75         struct usb_interface if_desc[USB_MAXINTERFACES];
76 } __attribute__ ((packed));
77
78 enum {
79         /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
80         PACKET_SIZE_8   = 0,
81         PACKET_SIZE_16  = 1,
82         PACKET_SIZE_32  = 2,
83         PACKET_SIZE_64  = 3,
84 };
85
86 struct usb_device {
87         int     devnum;                 /* Device number on USB bus */
88         int     speed;                  /* full/low/high */
89         char    mf[32];                 /* manufacturer */
90         char    prod[32];               /* product */
91         char    serial[32];             /* serial number */
92
93         /* Maximum packet size; one of: PACKET_SIZE_* */
94         int maxpacketsize;
95         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
96         unsigned int toggle[2];
97         /* endpoint halts; one bit per endpoint # & direction;
98          * [0] = IN, [1] = OUT
99          */
100         unsigned int halted[2];
101         int epmaxpacketin[16];          /* INput endpoint specific maximums */
102         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
103
104         int configno;                   /* selected config number */
105         /* Device Descriptor */
106         struct usb_device_descriptor descriptor
107                 __attribute__((aligned(ARCH_DMA_MINALIGN)));
108         struct usb_config config; /* config descriptor */
109
110         int have_langid;                /* whether string_langid is valid yet */
111         int string_langid;              /* language ID for strings */
112         int (*irq_handle)(struct usb_device *dev);
113         unsigned long irq_status;
114         int irq_act_len;                /* transfered bytes */
115         void *privptr;
116         /*
117          * Child devices -  if this is a hub device
118          * Each instance needs its own set of data structures.
119          */
120         unsigned long status;
121         int act_len;                    /* transfered bytes */
122         int maxchild;                   /* Number of ports if hub */
123         int portnr;
124         struct usb_device *parent;
125         struct usb_device *children[USB_MAXCHILDREN];
126
127         void *controller;               /* hardware controller private data */
128         /* slot_id - for xHCI enabled devices */
129         unsigned int slot_id;
130 };
131
132 /*
133  * You can initialize platform's USB host or device
134  * ports by passing this enum as an argument to
135  * board_usb_init().
136  */
137 enum usb_init_type {
138         USB_INIT_HOST,
139         USB_INIT_DEVICE
140 };
141
142 /**********************************************************************
143  * this is how the lowlevel part communicate with the outer world
144  */
145
146 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
147         defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
148         defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
149         defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
150         defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
151         defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
152         defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
153         defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_XHCI)
154
155 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
156 int usb_lowlevel_stop(int index);
157
158 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
159                         void *buffer, int transfer_len);
160 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
161                         int transfer_len, struct devrequest *setup);
162 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
163                         int transfer_len, int interval);
164
165 /* Defines */
166 #define USB_UHCI_VEND_ID        0x8086
167 #define USB_UHCI_DEV_ID         0x7112
168
169 /*
170  * PXA25x can only act as USB device. There are drivers
171  * which works with USB CDC gadgets implementations.
172  * Some of them have common routines which can be used
173  * in boards init functions e.g. udc_disconnect() used for
174  * forced device disconnection from host.
175  */
176 #elif defined(CONFIG_USB_GADGET_PXA2XX)
177
178 extern void udc_disconnect(void);
179
180 #endif
181
182 /*
183  * board-specific hardware initialization, called by
184  * usb drivers and u-boot commands
185  *
186  * @param index USB controller number
187  * @param init initializes controller as USB host or device
188  */
189 int board_usb_init(int index, enum usb_init_type init);
190
191 /*
192  * can be used to clean up after failed USB initialization attempt
193  * vide: board_usb_init()
194  *
195  * @param index USB controller number for selective cleanup
196  * @param init usb_init_type passed to board_usb_init()
197  */
198 int board_usb_cleanup(int index, enum usb_init_type init);
199
200 /*
201  * If CONFIG_USB_CABLE_CHECK is set then this function
202  * should be defined in board file.
203  *
204  * @return 1 if cable is connected and 0 otherwise.
205  */
206 #ifdef CONFIG_USB_CABLE_CHECK
207 int usb_cable_connected(void);
208 #endif
209
210 #ifdef CONFIG_USB_STORAGE
211
212 #define USB_MAX_STOR_DEV 5
213 block_dev_desc_t *usb_stor_get_dev(int index);
214 int usb_stor_scan(int mode);
215 int usb_stor_info(void);
216
217 #endif
218
219 #ifdef CONFIG_USB_HOST_ETHER
220
221 #define USB_MAX_ETH_DEV 5
222 int usb_host_eth_scan(int mode);
223
224 #endif
225
226 #ifdef CONFIG_USB_KEYBOARD
227
228 int drv_usb_kbd_init(void);
229 int usb_kbd_deregister(void);
230
231 #endif
232 /* routines */
233 int usb_init(void); /* initialize the USB Controller */
234 int usb_stop(void); /* stop the USB Controller */
235
236
237 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
238 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
239                         int report_id);
240 struct usb_device *usb_get_dev_index(int index);
241 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
242                         unsigned char request, unsigned char requesttype,
243                         unsigned short value, unsigned short index,
244                         void *data, unsigned short size, int timeout);
245 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
246                         void *data, int len, int *actual_length, int timeout);
247 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
248                         void *buffer, int transfer_len, int interval);
249 int usb_disable_asynch(int disable);
250 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
251 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
252                                 int cfgno);
253 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
254                         unsigned char id, void *buf, int size);
255 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
256                         unsigned char type, unsigned char id, void *buf,
257                         int size);
258 int usb_clear_halt(struct usb_device *dev, int pipe);
259 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
260 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
261
262 /* big endian -> little endian conversion */
263 /* some CPUs are already little endian e.g. the ARM920T */
264 #define __swap_16(x) \
265         ({ unsigned short x_ = (unsigned short)x; \
266          (unsigned short)( \
267                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
268         })
269 #define __swap_32(x) \
270         ({ unsigned long x_ = (unsigned long)x; \
271          (unsigned long)( \
272                 ((x_ & 0x000000FFUL) << 24) | \
273                 ((x_ & 0x0000FF00UL) <<  8) | \
274                 ((x_ & 0x00FF0000UL) >>  8) | \
275                 ((x_ & 0xFF000000UL) >> 24)); \
276         })
277
278 #ifdef __LITTLE_ENDIAN
279 # define swap_16(x) (x)
280 # define swap_32(x) (x)
281 #else
282 # define swap_16(x) __swap_16(x)
283 # define swap_32(x) __swap_32(x)
284 #endif
285
286 /*
287  * Calling this entity a "pipe" is glorifying it. A USB pipe
288  * is something embarrassingly simple: it basically consists
289  * of the following information:
290  *  - device number (7 bits)
291  *  - endpoint number (4 bits)
292  *  - current Data0/1 state (1 bit)
293  *  - direction (1 bit)
294  *  - speed (2 bits)
295  *  - max packet size (2 bits: 8, 16, 32 or 64)
296  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
297  *
298  * That's 18 bits. Really. Nothing more. And the USB people have
299  * documented these eighteen bits as some kind of glorious
300  * virtual data structure.
301  *
302  * Let's not fall in that trap. We'll just encode it as a simple
303  * unsigned int. The encoding is:
304  *
305  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64)
306  *  - direction:        bit 7           (0 = Host-to-Device [Out],
307  *                                      (1 = Device-to-Host [In])
308  *  - device:           bits 8-14
309  *  - endpoint:         bits 15-18
310  *  - Data0/1:          bit 19
311  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
312  *                                       10 = control, 11 = bulk)
313  *
314  * Why? Because it's arbitrary, and whatever encoding we select is really
315  * up to us. This one happens to share a lot of bit positions with the UHCI
316  * specification, so that much of the uhci driver can just mask the bits
317  * appropriately.
318  */
319 /* Create various pipes... */
320 #define create_pipe(dev,endpoint) \
321                 (((dev)->devnum << 8) | ((endpoint) << 15) | \
322                 (dev)->maxpacketsize)
323 #define default_pipe(dev) ((dev)->speed << 26)
324
325 #define usb_sndctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
326                                          create_pipe(dev, endpoint))
327 #define usb_rcvctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
328                                          create_pipe(dev, endpoint) | \
329                                          USB_DIR_IN)
330 #define usb_sndisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
331                                          create_pipe(dev, endpoint))
332 #define usb_rcvisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
333                                          create_pipe(dev, endpoint) | \
334                                          USB_DIR_IN)
335 #define usb_sndbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
336                                          create_pipe(dev, endpoint))
337 #define usb_rcvbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
338                                          create_pipe(dev, endpoint) | \
339                                          USB_DIR_IN)
340 #define usb_sndintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
341                                          create_pipe(dev, endpoint))
342 #define usb_rcvintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
343                                          create_pipe(dev, endpoint) | \
344                                          USB_DIR_IN)
345 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | \
346                                          default_pipe(dev))
347 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | \
348                                          default_pipe(dev) | \
349                                          USB_DIR_IN)
350
351 /* The D0/D1 toggle bits */
352 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
353 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
354 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
355                                                 ((dev)->toggle[out] & \
356                                                  ~(1 << ep)) | ((bit) << ep))
357
358 /* Endpoint halt control/status */
359 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
360 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
361 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
362 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
363
364 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
365                                  USB_PID_OUT)
366
367 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
368 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
369 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
370 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
371 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
372 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
373 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
374 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
375 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
376 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
377 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
378
379 #define usb_pipe_ep_index(pipe) \
380                 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
381                                 ((usb_pipeendpoint(pipe) * 2) - \
382                                  (usb_pipein(pipe) ? 0 : 1))
383
384 /*************************************************************************
385  * Hub Stuff
386  */
387 struct usb_port_status {
388         unsigned short wPortStatus;
389         unsigned short wPortChange;
390 } __attribute__ ((packed));
391
392 struct usb_hub_status {
393         unsigned short wHubStatus;
394         unsigned short wHubChange;
395 } __attribute__ ((packed));
396
397
398 /* Hub descriptor */
399 struct usb_hub_descriptor {
400         unsigned char  bLength;
401         unsigned char  bDescriptorType;
402         unsigned char  bNbrPorts;
403         unsigned short wHubCharacteristics;
404         unsigned char  bPwrOn2PwrGood;
405         unsigned char  bHubContrCurrent;
406         unsigned char  DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
407         unsigned char  PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
408         /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
409            bitmaps that hold max 255 entries. (bit0 is ignored) */
410 } __attribute__ ((packed));
411
412
413 struct usb_hub_device {
414         struct usb_device *pusb_dev;
415         struct usb_hub_descriptor desc;
416 };
417
418 int usb_hub_probe(struct usb_device *dev, int ifnum);
419 void usb_hub_reset(void);
420 int hub_port_reset(struct usb_device *dev, int port,
421                           unsigned short *portstat);
422
423 struct usb_device *usb_alloc_new_device(void *controller);
424
425 int usb_new_device(struct usb_device *dev);
426 void usb_free_device(void);
427 int usb_alloc_device(struct usb_device *dev);
428
429 #endif /*_USB_H_ */