2 * Copyright (c) 2001-2002 by David Brownell
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.
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
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.
19 #ifndef __USB_CORE_HCD_H
20 #define __USB_CORE_HCD_H
24 #include <linux/rwsem.h>
26 #define MAX_TOPO_LEVEL 6
28 /* This file contains declarations of usbcore internals that are mostly
29 * used or exposed by Host Controller Drivers.
33 * USB Packet IDs (PIDs)
35 #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
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 */
53 /*-------------------------------------------------------------------------*/
56 * USB Host Controller Driver (usb_hcd) framework
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.
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.
68 /*-------------------------------------------------------------------------*/
75 struct usb_bus self; /* hcd is-a bus */
76 struct kref kref; /* reference counter */
78 const char *product_desc; /* product/vendor string */
79 char irq_descr[24]; /* driver + bus # */
81 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
84 struct work_struct wakeup_work; /* for remote wakeup */
90 const struct hc_driver *driver; /* hw-specific hooks */
92 /* Flags that need to be manipulated atomically */
94 #define HCD_FLAG_HW_ACCESSIBLE 0x00000001
95 #define HCD_FLAG_SAW_IRQ 0x00000002
97 unsigned rh_registered:1;/* is root hub registered? */
99 /* The next flag is a stopgap, to be removed when all the HCDs
100 * support the new root-hub polling mechanism. */
101 unsigned uses_new_polling:1;
102 unsigned poll_rh:1; /* poll for rh status? */
103 unsigned poll_pending:1; /* status has changed? */
104 unsigned wireless:1; /* Wireless USB HCD */
105 unsigned authorized_default:1;
106 unsigned has_tt:1; /* Integrated TT in root hub */
108 int irq; /* irq allocated */
109 void __iomem *regs; /* device memory/io */
110 u64 rsrc_start; /* memory/io resource start */
111 u64 rsrc_len; /* memory/io resource length */
112 unsigned power_budget; /* in mA, 0 = no limit */
114 #define HCD_BUFFER_POOLS 4
115 struct dma_pool *pool [HCD_BUFFER_POOLS];
118 # define __ACTIVE 0x01
119 # define __SUSPEND 0x04
120 # define __TRANSIENT 0x80
122 # define HC_STATE_HALT 0
123 # define HC_STATE_RUNNING (__ACTIVE)
124 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
125 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
126 # define HC_STATE_SUSPENDED (__SUSPEND)
128 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
129 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
131 /* more shared queuing code would be good; it should support
132 * smarter scheduling, handle transaction translators, etc;
133 * input size of periodic table to an interrupt scheduler.
134 * (ohci 32, uhci 1024, ehci 256/512/1024).
137 /* The HC driver's private data is stored at the end of
140 unsigned long hcd_priv[0]
141 __attribute__ ((aligned(sizeof(unsigned long))));
144 /* 2.4 does this a bit differently ... */
145 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
150 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
152 return container_of(bus, struct usb_hcd, self);
155 struct hcd_timeout { /* timeouts we allocate */
156 struct list_head timeout_list;
157 struct timer_list timer;
160 /*-------------------------------------------------------------------------*/
164 const char *description; /* "ehci-hcd" etc */
165 const char *product_desc; /* product/vendor string */
166 size_t hcd_priv_size; /* size of private data */
169 irqreturn_t (*irq) (struct usb_hcd *hcd);
172 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
173 #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
174 #define HCD_USB11 0x0010 /* USB 1.1 */
175 #define HCD_USB2 0x0020 /* USB 2.0 */
176 #define HCD_USB3 0x0040 /* USB 3.0 */
177 #define HCD_MASK 0x0070
179 /* called to init HCD and root hub */
180 int (*reset) (struct usb_hcd *hcd);
181 int (*start) (struct usb_hcd *hcd);
183 /* NOTE: these suspend/resume calls relate to the HC as
184 * a whole, not just the root hub; they're for PCI bus glue.
186 /* called after suspending the hub, before entering D3 etc */
187 int (*pci_suspend)(struct usb_hcd *hcd);
189 /* called after entering D0 (etc), before resuming the hub */
190 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
192 /* cleanly make HCD stop writing memory and doing I/O */
193 void (*stop) (struct usb_hcd *hcd);
196 void (*shutdown) (struct usb_hcd *hcd);
198 /* return current frame number */
199 int (*get_frame_number) (struct usb_hcd *hcd);
201 /* manage i/o requests, device state */
202 int (*urb_enqueue)(struct usb_hcd *hcd,
203 struct urb *urb, gfp_t mem_flags);
204 int (*urb_dequeue)(struct usb_hcd *hcd,
205 struct urb *urb, int status);
207 /* hw synch, freeing endpoint resources that urb_dequeue can't */
208 void (*endpoint_disable)(struct usb_hcd *hcd,
209 struct usb_host_endpoint *ep);
211 /* (optional) reset any endpoint state such as sequence number
212 and current window */
213 void (*endpoint_reset)(struct usb_hcd *hcd,
214 struct usb_host_endpoint *ep);
216 /* root hub support */
217 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
218 int (*hub_control) (struct usb_hcd *hcd,
219 u16 typeReq, u16 wValue, u16 wIndex,
220 char *buf, u16 wLength);
221 int (*bus_suspend)(struct usb_hcd *);
222 int (*bus_resume)(struct usb_hcd *);
223 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
225 /* force handover of high-speed port to full-speed companion */
226 void (*relinquish_port)(struct usb_hcd *, int);
227 /* has a port been handed over to a companion? */
228 int (*port_handed_over)(struct usb_hcd *, int);
230 /* xHCI specific functions */
231 /* Called by usb_alloc_dev to alloc HC device structures */
232 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
233 /* Called by usb_release_dev to free HC device structures */
234 void (*free_dev)(struct usb_hcd *, struct usb_device *);
236 /* Bandwidth computation functions */
237 /* Note that add_endpoint() can only be called once per endpoint before
238 * check_bandwidth() or reset_bandwidth() must be called.
239 * drop_endpoint() can only be called once per endpoint also.
240 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
241 * add the endpoint to the schedule with possibly new parameters denoted by a
242 * different endpoint descriptor in usb_host_endpoint.
243 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
246 /* Allocate endpoint resources and add them to a new schedule */
247 int (*add_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
248 /* Drop an endpoint from a new schedule */
249 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
250 /* Check that a new hardware configuration, set using
251 * endpoint_enable and endpoint_disable, does not exceed bus
252 * bandwidth. This must be called before any set configuration
253 * or set interface requests are sent to the device.
255 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
256 /* Reset the device schedule to the last known good schedule,
257 * which was set from a previous successful call to
258 * check_bandwidth(). This reverts any add_endpoint() and
259 * drop_endpoint() calls since that last successful call.
260 * Used for when a check_bandwidth() call fails due to resource
261 * or bandwidth constraints.
263 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
264 /* Returns the hardware-chosen device address */
265 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
268 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
269 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
271 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
273 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
274 extern int usb_hcd_unlink_urb(struct urb *urb, int status);
275 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
277 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
278 struct usb_host_endpoint *ep);
279 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
280 struct usb_host_endpoint *ep);
281 extern void usb_hcd_reset_endpoint(struct usb_device *udev,
282 struct usb_host_endpoint *ep);
283 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
284 extern int usb_hcd_check_bandwidth(struct usb_device *udev,
285 struct usb_host_config *new_config,
286 struct usb_interface *new_intf);
287 extern int usb_hcd_get_frame_number(struct usb_device *udev);
289 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
290 struct device *dev, const char *bus_name);
291 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
292 extern void usb_put_hcd(struct usb_hcd *hcd);
293 extern int usb_add_hcd(struct usb_hcd *hcd,
294 unsigned int irqnum, unsigned long irqflags);
295 extern void usb_remove_hcd(struct usb_hcd *hcd);
297 struct platform_device;
298 extern void usb_hcd_platform_shutdown(struct platform_device *dev);
302 struct pci_device_id;
303 extern int usb_hcd_pci_probe(struct pci_dev *dev,
304 const struct pci_device_id *id);
305 extern void usb_hcd_pci_remove(struct pci_dev *dev);
306 extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
308 #ifdef CONFIG_PM_SLEEP
309 extern struct dev_pm_ops usb_hcd_pci_pm_ops;
311 #endif /* CONFIG_PCI */
313 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
314 int hcd_buffer_create(struct usb_hcd *hcd);
315 void hcd_buffer_destroy(struct usb_hcd *hcd);
317 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
318 gfp_t mem_flags, dma_addr_t *dma);
319 void hcd_buffer_free(struct usb_bus *bus, size_t size,
320 void *addr, dma_addr_t dma);
322 /* generic bus glue, needed for host controllers that don't use PCI */
323 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
325 extern void usb_hc_died(struct usb_hcd *hcd);
326 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
328 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
329 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
330 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
331 #define usb_settoggle(dev, ep, out, bit) \
332 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
335 /* -------------------------------------------------------------------------- */
337 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
338 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
339 struct usb_bus *, unsigned port);
340 extern int usb_new_device(struct usb_device *dev);
341 extern void usb_disconnect(struct usb_device **);
343 extern int usb_get_configuration(struct usb_device *dev);
344 extern void usb_destroy_configuration(struct usb_device *dev);
346 /*-------------------------------------------------------------------------*/
349 * HCD Root Hub support
354 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
355 #define DeviceRequest \
356 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
357 #define DeviceOutRequest \
358 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
360 #define InterfaceRequest \
361 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
363 #define EndpointRequest \
364 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
365 #define EndpointOutRequest \
366 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
368 /* class requests from the USB 2.0 hub spec, table 11-15 */
369 /* GetBusState and SetHubDescriptor are optional, omitted */
370 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
371 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
372 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
373 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
374 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
375 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
376 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
379 /*-------------------------------------------------------------------------*/
382 * Generic bandwidth allocation constants/support
384 #define FRAME_TIME_USECS 1000L
385 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
386 /* Trying not to use worst-case bit-stuffing
387 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
388 /* bytecount = data payload byte count */
390 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
391 /* convert & round nanoseconds to microseconds */
395 * Full/low speed bandwidth allocation constants/support.
397 #define BW_HOST_DELAY 1000L /* nanoseconds */
398 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
399 /* 4 full-speed bit times (est.) */
401 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
402 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
403 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
406 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
407 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
408 * to preallocate bandwidth)
410 #define USB2_HOST_DELAY 5 /* nsec, guess */
411 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
412 + (2083UL * (3 + BitTime(bytes))))/1000 \
414 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
415 + (2083UL * (3 + BitTime(bytes))))/1000 \
417 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
418 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
420 extern long usb_calc_bus_time(int speed, int is_input,
421 int isoc, int bytecount);
423 /*-------------------------------------------------------------------------*/
425 extern void usb_set_device_state(struct usb_device *udev,
426 enum usb_device_state new_state);
428 /*-------------------------------------------------------------------------*/
430 /* exported only within usbcore */
432 extern struct list_head usb_bus_list;
433 extern struct mutex usb_bus_list_lock;
434 extern wait_queue_head_t usb_kill_urb_queue;
436 extern int usb_find_interface_driver(struct usb_device *dev,
437 struct usb_interface *interface);
439 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
442 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
443 extern void usb_root_hub_lost_power(struct usb_device *rhdev);
444 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
445 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
447 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
451 #endif /* CONFIG_PM */
454 * USB device fs stuff
457 #ifdef CONFIG_USB_DEVICEFS
460 * these are expected to be called from the USB core/hub thread
461 * with the kernel lock held
463 extern void usbfs_update_special(void);
464 extern int usbfs_init(void);
465 extern void usbfs_cleanup(void);
467 #else /* CONFIG_USB_DEVICEFS */
469 static inline void usbfs_update_special(void) {}
470 static inline int usbfs_init(void) { return 0; }
471 static inline void usbfs_cleanup(void) { }
473 #endif /* CONFIG_USB_DEVICEFS */
475 /*-------------------------------------------------------------------------*/
477 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
479 struct usb_mon_operations {
480 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
481 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
482 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
483 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
486 extern struct usb_mon_operations *mon_ops;
488 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
491 (*mon_ops->urb_submit)(bus, urb);
494 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
498 (*mon_ops->urb_submit_error)(bus, urb, error);
501 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
505 (*mon_ops->urb_complete)(bus, urb, status);
508 int usb_mon_register(struct usb_mon_operations *ops);
509 void usb_mon_deregister(void);
513 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
514 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
516 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
519 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
521 /*-------------------------------------------------------------------------*/
523 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
524 /* bleech -- resurfaced in 2.4.11 or 2.4.12 */
525 #define bitmap DeviceRemovable
528 /*-------------------------------------------------------------------------*/
532 #define RUN_CONTEXT (in_irq() ? "in_irq" \
533 : (in_interrupt() ? "in_interrupt" : "can sleep"))
536 /* This rwsem is for use only by the hub driver and ehci-hcd.
537 * Nobody else should touch it.
539 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
541 /* Keep track of which host controller drivers are loaded */
542 #define USB_UHCI_LOADED 0
543 #define USB_OHCI_LOADED 1
544 #define USB_EHCI_LOADED 2
545 extern unsigned long usb_hcds_loaded;
547 #endif /* __KERNEL__ */
549 #endif /* __USB_CORE_HCD_H */