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