blob: 9b867e64a0f463af086bd1e99bcadef6360b642a [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 */
79 char irq_descr[24]; /* driver + bus # */
80
Alan Sternd5926ae72005-04-21 15:56:37 -040081 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
Alan Stern9bbdf1e2010-01-08 12:57:28 -050083#ifdef CONFIG_USB_SUSPEND
Alan Stern6b157c92007-03-13 16:37:30 -040084 struct work_struct wakeup_work; /* for remote wakeup */
85#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87 /*
88 * hardware info/state
89 */
90 const struct hc_driver *driver; /* hw-specific hooks */
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +110091
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 unsigned rh_registered:1;/* is root hub registered? */
Alan Stern6d88e672010-06-09 17:34:17 -040098 unsigned rh_pollable:1; /* may we poll the root hub? */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Alan Sternd5926ae72005-04-21 15:56:37 -0400100 /* The next flag is a stopgap, to be removed when all the HCDs
101 * support the new root-hub polling mechanism. */
102 unsigned uses_new_polling:1;
103 unsigned poll_rh:1; /* poll for rh status? */
104 unsigned poll_pending:1; /* status has changed? */
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -0700105 unsigned wireless:1; /* Wireless USB HCD */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700106 unsigned authorized_default:1;
Alan Stern7329e212008-04-03 18:02:56 -0400107 unsigned has_tt:1; /* Integrated TT in root hub */
Alan Sternd5926ae72005-04-21 15:56:37 -0400108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 int irq; /* irq allocated */
110 void __iomem *regs; /* device memory/io */
111 u64 rsrc_start; /* memory/io resource start */
112 u64 rsrc_len; /* memory/io resource length */
Alan Stern7d35b922005-04-25 11:18:32 -0400113 unsigned power_budget; /* in mA, 0 = no limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800115 /* bandwidth_mutex should be taken before adding or removing
116 * any new bus bandwidth constraints:
117 * 1. Before adding a configuration for a new device.
118 * 2. Before removing the configuration to put the device into
119 * the addressed state.
120 * 3. Before selecting a different configuration.
121 * 4. Before selecting an alternate interface setting.
122 *
123 * bandwidth_mutex should be dropped after a successful control message
124 * to the device, or resetting the bandwidth after a failed attempt.
125 */
126 struct mutex bandwidth_mutex;
127
128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129#define HCD_BUFFER_POOLS 4
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700130 struct dma_pool *pool[HCD_BUFFER_POOLS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132 int state;
133# define __ACTIVE 0x01
134# define __SUSPEND 0x04
135# define __TRANSIENT 0x80
136
137# define HC_STATE_HALT 0
138# define HC_STATE_RUNNING (__ACTIVE)
139# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
140# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
141# define HC_STATE_SUSPENDED (__SUSPEND)
142
143#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
144#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
145
146 /* more shared queuing code would be good; it should support
147 * smarter scheduling, handle transaction translators, etc;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800148 * input size of periodic table to an interrupt scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * (ohci 32, uhci 1024, ehci 256/512/1024).
150 */
151
152 /* The HC driver's private data is stored at the end of
153 * this structure.
154 */
155 unsigned long hcd_priv[0]
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800156 __attribute__ ((aligned(sizeof(unsigned long))));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157};
158
159/* 2.4 does this a bit differently ... */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800160static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
162 return &hcd->self;
163}
164
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800165static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
Alan Stern17200582006-08-30 11:32:52 -0400166{
167 return container_of(bus, struct usb_hcd, self);
168}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170struct hcd_timeout { /* timeouts we allocate */
171 struct list_head timeout_list;
172 struct timer_list timer;
173};
174
175/*-------------------------------------------------------------------------*/
176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178struct hc_driver {
179 const char *description; /* "ehci-hcd" etc */
180 const char *product_desc; /* product/vendor string */
181 size_t hcd_priv_size; /* size of private data */
182
183 /* irq handler */
David Howells7d12e782006-10-05 14:55:46 +0100184 irqreturn_t (*irq) (struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 int flags;
187#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
Magnus Dammb3476672008-01-23 15:58:35 +0900188#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189#define HCD_USB11 0x0010 /* USB 1.1 */
190#define HCD_USB2 0x0020 /* USB 2.0 */
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700191#define HCD_USB3 0x0040 /* USB 3.0 */
Sarah Sharp6b403b02009-04-27 19:54:10 -0700192#define HCD_MASK 0x0070
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 /* called to init HCD and root hub */
195 int (*reset) (struct usb_hcd *hcd);
196 int (*start) (struct usb_hcd *hcd);
197
198 /* NOTE: these suspend/resume calls relate to the HC as
David Brownell5f827ea2005-09-22 22:38:16 -0700199 * a whole, not just the root hub; they're for PCI bus glue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 */
David Brownell5f827ea2005-09-22 22:38:16 -0700201 /* called after suspending the hub, before entering D3 etc */
Alan Stern6ec4beb2009-04-27 13:33:41 -0400202 int (*pci_suspend)(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
David Brownell5f827ea2005-09-22 22:38:16 -0700204 /* called after entering D0 (etc), before resuming the hub */
Alan Stern6ec4beb2009-04-27 13:33:41 -0400205 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207 /* cleanly make HCD stop writing memory and doing I/O */
208 void (*stop) (struct usb_hcd *hcd);
209
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700210 /* shutdown HCD */
211 void (*shutdown) (struct usb_hcd *hcd);
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 /* return current frame number */
214 int (*get_frame_number) (struct usb_hcd *hcd);
215
216 /* manage i/o requests, device state */
Alan Sterne9df41c2007-08-08 11:48:02 -0400217 int (*urb_enqueue)(struct usb_hcd *hcd,
218 struct urb *urb, gfp_t mem_flags);
219 int (*urb_dequeue)(struct usb_hcd *hcd,
220 struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222 /* hw synch, freeing endpoint resources that urb_dequeue can't */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700223 void (*endpoint_disable)(struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 struct usb_host_endpoint *ep);
225
David Vrabel3444b262009-04-08 17:36:28 +0000226 /* (optional) reset any endpoint state such as sequence number
227 and current window */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700228 void (*endpoint_reset)(struct usb_hcd *hcd,
David Vrabel3444b262009-04-08 17:36:28 +0000229 struct usb_host_endpoint *ep);
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 /* root hub support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800232 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
233 int (*hub_control) (struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 u16 typeReq, u16 wValue, u16 wIndex,
235 char *buf, u16 wLength);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800236 int (*bus_suspend)(struct usb_hcd *);
237 int (*bus_resume)(struct usb_hcd *);
238 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
Balaji Rao90da0962007-11-22 01:58:14 +0530239
240 /* force handover of high-speed port to full-speed companion */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800241 void (*relinquish_port)(struct usb_hcd *, int);
Alan Stern3a311552008-05-20 16:58:29 -0400242 /* has a port been handed over to a companion? */
243 int (*port_handed_over)(struct usb_hcd *, int);
Sarah Sharpc6515272009-04-27 19:57:26 -0700244
Alan Sterncb88a1b2009-06-29 10:43:32 -0400245 /* CLEAR_TT_BUFFER completion callback */
246 void (*clear_tt_buffer_complete)(struct usb_hcd *,
247 struct usb_host_endpoint *);
248
Sarah Sharpc6515272009-04-27 19:57:26 -0700249 /* xHCI specific functions */
250 /* Called by usb_alloc_dev to alloc HC device structures */
251 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
Herbert Xuf7410ce2010-01-10 20:15:03 +1100252 /* Called by usb_disconnect to free HC device structures */
Sarah Sharpc6515272009-04-27 19:57:26 -0700253 void (*free_dev)(struct usb_hcd *, struct usb_device *);
Sarah Sharpeab1caf2010-04-05 10:55:58 -0700254 /* Change a group of bulk endpoints to support multiple stream IDs */
255 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
256 struct usb_host_endpoint **eps, unsigned int num_eps,
257 unsigned int num_streams, gfp_t mem_flags);
258 /* Reverts a group of bulk endpoints back to not using stream IDs.
259 * Can fail if we run out of memory.
260 */
261 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
262 struct usb_host_endpoint **eps, unsigned int num_eps,
263 gfp_t mem_flags);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700264
265 /* Bandwidth computation functions */
266 /* Note that add_endpoint() can only be called once per endpoint before
267 * check_bandwidth() or reset_bandwidth() must be called.
268 * drop_endpoint() can only be called once per endpoint also.
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700269 * A call to xhci_drop_endpoint() followed by a call to
270 * xhci_add_endpoint() will add the endpoint to the schedule with
271 * possibly new parameters denoted by a different endpoint descriptor
272 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
273 * call to xhci_drop_endpoint() is not allowed.
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700274 */
275 /* Allocate endpoint resources and add them to a new schedule */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700276 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
277 struct usb_host_endpoint *);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700278 /* Drop an endpoint from a new schedule */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700279 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
280 struct usb_host_endpoint *);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700281 /* Check that a new hardware configuration, set using
282 * endpoint_enable and endpoint_disable, does not exceed bus
283 * bandwidth. This must be called before any set configuration
284 * or set interface requests are sent to the device.
285 */
286 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
287 /* Reset the device schedule to the last known good schedule,
288 * which was set from a previous successful call to
289 * check_bandwidth(). This reverts any add_endpoint() and
290 * drop_endpoint() calls since that last successful call.
291 * Used for when a check_bandwidth() call fails due to resource
292 * or bandwidth constraints.
293 */
294 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
Sarah Sharpc6515272009-04-27 19:57:26 -0700295 /* Returns the hardware-chosen device address */
296 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
Sarah Sharpb356b7c2009-09-04 10:53:24 -0700297 /* Notifies the HCD after a hub descriptor is fetched.
298 * Will block.
299 */
300 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
301 struct usb_tt *tt, gfp_t mem_flags);
Sarah Sharpa5f0efa2009-12-09 15:59:17 -0800302 int (*reset_device)(struct usb_hcd *, struct usb_device *);
Alek Du48f24972010-06-04 15:47:55 +0800303 /* Notifies the HCD after a device is connected and its
304 * address is set
305 */
306 int (*update_device)(struct usb_hcd *, struct usb_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307};
308
Alan Sterne9df41c2007-08-08 11:48:02 -0400309extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
310extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
311 int status);
312extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
313
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800314extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
315extern int usb_hcd_unlink_urb(struct urb *urb, int status);
Alan Stern4a000272007-08-24 15:42:24 -0400316extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
317 int status);
Alan Stern95cf82f2007-09-10 11:33:05 -0400318extern void usb_hcd_flush_endpoint(struct usb_device *udev,
319 struct usb_host_endpoint *ep);
320extern void usb_hcd_disable_endpoint(struct usb_device *udev,
Alan Sterna6d2bb92006-08-30 11:27:36 -0400321 struct usb_host_endpoint *ep);
David Vrabel3444b262009-04-08 17:36:28 +0000322extern void usb_hcd_reset_endpoint(struct usb_device *udev,
323 struct usb_host_endpoint *ep);
Alan Sterncde217a2008-10-21 15:28:46 -0400324extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800325extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700326 struct usb_host_config *new_config,
Sarah Sharp3f0479e2009-12-03 09:44:36 -0800327 struct usb_host_interface *old_alt,
328 struct usb_host_interface *new_alt);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800329extern int usb_hcd_get_frame_number(struct usb_device *udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800331extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700332 struct device *dev, const char *bus_name);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800333extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
334extern void usb_put_hcd(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335extern int usb_add_hcd(struct usb_hcd *hcd,
336 unsigned int irqnum, unsigned long irqflags);
337extern void usb_remove_hcd(struct usb_hcd *hcd);
338
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700339struct platform_device;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800340extern void usb_hcd_platform_shutdown(struct platform_device *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342#ifdef CONFIG_PCI
343struct pci_dev;
344struct pci_device_id;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800345extern int usb_hcd_pci_probe(struct pci_dev *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 const struct pci_device_id *id);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800347extern void usb_hcd_pci_remove(struct pci_dev *dev);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800348extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700349
Alan Sternabb30642009-04-27 13:33:24 -0400350#ifdef CONFIG_PM_SLEEP
Alexey Dobriyan47145212009-12-14 18:00:08 -0800351extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
Alan Sternabb30642009-04-27 13:33:24 -0400352#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353#endif /* CONFIG_PCI */
354
355/* pci-ish (pdev null is ok) buffer alloc/mapping support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800356int hcd_buffer_create(struct usb_hcd *hcd);
357void hcd_buffer_destroy(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800359void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
Al Viro55016f12005-10-21 03:21:58 -0400360 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800361void hcd_buffer_free(struct usb_bus *bus, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 void *addr, dma_addr_t dma);
363
364/* generic bus glue, needed for host controllers that don't use PCI */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800365extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400366
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800367extern void usb_hc_died(struct usb_hcd *hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400368extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
David Vrabel3444b262009-04-08 17:36:28 +0000370/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
371#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
372#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
373#define usb_settoggle(dev, ep, out, bit) \
374 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
375 ((bit) << (ep)))
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377/* -------------------------------------------------------------------------- */
378
379/* Enumeration is only for the hub driver, or HCD virtual root hubs */
380extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
381 struct usb_bus *, unsigned port);
382extern int usb_new_device(struct usb_device *dev);
383extern void usb_disconnect(struct usb_device **);
384
385extern int usb_get_configuration(struct usb_device *dev);
386extern void usb_destroy_configuration(struct usb_device *dev);
387
388/*-------------------------------------------------------------------------*/
389
390/*
391 * HCD Root Hub support
392 */
393
Eric Lescouetd20db4b2010-04-24 23:38:17 +0200394#include <linux/usb/ch11.h>
395
396/*
397 * As of USB 2.0, full/low speed devices are segregated into trees.
398 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
399 * The other type grows from high speed hubs when they connect to
400 * full/low speed devices using "Transaction Translators" (TTs).
401 *
402 * TTs should only be known to the hub driver, and high speed bus
403 * drivers (only EHCI for now). They affect periodic scheduling and
404 * sometimes control/bulk error recovery.
405 */
406
407struct usb_device;
408
409struct usb_tt {
410 struct usb_device *hub; /* upstream highspeed hub */
411 int multi; /* true means one TT per port */
412 unsigned think_time; /* think time in ns */
413
414 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
415 spinlock_t lock;
416 struct list_head clear_list; /* of usb_tt_clear */
417 struct work_struct clear_work;
418};
419
420struct usb_tt_clear {
421 struct list_head clear_list;
422 unsigned tt;
423 u16 devinfo;
424 struct usb_hcd *hcd;
425 struct usb_host_endpoint *ep;
426};
427
428extern int usb_hub_clear_tt_buffer(struct urb *urb);
429extern void usb_ep0_reinit(struct usb_device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
431/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
432#define DeviceRequest \
433 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
434#define DeviceOutRequest \
435 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
436
437#define InterfaceRequest \
438 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
439
440#define EndpointRequest \
441 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
442#define EndpointOutRequest \
443 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
444
445/* class requests from the USB 2.0 hub spec, table 11-15 */
446/* GetBusState and SetHubDescriptor are optional, omitted */
447#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
448#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
449#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
450#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
451#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
452#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
453#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
454
455
456/*-------------------------------------------------------------------------*/
457
458/*
459 * Generic bandwidth allocation constants/support
460 */
461#define FRAME_TIME_USECS 1000L
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800462#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 /* Trying not to use worst-case bit-stuffing
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800464 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 /* bytecount = data payload byte count */
466
467#define NS_TO_US(ns) ((ns + 500L) / 1000L)
468 /* convert & round nanoseconds to microseconds */
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471/*
472 * Full/low speed bandwidth allocation constants/support.
473 */
474#define BW_HOST_DELAY 1000L /* nanoseconds */
475#define BW_HUB_LS_SETUP 333L /* nanoseconds */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800476 /* 4 full-speed bit times (est.) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800478#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
480#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482/*
Dan Streetman498f78e2005-07-29 12:18:28 -0700483 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
485 * to preallocate bandwidth)
486 */
487#define USB2_HOST_DELAY 5 /* nsec, guess */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800488#define HS_NSECS(bytes) (((55 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700489 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 + USB2_HOST_DELAY)
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800491#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700492 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 + USB2_HOST_DELAY)
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700494#define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
495#define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800497extern long usb_calc_bus_time(int speed, int is_input,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 int isoc, int bytecount);
499
500/*-------------------------------------------------------------------------*/
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502extern void usb_set_device_state(struct usb_device *udev,
503 enum usb_device_state new_state);
504
505/*-------------------------------------------------------------------------*/
506
507/* exported only within usbcore */
508
509extern struct list_head usb_bus_list;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100510extern struct mutex usb_bus_list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511extern wait_queue_head_t usb_kill_urb_queue;
512
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800513extern int usb_find_interface_driver(struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 struct usb_interface *interface);
515
516#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
517
Alan Stern0c0382e2005-10-13 17:08:02 -0400518#ifdef CONFIG_PM
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800519extern void usb_root_hub_lost_power(struct usb_device *rhdev);
Alan Stern65bfd292008-11-25 16:39:18 -0500520extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
521extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500522#endif /* CONFIG_PM */
523
524#ifdef CONFIG_USB_SUSPEND
525extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
Alan Stern0c0382e2005-10-13 17:08:02 -0400526#else
Andrew Mortondb2d55b2005-10-23 23:04:25 -0700527static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
528{
529 return;
530}
Alan Stern9bbdf1e2010-01-08 12:57:28 -0500531#endif /* CONFIG_USB_SUSPEND */
532
Alan Stern0c0382e2005-10-13 17:08:02 -0400533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534/*
535 * USB device fs stuff
536 */
537
538#ifdef CONFIG_USB_DEVICEFS
539
540/*
541 * these are expected to be called from the USB core/hub thread
542 * with the kernel lock held
543 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800544extern void usbfs_update_special(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545extern int usbfs_init(void);
546extern void usbfs_cleanup(void);
547
548#else /* CONFIG_USB_DEVICEFS */
549
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800550static inline void usbfs_update_special(void) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551static inline int usbfs_init(void) { return 0; }
552static inline void usbfs_cleanup(void) { }
553
554#endif /* CONFIG_USB_DEVICEFS */
555
556/*-------------------------------------------------------------------------*/
557
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700558#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560struct usb_mon_operations {
561 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
562 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
Alan Stern9347d512007-08-24 15:41:41 -0400563 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565};
566
567extern struct usb_mon_operations *mon_ops;
568
569static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
570{
571 if (bus->monitored)
572 (*mon_ops->urb_submit)(bus, urb);
573}
574
575static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
576 int error)
577{
578 if (bus->monitored)
579 (*mon_ops->urb_submit_error)(bus, urb, error);
580}
581
Alan Stern9347d512007-08-24 15:41:41 -0400582static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
583 int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
585 if (bus->monitored)
Alan Stern9347d512007-08-24 15:41:41 -0400586 (*mon_ops->urb_complete)(bus, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
589int usb_mon_register(struct usb_mon_operations *ops);
590void usb_mon_deregister(void);
591
592#else
593
594static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
595static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
596 int error) {}
Alan Stern9347d512007-08-24 15:41:41 -0400597static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
598 int status) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700600#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602/*-------------------------------------------------------------------------*/
603
604/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800605/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
Greg Kroah-Hartman0858a3a2010-05-17 10:58:12 -0700606#define bitmap DeviceRemovable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
608
609/*-------------------------------------------------------------------------*/
610
611/* random stuff */
612
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800613#define RUN_CONTEXT (in_irq() ? "in_irq" \
614 : (in_interrupt() ? "in_interrupt" : "can sleep"))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
616
Alan Stern32fe0192007-10-10 16:27:07 -0400617/* This rwsem is for use only by the hub driver and ehci-hcd.
618 * Nobody else should touch it.
619 */
620extern struct rw_semaphore ehci_cf_port_reset_rwsem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Alan Stern9beeee62008-10-02 11:48:13 -0400622/* Keep track of which host controller drivers are loaded */
623#define USB_UHCI_LOADED 0
624#define USB_OHCI_LOADED 1
625#define USB_EHCI_LOADED 2
626extern unsigned long usb_hcds_loaded;
627
Alan Stern32fe0192007-10-10 16:27:07 -0400628#endif /* __KERNEL__ */
Anton Vorontsovaa459e62008-10-29 14:25:50 -0700629
630#endif /* __USB_CORE_HCD_H */