blob: ec5c67ea07b745a95b92e8db88349abadc1bbca1 [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 Stern6b157c92007-03-13 16:37:30 -040083#ifdef CONFIG_PM
84 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? */
98
Alan Sternd5926ae72005-04-21 15:56:37 -040099 /* The next flag is a stopgap, to be removed when all the HCDs
100 * support the new root-hub polling mechanism. */
101 unsigned uses_new_polling:1;
102 unsigned poll_rh:1; /* poll for rh status? */
103 unsigned poll_pending:1; /* status has changed? */
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -0700104 unsigned wireless:1; /* Wireless USB HCD */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700105 unsigned authorized_default:1;
Alan Stern7329e212008-04-03 18:02:56 -0400106 unsigned has_tt:1; /* Integrated TT in root hub */
Alan Sternd5926ae72005-04-21 15:56:37 -0400107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int irq; /* irq allocated */
109 void __iomem *regs; /* device memory/io */
110 u64 rsrc_start; /* memory/io resource start */
111 u64 rsrc_len; /* memory/io resource length */
Alan Stern7d35b922005-04-25 11:18:32 -0400112 unsigned power_budget; /* in mA, 0 = no limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114#define HCD_BUFFER_POOLS 4
115 struct dma_pool *pool [HCD_BUFFER_POOLS];
116
117 int state;
118# define __ACTIVE 0x01
119# define __SUSPEND 0x04
120# define __TRANSIENT 0x80
121
122# define HC_STATE_HALT 0
123# define HC_STATE_RUNNING (__ACTIVE)
124# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
125# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
126# define HC_STATE_SUSPENDED (__SUSPEND)
127
128#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
129#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
130
131 /* more shared queuing code would be good; it should support
132 * smarter scheduling, handle transaction translators, etc;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800133 * input size of periodic table to an interrupt scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * (ohci 32, uhci 1024, ehci 256/512/1024).
135 */
136
137 /* The HC driver's private data is stored at the end of
138 * this structure.
139 */
140 unsigned long hcd_priv[0]
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800141 __attribute__ ((aligned(sizeof(unsigned long))));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142};
143
144/* 2.4 does this a bit differently ... */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800145static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
147 return &hcd->self;
148}
149
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800150static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
Alan Stern17200582006-08-30 11:32:52 -0400151{
152 return container_of(bus, struct usb_hcd, self);
153}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155struct hcd_timeout { /* timeouts we allocate */
156 struct list_head timeout_list;
157 struct timer_list timer;
158};
159
160/*-------------------------------------------------------------------------*/
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163struct hc_driver {
164 const char *description; /* "ehci-hcd" etc */
165 const char *product_desc; /* product/vendor string */
166 size_t hcd_priv_size; /* size of private data */
167
168 /* irq handler */
David Howells7d12e782006-10-05 14:55:46 +0100169 irqreturn_t (*irq) (struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 int flags;
172#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
Magnus Dammb3476672008-01-23 15:58:35 +0900173#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174#define HCD_USB11 0x0010 /* USB 1.1 */
175#define HCD_USB2 0x0020 /* USB 2.0 */
Sarah Sharp66d4ead2009-04-27 19:52:28 -0700176#define HCD_USB3 0x0040 /* USB 3.0 */
Sarah Sharp6b403b02009-04-27 19:54:10 -0700177#define HCD_MASK 0x0070
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 /* called to init HCD and root hub */
180 int (*reset) (struct usb_hcd *hcd);
181 int (*start) (struct usb_hcd *hcd);
182
183 /* NOTE: these suspend/resume calls relate to the HC as
David Brownell5f827ea2005-09-22 22:38:16 -0700184 * a whole, not just the root hub; they're for PCI bus glue.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 */
David Brownell5f827ea2005-09-22 22:38:16 -0700186 /* called after suspending the hub, before entering D3 etc */
Alan Stern6ec4beb2009-04-27 13:33:41 -0400187 int (*pci_suspend)(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
David Brownell5f827ea2005-09-22 22:38:16 -0700189 /* called after entering D0 (etc), before resuming the hub */
Alan Stern6ec4beb2009-04-27 13:33:41 -0400190 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 /* cleanly make HCD stop writing memory and doing I/O */
193 void (*stop) (struct usb_hcd *hcd);
194
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700195 /* shutdown HCD */
196 void (*shutdown) (struct usb_hcd *hcd);
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 /* return current frame number */
199 int (*get_frame_number) (struct usb_hcd *hcd);
200
201 /* manage i/o requests, device state */
Alan Sterne9df41c2007-08-08 11:48:02 -0400202 int (*urb_enqueue)(struct usb_hcd *hcd,
203 struct urb *urb, gfp_t mem_flags);
204 int (*urb_dequeue)(struct usb_hcd *hcd,
205 struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207 /* hw synch, freeing endpoint resources that urb_dequeue can't */
208 void (*endpoint_disable)(struct usb_hcd *hcd,
209 struct usb_host_endpoint *ep);
210
David Vrabel3444b262009-04-08 17:36:28 +0000211 /* (optional) reset any endpoint state such as sequence number
212 and current window */
213 void (*endpoint_reset)(struct usb_hcd *hcd,
214 struct usb_host_endpoint *ep);
215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 /* root hub support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800217 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
218 int (*hub_control) (struct usb_hcd *hcd,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 u16 typeReq, u16 wValue, u16 wIndex,
220 char *buf, u16 wLength);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800221 int (*bus_suspend)(struct usb_hcd *);
222 int (*bus_resume)(struct usb_hcd *);
223 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
Balaji Rao90da0962007-11-22 01:58:14 +0530224
225 /* force handover of high-speed port to full-speed companion */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800226 void (*relinquish_port)(struct usb_hcd *, int);
Alan Stern3a311552008-05-20 16:58:29 -0400227 /* has a port been handed over to a companion? */
228 int (*port_handed_over)(struct usb_hcd *, int);
Sarah Sharpc6515272009-04-27 19:57:26 -0700229
Alan Sterncb88a1b2009-06-29 10:43:32 -0400230 /* CLEAR_TT_BUFFER completion callback */
231 void (*clear_tt_buffer_complete)(struct usb_hcd *,
232 struct usb_host_endpoint *);
233
Sarah Sharpc6515272009-04-27 19:57:26 -0700234 /* xHCI specific functions */
235 /* Called by usb_alloc_dev to alloc HC device structures */
236 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
237 /* Called by usb_release_dev to free HC device structures */
238 void (*free_dev)(struct usb_hcd *, struct usb_device *);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700239
240 /* Bandwidth computation functions */
241 /* Note that add_endpoint() can only be called once per endpoint before
242 * check_bandwidth() or reset_bandwidth() must be called.
243 * drop_endpoint() can only be called once per endpoint also.
244 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
245 * add the endpoint to the schedule with possibly new parameters denoted by a
246 * different endpoint descriptor in usb_host_endpoint.
247 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
248 * not allowed.
249 */
250 /* Allocate endpoint resources and add them to a new schedule */
251 int (*add_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
252 /* Drop an endpoint from a new schedule */
253 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *);
254 /* Check that a new hardware configuration, set using
255 * endpoint_enable and endpoint_disable, does not exceed bus
256 * bandwidth. This must be called before any set configuration
257 * or set interface requests are sent to the device.
258 */
259 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
260 /* Reset the device schedule to the last known good schedule,
261 * which was set from a previous successful call to
262 * check_bandwidth(). This reverts any add_endpoint() and
263 * drop_endpoint() calls since that last successful call.
264 * Used for when a check_bandwidth() call fails due to resource
265 * or bandwidth constraints.
266 */
267 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
Sarah Sharpc6515272009-04-27 19:57:26 -0700268 /* Returns the hardware-chosen device address */
269 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270};
271
Alan Sterne9df41c2007-08-08 11:48:02 -0400272extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
273extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
274 int status);
275extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
276
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800277extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
278extern int usb_hcd_unlink_urb(struct urb *urb, int status);
Alan Stern4a000272007-08-24 15:42:24 -0400279extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
280 int status);
Alan Stern95cf82f2007-09-10 11:33:05 -0400281extern void usb_hcd_flush_endpoint(struct usb_device *udev,
282 struct usb_host_endpoint *ep);
283extern void usb_hcd_disable_endpoint(struct usb_device *udev,
Alan Sterna6d2bb92006-08-30 11:27:36 -0400284 struct usb_host_endpoint *ep);
David Vrabel3444b262009-04-08 17:36:28 +0000285extern void usb_hcd_reset_endpoint(struct usb_device *udev,
286 struct usb_host_endpoint *ep);
Alan Sterncde217a2008-10-21 15:28:46 -0400287extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700288extern int usb_hcd_check_bandwidth(struct usb_device *udev,
289 struct usb_host_config *new_config,
290 struct usb_interface *new_intf);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800291extern int usb_hcd_get_frame_number(struct usb_device *udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800293extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -0700294 struct device *dev, const char *bus_name);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800295extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
296extern void usb_put_hcd(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297extern int usb_add_hcd(struct usb_hcd *hcd,
298 unsigned int irqnum, unsigned long irqflags);
299extern void usb_remove_hcd(struct usb_hcd *hcd);
300
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700301struct platform_device;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800302extern void usb_hcd_platform_shutdown(struct platform_device *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304#ifdef CONFIG_PCI
305struct pci_dev;
306struct pci_device_id;
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800307extern int usb_hcd_pci_probe(struct pci_dev *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 const struct pci_device_id *id);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800309extern void usb_hcd_pci_remove(struct pci_dev *dev);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800310extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700311
Alan Sternabb30642009-04-27 13:33:24 -0400312#ifdef CONFIG_PM_SLEEP
313extern struct dev_pm_ops usb_hcd_pci_pm_ops;
314#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#endif /* CONFIG_PCI */
316
317/* pci-ish (pdev null is ok) buffer alloc/mapping support */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800318int hcd_buffer_create(struct usb_hcd *hcd);
319void hcd_buffer_destroy(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800321void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
Al Viro55016f12005-10-21 03:21:58 -0400322 gfp_t mem_flags, dma_addr_t *dma);
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800323void hcd_buffer_free(struct usb_bus *bus, size_t size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 void *addr, dma_addr_t dma);
325
326/* generic bus glue, needed for host controllers that don't use PCI */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800327extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400328
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800329extern void usb_hc_died(struct usb_hcd *hcd);
Alan Sternd5926ae72005-04-21 15:56:37 -0400330extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
David Vrabel3444b262009-04-08 17:36:28 +0000332/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
333#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
334#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
335#define usb_settoggle(dev, ep, out, bit) \
336 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
337 ((bit) << (ep)))
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339/* -------------------------------------------------------------------------- */
340
341/* Enumeration is only for the hub driver, or HCD virtual root hubs */
342extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
343 struct usb_bus *, unsigned port);
344extern int usb_new_device(struct usb_device *dev);
345extern void usb_disconnect(struct usb_device **);
346
347extern int usb_get_configuration(struct usb_device *dev);
348extern void usb_destroy_configuration(struct usb_device *dev);
349
350/*-------------------------------------------------------------------------*/
351
352/*
353 * HCD Root Hub support
354 */
355
356#include "hub.h"
357
358/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
359#define DeviceRequest \
360 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
361#define DeviceOutRequest \
362 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
363
364#define InterfaceRequest \
365 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
366
367#define EndpointRequest \
368 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
369#define EndpointOutRequest \
370 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
371
372/* class requests from the USB 2.0 hub spec, table 11-15 */
373/* GetBusState and SetHubDescriptor are optional, omitted */
374#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
375#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
376#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
377#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
378#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
379#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
380#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
381
382
383/*-------------------------------------------------------------------------*/
384
385/*
386 * Generic bandwidth allocation constants/support
387 */
388#define FRAME_TIME_USECS 1000L
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800389#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 /* Trying not to use worst-case bit-stuffing
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800391 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 /* bytecount = data payload byte count */
393
394#define NS_TO_US(ns) ((ns + 500L) / 1000L)
395 /* convert & round nanoseconds to microseconds */
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398/*
399 * Full/low speed bandwidth allocation constants/support.
400 */
401#define BW_HOST_DELAY 1000L /* nanoseconds */
402#define BW_HUB_LS_SETUP 333L /* nanoseconds */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800403 /* 4 full-speed bit times (est.) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800405#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
407#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*
Dan Streetman498f78e2005-07-29 12:18:28 -0700410 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
412 * to preallocate bandwidth)
413 */
414#define USB2_HOST_DELAY 5 /* nsec, guess */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800415#define HS_NSECS(bytes) (((55 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700416 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 + USB2_HOST_DELAY)
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800418#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
david-b@pacbell.netf956e7c2005-08-11 19:37:01 -0700419 + (2083UL * (3 + BitTime(bytes))))/1000 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 + USB2_HOST_DELAY)
Dan Streetman498f78e2005-07-29 12:18:28 -0700421#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
422#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800424extern long usb_calc_bus_time(int speed, int is_input,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 int isoc, int bytecount);
426
427/*-------------------------------------------------------------------------*/
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429extern void usb_set_device_state(struct usb_device *udev,
430 enum usb_device_state new_state);
431
432/*-------------------------------------------------------------------------*/
433
434/* exported only within usbcore */
435
436extern struct list_head usb_bus_list;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100437extern struct mutex usb_bus_list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438extern wait_queue_head_t usb_kill_urb_queue;
439
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800440extern int usb_find_interface_driver(struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 struct usb_interface *interface);
442
443#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
444
Alan Stern0c0382e2005-10-13 17:08:02 -0400445#ifdef CONFIG_PM
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800446extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
447extern void usb_root_hub_lost_power(struct usb_device *rhdev);
Alan Stern65bfd292008-11-25 16:39:18 -0500448extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
449extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
Alan Stern0c0382e2005-10-13 17:08:02 -0400450#else
Andrew Mortondb2d55b2005-10-23 23:04:25 -0700451static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
452{
453 return;
454}
Alan Stern0c0382e2005-10-13 17:08:02 -0400455#endif /* CONFIG_PM */
456
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457/*
458 * USB device fs stuff
459 */
460
461#ifdef CONFIG_USB_DEVICEFS
462
463/*
464 * these are expected to be called from the USB core/hub thread
465 * with the kernel lock held
466 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800467extern void usbfs_update_special(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468extern int usbfs_init(void);
469extern void usbfs_cleanup(void);
470
471#else /* CONFIG_USB_DEVICEFS */
472
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800473static inline void usbfs_update_special(void) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474static inline int usbfs_init(void) { return 0; }
475static inline void usbfs_cleanup(void) { }
476
477#endif /* CONFIG_USB_DEVICEFS */
478
479/*-------------------------------------------------------------------------*/
480
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700481#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483struct usb_mon_operations {
484 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
485 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
Alan Stern9347d512007-08-24 15:41:41 -0400486 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488};
489
490extern struct usb_mon_operations *mon_ops;
491
492static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
493{
494 if (bus->monitored)
495 (*mon_ops->urb_submit)(bus, urb);
496}
497
498static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
499 int error)
500{
501 if (bus->monitored)
502 (*mon_ops->urb_submit_error)(bus, urb, error);
503}
504
Alan Stern9347d512007-08-24 15:41:41 -0400505static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
506 int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 if (bus->monitored)
Alan Stern9347d512007-08-24 15:41:41 -0400509 (*mon_ops->urb_complete)(bus, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
512int usb_mon_register(struct usb_mon_operations *ops);
513void usb_mon_deregister(void);
514
515#else
516
517static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
518static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
519 int error) {}
Alan Stern9347d512007-08-24 15:41:41 -0400520static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
521 int status) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Pete Zaitcevf150fa12008-11-13 21:31:21 -0700523#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525/*-------------------------------------------------------------------------*/
526
527/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800528/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529#define bitmap DeviceRemovable
530
531
532/*-------------------------------------------------------------------------*/
533
534/* random stuff */
535
Greg Kroah-Hartman84cca822008-01-30 15:21:33 -0800536#define RUN_CONTEXT (in_irq() ? "in_irq" \
537 : (in_interrupt() ? "in_interrupt" : "can sleep"))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
539
Alan Stern32fe0192007-10-10 16:27:07 -0400540/* This rwsem is for use only by the hub driver and ehci-hcd.
541 * Nobody else should touch it.
542 */
543extern struct rw_semaphore ehci_cf_port_reset_rwsem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Alan Stern9beeee62008-10-02 11:48:13 -0400545/* Keep track of which host controller drivers are loaded */
546#define USB_UHCI_LOADED 0
547#define USB_OHCI_LOADED 1
548#define USB_EHCI_LOADED 2
549extern unsigned long usb_hcds_loaded;
550
Alan Stern32fe0192007-10-10 16:27:07 -0400551#endif /* __KERNEL__ */
Anton Vorontsovaa459e62008-10-29 14:25:50 -0700552
553#endif /* __USB_CORE_HCD_H */