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