blob: 5de415707c234f0e54939195062b5dc39f0a1c06 [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
Anton Vorontsovaa459e62008-10-29 14:25:50 -070019#ifndef __USB_CORE_HCD_H
20#define __USB_CORE_HCD_H
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22#ifdef __KERNEL__
23
Alan Stern32fe0192007-10-10 16:27:07 -040024#include <linux/rwsem.h>
25
Felipe Balbi38f3ad52008-06-12 10:49:47 +030026#define MAX_TOPO_LEVEL 6
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/* 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 */
David Brownelldbe0dbb2008-02-10 12:24:00 -080035#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#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.
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -070060 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 */
67
68/*-------------------------------------------------------------------------*/
69
Alan Stern17200582006-08-30 11:32:52 -040070struct usb_hcd {
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72 /*
73 * housekeeping
74 */
75 struct usb_bus self; /* hcd is-a bus */
Alan Stern17200582006-08-30 11:32:52 -040076 struct kref kref; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78 const char *product_desc; /* product/vendor string */
Sarah Sharp83de4b22010-12-02 14:45:18 -080079 int speed; /* Speed for this roothub.
80 * May be different from
81 * hcd->driver->flags & HCD_MASK
82 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 char irq_descr[24]; /* driver + bus # */
84
Alan Sternd5926ae72005-04-21 15:56:37 -040085 struct timer_list rh_timer; /* drives root-hub polling */
86 struct urb *status_urb; /* the current status urb */
Alan Stern9bbdf1e2010-01-08 12:57:28 -050087#ifdef CONFIG_USB_SUSPEND
Alan Stern6b157c92007-03-13 16:37:30 -040088 struct work_struct wakeup_work; /* for remote wakeup */
89#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91 /*
92 * hardware info/state
93 */
94 const struct hc_driver *driver; /* hw-specific hooks */
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +110095
Alan Stern541c7d42010-06-22 16:39:10 -040096 /* Flags that need to be manipulated atomically because they can
97 * change while the host controller is running. Always use
98 * set_bit() or clear_bit() to change their values.
99 */
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100100 unsigned long flags;
Alan Stern541c7d42010-06-22 16:39:10 -0400101#define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
Alan Stern541c7d42010-06-22 16:39:10 -0400102#define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
103#define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
Alan Sternff2f0782010-06-25 14:02:35 -0400104#define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
Alan Stern9b375962011-03-07 11:11:52 -0500105#define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */
106#define HCD_FLAG_DEAD 6 /* controller has died? */
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100107
Alan Stern541c7d42010-06-22 16:39:10 -0400108 /* The flags can be tested using these macros; they are likely to
109 * be slightly faster than test_bit().
110 */
111#define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
Alan Stern541c7d42010-06-22 16:39:10 -0400112#define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
113#define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
Alan Sternff2f0782010-06-25 14:02:35 -0400114#define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
Alan Stern9b375962011-03-07 11:11:52 -0500115#define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
116#define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
Alan Stern541c7d42010-06-22 16:39:10 -0400117
118 /* Flags that get set only during HCD registration or removal. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 unsigned rh_registered:1;/* is root hub registered? */
Alan Stern6d88e672010-06-09 17:34:17 -0400120 unsigned rh_pollable:1; /* may we poll the root hub? */
Andiry Xu00292272010-12-27 17:39:02 +0800121 unsigned msix_enabled:1; /* driver has MSI-X enabled? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Alan Sternd5926ae72005-04-21 15:56:37 -0400123 /* The next flag is a stopgap, to be removed when all the HCDs
124 * support the new root-hub polling mechanism. */
125 unsigned uses_new_polling:1;
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -0700126 unsigned wireless:1; /* Wireless USB HCD */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700127 unsigned authorized_default:1;
Alan Stern7329e212008-04-03 18:02:56 -0400128 unsigned has_tt:1; /* Integrated TT in root hub */
Alan Sternd5926ae72005-04-21 15:56:37 -0400129
Felipe Balbicd704692012-02-29 16:46:23 +0200130 unsigned int irq; /* irq allocated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 void __iomem *regs; /* device memory/io */
132 u64 rsrc_start; /* memory/io resource start */
133 u64 rsrc_len; /* memory/io resource length */
Alan Stern7d35b922005-04-25 11:18:32 -0400134 unsigned power_budget; /* in mA, 0 = no limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800136 /* bandwidth_mutex should be taken before adding or removing
137 * any new bus bandwidth constraints:
138 * 1. Before adding a configuration for a new device.
139 * 2. Before removing the configuration to put the device into
140 * the addressed state.
141 * 3. Before selecting a different configuration.
142 * 4. Before selecting an alternate interface setting.
143 *
144 * bandwidth_mutex should be dropped after a successful control message
145 * to the device, or resetting the bandwidth after a failed attempt.
146 */
Sarah Sharpd673bfc2010-10-15 08:55:24 -0700147 struct mutex *bandwidth_mutex;
Sarah Sharpc5635432010-10-28 15:40:26 -0700148 struct usb_hcd *shared_hcd;
149 struct usb_hcd *primary_hcd;
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800150
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#define HCD_BUFFER_POOLS 4
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700153 struct dma_pool *pool[HCD_BUFFER_POOLS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155 int state;
156# define __ACTIVE 0x01
157# define __SUSPEND 0x04
158# define __TRANSIENT 0x80
159
160# define HC_STATE_HALT 0
161# define HC_STATE_RUNNING (__ACTIVE)
162# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
163# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
164# define HC_STATE_SUSPENDED (__SUSPEND)
165
166#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
167#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
168
169 /* more shared queuing code would be good; it should support
170 * smarter scheduling, handle transaction translators, etc;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800171 * input size of periodic table to an interrupt scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 * (ohci 32, uhci 1024, ehci 256/512/1024).
173 */
174
175 /* The HC driver's private data is stored at the end of
176 * this structure.
177 */
178 unsigned long hcd_priv[0]
Harro Haan276532b2011-10-10 14:38:27 +0200179 __attribute__ ((aligned(sizeof(s64))));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180};
181
182/* 2.4 does this a bit differently ... */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800183static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
185 return &hcd->self;
186}
187
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800188static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
Alan Stern17200582006-08-30 11:32:52 -0400189{
190 return container_of(bus, struct usb_hcd, self);
191}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193struct hcd_timeout { /* timeouts we allocate */
194 struct list_head timeout_list;
195 struct timer_list timer;
196};
197
198/*-------------------------------------------------------------------------*/
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201struct hc_driver {
202 const char *description; /* "ehci-hcd" etc */
203 const char *product_desc; /* product/vendor string */
204 size_t hcd_priv_size; /* size of private data */
205
206 /* irq handler */
David Howells7d12e782006-10-05 14:55:46 +0100207 irqreturn_t (*irq) (struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209 int flags;
210#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
Magnus Dammb3476672008-01-23 15:58:35 +0900211#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
Sarah Sharpc5635432010-10-28 15:40:26 -0700212#define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213#define HCD_USB11 0x0010 /* USB 1.1 */
214#define HCD_USB2 0x0020 /* USB 2.0 */
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700215#define HCD_USB3 0x0040 /* USB 3.0 */
Sarah Sharp6b403b02009-04-27 19:54:10 -0700216#define HCD_MASK 0x0070
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 /* called to init HCD and root hub */
219 int (*reset) (struct usb_hcd *hcd);
220 int (*start) (struct usb_hcd *hcd);
221
222 /* NOTE: these suspend/resume calls relate to the HC as
David Brownell5f827ea2005-09-22 22:38:16 -0700223 * a whole, not just the root hub; they're for PCI bus glue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 */
David Brownell5f827ea2005-09-22 22:38:16 -0700225 /* called after suspending the hub, before entering D3 etc */
Alan Stern41472002010-06-25 14:02:14 -0400226 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
David Brownell5f827ea2005-09-22 22:38:16 -0700228 /* called after entering D0 (etc), before resuming the hub */
Alan Stern6ec4beb2009-04-27 13:33:41 -0400229 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231 /* cleanly make HCD stop writing memory and doing I/O */
232 void (*stop) (struct usb_hcd *hcd);
233
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700234 /* shutdown HCD */
235 void (*shutdown) (struct usb_hcd *hcd);
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 /* return current frame number */
238 int (*get_frame_number) (struct usb_hcd *hcd);
239
240 /* manage i/o requests, device state */
Alan Sterne9df41c2007-08-08 11:48:02 -0400241 int (*urb_enqueue)(struct usb_hcd *hcd,
242 struct urb *urb, gfp_t mem_flags);
243 int (*urb_dequeue)(struct usb_hcd *hcd,
244 struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Robert Morell2694a482011-01-26 19:06:48 -0800246 /*
247 * (optional) these hooks allow an HCD to override the default DMA
248 * mapping and unmapping routines. In general, they shouldn't be
249 * necessary unless the host controller has special DMA requirements,
250 * such as alignment contraints. If these are not specified, the
251 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
252 * (and it may be a good idea to call these functions in your HCD
253 * implementation)
254 */
255 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
256 gfp_t mem_flags);
257 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 /* hw synch, freeing endpoint resources that urb_dequeue can't */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700260 void (*endpoint_disable)(struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 struct usb_host_endpoint *ep);
262
David Vrabel3444b262009-04-08 17:36:28 +0000263 /* (optional) reset any endpoint state such as sequence number
264 and current window */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700265 void (*endpoint_reset)(struct usb_hcd *hcd,
David Vrabel3444b262009-04-08 17:36:28 +0000266 struct usb_host_endpoint *ep);
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 /* root hub support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800269 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
270 int (*hub_control) (struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 u16 typeReq, u16 wValue, u16 wIndex,
272 char *buf, u16 wLength);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800273 int (*bus_suspend)(struct usb_hcd *);
274 int (*bus_resume)(struct usb_hcd *);
275 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
Balaji Rao90da0962007-11-22 01:58:14 +0530276
277 /* force handover of high-speed port to full-speed companion */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800278 void (*relinquish_port)(struct usb_hcd *, int);
Alan Stern3a311552008-05-20 16:58:29 -0400279 /* has a port been handed over to a companion? */
280 int (*port_handed_over)(struct usb_hcd *, int);
Sarah Sharpc6515272009-04-27 19:57:26 -0700281
Alan Sterncb88a1b2009-06-29 10:43:32 -0400282 /* CLEAR_TT_BUFFER completion callback */
283 void (*clear_tt_buffer_complete)(struct usb_hcd *,
284 struct usb_host_endpoint *);
285
Sarah Sharpc6515272009-04-27 19:57:26 -0700286 /* xHCI specific functions */
287 /* Called by usb_alloc_dev to alloc HC device structures */
288 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
Herbert Xuf7410ce2010-01-10 20:15:03 +1100289 /* Called by usb_disconnect to free HC device structures */
Sarah Sharpc6515272009-04-27 19:57:26 -0700290 void (*free_dev)(struct usb_hcd *, struct usb_device *);
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700291 /* Change a group of bulk endpoints to support multiple stream IDs */
292 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
293 struct usb_host_endpoint **eps, unsigned int num_eps,
294 unsigned int num_streams, gfp_t mem_flags);
295 /* Reverts a group of bulk endpoints back to not using stream IDs.
296 * Can fail if we run out of memory.
297 */
298 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
299 struct usb_host_endpoint **eps, unsigned int num_eps,
300 gfp_t mem_flags);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700301
302 /* Bandwidth computation functions */
303 /* Note that add_endpoint() can only be called once per endpoint before
304 * check_bandwidth() or reset_bandwidth() must be called.
305 * drop_endpoint() can only be called once per endpoint also.
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700306 * A call to xhci_drop_endpoint() followed by a call to
307 * xhci_add_endpoint() will add the endpoint to the schedule with
308 * possibly new parameters denoted by a different endpoint descriptor
309 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
310 * call to xhci_drop_endpoint() is not allowed.
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700311 */
312 /* Allocate endpoint resources and add them to a new schedule */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700313 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
314 struct usb_host_endpoint *);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700315 /* Drop an endpoint from a new schedule */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700316 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
317 struct usb_host_endpoint *);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700318 /* Check that a new hardware configuration, set using
319 * endpoint_enable and endpoint_disable, does not exceed bus
320 * bandwidth. This must be called before any set configuration
321 * or set interface requests are sent to the device.
322 */
323 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
324 /* Reset the device schedule to the last known good schedule,
325 * which was set from a previous successful call to
326 * check_bandwidth(). This reverts any add_endpoint() and
327 * drop_endpoint() calls since that last successful call.
328 * Used for when a check_bandwidth() call fails due to resource
329 * or bandwidth constraints.
330 */
331 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
Sarah Sharpc6515272009-04-27 19:57:26 -0700332 /* Returns the hardware-chosen device address */
333 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
Sarah Sharpb356b7c2009-09-04 10:53:24 -0700334 /* Notifies the HCD after a hub descriptor is fetched.
335 * Will block.
336 */
337 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
338 struct usb_tt *tt, gfp_t mem_flags);
Sarah Sharpa5f0efa2009-12-09 15:59:17 -0800339 int (*reset_device)(struct usb_hcd *, struct usb_device *);
Alek Du48f24972010-06-04 15:47:55 +0800340 /* Notifies the HCD after a device is connected and its
341 * address is set
342 */
343 int (*update_device)(struct usb_hcd *, struct usb_device *);
Andiry Xu65580b432011-09-23 14:19:52 -0700344 int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345};
346
Alan Sterne9df41c2007-08-08 11:48:02 -0400347extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
348extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
349 int status);
350extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
351
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800352extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
353extern int usb_hcd_unlink_urb(struct urb *urb, int status);
Alan Stern4a000272007-08-24 15:42:24 -0400354extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
355 int status);
Robert Morell2694a482011-01-26 19:06:48 -0800356extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
357 gfp_t mem_flags);
Robert Morellc8cf2032011-01-26 19:06:47 -0800358extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
359extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
Alan Stern95cf82f2007-09-10 11:33:05 -0400360extern void usb_hcd_flush_endpoint(struct usb_device *udev,
361 struct usb_host_endpoint *ep);
362extern void usb_hcd_disable_endpoint(struct usb_device *udev,
Alan Sterna6d2bb92006-08-30 11:27:36 -0400363 struct usb_host_endpoint *ep);
David Vrabel3444b262009-04-08 17:36:28 +0000364extern void usb_hcd_reset_endpoint(struct usb_device *udev,
365 struct usb_host_endpoint *ep);
Alan Sterncde217a2008-10-21 15:28:46 -0400366extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800367extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700368 struct usb_host_config *new_config,
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800369 struct usb_host_interface *old_alt,
370 struct usb_host_interface *new_alt);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800371extern int usb_hcd_get_frame_number(struct usb_device *udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800373extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700374 struct device *dev, const char *bus_name);
Sarah Sharpc5635432010-10-28 15:40:26 -0700375extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
376 struct device *dev, const char *bus_name,
377 struct usb_hcd *shared_hcd);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800378extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
379extern void usb_put_hcd(struct usb_hcd *hcd);
Sarah Sharpc5635432010-10-28 15:40:26 -0700380extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381extern int usb_add_hcd(struct usb_hcd *hcd,
382 unsigned int irqnum, unsigned long irqflags);
383extern void usb_remove_hcd(struct usb_hcd *hcd);
384
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700385struct platform_device;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800386extern void usb_hcd_platform_shutdown(struct platform_device *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388#ifdef CONFIG_PCI
389struct pci_dev;
390struct pci_device_id;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800391extern int usb_hcd_pci_probe(struct pci_dev *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 const struct pci_device_id *id);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800393extern void usb_hcd_pci_remove(struct pci_dev *dev);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800394extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700395
Alan Sternabb30642009-04-27 13:33:24 -0400396#ifdef CONFIG_PM_SLEEP
Alexey Dobriyan47145212009-12-14 18:00:08 -0800397extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
Alan Sternabb30642009-04-27 13:33:24 -0400398#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399#endif /* CONFIG_PCI */
400
401/* pci-ish (pdev null is ok) buffer alloc/mapping support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800402int hcd_buffer_create(struct usb_hcd *hcd);
403void hcd_buffer_destroy(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800405void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
Al Viro55016f12005-10-21 03:21:58 -0400406 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800407void hcd_buffer_free(struct usb_bus *bus, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 void *addr, dma_addr_t dma);
409
410/* generic bus glue, needed for host controllers that don't use PCI */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800411extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400412
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800413extern void usb_hc_died(struct usb_hcd *hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400414extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800415extern void usb_wakeup_notification(struct usb_device *hdev,
416 unsigned int portnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
David Vrabel3444b262009-04-08 17:36:28 +0000418/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
419#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
420#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
421#define usb_settoggle(dev, ep, out, bit) \
422 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
423 ((bit) << (ep)))
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425/* -------------------------------------------------------------------------- */
426
427/* Enumeration is only for the hub driver, or HCD virtual root hubs */
428extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
429 struct usb_bus *, unsigned port);
430extern int usb_new_device(struct usb_device *dev);
431extern void usb_disconnect(struct usb_device **);
432
433extern int usb_get_configuration(struct usb_device *dev);
434extern void usb_destroy_configuration(struct usb_device *dev);
435
436/*-------------------------------------------------------------------------*/
437
438/*
439 * HCD Root Hub support
440 */
441
Eric Lescouetd20db4b2010-04-24 23:38:17 +0200442#include <linux/usb/ch11.h>
443
444/*
445 * As of USB 2.0, full/low speed devices are segregated into trees.
446 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
447 * The other type grows from high speed hubs when they connect to
448 * full/low speed devices using "Transaction Translators" (TTs).
449 *
450 * TTs should only be known to the hub driver, and high speed bus
451 * drivers (only EHCI for now). They affect periodic scheduling and
452 * sometimes control/bulk error recovery.
453 */
454
455struct usb_device;
456
457struct usb_tt {
458 struct usb_device *hub; /* upstream highspeed hub */
459 int multi; /* true means one TT per port */
460 unsigned think_time; /* think time in ns */
461
462 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
463 spinlock_t lock;
464 struct list_head clear_list; /* of usb_tt_clear */
465 struct work_struct clear_work;
466};
467
468struct usb_tt_clear {
469 struct list_head clear_list;
470 unsigned tt;
471 u16 devinfo;
472 struct usb_hcd *hcd;
473 struct usb_host_endpoint *ep;
474};
475
476extern int usb_hub_clear_tt_buffer(struct urb *urb);
477extern void usb_ep0_reinit(struct usb_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
480#define DeviceRequest \
481 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
482#define DeviceOutRequest \
483 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
484
485#define InterfaceRequest \
486 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
487
488#define EndpointRequest \
489 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
490#define EndpointOutRequest \
491 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
492
493/* class requests from the USB 2.0 hub spec, table 11-15 */
494/* GetBusState and SetHubDescriptor are optional, omitted */
495#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
496#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
497#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
498#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
499#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
500#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
501#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
502
503
504/*-------------------------------------------------------------------------*/
505
Tatyana Brokhman0eadcc02010-11-01 18:18:24 +0200506/* class requests from USB 3.0 hub spec, table 10-5 */
507#define SetHubDepth (0x3000 | HUB_SET_DEPTH)
508#define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510/*
511 * Generic bandwidth allocation constants/support
512 */
513#define FRAME_TIME_USECS 1000L
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800514#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 /* Trying not to use worst-case bit-stuffing
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800516 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 /* bytecount = data payload byte count */
518
519#define NS_TO_US(ns) ((ns + 500L) / 1000L)
520 /* convert & round nanoseconds to microseconds */
521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523/*
524 * Full/low speed bandwidth allocation constants/support.
525 */
526#define BW_HOST_DELAY 1000L /* nanoseconds */
527#define BW_HUB_LS_SETUP 333L /* nanoseconds */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800528 /* 4 full-speed bit times (est.) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800530#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
532#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534/*
Dan Streetman498f78e2005-07-29 12:18:28 -0700535 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
537 * to preallocate bandwidth)
538 */
539#define USB2_HOST_DELAY 5 /* nsec, guess */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800540#define HS_NSECS(bytes) (((55 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700541 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 + USB2_HOST_DELAY)
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800543#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700544 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 + USB2_HOST_DELAY)
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700546#define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
547#define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800549extern long usb_calc_bus_time(int speed, int is_input,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 int isoc, int bytecount);
551
552/*-------------------------------------------------------------------------*/
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554extern void usb_set_device_state(struct usb_device *udev,
555 enum usb_device_state new_state);
556
557/*-------------------------------------------------------------------------*/
558
559/* exported only within usbcore */
560
561extern struct list_head usb_bus_list;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100562extern struct mutex usb_bus_list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563extern wait_queue_head_t usb_kill_urb_queue;
564
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800565extern int usb_find_interface_driver(struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 struct usb_interface *interface);
567
568#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
569
Alan Stern0c0382e2005-10-13 17:08:02 -0400570#ifdef CONFIG_PM
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800571extern void usb_root_hub_lost_power(struct usb_device *rhdev);
Alan Stern65bfd292008-11-25 16:39:18 -0500572extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
573extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500574#endif /* CONFIG_PM */
575
576#ifdef CONFIG_USB_SUSPEND
577extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
Alan Stern0c0382e2005-10-13 17:08:02 -0400578#else
Andrew Mortondb2d55b2005-10-23 23:04:25 -0700579static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
580{
581 return;
582}
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500583#endif /* CONFIG_USB_SUSPEND */
584
Alan Stern0c0382e2005-10-13 17:08:02 -0400585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586/*
587 * USB device fs stuff
588 */
589
590#ifdef CONFIG_USB_DEVICEFS
591
592/*
593 * these are expected to be called from the USB core/hub thread
594 * with the kernel lock held
595 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800596extern void usbfs_update_special(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597extern int usbfs_init(void);
598extern void usbfs_cleanup(void);
599
600#else /* CONFIG_USB_DEVICEFS */
601
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800602static inline void usbfs_update_special(void) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603static inline int usbfs_init(void) { return 0; }
604static inline void usbfs_cleanup(void) { }
605
606#endif /* CONFIG_USB_DEVICEFS */
607
608/*-------------------------------------------------------------------------*/
609
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700610#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612struct usb_mon_operations {
613 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
614 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
Alan Stern9347d512007-08-24 15:41:41 -0400615 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617};
618
619extern struct usb_mon_operations *mon_ops;
620
621static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
622{
623 if (bus->monitored)
624 (*mon_ops->urb_submit)(bus, urb);
625}
626
627static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
628 int error)
629{
630 if (bus->monitored)
631 (*mon_ops->urb_submit_error)(bus, urb, error);
632}
633
Alan Stern9347d512007-08-24 15:41:41 -0400634static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
635 int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
637 if (bus->monitored)
Alan Stern9347d512007-08-24 15:41:41 -0400638 (*mon_ops->urb_complete)(bus, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
641int usb_mon_register(struct usb_mon_operations *ops);
642void usb_mon_deregister(void);
643
644#else
645
646static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
647static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
648 int error) {}
Alan Stern9347d512007-08-24 15:41:41 -0400649static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
650 int status) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700652#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654/*-------------------------------------------------------------------------*/
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656/* random stuff */
657
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800658#define RUN_CONTEXT (in_irq() ? "in_irq" \
659 : (in_interrupt() ? "in_interrupt" : "can sleep"))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661
Alan Stern32fe0192007-10-10 16:27:07 -0400662/* This rwsem is for use only by the hub driver and ehci-hcd.
663 * Nobody else should touch it.
664 */
665extern struct rw_semaphore ehci_cf_port_reset_rwsem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Alan Stern9beeee62008-10-02 11:48:13 -0400667/* Keep track of which host controller drivers are loaded */
668#define USB_UHCI_LOADED 0
669#define USB_OHCI_LOADED 1
670#define USB_EHCI_LOADED 2
671extern unsigned long usb_hcds_loaded;
672
Alan Stern32fe0192007-10-10 16:27:07 -0400673#endif /* __KERNEL__ */
Anton Vorontsovaa459e62008-10-29 14:25:50 -0700674
675#endif /* __USB_CORE_HCD_H */