]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (c) 2001-2002 by David Brownell | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify it | |
5 | * under the terms of the GNU General Public License as published by the | |
6 | * Free Software Foundation; either version 2 of the License, or (at your | |
7 | * option) any later version. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, but | |
10 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY | |
11 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
12 | * for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software Foundation, | |
16 | * Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
17 | */ | |
18 | ||
aa459e6a AV |
19 | #ifndef __USB_CORE_HCD_H |
20 | #define __USB_CORE_HCD_H | |
1da177e4 LT |
21 | |
22 | #ifdef __KERNEL__ | |
23 | ||
32fe0198 AS |
24 | #include <linux/rwsem.h> |
25 | ||
38f3ad5e FB |
26 | #define MAX_TOPO_LEVEL 6 |
27 | ||
1da177e4 LT |
28 | /* This file contains declarations of usbcore internals that are mostly |
29 | * used or exposed by Host Controller Drivers. | |
30 | */ | |
31 | ||
32 | /* | |
33 | * USB Packet IDs (PIDs) | |
34 | */ | |
dbe0dbb7 | 35 | #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */ |
1da177e4 LT |
36 | #define USB_PID_OUT 0xe1 |
37 | #define USB_PID_ACK 0xd2 | |
38 | #define USB_PID_DATA0 0xc3 | |
39 | #define USB_PID_PING 0xb4 /* USB 2.0 */ | |
40 | #define USB_PID_SOF 0xa5 | |
41 | #define USB_PID_NYET 0x96 /* USB 2.0 */ | |
42 | #define USB_PID_DATA2 0x87 /* USB 2.0 */ | |
43 | #define USB_PID_SPLIT 0x78 /* USB 2.0 */ | |
44 | #define USB_PID_IN 0x69 | |
45 | #define USB_PID_NAK 0x5a | |
46 | #define USB_PID_DATA1 0x4b | |
47 | #define USB_PID_PREAMBLE 0x3c /* Token mode */ | |
48 | #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */ | |
49 | #define USB_PID_SETUP 0x2d | |
50 | #define USB_PID_STALL 0x1e | |
51 | #define USB_PID_MDATA 0x0f /* USB 2.0 */ | |
52 | ||
53 | /*-------------------------------------------------------------------------*/ | |
54 | ||
55 | /* | |
56 | * USB Host Controller Driver (usb_hcd) framework | |
57 | * | |
58 | * Since "struct usb_bus" is so thin, you can't share much code in it. | |
59 | * This framework is a layer over that, and should be more sharable. | |
5234ce1b IPG |
60 | * |
61 | * @authorized_default: Specifies if new devices are authorized to | |
62 | * connect by default or they require explicit | |
63 | * user space authorization; this bit is settable | |
64 | * through /sys/class/usb_host/X/authorized_default. | |
65 | * For the rest is RO, so we don't lock to r/w it. | |
1da177e4 LT |
66 | */ |
67 | ||
68 | /*-------------------------------------------------------------------------*/ | |
69 | ||
17200583 | 70 | struct usb_hcd { |
1da177e4 LT |
71 | |
72 | /* | |
73 | * housekeeping | |
74 | */ | |
75 | struct usb_bus self; /* hcd is-a bus */ | |
17200583 | 76 | struct kref kref; /* reference counter */ |
1da177e4 LT |
77 | |
78 | const char *product_desc; /* product/vendor string */ | |
79 | char irq_descr[24]; /* driver + bus # */ | |
80 | ||
d5926ae7 AS |
81 | struct timer_list rh_timer; /* drives root-hub polling */ |
82 | struct urb *status_urb; /* the current status urb */ | |
9bbdf1e0 | 83 | #ifdef CONFIG_USB_SUSPEND |
6b157c9b AS |
84 | struct work_struct wakeup_work; /* for remote wakeup */ |
85 | #endif | |
1da177e4 LT |
86 | |
87 | /* | |
88 | * hardware info/state | |
89 | */ | |
90 | const struct hc_driver *driver; /* hw-specific hooks */ | |
8de98402 | 91 | |
541c7d43 AS |
92 | /* Flags that need to be manipulated atomically because they can |
93 | * change while the host controller is running. Always use | |
94 | * set_bit() or clear_bit() to change their values. | |
95 | */ | |
8de98402 | 96 | unsigned long flags; |
541c7d43 AS |
97 | #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */ |
98 | #define HCD_FLAG_SAW_IRQ 1 | |
99 | #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */ | |
100 | #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */ | |
ff2f0787 | 101 | #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */ |
541c7d43 AS |
102 | |
103 | /* The flags can be tested using these macros; they are likely to | |
104 | * be slightly faster than test_bit(). | |
105 | */ | |
106 | #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE)) | |
107 | #define HCD_SAW_IRQ(hcd) ((hcd)->flags & (1U << HCD_FLAG_SAW_IRQ)) | |
108 | #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH)) | |
109 | #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING)) | |
ff2f0787 | 110 | #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING)) |
8de98402 | 111 | |
541c7d43 | 112 | /* Flags that get set only during HCD registration or removal. */ |
1da177e4 | 113 | unsigned rh_registered:1;/* is root hub registered? */ |
6d88e679 | 114 | unsigned rh_pollable:1; /* may we poll the root hub? */ |
1da177e4 | 115 | |
d5926ae7 AS |
116 | /* The next flag is a stopgap, to be removed when all the HCDs |
117 | * support the new root-hub polling mechanism. */ | |
118 | unsigned uses_new_polling:1; | |
0165de09 | 119 | unsigned wireless:1; /* Wireless USB HCD */ |
5234ce1b | 120 | unsigned authorized_default:1; |
7329e211 | 121 | unsigned has_tt:1; /* Integrated TT in root hub */ |
d5926ae7 | 122 | |
1da177e4 LT |
123 | int irq; /* irq allocated */ |
124 | void __iomem *regs; /* device memory/io */ | |
125 | u64 rsrc_start; /* memory/io resource start */ | |
126 | u64 rsrc_len; /* memory/io resource length */ | |
7d35b929 | 127 | unsigned power_budget; /* in mA, 0 = no limit */ |
1da177e4 | 128 | |
3f0479e0 SS |
129 | /* bandwidth_mutex should be taken before adding or removing |
130 | * any new bus bandwidth constraints: | |
131 | * 1. Before adding a configuration for a new device. | |
132 | * 2. Before removing the configuration to put the device into | |
133 | * the addressed state. | |
134 | * 3. Before selecting a different configuration. | |
135 | * 4. Before selecting an alternate interface setting. | |
136 | * | |
137 | * bandwidth_mutex should be dropped after a successful control message | |
138 | * to the device, or resetting the bandwidth after a failed attempt. | |
139 | */ | |
140 | struct mutex bandwidth_mutex; | |
141 | ||
142 | ||
1da177e4 | 143 | #define HCD_BUFFER_POOLS 4 |
0858a3a5 | 144 | struct dma_pool *pool[HCD_BUFFER_POOLS]; |
1da177e4 LT |
145 | |
146 | int state; | |
147 | # define __ACTIVE 0x01 | |
148 | # define __SUSPEND 0x04 | |
149 | # define __TRANSIENT 0x80 | |
150 | ||
151 | # define HC_STATE_HALT 0 | |
152 | # define HC_STATE_RUNNING (__ACTIVE) | |
153 | # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE) | |
154 | # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT) | |
155 | # define HC_STATE_SUSPENDED (__SUSPEND) | |
156 | ||
157 | #define HC_IS_RUNNING(state) ((state) & __ACTIVE) | |
158 | #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND) | |
159 | ||
160 | /* more shared queuing code would be good; it should support | |
161 | * smarter scheduling, handle transaction translators, etc; | |
84cca820 | 162 | * input size of periodic table to an interrupt scheduler. |
1da177e4 LT |
163 | * (ohci 32, uhci 1024, ehci 256/512/1024). |
164 | */ | |
165 | ||
166 | /* The HC driver's private data is stored at the end of | |
167 | * this structure. | |
168 | */ | |
169 | unsigned long hcd_priv[0] | |
84cca820 | 170 | __attribute__ ((aligned(sizeof(unsigned long)))); |
1da177e4 LT |
171 | }; |
172 | ||
173 | /* 2.4 does this a bit differently ... */ | |
84cca820 | 174 | static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd) |
1da177e4 LT |
175 | { |
176 | return &hcd->self; | |
177 | } | |
178 | ||
84cca820 | 179 | static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus) |
17200583 AS |
180 | { |
181 | return container_of(bus, struct usb_hcd, self); | |
182 | } | |
1da177e4 LT |
183 | |
184 | struct hcd_timeout { /* timeouts we allocate */ | |
185 | struct list_head timeout_list; | |
186 | struct timer_list timer; | |
187 | }; | |
188 | ||
189 | /*-------------------------------------------------------------------------*/ | |
190 | ||
1da177e4 | 191 | |
1da177e4 LT |
192 | struct hc_driver { |
193 | const char *description; /* "ehci-hcd" etc */ | |
194 | const char *product_desc; /* product/vendor string */ | |
195 | size_t hcd_priv_size; /* size of private data */ | |
196 | ||
197 | /* irq handler */ | |
7d12e780 | 198 | irqreturn_t (*irq) (struct usb_hcd *hcd); |
1da177e4 LT |
199 | |
200 | int flags; | |
201 | #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */ | |
b3476675 | 202 | #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */ |
1da177e4 LT |
203 | #define HCD_USB11 0x0010 /* USB 1.1 */ |
204 | #define HCD_USB2 0x0020 /* USB 2.0 */ | |
66d4eadd | 205 | #define HCD_USB3 0x0040 /* USB 3.0 */ |
6b403b02 | 206 | #define HCD_MASK 0x0070 |
1da177e4 LT |
207 | |
208 | /* called to init HCD and root hub */ | |
209 | int (*reset) (struct usb_hcd *hcd); | |
210 | int (*start) (struct usb_hcd *hcd); | |
211 | ||
212 | /* NOTE: these suspend/resume calls relate to the HC as | |
5f827ea3 | 213 | * a whole, not just the root hub; they're for PCI bus glue. |
1da177e4 | 214 | */ |
5f827ea3 | 215 | /* called after suspending the hub, before entering D3 etc */ |
4147200d | 216 | int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup); |
1da177e4 | 217 | |
5f827ea3 | 218 | /* called after entering D0 (etc), before resuming the hub */ |
6ec4beb5 | 219 | int (*pci_resume)(struct usb_hcd *hcd, bool hibernated); |
1da177e4 LT |
220 | |
221 | /* cleanly make HCD stop writing memory and doing I/O */ | |
222 | void (*stop) (struct usb_hcd *hcd); | |
223 | ||
64a21d02 AG |
224 | /* shutdown HCD */ |
225 | void (*shutdown) (struct usb_hcd *hcd); | |
226 | ||
1da177e4 LT |
227 | /* return current frame number */ |
228 | int (*get_frame_number) (struct usb_hcd *hcd); | |
229 | ||
230 | /* manage i/o requests, device state */ | |
e9df41c5 AS |
231 | int (*urb_enqueue)(struct usb_hcd *hcd, |
232 | struct urb *urb, gfp_t mem_flags); | |
233 | int (*urb_dequeue)(struct usb_hcd *hcd, | |
234 | struct urb *urb, int status); | |
1da177e4 LT |
235 | |
236 | /* hw synch, freeing endpoint resources that urb_dequeue can't */ | |
0858a3a5 | 237 | void (*endpoint_disable)(struct usb_hcd *hcd, |
1da177e4 LT |
238 | struct usb_host_endpoint *ep); |
239 | ||
3444b26a DV |
240 | /* (optional) reset any endpoint state such as sequence number |
241 | and current window */ | |
0858a3a5 | 242 | void (*endpoint_reset)(struct usb_hcd *hcd, |
3444b26a DV |
243 | struct usb_host_endpoint *ep); |
244 | ||
1da177e4 | 245 | /* root hub support */ |
84cca820 GKH |
246 | int (*hub_status_data) (struct usb_hcd *hcd, char *buf); |
247 | int (*hub_control) (struct usb_hcd *hcd, | |
1da177e4 LT |
248 | u16 typeReq, u16 wValue, u16 wIndex, |
249 | char *buf, u16 wLength); | |
84cca820 GKH |
250 | int (*bus_suspend)(struct usb_hcd *); |
251 | int (*bus_resume)(struct usb_hcd *); | |
252 | int (*start_port_reset)(struct usb_hcd *, unsigned port_num); | |
90da096e BR |
253 | |
254 | /* force handover of high-speed port to full-speed companion */ | |
84cca820 | 255 | void (*relinquish_port)(struct usb_hcd *, int); |
3a31155c AS |
256 | /* has a port been handed over to a companion? */ |
257 | int (*port_handed_over)(struct usb_hcd *, int); | |
c6515272 | 258 | |
cb88a1b8 AS |
259 | /* CLEAR_TT_BUFFER completion callback */ |
260 | void (*clear_tt_buffer_complete)(struct usb_hcd *, | |
261 | struct usb_host_endpoint *); | |
262 | ||
c6515272 SS |
263 | /* xHCI specific functions */ |
264 | /* Called by usb_alloc_dev to alloc HC device structures */ | |
265 | int (*alloc_dev)(struct usb_hcd *, struct usb_device *); | |
f7410ced | 266 | /* Called by usb_disconnect to free HC device structures */ |
c6515272 | 267 | void (*free_dev)(struct usb_hcd *, struct usb_device *); |
eab1cafc SS |
268 | /* Change a group of bulk endpoints to support multiple stream IDs */ |
269 | int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev, | |
270 | struct usb_host_endpoint **eps, unsigned int num_eps, | |
271 | unsigned int num_streams, gfp_t mem_flags); | |
272 | /* Reverts a group of bulk endpoints back to not using stream IDs. | |
273 | * Can fail if we run out of memory. | |
274 | */ | |
275 | int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev, | |
276 | struct usb_host_endpoint **eps, unsigned int num_eps, | |
277 | gfp_t mem_flags); | |
79abb1ab SS |
278 | |
279 | /* Bandwidth computation functions */ | |
280 | /* Note that add_endpoint() can only be called once per endpoint before | |
281 | * check_bandwidth() or reset_bandwidth() must be called. | |
282 | * drop_endpoint() can only be called once per endpoint also. | |
0858a3a5 GKH |
283 | * A call to xhci_drop_endpoint() followed by a call to |
284 | * xhci_add_endpoint() will add the endpoint to the schedule with | |
285 | * possibly new parameters denoted by a different endpoint descriptor | |
286 | * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a | |
287 | * call to xhci_drop_endpoint() is not allowed. | |
79abb1ab SS |
288 | */ |
289 | /* Allocate endpoint resources and add them to a new schedule */ | |
0858a3a5 GKH |
290 | int (*add_endpoint)(struct usb_hcd *, struct usb_device *, |
291 | struct usb_host_endpoint *); | |
79abb1ab | 292 | /* Drop an endpoint from a new schedule */ |
0858a3a5 GKH |
293 | int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, |
294 | struct usb_host_endpoint *); | |
79abb1ab SS |
295 | /* Check that a new hardware configuration, set using |
296 | * endpoint_enable and endpoint_disable, does not exceed bus | |
297 | * bandwidth. This must be called before any set configuration | |
298 | * or set interface requests are sent to the device. | |
299 | */ | |
300 | int (*check_bandwidth)(struct usb_hcd *, struct usb_device *); | |
301 | /* Reset the device schedule to the last known good schedule, | |
302 | * which was set from a previous successful call to | |
303 | * check_bandwidth(). This reverts any add_endpoint() and | |
304 | * drop_endpoint() calls since that last successful call. | |
305 | * Used for when a check_bandwidth() call fails due to resource | |
306 | * or bandwidth constraints. | |
307 | */ | |
308 | void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *); | |
c6515272 SS |
309 | /* Returns the hardware-chosen device address */ |
310 | int (*address_device)(struct usb_hcd *, struct usb_device *udev); | |
b356b7c7 SS |
311 | /* Notifies the HCD after a hub descriptor is fetched. |
312 | * Will block. | |
313 | */ | |
314 | int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev, | |
315 | struct usb_tt *tt, gfp_t mem_flags); | |
a5f0efab | 316 | int (*reset_device)(struct usb_hcd *, struct usb_device *); |
48f24970 AD |
317 | /* Notifies the HCD after a device is connected and its |
318 | * address is set | |
319 | */ | |
320 | int (*update_device)(struct usb_hcd *, struct usb_device *); | |
1da177e4 LT |
321 | }; |
322 | ||
e9df41c5 AS |
323 | extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb); |
324 | extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb, | |
325 | int status); | |
326 | extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb); | |
327 | ||
84cca820 GKH |
328 | extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags); |
329 | extern int usb_hcd_unlink_urb(struct urb *urb, int status); | |
4a00027d AS |
330 | extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, |
331 | int status); | |
1dae423d | 332 | extern void unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *); |
496dda70 | 333 | extern void unmap_urb_for_dma(struct usb_hcd *, struct urb *); |
95cf82f9 AS |
334 | extern void usb_hcd_flush_endpoint(struct usb_device *udev, |
335 | struct usb_host_endpoint *ep); | |
336 | extern void usb_hcd_disable_endpoint(struct usb_device *udev, | |
a6d2bb9f | 337 | struct usb_host_endpoint *ep); |
3444b26a DV |
338 | extern void usb_hcd_reset_endpoint(struct usb_device *udev, |
339 | struct usb_host_endpoint *ep); | |
cde217a5 | 340 | extern void usb_hcd_synchronize_unlinks(struct usb_device *udev); |
3f0479e0 | 341 | extern int usb_hcd_alloc_bandwidth(struct usb_device *udev, |
79abb1ab | 342 | struct usb_host_config *new_config, |
3f0479e0 SS |
343 | struct usb_host_interface *old_alt, |
344 | struct usb_host_interface *new_alt); | |
84cca820 | 345 | extern int usb_hcd_get_frame_number(struct usb_device *udev); |
1da177e4 | 346 | |
84cca820 | 347 | extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver, |
1b26da15 | 348 | struct device *dev, const char *bus_name); |
84cca820 GKH |
349 | extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd); |
350 | extern void usb_put_hcd(struct usb_hcd *hcd); | |
1da177e4 LT |
351 | extern int usb_add_hcd(struct usb_hcd *hcd, |
352 | unsigned int irqnum, unsigned long irqflags); | |
353 | extern void usb_remove_hcd(struct usb_hcd *hcd); | |
354 | ||
64a21d02 | 355 | struct platform_device; |
84cca820 | 356 | extern void usb_hcd_platform_shutdown(struct platform_device *dev); |
64a21d02 | 357 | |
1da177e4 LT |
358 | #ifdef CONFIG_PCI |
359 | struct pci_dev; | |
360 | struct pci_device_id; | |
84cca820 | 361 | extern int usb_hcd_pci_probe(struct pci_dev *dev, |
1da177e4 | 362 | const struct pci_device_id *id); |
84cca820 | 363 | extern void usb_hcd_pci_remove(struct pci_dev *dev); |
84cca820 | 364 | extern void usb_hcd_pci_shutdown(struct pci_dev *dev); |
64a21d02 | 365 | |
abb30641 | 366 | #ifdef CONFIG_PM_SLEEP |
47145210 | 367 | extern const struct dev_pm_ops usb_hcd_pci_pm_ops; |
abb30641 | 368 | #endif |
1da177e4 LT |
369 | #endif /* CONFIG_PCI */ |
370 | ||
371 | /* pci-ish (pdev null is ok) buffer alloc/mapping support */ | |
84cca820 GKH |
372 | int hcd_buffer_create(struct usb_hcd *hcd); |
373 | void hcd_buffer_destroy(struct usb_hcd *hcd); | |
1da177e4 | 374 | |
84cca820 | 375 | void *hcd_buffer_alloc(struct usb_bus *bus, size_t size, |
55016f10 | 376 | gfp_t mem_flags, dma_addr_t *dma); |
84cca820 | 377 | void hcd_buffer_free(struct usb_bus *bus, size_t size, |
1da177e4 LT |
378 | void *addr, dma_addr_t dma); |
379 | ||
380 | /* generic bus glue, needed for host controllers that don't use PCI */ | |
84cca820 | 381 | extern irqreturn_t usb_hcd_irq(int irq, void *__hcd); |
d5926ae7 | 382 | |
84cca820 | 383 | extern void usb_hc_died(struct usb_hcd *hcd); |
d5926ae7 | 384 | extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd); |
1da177e4 | 385 | |
3444b26a DV |
386 | /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */ |
387 | #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1) | |
388 | #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep))) | |
389 | #define usb_settoggle(dev, ep, out, bit) \ | |
390 | ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \ | |
391 | ((bit) << (ep))) | |
392 | ||
1da177e4 LT |
393 | /* -------------------------------------------------------------------------- */ |
394 | ||
395 | /* Enumeration is only for the hub driver, or HCD virtual root hubs */ | |
396 | extern struct usb_device *usb_alloc_dev(struct usb_device *parent, | |
397 | struct usb_bus *, unsigned port); | |
398 | extern int usb_new_device(struct usb_device *dev); | |
399 | extern void usb_disconnect(struct usb_device **); | |
400 | ||
401 | extern int usb_get_configuration(struct usb_device *dev); | |
402 | extern void usb_destroy_configuration(struct usb_device *dev); | |
403 | ||
404 | /*-------------------------------------------------------------------------*/ | |
405 | ||
406 | /* | |
407 | * HCD Root Hub support | |
408 | */ | |
409 | ||
d20db4b4 EL |
410 | #include <linux/usb/ch11.h> |
411 | ||
412 | /* | |
413 | * As of USB 2.0, full/low speed devices are segregated into trees. | |
414 | * One type grows from USB 1.1 host controllers (OHCI, UHCI etc). | |
415 | * The other type grows from high speed hubs when they connect to | |
416 | * full/low speed devices using "Transaction Translators" (TTs). | |
417 | * | |
418 | * TTs should only be known to the hub driver, and high speed bus | |
419 | * drivers (only EHCI for now). They affect periodic scheduling and | |
420 | * sometimes control/bulk error recovery. | |
421 | */ | |
422 | ||
423 | struct usb_device; | |
424 | ||
425 | struct usb_tt { | |
426 | struct usb_device *hub; /* upstream highspeed hub */ | |
427 | int multi; /* true means one TT per port */ | |
428 | unsigned think_time; /* think time in ns */ | |
429 | ||
430 | /* for control/bulk error recovery (CLEAR_TT_BUFFER) */ | |
431 | spinlock_t lock; | |
432 | struct list_head clear_list; /* of usb_tt_clear */ | |
433 | struct work_struct clear_work; | |
434 | }; | |
435 | ||
436 | struct usb_tt_clear { | |
437 | struct list_head clear_list; | |
438 | unsigned tt; | |
439 | u16 devinfo; | |
440 | struct usb_hcd *hcd; | |
441 | struct usb_host_endpoint *ep; | |
442 | }; | |
443 | ||
444 | extern int usb_hub_clear_tt_buffer(struct urb *urb); | |
445 | extern void usb_ep0_reinit(struct usb_device *); | |
1da177e4 LT |
446 | |
447 | /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */ | |
448 | #define DeviceRequest \ | |
449 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
450 | #define DeviceOutRequest \ | |
451 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
452 | ||
453 | #define InterfaceRequest \ | |
454 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
455 | ||
456 | #define EndpointRequest \ | |
457 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
458 | #define EndpointOutRequest \ | |
459 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
460 | ||
461 | /* class requests from the USB 2.0 hub spec, table 11-15 */ | |
462 | /* GetBusState and SetHubDescriptor are optional, omitted */ | |
463 | #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE) | |
464 | #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE) | |
465 | #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR) | |
466 | #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS) | |
467 | #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS) | |
468 | #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE) | |
469 | #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE) | |
470 | ||
471 | ||
472 | /*-------------------------------------------------------------------------*/ | |
0eadcc09 TB |
473 | |
474 | /* class requests from USB 3.0 hub spec, table 10-5 */ | |
475 | #define SetHubDepth (0x3000 | HUB_SET_DEPTH) | |
476 | #define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT) | |
1da177e4 LT |
477 | |
478 | /* | |
479 | * Generic bandwidth allocation constants/support | |
480 | */ | |
481 | #define FRAME_TIME_USECS 1000L | |
84cca820 | 482 | #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ |
1da177e4 | 483 | /* Trying not to use worst-case bit-stuffing |
84cca820 | 484 | * of (7/6 * 8 * bytecount) = 9.33 * bytecount */ |
1da177e4 LT |
485 | /* bytecount = data payload byte count */ |
486 | ||
487 | #define NS_TO_US(ns) ((ns + 500L) / 1000L) | |
488 | /* convert & round nanoseconds to microseconds */ | |
489 | ||
1da177e4 LT |
490 | |
491 | /* | |
492 | * Full/low speed bandwidth allocation constants/support. | |
493 | */ | |
494 | #define BW_HOST_DELAY 1000L /* nanoseconds */ | |
495 | #define BW_HUB_LS_SETUP 333L /* nanoseconds */ | |
84cca820 | 496 | /* 4 full-speed bit times (est.) */ |
1da177e4 | 497 | |
84cca820 | 498 | #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ |
1da177e4 LT |
499 | #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) |
500 | #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) | |
501 | ||
1da177e4 | 502 | /* |
498f78e6 | 503 | * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed |
1da177e4 LT |
504 | * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed |
505 | * to preallocate bandwidth) | |
506 | */ | |
507 | #define USB2_HOST_DELAY 5 /* nsec, guess */ | |
84cca820 | 508 | #define HS_NSECS(bytes) (((55 * 8 * 2083) \ |
f956e7cd | 509 | + (2083UL * (3 + BitTime(bytes))))/1000 \ |
1da177e4 | 510 | + USB2_HOST_DELAY) |
84cca820 | 511 | #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \ |
f956e7cd | 512 | + (2083UL * (3 + BitTime(bytes))))/1000 \ |
1da177e4 | 513 | + USB2_HOST_DELAY) |
0858a3a5 GKH |
514 | #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes)) |
515 | #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes)) | |
1da177e4 | 516 | |
84cca820 | 517 | extern long usb_calc_bus_time(int speed, int is_input, |
1da177e4 LT |
518 | int isoc, int bytecount); |
519 | ||
520 | /*-------------------------------------------------------------------------*/ | |
521 | ||
1da177e4 LT |
522 | extern void usb_set_device_state(struct usb_device *udev, |
523 | enum usb_device_state new_state); | |
524 | ||
525 | /*-------------------------------------------------------------------------*/ | |
526 | ||
527 | /* exported only within usbcore */ | |
528 | ||
529 | extern struct list_head usb_bus_list; | |
4186ecf8 | 530 | extern struct mutex usb_bus_list_lock; |
1da177e4 LT |
531 | extern wait_queue_head_t usb_kill_urb_queue; |
532 | ||
84cca820 | 533 | extern int usb_find_interface_driver(struct usb_device *dev, |
1da177e4 LT |
534 | struct usb_interface *interface); |
535 | ||
536 | #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN)) | |
537 | ||
0c0382e3 | 538 | #ifdef CONFIG_PM |
84cca820 | 539 | extern void usb_root_hub_lost_power(struct usb_device *rhdev); |
65bfd296 AS |
540 | extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg); |
541 | extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg); | |
9bbdf1e0 AS |
542 | #endif /* CONFIG_PM */ |
543 | ||
544 | #ifdef CONFIG_USB_SUSPEND | |
545 | extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd); | |
0c0382e3 | 546 | #else |
db2d55b7 AM |
547 | static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd) |
548 | { | |
549 | return; | |
550 | } | |
9bbdf1e0 AS |
551 | #endif /* CONFIG_USB_SUSPEND */ |
552 | ||
0c0382e3 | 553 | |
1da177e4 LT |
554 | /* |
555 | * USB device fs stuff | |
556 | */ | |
557 | ||
558 | #ifdef CONFIG_USB_DEVICEFS | |
559 | ||
560 | /* | |
561 | * these are expected to be called from the USB core/hub thread | |
562 | * with the kernel lock held | |
563 | */ | |
84cca820 | 564 | extern void usbfs_update_special(void); |
1da177e4 LT |
565 | extern int usbfs_init(void); |
566 | extern void usbfs_cleanup(void); | |
567 | ||
568 | #else /* CONFIG_USB_DEVICEFS */ | |
569 | ||
84cca820 | 570 | static inline void usbfs_update_special(void) {} |
1da177e4 LT |
571 | static inline int usbfs_init(void) { return 0; } |
572 | static inline void usbfs_cleanup(void) { } | |
573 | ||
574 | #endif /* CONFIG_USB_DEVICEFS */ | |
575 | ||
576 | /*-------------------------------------------------------------------------*/ | |
577 | ||
f150fa1a | 578 | #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) |
1da177e4 LT |
579 | |
580 | struct usb_mon_operations { | |
581 | void (*urb_submit)(struct usb_bus *bus, struct urb *urb); | |
582 | void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err); | |
9347d51c | 583 | void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status); |
1da177e4 | 584 | /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */ |
1da177e4 LT |
585 | }; |
586 | ||
587 | extern struct usb_mon_operations *mon_ops; | |
588 | ||
589 | static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) | |
590 | { | |
591 | if (bus->monitored) | |
592 | (*mon_ops->urb_submit)(bus, urb); | |
593 | } | |
594 | ||
595 | static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, | |
596 | int error) | |
597 | { | |
598 | if (bus->monitored) | |
599 | (*mon_ops->urb_submit_error)(bus, urb, error); | |
600 | } | |
601 | ||
9347d51c AS |
602 | static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, |
603 | int status) | |
1da177e4 LT |
604 | { |
605 | if (bus->monitored) | |
9347d51c | 606 | (*mon_ops->urb_complete)(bus, urb, status); |
1da177e4 | 607 | } |
1da177e4 LT |
608 | |
609 | int usb_mon_register(struct usb_mon_operations *ops); | |
610 | void usb_mon_deregister(void); | |
611 | ||
612 | #else | |
613 | ||
614 | static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {} | |
615 | static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, | |
616 | int error) {} | |
9347d51c AS |
617 | static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, |
618 | int status) {} | |
1da177e4 | 619 | |
f150fa1a | 620 | #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */ |
1da177e4 LT |
621 | |
622 | /*-------------------------------------------------------------------------*/ | |
623 | ||
624 | /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */ | |
84cca820 | 625 | /* bleech -- resurfaced in 2.4.11 or 2.4.12 */ |
0858a3a5 | 626 | #define bitmap DeviceRemovable |
1da177e4 LT |
627 | |
628 | ||
629 | /*-------------------------------------------------------------------------*/ | |
630 | ||
631 | /* random stuff */ | |
632 | ||
84cca820 GKH |
633 | #define RUN_CONTEXT (in_irq() ? "in_irq" \ |
634 | : (in_interrupt() ? "in_interrupt" : "can sleep")) | |
1da177e4 LT |
635 | |
636 | ||
32fe0198 AS |
637 | /* This rwsem is for use only by the hub driver and ehci-hcd. |
638 | * Nobody else should touch it. | |
639 | */ | |
640 | extern struct rw_semaphore ehci_cf_port_reset_rwsem; | |
1da177e4 | 641 | |
9beeee65 AS |
642 | /* Keep track of which host controller drivers are loaded */ |
643 | #define USB_UHCI_LOADED 0 | |
644 | #define USB_OHCI_LOADED 1 | |
645 | #define USB_EHCI_LOADED 2 | |
646 | extern unsigned long usb_hcds_loaded; | |
647 | ||
32fe0198 | 648 | #endif /* __KERNEL__ */ |
aa459e6a AV |
649 | |
650 | #endif /* __USB_CORE_HCD_H */ |