tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
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
26#define MAX_TOPO_LEVEL 6
27
28/* This file contains declarations of usbcore internals that are mostly
29 * used or exposed by Host Controller Drivers.
30 */
31
32/*
33 * USB Packet IDs (PIDs)
34 */
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 */
52
53/*-------------------------------------------------------------------------*/
54
55/*
56 * USB Host Controller Driver (usb_hcd) framework
57 *
58 * Since "struct usb_bus" is so thin, you can't share much code in it.
59 * This framework is a layer over that, and should be more sharable.
60 *
61 * @authorized_default: Specifies if new devices are authorized to
62 * connect by default or they require explicit
63 * user space authorization; this bit is settable
64 * through /sys/class/usb_host/X/authorized_default.
65 * For the rest is RO, so we don't lock to r/w it.
66 */
67
68/*-------------------------------------------------------------------------*/
69
70struct usb_hcd {
71
72 /*
73 * housekeeping
74 */
75 struct usb_bus self; /* hcd is-a bus */
76 struct kref kref; /* reference counter */
77
78 const char *product_desc; /* product/vendor string */
79 char irq_descr[24]; /* driver + bus # */
80
81 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
83#ifdef CONFIG_PM
84 struct work_struct wakeup_work; /* for remote wakeup */
85#endif
86
87 /*
88 * hardware info/state
89 */
90 const struct hc_driver *driver; /* hw-specific hooks */
91
92 /* Flags that need to be manipulated atomically */
93 unsigned long flags;
94#define HCD_FLAG_HW_ACCESSIBLE 0x00000001
95#define HCD_FLAG_SAW_IRQ 0x00000002
96
97 unsigned rh_registered:1;/* is root hub registered? */
98
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 */
107
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 */
113
114 /* bandwidth_mutex should be taken before adding or removing
115 * any new bus bandwidth constraints:
116 * 1. Before adding a configuration for a new device.
117 * 2. Before removing the configuration to put the device into
118 * the addressed state.
119 * 3. Before selecting a different configuration.
120 * 4. Before selecting an alternate interface setting.
121 *
122 * bandwidth_mutex should be dropped after a successful control message
123 * to the device, or resetting the bandwidth after a failed attempt.
124 */
125 struct mutex bandwidth_mutex;
126
127
128#define HCD_BUFFER_POOLS 4
129 struct dma_pool *pool [HCD_BUFFER_POOLS];
130
131 int state;
132# define __ACTIVE 0x01
133# define __SUSPEND 0x04
134# define __TRANSIENT 0x80
135
136# define HC_STATE_HALT 0
137# define HC_STATE_RUNNING (__ACTIVE)
138# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
139# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
140# define HC_STATE_SUSPENDED (__SUSPEND)
141
142#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
143#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
144
145 /* more shared queuing code would be good; it should support
146 * smarter scheduling, handle transaction translators, etc;
147 * input size of periodic table to an interrupt scheduler.
148 * (ohci 32, uhci 1024, ehci 256/512/1024).
149 */
150
151 /* The HC driver's private data is stored at the end of
152 * this structure.
153 */
154 unsigned long hcd_priv[0]
155 __attribute__ ((aligned(sizeof(unsigned long))));
156};
157
158/* 2.4 does this a bit differently ... */
159static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
160{
161 return &hcd->self;
162}
163
164static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
165{
166 return container_of(bus, struct usb_hcd, self);
167}
168
169struct hcd_timeout { /* timeouts we allocate */
170 struct list_head timeout_list;
171 struct timer_list timer;
172};
173
174/*-------------------------------------------------------------------------*/
175
176
177struct hc_driver {
178 const char *description; /* "ehci-hcd" etc */
179 const char *product_desc; /* product/vendor string */
180 size_t hcd_priv_size; /* size of private data */
181
182 /* irq handler */
183 irqreturn_t (*irq) (struct usb_hcd *hcd);
184
185 int flags;
186#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
187#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
188#define HCD_USB11 0x0010 /* USB 1.1 */
189#define HCD_USB2 0x0020 /* USB 2.0 */
190#define HCD_USB3 0x0040 /* USB 3.0 */
191#define HCD_MASK 0x0070
192
193 /* called to init HCD and root hub */
194 int (*reset) (struct usb_hcd *hcd);
195 int (*start) (struct usb_hcd *hcd);
196
197 /* NOTE: these suspend/resume calls relate to the HC as
198 * a whole, not just the root hub; they're for PCI bus glue.
199 */
200 /* called after suspending the hub, before entering D3 etc */
201 int (*pci_suspend)(struct usb_hcd *hcd);
202
203 /* called after entering D0 (etc), before resuming the hub */
204 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
205
206 /* cleanly make HCD stop writing memory and doing I/O */
207 void (*stop) (struct usb_hcd *hcd);
208
209 /* shutdown HCD */
210 void (*shutdown) (struct usb_hcd *hcd);
211
212 /* return current frame number */
213 int (*get_frame_number) (struct usb_hcd *hcd);
214
215 /* manage i/o requests, device state */
216 int (*urb_enqueue)(struct usb_hcd *hcd,
217 struct urb *urb, gfp_t mem_flags);
218 int (*urb_dequeue)(struct usb_hcd *hcd,
219 struct urb *urb, int status);
220
221 /* hw synch, freeing endpoint resources that urb_dequeue can't */
222 void (*endpoint_disable)(struct usb_hcd *hcd,
223 struct usb_host_endpoint *ep);
224
225 /* (optional) reset any endpoint state such as sequence number
226 and current window */
227 void (*endpoint_reset)(struct usb_hcd *hcd,
228 struct usb_host_endpoint *ep);
229
230 /* root hub support */
231 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
232 int (*hub_control) (struct usb_hcd *hcd,
233 u16 typeReq, u16 wValue, u16 wIndex,
234 char *buf, u16 wLength);
235 int (*bus_suspend)(struct usb_hcd *);
236 int (*bus_resume)(struct usb_hcd *);
237 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
238
239 /* force handover of high-speed port to full-speed companion */
240 void (*relinquish_port)(struct usb_hcd *, int);
241 /* has a port been handed over to a companion? */
242 int (*port_handed_over)(struct usb_hcd *, int);
243
244 /* CLEAR_TT_BUFFER completion callback */
245 void (*clear_tt_buffer_complete)(struct usb_hcd *,
246 struct usb_host_endpoint *);
247
248 /* xHCI specific functions */
249 /* Called by usb_alloc_dev to alloc HC device structures */
250 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
251 /* Called by usb_release_dev to free HC device structures */
252 void (*free_dev)(struct usb_hcd *, struct usb_device *);
253
254 /* Bandwidth computation functions */
255 /* Note that add_endpoint() can only be called once per endpoint before
256 * check_bandwidth() or reset_bandwidth() must be called.
257 * drop_endpoint() can only be called once per endpoint also.
258 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
259 * add the endpoint to the schedule with possibly new parameters denoted by a
260 * different endpoint descriptor in usb_host_endpoint.
261 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
262 * not allowed.
263 */
264 /* Allocate endpoint resources and add them to a new schedule */
265 int (*add_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
266 /* Drop an endpoint from a new schedule */
267 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
268 /* Check that a new hardware configuration, set using
269 * endpoint_enable and endpoint_disable, does not exceed bus
270 * bandwidth. This must be called before any set configuration
271 * or set interface requests are sent to the device.
272 */
273 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
274 /* Reset the device schedule to the last known good schedule,
275 * which was set from a previous successful call to
276 * check_bandwidth(). This reverts any add_endpoint() and
277 * drop_endpoint() calls since that last successful call.
278 * Used for when a check_bandwidth() call fails due to resource
279 * or bandwidth constraints.
280 */
281 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
282 /* Returns the hardware-chosen device address */
283 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
284 /* Notifies the HCD after a hub descriptor is fetched.
285 * Will block.
286 */
287 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
288 struct usb_tt *tt, gfp_t mem_flags);
289};
290
291extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
292extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
293 int status);
294extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
295
296extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
297extern int usb_hcd_unlink_urb(struct urb *urb, int status);
298extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
299 int status);
300extern void usb_hcd_flush_endpoint(struct usb_device *udev,
301 struct usb_host_endpoint *ep);
302extern void usb_hcd_disable_endpoint(struct usb_device *udev,
303 struct usb_host_endpoint *ep);
304extern void usb_hcd_reset_endpoint(struct usb_device *udev,
305 struct usb_host_endpoint *ep);
306extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
307extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
308 struct usb_host_config *new_config,
309 struct usb_host_interface *old_alt,
310 struct usb_host_interface *new_alt);
311extern int usb_hcd_get_frame_number(struct usb_device *udev);
312
313extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
314 struct device *dev, const char *bus_name);
315extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
316extern void usb_put_hcd(struct usb_hcd *hcd);
317extern int usb_add_hcd(struct usb_hcd *hcd,
318 unsigned int irqnum, unsigned long irqflags);
319extern void usb_remove_hcd(struct usb_hcd *hcd);
320
321struct platform_device;
322extern void usb_hcd_platform_shutdown(struct platform_device *dev);
323
324#ifdef CONFIG_PCI
325struct pci_dev;
326struct pci_device_id;
327extern int usb_hcd_pci_probe(struct pci_dev *dev,
328 const struct pci_device_id *id);
329extern void usb_hcd_pci_remove(struct pci_dev *dev);
330extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
331
332#ifdef CONFIG_PM_SLEEP
333extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
334#endif
335#endif /* CONFIG_PCI */
336
337/* pci-ish (pdev null is ok) buffer alloc/mapping support */
338int hcd_buffer_create(struct usb_hcd *hcd);
339void hcd_buffer_destroy(struct usb_hcd *hcd);
340
341void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
342 gfp_t mem_flags, dma_addr_t *dma);
343void hcd_buffer_free(struct usb_bus *bus, size_t size,
344 void *addr, dma_addr_t dma);
345
346/* generic bus glue, needed for host controllers that don't use PCI */
347extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
348
349extern void usb_hc_died(struct usb_hcd *hcd);
350extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
351
352/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
353#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
354#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
355#define usb_settoggle(dev, ep, out, bit) \
356 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
357 ((bit) << (ep)))
358
359/* -------------------------------------------------------------------------- */
360
361/* Enumeration is only for the hub driver, or HCD virtual root hubs */
362extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
363 struct usb_bus *, unsigned port);
364extern int usb_new_device(struct usb_device *dev);
365extern void usb_disconnect(struct usb_device **);
366
367extern int usb_get_configuration(struct usb_device *dev);
368extern void usb_destroy_configuration(struct usb_device *dev);
369
370/*-------------------------------------------------------------------------*/
371
372/*
373 * HCD Root Hub support
374 */
375
376#include "hub.h"
377
378/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
379#define DeviceRequest \
380 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
381#define DeviceOutRequest \
382 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
383
384#define InterfaceRequest \
385 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
386
387#define EndpointRequest \
388 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
389#define EndpointOutRequest \
390 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
391
392/* class requests from the USB 2.0 hub spec, table 11-15 */
393/* GetBusState and SetHubDescriptor are optional, omitted */
394#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
395#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
396#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
397#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
398#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
399#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
400#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
401
402
403/*-------------------------------------------------------------------------*/
404
405/*
406 * Generic bandwidth allocation constants/support
407 */
408#define FRAME_TIME_USECS 1000L
409#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
410 /* Trying not to use worst-case bit-stuffing
411 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
412 /* bytecount = data payload byte count */
413
414#define NS_TO_US(ns) ((ns + 500L) / 1000L)
415 /* convert & round nanoseconds to microseconds */
416
417
418/*
419 * Full/low speed bandwidth allocation constants/support.
420 */
421#define BW_HOST_DELAY 1000L /* nanoseconds */
422#define BW_HUB_LS_SETUP 333L /* nanoseconds */
423 /* 4 full-speed bit times (est.) */
424
425#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
426#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
427#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
428
429/*
430 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
431 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
432 * to preallocate bandwidth)
433 */
434#define USB2_HOST_DELAY 5 /* nsec, guess */
435#define HS_NSECS(bytes) (((55 * 8 * 2083) \
436 + (2083UL * (3 + BitTime(bytes))))/1000 \
437 + USB2_HOST_DELAY)
438#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
439 + (2083UL * (3 + BitTime(bytes))))/1000 \
440 + USB2_HOST_DELAY)
441#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
442#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
443
444extern long usb_calc_bus_time(int speed, int is_input,
445 int isoc, int bytecount);
446
447/*-------------------------------------------------------------------------*/
448
449extern void usb_set_device_state(struct usb_device *udev,
450 enum usb_device_state new_state);
451
452/*-------------------------------------------------------------------------*/
453
454/* exported only within usbcore */
455
456extern struct list_head usb_bus_list;
457extern struct mutex usb_bus_list_lock;
458extern wait_queue_head_t usb_kill_urb_queue;
459
460extern int usb_find_interface_driver(struct usb_device *dev,
461 struct usb_interface *interface);
462
463#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
464
465#ifdef CONFIG_PM
466extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
467extern void usb_root_hub_lost_power(struct usb_device *rhdev);
468extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
469extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
470#else
471static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
472{
473 return;
474}
475#endif /* CONFIG_PM */
476
477/*
478 * USB device fs stuff
479 */
480
481#ifdef CONFIG_USB_DEVICEFS
482
483/*
484 * these are expected to be called from the USB core/hub thread
485 * with the kernel lock held
486 */
487extern void usbfs_update_special(void);
488extern int usbfs_init(void);
489extern void usbfs_cleanup(void);
490
491#else /* CONFIG_USB_DEVICEFS */
492
493static inline void usbfs_update_special(void) {}
494static inline int usbfs_init(void) { return 0; }
495static inline void usbfs_cleanup(void) { }
496
497#endif /* CONFIG_USB_DEVICEFS */
498
499/*-------------------------------------------------------------------------*/
500
501#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
502
503struct usb_mon_operations {
504 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
505 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
506 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
507 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
508};
509
510extern struct usb_mon_operations *mon_ops;
511
512static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
513{
514 if (bus->monitored)
515 (*mon_ops->urb_submit)(bus, urb);
516}
517
518static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
519 int error)
520{
521 if (bus->monitored)
522 (*mon_ops->urb_submit_error)(bus, urb, error);
523}
524
525static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
526 int status)
527{
528 if (bus->monitored)
529 (*mon_ops->urb_complete)(bus, urb, status);
530}
531
532int usb_mon_register(struct usb_mon_operations *ops);
533void usb_mon_deregister(void);
534
535#else
536
537static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
538static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
539 int error) {}
540static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
541 int status) {}
542
543#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
544
545/*-------------------------------------------------------------------------*/
546
547/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
548/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
549#define bitmap DeviceRemovable
550
551
552/*-------------------------------------------------------------------------*/
553
554/* random stuff */
555
556#define RUN_CONTEXT (in_irq() ? "in_irq" \
557 : (in_interrupt() ? "in_interrupt" : "can sleep"))
558
559
560/* This rwsem is for use only by the hub driver and ehci-hcd.
561 * Nobody else should touch it.
562 */
563extern struct rw_semaphore ehci_cf_port_reset_rwsem;
564
565/* Keep track of which host controller drivers are loaded */
566#define USB_UHCI_LOADED 0
567#define USB_OHCI_LOADED 1
568#define USB_EHCI_LOADED 2
569extern unsigned long usb_hcds_loaded;
570
571#endif /* __KERNEL__ */
572
573#endif /* __USB_CORE_HCD_H */