blob: 2dcde61c465e0176d44a418cfdc038666556579c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Alan Stern32fe0192007-10-10 16:27:07 -040022#include <linux/rwsem.h>
23
Felipe Balbi38f3ad52008-06-12 10:49:47 +030024#define MAX_TOPO_LEVEL 6
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/* 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 */
David Brownelldbe0dbb2008-02-10 12:24:00 -080033#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#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.
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -070058 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 */
65
66/*-------------------------------------------------------------------------*/
67
Alan Stern17200582006-08-30 11:32:52 -040068struct usb_hcd {
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 /*
71 * housekeeping
72 */
73 struct usb_bus self; /* hcd is-a bus */
Alan Stern17200582006-08-30 11:32:52 -040074 struct kref kref; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76 const char *product_desc; /* product/vendor string */
77 char irq_descr[24]; /* driver + bus # */
78
Alan Sternd5926ae72005-04-21 15:56:37 -040079 struct timer_list rh_timer; /* drives root-hub polling */
80 struct urb *status_urb; /* the current status urb */
Alan Stern6b157c92007-03-13 16:37:30 -040081#ifdef CONFIG_PM
82 struct work_struct wakeup_work; /* for remote wakeup */
83#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 /*
86 * hardware info/state
87 */
88 const struct hc_driver *driver; /* hw-specific hooks */
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +110089
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 unsigned rh_registered:1;/* is root hub registered? */
96
Alan Sternd5926ae72005-04-21 15:56:37 -040097 /* 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? */
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -0700102 unsigned wireless:1; /* Wireless USB HCD */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700103 unsigned authorized_default:1;
Alan Stern7329e212008-04-03 18:02:56 -0400104 unsigned has_tt:1; /* Integrated TT in root hub */
Alan Sternd5926ae72005-04-21 15:56:37 -0400105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 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 */
Alan Stern7d35b922005-04-25 11:18:32 -0400110 unsigned power_budget; /* in mA, 0 = no limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
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;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800131 * input size of periodic table to an interrupt scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * (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]
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800139 __attribute__ ((aligned(sizeof(unsigned long))));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
142/* 2.4 does this a bit differently ... */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800143static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
145 return &hcd->self;
146}
147
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800148static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
Alan Stern17200582006-08-30 11:32:52 -0400149{
150 return container_of(bus, struct usb_hcd, self);
151}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153struct hcd_timeout { /* timeouts we allocate */
154 struct list_head timeout_list;
155 struct timer_list timer;
156};
157
158/*-------------------------------------------------------------------------*/
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161struct 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 */
David Howells7d12e782006-10-05 14:55:46 +0100167 irqreturn_t (*irq) (struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 int flags;
170#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
Magnus Dammb3476672008-01-23 15:58:35 +0900171#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172#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
David Brownell5f827ea2005-09-22 22:38:16 -0700180 * a whole, not just the root hub; they're for PCI bus glue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 */
David Brownell5f827ea2005-09-22 22:38:16 -0700182 /* called after suspending the hub, before entering D3 etc */
Alan Stern7be7d742008-04-03 18:03:06 -0400183 int (*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
David Brownell5f827ea2005-09-22 22:38:16 -0700185 /* called after entering D0 (etc), before resuming the hub */
Alan Stern7be7d742008-04-03 18:03:06 -0400186 int (*pci_resume) (struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 /* cleanly make HCD stop writing memory and doing I/O */
189 void (*stop) (struct usb_hcd *hcd);
190
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700191 /* shutdown HCD */
192 void (*shutdown) (struct usb_hcd *hcd);
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 /* return current frame number */
195 int (*get_frame_number) (struct usb_hcd *hcd);
196
197 /* manage i/o requests, device state */
Alan Sterne9df41c2007-08-08 11:48:02 -0400198 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
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 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800208 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
209 int (*hub_control) (struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 u16 typeReq, u16 wValue, u16 wIndex,
211 char *buf, u16 wLength);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800212 int (*bus_suspend)(struct usb_hcd *);
213 int (*bus_resume)(struct usb_hcd *);
214 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
Balaji Rao90da0962007-11-22 01:58:14 +0530215
216 /* force handover of high-speed port to full-speed companion */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800217 void (*relinquish_port)(struct usb_hcd *, int);
Alan Stern3a311552008-05-20 16:58:29 -0400218 /* has a port been handed over to a companion? */
219 int (*port_handed_over)(struct usb_hcd *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220};
221
Alan Sterne9df41c2007-08-08 11:48:02 -0400222extern 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
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800227extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
228extern int usb_hcd_unlink_urb(struct urb *urb, int status);
Alan Stern4a000272007-08-24 15:42:24 -0400229extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
230 int status);
Alan Stern95cf82f2007-09-10 11:33:05 -0400231extern 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,
Alan Sterna6d2bb92006-08-30 11:27:36 -0400234 struct usb_host_endpoint *ep);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800235extern int usb_hcd_get_frame_number(struct usb_device *udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800237extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700238 struct device *dev, const char *bus_name);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800239extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
240extern void usb_put_hcd(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241extern int usb_add_hcd(struct usb_hcd *hcd,
242 unsigned int irqnum, unsigned long irqflags);
243extern void usb_remove_hcd(struct usb_hcd *hcd);
244
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700245struct platform_device;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800246extern void usb_hcd_platform_shutdown(struct platform_device *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#ifdef CONFIG_PCI
249struct pci_dev;
250struct pci_device_id;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800251extern int usb_hcd_pci_probe(struct pci_dev *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 const struct pci_device_id *id);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800253extern void usb_hcd_pci_remove(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255#ifdef CONFIG_PM
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800256extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t state);
257extern int usb_hcd_pci_resume(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#endif /* CONFIG_PM */
259
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800260extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#endif /* CONFIG_PCI */
263
264/* pci-ish (pdev null is ok) buffer alloc/mapping support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800265int hcd_buffer_create(struct usb_hcd *hcd);
266void hcd_buffer_destroy(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800268void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
Al Viro55016f12005-10-21 03:21:58 -0400269 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800270void hcd_buffer_free(struct usb_bus *bus, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 void *addr, dma_addr_t dma);
272
273/* generic bus glue, needed for host controllers that don't use PCI */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800274extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400275
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800276extern void usb_hc_died(struct usb_hcd *hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400277extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279/* -------------------------------------------------------------------------- */
280
281/* Enumeration is only for the hub driver, or HCD virtual root hubs */
282extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
283 struct usb_bus *, unsigned port);
284extern int usb_new_device(struct usb_device *dev);
285extern void usb_disconnect(struct usb_device **);
286
287extern int usb_get_configuration(struct usb_device *dev);
288extern void usb_destroy_configuration(struct usb_device *dev);
289
290/*-------------------------------------------------------------------------*/
291
292/*
293 * HCD Root Hub support
294 */
295
296#include "hub.h"
297
298/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
299#define DeviceRequest \
300 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
301#define DeviceOutRequest \
302 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
303
304#define InterfaceRequest \
305 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
306
307#define EndpointRequest \
308 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
309#define EndpointOutRequest \
310 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
311
312/* class requests from the USB 2.0 hub spec, table 11-15 */
313/* GetBusState and SetHubDescriptor are optional, omitted */
314#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
315#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
316#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
317#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
318#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
319#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
320#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
321
322
323/*-------------------------------------------------------------------------*/
324
325/*
326 * Generic bandwidth allocation constants/support
327 */
328#define FRAME_TIME_USECS 1000L
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800329#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 /* Trying not to use worst-case bit-stuffing
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800331 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 /* bytecount = data payload byte count */
333
334#define NS_TO_US(ns) ((ns + 500L) / 1000L)
335 /* convert & round nanoseconds to microseconds */
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338/*
339 * Full/low speed bandwidth allocation constants/support.
340 */
341#define BW_HOST_DELAY 1000L /* nanoseconds */
342#define BW_HUB_LS_SETUP 333L /* nanoseconds */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800343 /* 4 full-speed bit times (est.) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800345#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
347#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/*
Dan Streetman498f78e2005-07-29 12:18:28 -0700350 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
352 * to preallocate bandwidth)
353 */
354#define USB2_HOST_DELAY 5 /* nsec, guess */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800355#define HS_NSECS(bytes) (((55 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700356 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 + USB2_HOST_DELAY)
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800358#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700359 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 + USB2_HOST_DELAY)
Dan Streetman498f78e2005-07-29 12:18:28 -0700361#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
362#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800364extern long usb_calc_bus_time(int speed, int is_input,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int isoc, int bytecount);
366
367/*-------------------------------------------------------------------------*/
368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369extern void usb_set_device_state(struct usb_device *udev,
370 enum usb_device_state new_state);
371
372/*-------------------------------------------------------------------------*/
373
374/* exported only within usbcore */
375
376extern struct list_head usb_bus_list;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100377extern struct mutex usb_bus_list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378extern wait_queue_head_t usb_kill_urb_queue;
379
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800380extern int usb_find_interface_driver(struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 struct usb_interface *interface);
382
383#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
384
Alan Stern0c0382e2005-10-13 17:08:02 -0400385#ifdef CONFIG_PM
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800386extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
387extern void usb_root_hub_lost_power(struct usb_device *rhdev);
Alan Stern686314c2007-05-30 15:34:36 -0400388extern int hcd_bus_suspend(struct usb_device *rhdev);
389extern int hcd_bus_resume(struct usb_device *rhdev);
Alan Stern0c0382e2005-10-13 17:08:02 -0400390#else
Andrew Mortondb2d55b2005-10-23 23:04:25 -0700391static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
392{
393 return;
394}
Alan Stern0c0382e2005-10-13 17:08:02 -0400395#endif /* CONFIG_PM */
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397/*
398 * USB device fs stuff
399 */
400
401#ifdef CONFIG_USB_DEVICEFS
402
403/*
404 * these are expected to be called from the USB core/hub thread
405 * with the kernel lock held
406 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800407extern void usbfs_update_special(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408extern int usbfs_init(void);
409extern void usbfs_cleanup(void);
410
411#else /* CONFIG_USB_DEVICEFS */
412
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800413static inline void usbfs_update_special(void) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414static inline int usbfs_init(void) { return 0; }
415static inline void usbfs_cleanup(void) { }
416
417#endif /* CONFIG_USB_DEVICEFS */
418
419/*-------------------------------------------------------------------------*/
420
Adrian Bunk4749f322005-06-23 11:36:56 +0200421#if defined(CONFIG_USB_MON)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423struct usb_mon_operations {
424 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
425 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
Alan Stern9347d512007-08-24 15:41:41 -0400426 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428};
429
430extern struct usb_mon_operations *mon_ops;
431
432static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
433{
434 if (bus->monitored)
435 (*mon_ops->urb_submit)(bus, urb);
436}
437
438static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
439 int error)
440{
441 if (bus->monitored)
442 (*mon_ops->urb_submit_error)(bus, urb, error);
443}
444
Alan Stern9347d512007-08-24 15:41:41 -0400445static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
446 int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447{
448 if (bus->monitored)
Alan Stern9347d512007-08-24 15:41:41 -0400449 (*mon_ops->urb_complete)(bus, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452int usb_mon_register(struct usb_mon_operations *ops);
453void usb_mon_deregister(void);
454
455#else
456
457static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
458static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
459 int error) {}
Alan Stern9347d512007-08-24 15:41:41 -0400460static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
461 int status) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463#endif /* CONFIG_USB_MON */
464
465/*-------------------------------------------------------------------------*/
466
467/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800468/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469#define bitmap DeviceRemovable
470
471
472/*-------------------------------------------------------------------------*/
473
474/* random stuff */
475
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800476#define RUN_CONTEXT (in_irq() ? "in_irq" \
477 : (in_interrupt() ? "in_interrupt" : "can sleep"))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479
Alan Stern32fe0192007-10-10 16:27:07 -0400480/* This rwsem is for use only by the hub driver and ehci-hcd.
481 * Nobody else should touch it.
482 */
483extern struct rw_semaphore ehci_cf_port_reset_rwsem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Alan Stern9beeee62008-10-02 11:48:13 -0400485/* Keep track of which host controller drivers are loaded */
486#define USB_UHCI_LOADED 0
487#define USB_OHCI_LOADED 1
488#define USB_EHCI_LOADED 2
489extern unsigned long usb_hcds_loaded;
490
Alan Stern32fe0192007-10-10 16:27:07 -0400491#endif /* __KERNEL__ */