diff options
| author | Eric Lescouet <Eric.Lescouet@virtuallogix.com> | 2010-04-24 17:21:52 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@suse.de> | 2010-05-20 16:21:30 -0400 |
| commit | 27729aadd31dafddaaf64c24f8ef6d0ff750f3aa (patch) | |
| tree | 20499b4132eaad36fb177b028600694fc4d0626a /include/linux/usb | |
| parent | 44ebd037c54f80db3121ac9f5fe6e677b76e11d5 (diff) | |
USB: make hcd.h public (drivers dependency)
The usbcore headers: hcd.h and hub.h are shared between usbcore,
HCDs and a couple of other drivers (e.g. USBIP modules).
So, it makes sense to move them into a more public location and
to cleanup dependency of those modules on kernel internal headers.
This patch moves hcd.h from drivers/usb/core into include/linux/usb/
Signed-of-by: Eric Lescouet <eric@lescouet.org>
Cc: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'include/linux/usb')
| -rw-r--r-- | include/linux/usb/hcd.h | 578 |
1 files changed, 578 insertions, 0 deletions
diff --git a/include/linux/usb/hcd.h b/include/linux/usb/hcd.h new file mode 100644 index 000000000000..c7e575cb3149 --- /dev/null +++ b/include/linux/usb/hcd.h | |||
| @@ -0,0 +1,578 @@ | |||
| 1 | /* | ||
| 2 | * Copyright (c) 2001-2002 by David Brownell | ||
| 3 | * | ||
| 4 | * This program is free software; you can redistribute it and/or modify it | ||
| 5 | * under the terms of the GNU General Public License as published by the | ||
| 6 | * Free Software Foundation; either version 2 of the License, or (at your | ||
| 7 | * option) any later version. | ||
| 8 | * | ||
| 9 | * This program is distributed in the hope that it will be useful, but | ||
| 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY | ||
| 11 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| 12 | * for more details. | ||
| 13 | * | ||
| 14 | * You should have received a copy of the GNU General Public License | ||
| 15 | * along with this program; if not, write to the Free Software Foundation, | ||
| 16 | * Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | ||
| 17 | */ | ||
| 18 | |||
| 19 | #ifndef __USB_CORE_HCD_H | ||
| 20 | #define __USB_CORE_HCD_H | ||
| 21 | |||
| 22 | #ifdef __KERNEL__ | ||
| 23 | |||
| 24 | #include <linux/rwsem.h> | ||
| 25 | |||
| 26 | #define MAX_TOPO_LEVEL 6 | ||
| 27 | |||
| 28 | /* 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 | */ | ||
| 35 | #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */ | ||
| 36 | #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. | ||
| 60 | * | ||
| 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. | ||
| 66 | */ | ||
| 67 | |||
| 68 | /*-------------------------------------------------------------------------*/ | ||
| 69 | |||
| 70 | struct usb_hcd { | ||
| 71 | |||
| 72 | /* | ||
| 73 | * housekeeping | ||
| 74 | */ | ||
| 75 | struct usb_bus self; /* hcd is-a bus */ | ||
| 76 | struct kref kref; /* reference counter */ | ||
| 77 | |||
| 78 | const char *product_desc; /* product/vendor string */ | ||
| 79 | char irq_descr[24]; /* driver + bus # */ | ||
| 80 | |||
| 81 | struct timer_list rh_timer; /* drives root-hub polling */ | ||
| 82 | struct urb *status_urb; /* the current status urb */ | ||
| 83 | #ifdef CONFIG_USB_SUSPEND | ||
| 84 | struct work_struct wakeup_work; /* for remote wakeup */ | ||
| 85 | #endif | ||
| 86 | |||
| 87 | /* | ||
| 88 | * hardware info/state | ||
| 89 | */ | ||
| 90 | const struct hc_driver *driver; /* hw-specific hooks */ | ||
| 91 | |||
| 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 | |||
| 97 | unsigned rh_registered:1;/* is root hub registered? */ | ||
| 98 | |||
| 99 | /* 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? */ | ||
| 104 | unsigned wireless:1; /* Wireless USB HCD */ | ||
| 105 | unsigned authorized_default:1; | ||
| 106 | unsigned has_tt:1; /* Integrated TT in root hub */ | ||
| 107 | |||
| 108 | 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 */ | ||
| 112 | unsigned power_budget; /* in mA, 0 = no limit */ | ||
| 113 | |||
| 114 | /* bandwidth_mutex should be taken before adding or removing | ||
| 115 | * any new bus bandwidth constraints: | ||
| 116 | * 1. Before adding a configuration for a new device. | ||
| 117 | * 2. Before removing the configuration to put the device into | ||
| 118 | * the addressed state. | ||
| 119 | * 3. Before selecting a different configuration. | ||
| 120 | * 4. Before selecting an alternate interface setting. | ||
| 121 | * | ||
| 122 | * bandwidth_mutex should be dropped after a successful control message | ||
| 123 | * to the device, or resetting the bandwidth after a failed attempt. | ||
| 124 | */ | ||
| 125 | struct mutex bandwidth_mutex; | ||
| 126 | |||
| 127 | |||
| 128 | #define HCD_BUFFER_POOLS 4 | ||
| 129 | struct dma_pool *pool [HCD_BUFFER_POOLS]; | ||
| 130 | |||
| 131 | int state; | ||
| 132 | # define __ACTIVE 0x01 | ||
| 133 | # define __SUSPEND 0x04 | ||
| 134 | # define __TRANSIENT 0x80 | ||
| 135 | |||
| 136 | # define HC_STATE_HALT 0 | ||
| 137 | # define HC_STATE_RUNNING (__ACTIVE) | ||
| 138 | # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE) | ||
| 139 | # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT) | ||
| 140 | # define HC_STATE_SUSPENDED (__SUSPEND) | ||
| 141 | |||
| 142 | #define HC_IS_RUNNING(state) ((state) & __ACTIVE) | ||
| 143 | #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND) | ||
| 144 | |||
| 145 | /* more shared queuing code would be good; it should support | ||
| 146 | * smarter scheduling, handle transaction translators, etc; | ||
| 147 | * input size of periodic table to an interrupt scheduler. | ||
| 148 | * (ohci 32, uhci 1024, ehci 256/512/1024). | ||
| 149 | */ | ||
| 150 | |||
| 151 | /* The HC driver's private data is stored at the end of | ||
| 152 | * this structure. | ||
| 153 | */ | ||
| 154 | unsigned long hcd_priv[0] | ||
| 155 | __attribute__ ((aligned(sizeof(unsigned long)))); | ||
| 156 | }; | ||
| 157 | |||
| 158 | /* 2.4 does this a bit differently ... */ | ||
| 159 | static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd) | ||
| 160 | { | ||
| 161 | return &hcd->self; | ||
| 162 | } | ||
| 163 | |||
| 164 | static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus) | ||
| 165 | { | ||
| 166 | return container_of(bus, struct usb_hcd, self); | ||
| 167 | } | ||
| 168 | |||
| 169 | struct hcd_timeout { /* timeouts we allocate */ | ||
| 170 | struct list_head timeout_list; | ||
| 171 | struct timer_list timer; | ||
| 172 | }; | ||
| 173 | |||
| 174 | /*-------------------------------------------------------------------------*/ | ||
| 175 | |||
| 176 | |||
| 177 | struct hc_driver { | ||
| 178 | const char *description; /* "ehci-hcd" etc */ | ||
| 179 | const char *product_desc; /* product/vendor string */ | ||
| 180 | size_t hcd_priv_size; /* size of private data */ | ||
| 181 | |||
| 182 | /* irq handler */ | ||
| 183 | irqreturn_t (*irq) (struct usb_hcd *hcd); | ||
| 184 | |||
| 185 | int flags; | ||
| 186 | #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */ | ||
| 187 | #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */ | ||
| 188 | #define HCD_USB11 0x0010 /* USB 1.1 */ | ||
| 189 | #define HCD_USB2 0x0020 /* USB 2.0 */ | ||
| 190 | #define HCD_USB3 0x0040 /* USB 3.0 */ | ||
| 191 | #define HCD_MASK 0x0070 | ||
| 192 | |||
| 193 | /* called to init HCD and root hub */ | ||
| 194 | int (*reset) (struct usb_hcd *hcd); | ||
| 195 | int (*start) (struct usb_hcd *hcd); | ||
| 196 | |||
| 197 | /* NOTE: these suspend/resume calls relate to the HC as | ||
| 198 | * a whole, not just the root hub; they're for PCI bus glue. | ||
| 199 | */ | ||
| 200 | /* called after suspending the hub, before entering D3 etc */ | ||
| 201 | int (*pci_suspend)(struct usb_hcd *hcd); | ||
| 202 | |||
| 203 | /* called after entering D0 (etc), before resuming the hub */ | ||
| 204 | int (*pci_resume)(struct usb_hcd *hcd, bool hibernated); | ||
| 205 | |||
| 206 | /* cleanly make HCD stop writing memory and doing I/O */ | ||
| 207 | void (*stop) (struct usb_hcd *hcd); | ||
| 208 | |||
| 209 | /* shutdown HCD */ | ||
| 210 | void (*shutdown) (struct usb_hcd *hcd); | ||
| 211 | |||
| 212 | /* return current frame number */ | ||
| 213 | int (*get_frame_number) (struct usb_hcd *hcd); | ||
| 214 | |||
| 215 | /* manage i/o requests, device state */ | ||
| 216 | int (*urb_enqueue)(struct usb_hcd *hcd, | ||
| 217 | struct urb *urb, gfp_t mem_flags); | ||
| 218 | int (*urb_dequeue)(struct usb_hcd *hcd, | ||
| 219 | struct urb *urb, int status); | ||
| 220 | |||
| 221 | /* hw synch, freeing endpoint resources that urb_dequeue can't */ | ||
| 222 | void (*endpoint_disable)(struct usb_hcd *hcd, | ||
| 223 | struct usb_host_endpoint *ep); | ||
| 224 | |||
| 225 | /* (optional) reset any endpoint state such as sequence number | ||
| 226 | and current window */ | ||
| 227 | void (*endpoint_reset)(struct usb_hcd *hcd, | ||
| 228 | struct usb_host_endpoint *ep); | ||
| 229 | |||
| 230 | /* root hub support */ | ||
| 231 | int (*hub_status_data) (struct usb_hcd *hcd, char *buf); | ||
| 232 | int (*hub_control) (struct usb_hcd *hcd, | ||
| 233 | u16 typeReq, u16 wValue, u16 wIndex, | ||
| 234 | char *buf, u16 wLength); | ||
| 235 | int (*bus_suspend)(struct usb_hcd *); | ||
| 236 | int (*bus_resume)(struct usb_hcd *); | ||
| 237 | int (*start_port_reset)(struct usb_hcd *, unsigned port_num); | ||
| 238 | |||
| 239 | /* force handover of high-speed port to full-speed companion */ | ||
| 240 | void (*relinquish_port)(struct usb_hcd *, int); | ||
| 241 | /* has a port been handed over to a companion? */ | ||
| 242 | int (*port_handed_over)(struct usb_hcd *, int); | ||
| 243 | |||
| 244 | /* CLEAR_TT_BUFFER completion callback */ | ||
| 245 | void (*clear_tt_buffer_complete)(struct usb_hcd *, | ||
| 246 | struct usb_host_endpoint *); | ||
| 247 | |||
| 248 | /* xHCI specific functions */ | ||
| 249 | /* Called by usb_alloc_dev to alloc HC device structures */ | ||
| 250 | int (*alloc_dev)(struct usb_hcd *, struct usb_device *); | ||
| 251 | /* Called by usb_disconnect to free HC device structures */ | ||
| 252 | void (*free_dev)(struct usb_hcd *, struct usb_device *); | ||
| 253 | |||
| 254 | /* Bandwidth computation functions */ | ||
| 255 | /* Note that add_endpoint() can only be called once per endpoint before | ||
| 256 | * check_bandwidth() or reset_bandwidth() must be called. | ||
| 257 | * drop_endpoint() can only be called once per endpoint also. | ||
| 258 | * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will | ||
| 259 | * add the endpoint to the schedule with possibly new parameters denoted by a | ||
| 260 | * different endpoint descriptor in usb_host_endpoint. | ||
| 261 | * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is | ||
| 262 | * not allowed. | ||
| 263 | */ | ||
| 264 | /* Allocate endpoint resources and add them to a new schedule */ | ||
| 265 | int (*add_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *); | ||
| 266 | /* Drop an endpoint from a new schedule */ | ||
| 267 | int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, struct usb_host_endpoint *); | ||
| 268 | /* Check that a new hardware configuration, set using | ||
| 269 | * endpoint_enable and endpoint_disable, does not exceed bus | ||
| 270 | * bandwidth. This must be called before any set configuration | ||
| 271 | * or set interface requests are sent to the device. | ||
| 272 | */ | ||
| 273 | int (*check_bandwidth)(struct usb_hcd *, struct usb_device *); | ||
| 274 | /* Reset the device schedule to the last known good schedule, | ||
| 275 | * which was set from a previous successful call to | ||
| 276 | * check_bandwidth(). This reverts any add_endpoint() and | ||
| 277 | * drop_endpoint() calls since that last successful call. | ||
| 278 | * Used for when a check_bandwidth() call fails due to resource | ||
| 279 | * or bandwidth constraints. | ||
| 280 | */ | ||
| 281 | void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *); | ||
| 282 | /* Returns the hardware-chosen device address */ | ||
| 283 | int (*address_device)(struct usb_hcd *, struct usb_device *udev); | ||
| 284 | /* Notifies the HCD after a hub descriptor is fetched. | ||
| 285 | * Will block. | ||
| 286 | */ | ||
| 287 | int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev, | ||
| 288 | struct usb_tt *tt, gfp_t mem_flags); | ||
| 289 | int (*reset_device)(struct usb_hcd *, struct usb_device *); | ||
| 290 | }; | ||
| 291 | |||
| 292 | extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb); | ||
| 293 | extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb, | ||
| 294 | int status); | ||
| 295 | extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb); | ||
| 296 | |||
| 297 | extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags); | ||
| 298 | extern int usb_hcd_unlink_urb(struct urb *urb, int status); | ||
| 299 | extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, | ||
| 300 | int status); | ||
| 301 | extern void usb_hcd_flush_endpoint(struct usb_device *udev, | ||
| 302 | struct usb_host_endpoint *ep); | ||
| 303 | extern void usb_hcd_disable_endpoint(struct usb_device *udev, | ||
| 304 | struct usb_host_endpoint *ep); | ||
| 305 | extern void usb_hcd_reset_endpoint(struct usb_device *udev, | ||
| 306 | struct usb_host_endpoint *ep); | ||
| 307 | extern void usb_hcd_synchronize_unlinks(struct usb_device *udev); | ||
| 308 | extern int usb_hcd_alloc_bandwidth(struct usb_device *udev, | ||
| 309 | struct usb_host_config *new_config, | ||
| 310 | struct usb_host_interface *old_alt, | ||
| 311 | struct usb_host_interface *new_alt); | ||
| 312 | extern int usb_hcd_get_frame_number(struct usb_device *udev); | ||
| 313 | |||
| 314 | extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver, | ||
| 315 | struct device *dev, const char *bus_name); | ||
| 316 | extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd); | ||
| 317 | extern void usb_put_hcd(struct usb_hcd *hcd); | ||
| 318 | extern int usb_add_hcd(struct usb_hcd *hcd, | ||
| 319 | unsigned int irqnum, unsigned long irqflags); | ||
| 320 | extern void usb_remove_hcd(struct usb_hcd *hcd); | ||
| 321 | |||
| 322 | struct platform_device; | ||
| 323 | extern void usb_hcd_platform_shutdown(struct platform_device *dev); | ||
| 324 | |||
| 325 | #ifdef CONFIG_PCI | ||
| 326 | struct pci_dev; | ||
| 327 | struct pci_device_id; | ||
| 328 | extern int usb_hcd_pci_probe(struct pci_dev *dev, | ||
| 329 | const struct pci_device_id *id); | ||
| 330 | extern void usb_hcd_pci_remove(struct pci_dev *dev); | ||
| 331 | extern void usb_hcd_pci_shutdown(struct pci_dev *dev); | ||
| 332 | |||
| 333 | #ifdef CONFIG_PM_SLEEP | ||
| 334 | extern const struct dev_pm_ops usb_hcd_pci_pm_ops; | ||
| 335 | #endif | ||
| 336 | #endif /* CONFIG_PCI */ | ||
| 337 | |||
| 338 | /* pci-ish (pdev null is ok) buffer alloc/mapping support */ | ||
| 339 | int hcd_buffer_create(struct usb_hcd *hcd); | ||
| 340 | void hcd_buffer_destroy(struct usb_hcd *hcd); | ||
| 341 | |||
| 342 | void *hcd_buffer_alloc(struct usb_bus *bus, size_t size, | ||
| 343 | gfp_t mem_flags, dma_addr_t *dma); | ||
| 344 | void hcd_buffer_free(struct usb_bus *bus, size_t size, | ||
| 345 | void *addr, dma_addr_t dma); | ||
| 346 | |||
| 347 | /* generic bus glue, needed for host controllers that don't use PCI */ | ||
| 348 | extern irqreturn_t usb_hcd_irq(int irq, void *__hcd); | ||
| 349 | |||
| 350 | extern void usb_hc_died(struct usb_hcd *hcd); | ||
| 351 | extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd); | ||
| 352 | |||
| 353 | /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */ | ||
| 354 | #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1) | ||
| 355 | #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep))) | ||
| 356 | #define usb_settoggle(dev, ep, out, bit) \ | ||
| 357 | ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \ | ||
| 358 | ((bit) << (ep))) | ||
| 359 | |||
| 360 | /* -------------------------------------------------------------------------- */ | ||
| 361 | |||
| 362 | /* Enumeration is only for the hub driver, or HCD virtual root hubs */ | ||
| 363 | extern struct usb_device *usb_alloc_dev(struct usb_device *parent, | ||
| 364 | struct usb_bus *, unsigned port); | ||
| 365 | extern int usb_new_device(struct usb_device *dev); | ||
| 366 | extern void usb_disconnect(struct usb_device **); | ||
| 367 | |||
| 368 | extern int usb_get_configuration(struct usb_device *dev); | ||
| 369 | extern void usb_destroy_configuration(struct usb_device *dev); | ||
| 370 | |||
| 371 | /*-------------------------------------------------------------------------*/ | ||
| 372 | |||
| 373 | /* | ||
| 374 | * HCD Root Hub support | ||
| 375 | */ | ||
| 376 | |||
| 377 | #include <linux/../../drivers/usb/core/hub.h> | ||
| 378 | |||
| 379 | /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */ | ||
| 380 | #define DeviceRequest \ | ||
| 381 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | ||
| 382 | #define DeviceOutRequest \ | ||
| 383 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | ||
| 384 | |||
| 385 | #define InterfaceRequest \ | ||
| 386 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | ||
| 387 | |||
| 388 | #define EndpointRequest \ | ||
| 389 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | ||
| 390 | #define EndpointOutRequest \ | ||
| 391 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | ||
| 392 | |||
| 393 | /* class requests from the USB 2.0 hub spec, table 11-15 */ | ||
| 394 | /* GetBusState and SetHubDescriptor are optional, omitted */ | ||
| 395 | #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE) | ||
| 396 | #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE) | ||
| 397 | #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR) | ||
| 398 | #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS) | ||
| 399 | #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS) | ||
| 400 | #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE) | ||
| 401 | #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE) | ||
| 402 | |||
| 403 | |||
| 404 | /*-------------------------------------------------------------------------*/ | ||
| 405 | |||
| 406 | /* | ||
| 407 | * Generic bandwidth allocation constants/support | ||
| 408 | */ | ||
| 409 | #define FRAME_TIME_USECS 1000L | ||
| 410 | #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ | ||
| 411 | /* Trying not to use worst-case bit-stuffing | ||
| 412 | * of (7/6 * 8 * bytecount) = 9.33 * bytecount */ | ||
| 413 | /* bytecount = data payload byte count */ | ||
| 414 | |||
| 415 | #define NS_TO_US(ns) ((ns + 500L) / 1000L) | ||
| 416 | /* convert & round nanoseconds to microseconds */ | ||
| 417 | |||
| 418 | |||
| 419 | /* | ||
| 420 | * Full/low speed bandwidth allocation constants/support. | ||
| 421 | */ | ||
| 422 | #define BW_HOST_DELAY 1000L /* nanoseconds */ | ||
| 423 | #define BW_HUB_LS_SETUP 333L /* nanoseconds */ | ||
| 424 | /* 4 full-speed bit times (est.) */ | ||
| 425 | |||
| 426 | #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ | ||
| 427 | #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) | ||
| 428 | #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) | ||
| 429 | |||
| 430 | /* | ||
| 431 | * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed | ||
| 432 | * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed | ||
| 433 | * to preallocate bandwidth) | ||
| 434 | */ | ||
| 435 | #define USB2_HOST_DELAY 5 /* nsec, guess */ | ||
| 436 | #define HS_NSECS(bytes) (((55 * 8 * 2083) \ | ||
| 437 | + (2083UL * (3 + BitTime(bytes))))/1000 \ | ||
| 438 | + USB2_HOST_DELAY) | ||
| 439 | #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \ | ||
| 440 | + (2083UL * (3 + BitTime(bytes))))/1000 \ | ||
| 441 | + USB2_HOST_DELAY) | ||
| 442 | #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes)) | ||
| 443 | #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes)) | ||
| 444 | |||
| 445 | extern long usb_calc_bus_time(int speed, int is_input, | ||
| 446 | int isoc, int bytecount); | ||
| 447 | |||
| 448 | /*-------------------------------------------------------------------------*/ | ||
| 449 | |||
| 450 | extern void usb_set_device_state(struct usb_device *udev, | ||
| 451 | enum usb_device_state new_state); | ||
| 452 | |||
| 453 | /*-------------------------------------------------------------------------*/ | ||
| 454 | |||
| 455 | /* exported only within usbcore */ | ||
| 456 | |||
| 457 | extern struct list_head usb_bus_list; | ||
| 458 | extern struct mutex usb_bus_list_lock; | ||
| 459 | extern wait_queue_head_t usb_kill_urb_queue; | ||
| 460 | |||
| 461 | extern int usb_find_interface_driver(struct usb_device *dev, | ||
| 462 | struct usb_interface *interface); | ||
| 463 | |||
| 464 | #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN)) | ||
| 465 | |||
| 466 | #ifdef CONFIG_PM | ||
| 467 | extern void usb_root_hub_lost_power(struct usb_device *rhdev); | ||
| 468 | extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg); | ||
| 469 | extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg); | ||
| 470 | #endif /* CONFIG_PM */ | ||
| 471 | |||
| 472 | #ifdef CONFIG_USB_SUSPEND | ||
| 473 | extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd); | ||
| 474 | #else | ||
| 475 | static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd) | ||
| 476 | { | ||
| 477 | return; | ||
| 478 | } | ||
| 479 | #endif /* CONFIG_USB_SUSPEND */ | ||
| 480 | |||
| 481 | |||
| 482 | /* | ||
| 483 | * USB device fs stuff | ||
| 484 | */ | ||
| 485 | |||
| 486 | #ifdef CONFIG_USB_DEVICEFS | ||
| 487 | |||
| 488 | /* | ||
| 489 | * these are expected to be called from the USB core/hub thread | ||
| 490 | * with the kernel lock held | ||
| 491 | */ | ||
| 492 | extern void usbfs_update_special(void); | ||
| 493 | extern int usbfs_init(void); | ||
| 494 | extern void usbfs_cleanup(void); | ||
| 495 | |||
| 496 | #else /* CONFIG_USB_DEVICEFS */ | ||
| 497 | |||
| 498 | static inline void usbfs_update_special(void) {} | ||
| 499 | static inline int usbfs_init(void) { return 0; } | ||
| 500 | static inline void usbfs_cleanup(void) { } | ||
| 501 | |||
| 502 | #endif /* CONFIG_USB_DEVICEFS */ | ||
| 503 | |||
| 504 | /*-------------------------------------------------------------------------*/ | ||
| 505 | |||
| 506 | #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) | ||
| 507 | |||
| 508 | struct usb_mon_operations { | ||
| 509 | void (*urb_submit)(struct usb_bus *bus, struct urb *urb); | ||
| 510 | void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err); | ||
| 511 | void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status); | ||
| 512 | /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */ | ||
| 513 | }; | ||
| 514 | |||
| 515 | extern struct usb_mon_operations *mon_ops; | ||
| 516 | |||
| 517 | static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) | ||
| 518 | { | ||
| 519 | if (bus->monitored) | ||
| 520 | (*mon_ops->urb_submit)(bus, urb); | ||
| 521 | } | ||
| 522 | |||
| 523 | static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, | ||
| 524 | int error) | ||
| 525 | { | ||
| 526 | if (bus->monitored) | ||
| 527 | (*mon_ops->urb_submit_error)(bus, urb, error); | ||
| 528 | } | ||
| 529 | |||
| 530 | static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, | ||
| 531 | int status) | ||
| 532 | { | ||
| 533 | if (bus->monitored) | ||
| 534 | (*mon_ops->urb_complete)(bus, urb, status); | ||
| 535 | } | ||
| 536 | |||
| 537 | int usb_mon_register(struct usb_mon_operations *ops); | ||
| 538 | void usb_mon_deregister(void); | ||
| 539 | |||
| 540 | #else | ||
| 541 | |||
| 542 | static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {} | ||
| 543 | static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, | ||
| 544 | int error) {} | ||
| 545 | static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, | ||
| 546 | int status) {} | ||
| 547 | |||
| 548 | #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */ | ||
| 549 | |||
| 550 | /*-------------------------------------------------------------------------*/ | ||
| 551 | |||
| 552 | /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */ | ||
| 553 | /* bleech -- resurfaced in 2.4.11 or 2.4.12 */ | ||
| 554 | #define bitmap DeviceRemovable | ||
| 555 | |||
| 556 | |||
| 557 | /*-------------------------------------------------------------------------*/ | ||
| 558 | |||
| 559 | /* random stuff */ | ||
| 560 | |||
| 561 | #define RUN_CONTEXT (in_irq() ? "in_irq" \ | ||
| 562 | : (in_interrupt() ? "in_interrupt" : "can sleep")) | ||
| 563 | |||
| 564 | |||
| 565 | /* This rwsem is for use only by the hub driver and ehci-hcd. | ||
| 566 | * Nobody else should touch it. | ||
| 567 | */ | ||
| 568 | extern struct rw_semaphore ehci_cf_port_reset_rwsem; | ||
| 569 | |||
| 570 | /* Keep track of which host controller drivers are loaded */ | ||
| 571 | #define USB_UHCI_LOADED 0 | ||
| 572 | #define USB_OHCI_LOADED 1 | ||
| 573 | #define USB_EHCI_LOADED 2 | ||
| 574 | extern unsigned long usb_hcds_loaded; | ||
| 575 | |||
| 576 | #endif /* __KERNEL__ */ | ||
| 577 | |||
| 578 | #endif /* __USB_CORE_HCD_H */ | ||
