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