projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4
[deliverable/linux.git] / drivers / usb / core / hcd.h
CommitLineData
1da177e4
LT		 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
20#ifdef __KERNEL__
21
32fe0198
AS		 22#include <linux/rwsem.h>
23
38f3ad5e
FB		 24#define MAX_TOPO_LEVEL 6
25
1da177e4
LT		 26/* This file contains declarations of usbcore internals that are mostly
27 * used or exposed by Host Controller Drivers.
28 */
29
30/*
31 * USB Packet IDs (PIDs)
32 */
dbe0dbb7 33#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
1da177e4
LT		 34#define USB_PID_OUT 0xe1
35#define USB_PID_ACK 0xd2
36#define USB_PID_DATA0 0xc3
37#define USB_PID_PING 0xb4 /* USB 2.0 */
38#define USB_PID_SOF 0xa5
39#define USB_PID_NYET 0x96 /* USB 2.0 */
40#define USB_PID_DATA2 0x87 /* USB 2.0 */
41#define USB_PID_SPLIT 0x78 /* USB 2.0 */
42#define USB_PID_IN 0x69
43#define USB_PID_NAK 0x5a
44#define USB_PID_DATA1 0x4b
45#define USB_PID_PREAMBLE 0x3c /* Token mode */
46#define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
47#define USB_PID_SETUP 0x2d
48#define USB_PID_STALL 0x1e
49#define USB_PID_MDATA 0x0f /* USB 2.0 */
50
51/*-------------------------------------------------------------------------*/
52
53/*
54 * USB Host Controller Driver (usb_hcd) framework
55 *
56 * Since "struct usb_bus" is so thin, you can't share much code in it.
57 * This framework is a layer over that, and should be more sharable.
5234ce1b
IPG		 58 *
59 * @authorized_default: Specifies if new devices are authorized to
60 * connect by default or they require explicit
61 * user space authorization; this bit is settable
62 * through /sys/class/usb_host/X/authorized_default.
63 * For the rest is RO, so we don't lock to r/w it.
1da177e4
LT		 64 */
65
66/*-------------------------------------------------------------------------*/
67
17200583 68struct usb_hcd {
1da177e4
LT		 69
70 /*
71 * housekeeping
72 */
73 struct usb_bus self; /* hcd is-a bus */
17200583 74 struct kref kref; /* reference counter */
1da177e4
LT		 75
76 const char *product_desc; /* product/vendor string */
77 char irq_descr[24]; /* driver + bus # */
78
d5926ae7
AS		 79 struct timer_list rh_timer; /* drives root-hub polling */
80 struct urb *status_urb; /* the current status urb */
6b157c9b
AS		 81#ifdef CONFIG_PM
82 struct work_struct wakeup_work; /* for remote wakeup */
83#endif
1da177e4
LT		 84
85 /*
86 * hardware info/state
87 */
88 const struct hc_driver *driver; /* hw-specific hooks */
8de98402
BH		 89
90 /* Flags that need to be manipulated atomically */
91 unsigned long flags;
92#define HCD_FLAG_HW_ACCESSIBLE 0x00000001
93#define HCD_FLAG_SAW_IRQ 0x00000002
94
1da177e4
LT		 95 unsigned rh_registered:1;/* is root hub registered? */
96
d5926ae7
AS		 97 /* The next flag is a stopgap, to be removed when all the HCDs
98 * support the new root-hub polling mechanism. */
99 unsigned uses_new_polling:1;
100 unsigned poll_rh:1; /* poll for rh status? */
101 unsigned poll_pending:1; /* status has changed? */
0165de09 102 unsigned wireless:1; /* Wireless USB HCD */
5234ce1b 103 unsigned authorized_default:1;
7329e211 104 unsigned has_tt:1; /* Integrated TT in root hub */
d5926ae7 105
1da177e4
LT		 106 int irq; /* irq allocated */
107 void __iomem *regs; /* device memory/io */
108 u64 rsrc_start; /* memory/io resource start */
109 u64 rsrc_len; /* memory/io resource length */
7d35b929 110 unsigned power_budget; /* in mA, 0 = no limit */
1da177e4
LT		 111
112#define HCD_BUFFER_POOLS 4
113 struct dma_pool *pool [HCD_BUFFER_POOLS];
114
115 int state;
116# define __ACTIVE 0x01
117# define __SUSPEND 0x04
118# define __TRANSIENT 0x80
119
120# define HC_STATE_HALT 0
121# define HC_STATE_RUNNING (__ACTIVE)
122# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
123# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
124# define HC_STATE_SUSPENDED (__SUSPEND)
125
126#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
127#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
128
129 /* more shared queuing code would be good; it should support
130 * smarter scheduling, handle transaction translators, etc;
84cca820 131 * input size of periodic table to an interrupt scheduler.
1da177e4
LT		 132 * (ohci 32, uhci 1024, ehci 256/512/1024).
133 */
134
135 /* The HC driver's private data is stored at the end of
136 * this structure.
137 */
138 unsigned long hcd_priv[0]
84cca820 139 __attribute__ ((aligned(sizeof(unsigned long))));
1da177e4
LT		 140};
141
142/* 2.4 does this a bit differently ... */
84cca820 143static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
1da177e4
LT		 144{
145 return &hcd->self;
146}
147
84cca820 148static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
17200583
AS		 149{
150 return container_of(bus, struct usb_hcd, self);
151}
1da177e4
LT		 152
153struct hcd_timeout { /* timeouts we allocate */
154 struct list_head timeout_list;
155 struct timer_list timer;
156};
157
158/*-------------------------------------------------------------------------*/
159
1da177e4 160
1da177e4
LT		 161struct hc_driver {
162 const char *description; /* "ehci-hcd" etc */
163 const char *product_desc; /* product/vendor string */
164 size_t hcd_priv_size; /* size of private data */
165
166 /* irq handler */
7d12e780 167 irqreturn_t (*irq) (struct usb_hcd *hcd);
1da177e4
LT		 168
169 int flags;
170#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
b3476675 171#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
1da177e4
LT		 172#define HCD_USB11 0x0010 /* USB 1.1 */
173#define HCD_USB2 0x0020 /* USB 2.0 */
174
175 /* called to init HCD and root hub */
176 int (*reset) (struct usb_hcd *hcd);
177 int (*start) (struct usb_hcd *hcd);
178
179 /* NOTE: these suspend/resume calls relate to the HC as
5f827ea3 180 * a whole, not just the root hub; they're for PCI bus glue.
1da177e4 181 */
5f827ea3 182 /* called after suspending the hub, before entering D3 etc */
7be7d741 183 int (*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);
1da177e4 184
5f827ea3 185 /* called after entering D0 (etc), before resuming the hub */
7be7d741 186 int (*pci_resume) (struct usb_hcd *hcd);
1da177e4
LT		 187
188 /* cleanly make HCD stop writing memory and doing I/O */
189 void (*stop) (struct usb_hcd *hcd);
190
64a21d02
AG		 191 /* shutdown HCD */
192 void (*shutdown) (struct usb_hcd *hcd);
193
1da177e4
LT		 194 /* return current frame number */
195 int (*get_frame_number) (struct usb_hcd *hcd);
196
197 /* manage i/o requests, device state */
e9df41c5
AS		 198 int (*urb_enqueue)(struct usb_hcd *hcd,
199 struct urb *urb, gfp_t mem_flags);
200 int (*urb_dequeue)(struct usb_hcd *hcd,
201 struct urb *urb, int status);
1da177e4
LT		 202
203 /* hw synch, freeing endpoint resources that urb_dequeue can't */
204 void (*endpoint_disable)(struct usb_hcd *hcd,
205 struct usb_host_endpoint *ep);
206
207 /* root hub support */
84cca820
GKH		 208 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
209 int (*hub_control) (struct usb_hcd *hcd,
1da177e4
LT		 210 u16 typeReq, u16 wValue, u16 wIndex,
211 char *buf, u16 wLength);
84cca820
GKH		 212 int (*bus_suspend)(struct usb_hcd *);
213 int (*bus_resume)(struct usb_hcd *);
214 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
90da096e
BR		 215
216 /* force handover of high-speed port to full-speed companion */
84cca820 217 void (*relinquish_port)(struct usb_hcd *, int);
3a31155c
AS		 218 /* has a port been handed over to a companion? */
219 int (*port_handed_over)(struct usb_hcd *, int);
1da177e4
LT		 220};
221
e9df41c5
AS		 222extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
223extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
224 int status);
225extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
226
84cca820
GKH		 227extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
228extern int usb_hcd_unlink_urb(struct urb *urb, int status);
4a00027d
AS		 229extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
230 int status);
95cf82f9
AS		 231extern void usb_hcd_flush_endpoint(struct usb_device *udev,
232 struct usb_host_endpoint *ep);
233extern void usb_hcd_disable_endpoint(struct usb_device *udev,
a6d2bb9f 234 struct usb_host_endpoint *ep);
cde217a5 235extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
84cca820 236extern int usb_hcd_get_frame_number(struct usb_device *udev);
1da177e4 237
84cca820 238extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
1b26da15 239 struct device *dev, const char *bus_name);
84cca820
GKH		 240extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
241extern void usb_put_hcd(struct usb_hcd *hcd);
1da177e4
LT		 242extern int usb_add_hcd(struct usb_hcd *hcd,
243 unsigned int irqnum, unsigned long irqflags);
244extern void usb_remove_hcd(struct usb_hcd *hcd);
245
64a21d02 246struct platform_device;
84cca820 247extern void usb_hcd_platform_shutdown(struct platform_device *dev);
64a21d02 248
1da177e4
LT		 249#ifdef CONFIG_PCI
250struct pci_dev;
251struct pci_device_id;
84cca820 252extern int usb_hcd_pci_probe(struct pci_dev *dev,
1da177e4 253 const struct pci_device_id *id);
84cca820 254extern void usb_hcd_pci_remove(struct pci_dev *dev);
1da177e4
LT		 255
256#ifdef CONFIG_PM
84cca820
GKH		 257extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t state);
258extern int usb_hcd_pci_resume(struct pci_dev *dev);
1da177e4
LT		 259#endif /* CONFIG_PM */
260
84cca820 261extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
64a21d02 262
1da177e4
LT		 263#endif /* CONFIG_PCI */
264
265/* pci-ish (pdev null is ok) buffer alloc/mapping support */
84cca820
GKH		 266int hcd_buffer_create(struct usb_hcd *hcd);
267void hcd_buffer_destroy(struct usb_hcd *hcd);
1da177e4 268
84cca820 269void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
55016f10 270 gfp_t mem_flags, dma_addr_t *dma);
84cca820 271void hcd_buffer_free(struct usb_bus *bus, size_t size,
1da177e4
LT		 272 void *addr, dma_addr_t dma);
273
274/* generic bus glue, needed for host controllers that don't use PCI */
84cca820 275extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
d5926ae7 276
84cca820 277extern void usb_hc_died(struct usb_hcd *hcd);
d5926ae7 278extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4
LT		 279
280/* -------------------------------------------------------------------------- */
281
282/* Enumeration is only for the hub driver, or HCD virtual root hubs */
283extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
284 struct usb_bus *, unsigned port);
285extern int usb_new_device(struct usb_device *dev);
286extern void usb_disconnect(struct usb_device **);
287
288extern int usb_get_configuration(struct usb_device *dev);
289extern void usb_destroy_configuration(struct usb_device *dev);
290
291/*-------------------------------------------------------------------------*/
292
293/*
294 * HCD Root Hub support
295 */
296
297#include "hub.h"
298
299/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
300#define DeviceRequest \
301 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
302#define DeviceOutRequest \
303 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
304
305#define InterfaceRequest \
306 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
307
308#define EndpointRequest \
309 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
310#define EndpointOutRequest \
311 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
312
313/* class requests from the USB 2.0 hub spec, table 11-15 */
314/* GetBusState and SetHubDescriptor are optional, omitted */
315#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
316#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
317#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
318#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
319#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
320#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
321#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
322
323
324/*-------------------------------------------------------------------------*/
325
326/*
327 * Generic bandwidth allocation constants/support
328 */
329#define FRAME_TIME_USECS 1000L
84cca820 330#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
1da177e4 331 /* Trying not to use worst-case bit-stuffing
84cca820 332 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
1da177e4
LT		 333 /* bytecount = data payload byte count */
334
335#define NS_TO_US(ns) ((ns + 500L) / 1000L)
336 /* convert & round nanoseconds to microseconds */
337
1da177e4
LT		 338
339/*
340 * Full/low speed bandwidth allocation constants/support.
341 */
342#define BW_HOST_DELAY 1000L /* nanoseconds */
343#define BW_HUB_LS_SETUP 333L /* nanoseconds */
84cca820 344 /* 4 full-speed bit times (est.) */
1da177e4 345
84cca820 346#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
1da177e4
LT		 347#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
348#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
349
1da177e4 350/*
498f78e6 351 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4
LT		 352 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
353 * to preallocate bandwidth)
354 */
355#define USB2_HOST_DELAY 5 /* nsec, guess */
84cca820 356#define HS_NSECS(bytes) (((55 * 8 * 2083) \
f956e7cd 357 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 358 + USB2_HOST_DELAY)
84cca820 359#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
f956e7cd 360 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 361 + USB2_HOST_DELAY)
498f78e6
DS		 362#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
363#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
1da177e4 364
84cca820 365extern long usb_calc_bus_time(int speed, int is_input,
1da177e4
LT		 366 int isoc, int bytecount);
367
368/*-------------------------------------------------------------------------*/
369
1da177e4
LT		 370extern void usb_set_device_state(struct usb_device *udev,
371 enum usb_device_state new_state);
372
373/*-------------------------------------------------------------------------*/
374
375/* exported only within usbcore */
376
377extern struct list_head usb_bus_list;
4186ecf8 378extern struct mutex usb_bus_list_lock;
1da177e4
LT		 379extern wait_queue_head_t usb_kill_urb_queue;
380
84cca820 381extern int usb_find_interface_driver(struct usb_device *dev,
1da177e4
LT		 382 struct usb_interface *interface);
383
384#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
385
0c0382e3 386#ifdef CONFIG_PM
84cca820
GKH		 387extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
388extern void usb_root_hub_lost_power(struct usb_device *rhdev);
686314cf
AS		 389extern int hcd_bus_suspend(struct usb_device *rhdev);
390extern int hcd_bus_resume(struct usb_device *rhdev);
0c0382e3 391#else
db2d55b7
AM		 392static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
393{
394 return;
395}
0c0382e3
AS		 396#endif /* CONFIG_PM */
397
1da177e4
LT		 398/*
399 * USB device fs stuff
400 */
401
402#ifdef CONFIG_USB_DEVICEFS
403
404/*
405 * these are expected to be called from the USB core/hub thread
406 * with the kernel lock held
407 */
84cca820 408extern void usbfs_update_special(void);
1da177e4
LT		 409extern int usbfs_init(void);
410extern void usbfs_cleanup(void);
411
412#else /* CONFIG_USB_DEVICEFS */
413
84cca820 414static inline void usbfs_update_special(void) {}
1da177e4
LT		 415static inline int usbfs_init(void) { return 0; }
416static inline void usbfs_cleanup(void) { }
417
418#endif /* CONFIG_USB_DEVICEFS */
419
420/*-------------------------------------------------------------------------*/
421
4749f32d 422#if defined(CONFIG_USB_MON)
1da177e4
LT		 423
424struct usb_mon_operations {
425 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
426 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
9347d51c 427 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
1da177e4 428 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
1da177e4
LT		 429};
430
431extern struct usb_mon_operations *mon_ops;
432
433static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
434{
435 if (bus->monitored)
436 (*mon_ops->urb_submit)(bus, urb);
437}
438
439static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
440 int error)
441{
442 if (bus->monitored)
443 (*mon_ops->urb_submit_error)(bus, urb, error);
444}
445
9347d51c
AS		 446static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
447 int status)
1da177e4
LT		 448{
449 if (bus->monitored)
9347d51c 450 (*mon_ops->urb_complete)(bus, urb, status);
1da177e4 451}
1da177e4
LT		 452
453int usb_mon_register(struct usb_mon_operations *ops);
454void usb_mon_deregister(void);
455
456#else
457
458static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
459static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
460 int error) {}
9347d51c
AS		 461static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
462 int status) {}
1da177e4
LT		 463
464#endif /* CONFIG_USB_MON */
465
466/*-------------------------------------------------------------------------*/
467
468/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
84cca820 469/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
1da177e4
LT		 470#define bitmap DeviceRemovable
471
472
473/*-------------------------------------------------------------------------*/
474
475/* random stuff */
476
84cca820
GKH		 477#define RUN_CONTEXT (in_irq() ? "in_irq" \
478 : (in_interrupt() ? "in_interrupt" : "can sleep"))
1da177e4
LT		 479
480
32fe0198
AS		 481/* This rwsem is for use only by the hub driver and ehci-hcd.
482 * Nobody else should touch it.
483 */
484extern struct rw_semaphore ehci_cf_port_reset_rwsem;
1da177e4 485
9beeee65
AS		 486/* Keep track of which host controller drivers are loaded */
487#define USB_UHCI_LOADED 0
488#define USB_OHCI_LOADED 1
489#define USB_EHCI_LOADED 2
490extern unsigned long usb_hcds_loaded;
491
32fe0198 492#endif /* __KERNEL__ */
Linux kernel - Deliverables
This page took 0.466892 seconds and 5 git commands to generate.