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 20#ifdef __KERNEL__ 21 22/* This file contains declarations of usbcore internals that are mostly 23 * used or exposed by Host Controller Drivers. 24 */ 25 26/* 27 * USB Packet IDs (PIDs) 28 */ 29#define USB_PID_UNDEF_0 0xf0 30#define USB_PID_OUT 0xe1 31#define USB_PID_ACK 0xd2 32#define USB_PID_DATA0 0xc3 33#define USB_PID_PING 0xb4 /* USB 2.0 */ 34#define USB_PID_SOF 0xa5 35#define USB_PID_NYET 0x96 /* USB 2.0 */ 36#define USB_PID_DATA2 0x87 /* USB 2.0 */ 37#define USB_PID_SPLIT 0x78 /* USB 2.0 */ 38#define USB_PID_IN 0x69 39#define USB_PID_NAK 0x5a 40#define USB_PID_DATA1 0x4b 41#define USB_PID_PREAMBLE 0x3c /* Token mode */ 42#define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */ 43#define USB_PID_SETUP 0x2d 44#define USB_PID_STALL 0x1e 45#define USB_PID_MDATA 0x0f /* USB 2.0 */ 46 47/*-------------------------------------------------------------------------*/ 48 49/* 50 * USB Host Controller Driver (usb_hcd) framework 51 * 52 * Since "struct usb_bus" is so thin, you can't share much code in it. 53 * This framework is a layer over that, and should be more sharable. 54 */ 55 56/*-------------------------------------------------------------------------*/ 57 58struct usb_hcd { 59 60 /* 61 * housekeeping 62 */ 63 struct usb_bus self; /* hcd is-a bus */ 64 struct kref kref; /* reference counter */ 65 66 const char *product_desc; /* product/vendor string */ 67 char irq_descr[24]; /* driver + bus # */ 68 69 struct timer_list rh_timer; /* drives root-hub polling */ 70 struct urb *status_urb; /* the current status urb */ 71#ifdef CONFIG_PM 72 struct work_struct wakeup_work; /* for remote wakeup */ 73#endif 74 75 /* 76 * hardware info/state 77 */ 78 const struct hc_driver *driver; /* hw-specific hooks */ 79 80 /* Flags that need to be manipulated atomically */ 81 unsigned long flags; 82#define HCD_FLAG_HW_ACCESSIBLE 0x00000001 83#define HCD_FLAG_SAW_IRQ 0x00000002 84 85 unsigned rh_registered:1;/* is root hub registered? */ 86 87 /* The next flag is a stopgap, to be removed when all the HCDs 88 * support the new root-hub polling mechanism. */ 89 unsigned uses_new_polling:1; 90 unsigned poll_rh:1; /* poll for rh status? */ 91 unsigned poll_pending:1; /* status has changed? */ 92 unsigned wireless:1; /* Wireless USB HCD */ 93 94 int irq; /* irq allocated */ 95 void __iomem *regs; /* device memory/io */ 96 u64 rsrc_start; /* memory/io resource start */ 97 u64 rsrc_len; /* memory/io resource length */ 98 unsigned power_budget; /* in mA, 0 = no limit */ 99 100#define HCD_BUFFER_POOLS 4 101 struct dma_pool *pool [HCD_BUFFER_POOLS]; 102 103 int state; 104# define __ACTIVE 0x01 105# define __SUSPEND 0x04 106# define __TRANSIENT 0x80 107 108# define HC_STATE_HALT 0 109# define HC_STATE_RUNNING (__ACTIVE) 110# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE) 111# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT) 112# define HC_STATE_SUSPENDED (__SUSPEND) 113 114#define HC_IS_RUNNING(state) ((state) & __ACTIVE) 115#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND) 116 117 /* more shared queuing code would be good; it should support 118 * smarter scheduling, handle transaction translators, etc; 119 * input size of periodic table to an interrupt scheduler. 120 * (ohci 32, uhci 1024, ehci 256/512/1024). 121 */ 122 123 /* The HC driver's private data is stored at the end of 124 * this structure. 125 */ 126 unsigned long hcd_priv[0] 127 __attribute__ ((aligned (sizeof(unsigned long)))); 128}; 129 130/* 2.4 does this a bit differently ... */ 131static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd) 132{ 133 return &hcd->self; 134} 135 136static inline struct usb_hcd *bus_to_hcd (struct usb_bus *bus) 137{ 138 return container_of(bus, struct usb_hcd, self); 139} 140 141struct hcd_timeout { /* timeouts we allocate */ 142 struct list_head timeout_list; 143 struct timer_list timer; 144}; 145 146/*-------------------------------------------------------------------------*/ 147 148 149struct hc_driver { 150 const char *description; /* "ehci-hcd" etc */ 151 const char *product_desc; /* product/vendor string */ 152 size_t hcd_priv_size; /* size of private data */ 153 154 /* irq handler */ 155 irqreturn_t (*irq) (struct usb_hcd *hcd); 156 157 int flags; 158#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */ 159#define HCD_USB11 0x0010 /* USB 1.1 */ 160#define HCD_USB2 0x0020 /* USB 2.0 */ 161 162 /* called to init HCD and root hub */ 163 int (*reset) (struct usb_hcd *hcd); 164 int (*start) (struct usb_hcd *hcd); 165 166 /* NOTE: these suspend/resume calls relate to the HC as 167 * a whole, not just the root hub; they're for PCI bus glue. 168 */ 169 /* called after suspending the hub, before entering D3 etc */ 170 int (*suspend) (struct usb_hcd *hcd, pm_message_t message); 171 172 /* called after entering D0 (etc), before resuming the hub */ 173 int (*resume) (struct usb_hcd *hcd); 174 175 /* cleanly make HCD stop writing memory and doing I/O */ 176 void (*stop) (struct usb_hcd *hcd); 177 178 /* shutdown HCD */ 179 void (*shutdown) (struct usb_hcd *hcd); 180 181 /* return current frame number */ 182 int (*get_frame_number) (struct usb_hcd *hcd); 183 184 /* manage i/o requests, device state */ 185 int (*urb_enqueue) (struct usb_hcd *hcd, 186 struct usb_host_endpoint *ep, 187 struct urb *urb, 188 gfp_t mem_flags); 189 int (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb); 190 191 /* hw synch, freeing endpoint resources that urb_dequeue can't */ 192 void (*endpoint_disable)(struct usb_hcd *hcd, 193 struct usb_host_endpoint *ep); 194 195 /* root hub support */ 196 int (*hub_status_data) (struct usb_hcd *hcd, char *buf); 197 int (*hub_control) (struct usb_hcd *hcd, 198 u16 typeReq, u16 wValue, u16 wIndex, 199 char *buf, u16 wLength); 200 int (*bus_suspend)(struct usb_hcd *); 201 int (*bus_resume)(struct usb_hcd *); 202 int (*start_port_reset)(struct usb_hcd *, unsigned port_num); 203 void (*hub_irq_enable)(struct usb_hcd *); 204 /* Needed only if port-change IRQs are level-triggered */ 205}; 206 207extern int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags); 208extern int usb_hcd_unlink_urb (struct urb *urb, int status); 209extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb); 210extern void usb_hcd_endpoint_disable (struct usb_device *udev, 211 struct usb_host_endpoint *ep); 212extern int usb_hcd_get_frame_number (struct usb_device *udev); 213 214extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver, 215 struct device *dev, char *bus_name); 216extern struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd); 217extern void usb_put_hcd (struct usb_hcd *hcd); 218extern int usb_add_hcd(struct usb_hcd *hcd, 219 unsigned int irqnum, unsigned long irqflags); 220extern void usb_remove_hcd(struct usb_hcd *hcd); 221 222struct platform_device; 223extern void usb_hcd_platform_shutdown(struct platform_device* dev); 224 225#ifdef CONFIG_PCI 226struct pci_dev; 227struct pci_device_id; 228extern int usb_hcd_pci_probe (struct pci_dev *dev, 229 const struct pci_device_id *id); 230extern void usb_hcd_pci_remove (struct pci_dev *dev); 231 232#ifdef CONFIG_PM 233extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state); 234extern int usb_hcd_pci_resume (struct pci_dev *dev); 235#endif /* CONFIG_PM */ 236 237extern void usb_hcd_pci_shutdown (struct pci_dev *dev); 238 239#endif /* CONFIG_PCI */ 240 241/* pci-ish (pdev null is ok) buffer alloc/mapping support */ 242int hcd_buffer_create (struct usb_hcd *hcd); 243void hcd_buffer_destroy (struct usb_hcd *hcd); 244 245void *hcd_buffer_alloc (struct usb_bus *bus, size_t size, 246 gfp_t mem_flags, dma_addr_t *dma); 247void hcd_buffer_free (struct usb_bus *bus, size_t size, 248 void *addr, dma_addr_t dma); 249 250/* generic bus glue, needed for host controllers that don't use PCI */ 251extern irqreturn_t usb_hcd_irq (int irq, void *__hcd); 252 253extern void usb_hc_died (struct usb_hcd *hcd); 254extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd); 255 256/* -------------------------------------------------------------------------- */ 257 258/* Enumeration is only for the hub driver, or HCD virtual root hubs */ 259extern struct usb_device *usb_alloc_dev(struct usb_device *parent, 260 struct usb_bus *, unsigned port); 261extern int usb_new_device(struct usb_device *dev); 262extern void usb_disconnect(struct usb_device **); 263 264extern int usb_get_configuration(struct usb_device *dev); 265extern void usb_destroy_configuration(struct usb_device *dev); 266 267/*-------------------------------------------------------------------------*/ 268 269/* 270 * HCD Root Hub support 271 */ 272 273#include "hub.h" 274 275/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */ 276#define DeviceRequest \ 277 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 278#define DeviceOutRequest \ 279 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 280 281#define InterfaceRequest \ 282 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) 283 284#define EndpointRequest \ 285 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) 286#define EndpointOutRequest \ 287 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) 288 289/* class requests from the USB 2.0 hub spec, table 11-15 */ 290/* GetBusState and SetHubDescriptor are optional, omitted */ 291#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE) 292#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE) 293#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR) 294#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS) 295#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS) 296#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE) 297#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE) 298 299 300/*-------------------------------------------------------------------------*/ 301 302/* 303 * Generic bandwidth allocation constants/support 304 */ 305#define FRAME_TIME_USECS 1000L 306#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ 307 /* Trying not to use worst-case bit-stuffing 308 of (7/6 * 8 * bytecount) = 9.33 * bytecount */ 309 /* bytecount = data payload byte count */ 310 311#define NS_TO_US(ns) ((ns + 500L) / 1000L) 312 /* convert & round nanoseconds to microseconds */ 313 314 315/* 316 * Full/low speed bandwidth allocation constants/support. 317 */ 318#define BW_HOST_DELAY 1000L /* nanoseconds */ 319#define BW_HUB_LS_SETUP 333L /* nanoseconds */ 320 /* 4 full-speed bit times (est.) */ 321 322#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ 323#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) 324#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) 325 326/* 327 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed 328 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed 329 * to preallocate bandwidth) 330 */ 331#define USB2_HOST_DELAY 5 /* nsec, guess */ 332#define HS_NSECS(bytes) ( ((55 * 8 * 2083) \ 333 + (2083UL * (3 + BitTime(bytes))))/1000 \ 334 + USB2_HOST_DELAY) 335#define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \ 336 + (2083UL * (3 + BitTime(bytes))))/1000 \ 337 + USB2_HOST_DELAY) 338#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes)) 339#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes)) 340 341extern long usb_calc_bus_time (int speed, int is_input, 342 int isoc, int bytecount); 343 344/*-------------------------------------------------------------------------*/ 345 346extern void usb_set_device_state(struct usb_device *udev, 347 enum usb_device_state new_state); 348 349/*-------------------------------------------------------------------------*/ 350 351/* exported only within usbcore */ 352 353extern struct list_head usb_bus_list; 354extern struct mutex usb_bus_list_lock; 355extern wait_queue_head_t usb_kill_urb_queue; 356 357extern void usb_enable_root_hub_irq (struct usb_bus *bus); 358 359extern int usb_find_interface_driver (struct usb_device *dev, 360 struct usb_interface *interface); 361 362#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN)) 363 364#ifdef CONFIG_PM 365extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd); 366extern void usb_root_hub_lost_power (struct usb_device *rhdev); 367extern int hcd_bus_suspend (struct usb_bus *bus); 368extern int hcd_bus_resume (struct usb_bus *bus); 369#else 370static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd) 371{ 372 return; 373} 374 375static inline int hcd_bus_suspend(struct usb_bus *bus) 376{ 377 return 0; 378} 379 380static inline int hcd_bus_resume (struct usb_bus *bus) 381{ 382 return 0; 383} 384#endif /* CONFIG_PM */ 385 386/* 387 * USB device fs stuff 388 */ 389 390#ifdef CONFIG_USB_DEVICEFS 391 392/* 393 * these are expected to be called from the USB core/hub thread 394 * with the kernel lock held 395 */ 396extern void usbfs_update_special (void); 397extern int usbfs_init(void); 398extern void usbfs_cleanup(void); 399 400#else /* CONFIG_USB_DEVICEFS */ 401 402static inline void usbfs_update_special (void) {} 403static inline int usbfs_init(void) { return 0; } 404static inline void usbfs_cleanup(void) { } 405 406#endif /* CONFIG_USB_DEVICEFS */ 407 408/*-------------------------------------------------------------------------*/ 409 410#if defined(CONFIG_USB_MON) 411 412struct usb_mon_operations { 413 void (*urb_submit)(struct usb_bus *bus, struct urb *urb); 414 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err); 415 void (*urb_complete)(struct usb_bus *bus, struct urb *urb); 416 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */ 417}; 418 419extern struct usb_mon_operations *mon_ops; 420 421static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) 422{ 423 if (bus->monitored) 424 (*mon_ops->urb_submit)(bus, urb); 425} 426 427static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 428 int error) 429{ 430 if (bus->monitored) 431 (*mon_ops->urb_submit_error)(bus, urb, error); 432} 433 434static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) 435{ 436 if (bus->monitored) 437 (*mon_ops->urb_complete)(bus, urb); 438} 439 440int usb_mon_register(struct usb_mon_operations *ops); 441void usb_mon_deregister(void); 442 443#else 444 445static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {} 446static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 447 int error) {} 448static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {} 449 450#endif /* CONFIG_USB_MON */ 451 452/*-------------------------------------------------------------------------*/ 453 454/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */ 455// bleech -- resurfaced in 2.4.11 or 2.4.12 456#define bitmap DeviceRemovable 457 458 459/*-------------------------------------------------------------------------*/ 460 461/* random stuff */ 462 463#define RUN_CONTEXT (in_irq () ? "in_irq" \ 464 : (in_interrupt () ? "in_interrupt" : "can sleep")) 465 466 467#endif /* __KERNEL__ */ 468