2 * Copyright (c) 2001-2002 by David Brownell
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.
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
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.
22 /* This file contains declarations of usbcore internals that are mostly
23 * used or exposed by Host Controller Drivers.
27 * USB Packet IDs (PIDs)
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 */
47 /*-------------------------------------------------------------------------*/
50 * USB Host Controller Driver (usb_hcd) framework
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.
56 /*-------------------------------------------------------------------------*/
58 struct usb_hcd { /* usb_bus.hcpriv points to this */
63 struct usb_bus self; /* hcd is-a bus */
65 const char *product_desc; /* product/vendor string */
66 char irq_descr[24]; /* driver + bus # */
68 struct timer_list rh_timer; /* drives root-hub polling */
69 struct urb *status_urb; /* the current status urb */
74 const struct hc_driver *driver; /* hw-specific hooks */
76 /* Flags that need to be manipulated atomically */
78 #define HCD_FLAG_HW_ACCESSIBLE 0x00000001
79 #define HCD_FLAG_SAW_IRQ 0x00000002
81 unsigned rh_registered:1;/* is root hub registered? */
83 /* The next flag is a stopgap, to be removed when all the HCDs
84 * support the new root-hub polling mechanism. */
85 unsigned uses_new_polling:1;
86 unsigned poll_rh:1; /* poll for rh status? */
87 unsigned poll_pending:1; /* status has changed? */
89 int irq; /* irq allocated */
90 void __iomem *regs; /* device memory/io */
91 u64 rsrc_start; /* memory/io resource start */
92 u64 rsrc_len; /* memory/io resource length */
93 unsigned power_budget; /* in mA, 0 = no limit */
95 #define HCD_BUFFER_POOLS 4
96 struct dma_pool *pool [HCD_BUFFER_POOLS];
99 # define __ACTIVE 0x01
100 # define __SUSPEND 0x04
101 # define __TRANSIENT 0x80
103 # define HC_STATE_HALT 0
104 # define HC_STATE_RUNNING (__ACTIVE)
105 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
106 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
107 # define HC_STATE_SUSPENDED (__SUSPEND)
109 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
110 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
112 /* more shared queuing code would be good; it should support
113 * smarter scheduling, handle transaction translators, etc;
114 * input size of periodic table to an interrupt scheduler.
115 * (ohci 32, uhci 1024, ehci 256/512/1024).
118 /* The HC driver's private data is stored at the end of
121 unsigned long hcd_priv[0]
122 __attribute__ ((aligned (sizeof(unsigned long))));
125 /* 2.4 does this a bit differently ... */
126 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
132 // urb.hcpriv is really hardware-specific
134 struct hcd_timeout { /* timeouts we allocate */
135 struct list_head timeout_list;
136 struct timer_list timer;
139 /*-------------------------------------------------------------------------*/
142 * FIXME usb_operations should vanish or become hc_driver,
143 * when usb_bus and usb_hcd become the same thing.
146 struct usb_operations {
147 int (*get_frame_number) (struct usb_device *usb_dev);
148 int (*submit_urb) (struct urb *urb, gfp_t mem_flags);
149 int (*unlink_urb) (struct urb *urb, int status);
151 /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
152 void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
155 void (*buffer_free)(struct usb_bus *bus, size_t size,
156 void *addr, dma_addr_t dma);
158 void (*disable)(struct usb_device *udev,
159 struct usb_host_endpoint *ep);
162 /* each driver provides one of these, and hardware init support */
167 const char *description; /* "ehci-hcd" etc */
168 const char *product_desc; /* product/vendor string */
169 size_t hcd_priv_size; /* size of private data */
172 irqreturn_t (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
175 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
176 #define HCD_USB11 0x0010 /* USB 1.1 */
177 #define HCD_USB2 0x0020 /* USB 2.0 */
179 /* called to init HCD and root hub */
180 int (*reset) (struct usb_hcd *hcd);
181 int (*start) (struct usb_hcd *hcd);
183 /* NOTE: these suspend/resume calls relate to the HC as
184 * a whole, not just the root hub; they're for PCI bus glue.
186 /* called after suspending the hub, before entering D3 etc */
187 int (*suspend) (struct usb_hcd *hcd, pm_message_t message);
189 /* called after entering D0 (etc), before resuming the hub */
190 int (*resume) (struct usb_hcd *hcd);
192 /* cleanly make HCD stop writing memory and doing I/O */
193 void (*stop) (struct usb_hcd *hcd);
196 void (*shutdown) (struct usb_hcd *hcd);
198 /* return current frame number */
199 int (*get_frame_number) (struct usb_hcd *hcd);
201 /* manage i/o requests, device state */
202 int (*urb_enqueue) (struct usb_hcd *hcd,
203 struct usb_host_endpoint *ep,
206 int (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
208 /* hw synch, freeing endpoint resources that urb_dequeue can't */
209 void (*endpoint_disable)(struct usb_hcd *hcd,
210 struct usb_host_endpoint *ep);
212 /* root hub support */
213 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
214 int (*hub_control) (struct usb_hcd *hcd,
215 u16 typeReq, u16 wValue, u16 wIndex,
216 char *buf, u16 wLength);
217 int (*bus_suspend)(struct usb_hcd *);
218 int (*bus_resume)(struct usb_hcd *);
219 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
220 void (*hub_irq_enable)(struct usb_hcd *);
221 /* Needed only if port-change IRQs are level-triggered */
224 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
226 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
227 struct device *dev, char *bus_name);
228 extern void usb_put_hcd (struct usb_hcd *hcd);
229 extern int usb_add_hcd(struct usb_hcd *hcd,
230 unsigned int irqnum, unsigned long irqflags);
231 extern void usb_remove_hcd(struct usb_hcd *hcd);
233 struct platform_device;
234 extern void usb_hcd_platform_shutdown(struct platform_device* dev);
238 struct pci_device_id;
239 extern int usb_hcd_pci_probe (struct pci_dev *dev,
240 const struct pci_device_id *id);
241 extern void usb_hcd_pci_remove (struct pci_dev *dev);
244 extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state);
245 extern int usb_hcd_pci_resume (struct pci_dev *dev);
246 #endif /* CONFIG_PM */
248 extern void usb_hcd_pci_shutdown (struct pci_dev *dev);
250 #endif /* CONFIG_PCI */
252 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
253 int hcd_buffer_create (struct usb_hcd *hcd);
254 void hcd_buffer_destroy (struct usb_hcd *hcd);
256 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
257 gfp_t mem_flags, dma_addr_t *dma);
258 void hcd_buffer_free (struct usb_bus *bus, size_t size,
259 void *addr, dma_addr_t dma);
261 /* generic bus glue, needed for host controllers that don't use PCI */
262 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
264 extern void usb_hc_died (struct usb_hcd *hcd);
265 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
267 /* -------------------------------------------------------------------------- */
269 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
270 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
271 struct usb_bus *, unsigned port);
272 extern int usb_new_device(struct usb_device *dev);
273 extern void usb_disconnect(struct usb_device **);
275 extern int usb_get_configuration(struct usb_device *dev);
276 extern void usb_destroy_configuration(struct usb_device *dev);
278 /*-------------------------------------------------------------------------*/
281 * HCD Root Hub support
286 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
287 #define DeviceRequest \
288 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
289 #define DeviceOutRequest \
290 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
292 #define InterfaceRequest \
293 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
295 #define EndpointRequest \
296 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
297 #define EndpointOutRequest \
298 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
300 /* class requests from the USB 2.0 hub spec, table 11-15 */
301 /* GetBusState and SetHubDescriptor are optional, omitted */
302 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
303 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
304 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
305 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
306 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
307 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
308 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
311 /*-------------------------------------------------------------------------*/
314 * Generic bandwidth allocation constants/support
316 #define FRAME_TIME_USECS 1000L
317 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
318 /* Trying not to use worst-case bit-stuffing
319 of (7/6 * 8 * bytecount) = 9.33 * bytecount */
320 /* bytecount = data payload byte count */
322 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
323 /* convert & round nanoseconds to microseconds */
325 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
326 int bustime, int isoc);
327 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
331 * Full/low speed bandwidth allocation constants/support.
333 #define BW_HOST_DELAY 1000L /* nanoseconds */
334 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
335 /* 4 full-speed bit times (est.) */
337 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
338 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
339 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
341 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
344 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
345 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
346 * to preallocate bandwidth)
348 #define USB2_HOST_DELAY 5 /* nsec, guess */
349 #define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
350 + (2083UL * (3 + BitTime(bytes))))/1000 \
352 #define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
353 + (2083UL * (3 + BitTime(bytes))))/1000 \
355 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
356 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
358 extern long usb_calc_bus_time (int speed, int is_input,
359 int isoc, int bytecount);
361 /*-------------------------------------------------------------------------*/
363 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
365 extern void usb_set_device_state(struct usb_device *udev,
366 enum usb_device_state new_state);
368 /*-------------------------------------------------------------------------*/
370 /* exported only within usbcore */
372 extern struct list_head usb_bus_list;
373 extern struct mutex usb_bus_list_lock;
374 extern wait_queue_head_t usb_kill_urb_queue;
376 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
377 extern void usb_bus_put (struct usb_bus *bus);
379 extern void usb_enable_root_hub_irq (struct usb_bus *bus);
381 extern int usb_find_interface_driver (struct usb_device *dev,
382 struct usb_interface *interface);
384 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
387 extern void usb_hcd_suspend_root_hub (struct usb_hcd *hcd);
388 extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
389 extern void usb_root_hub_lost_power (struct usb_device *rhdev);
390 extern int hcd_bus_suspend (struct usb_bus *bus);
391 extern int hcd_bus_resume (struct usb_bus *bus);
393 static inline void usb_hcd_suspend_root_hub(struct usb_hcd *hcd)
398 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
403 static inline int hcd_bus_suspend(struct usb_bus *bus)
408 static inline int hcd_bus_resume (struct usb_bus *bus)
412 #endif /* CONFIG_PM */
415 * USB device fs stuff
418 #ifdef CONFIG_USB_DEVICEFS
421 * these are expected to be called from the USB core/hub thread
422 * with the kernel lock held
424 extern void usbfs_update_special (void);
425 extern int usbfs_init(void);
426 extern void usbfs_cleanup(void);
428 #else /* CONFIG_USB_DEVICEFS */
430 static inline void usbfs_update_special (void) {}
431 static inline int usbfs_init(void) { return 0; }
432 static inline void usbfs_cleanup(void) { }
434 #endif /* CONFIG_USB_DEVICEFS */
436 /*-------------------------------------------------------------------------*/
438 #if defined(CONFIG_USB_MON)
440 struct usb_mon_operations {
441 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
442 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
443 void (*urb_complete)(struct usb_bus *bus, struct urb *urb);
444 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
447 extern struct usb_mon_operations *mon_ops;
449 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
452 (*mon_ops->urb_submit)(bus, urb);
455 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
459 (*mon_ops->urb_submit_error)(bus, urb, error);
462 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb)
465 (*mon_ops->urb_complete)(bus, urb);
468 int usb_mon_register(struct usb_mon_operations *ops);
469 void usb_mon_deregister(void);
473 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
474 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
476 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {}
478 #endif /* CONFIG_USB_MON */
480 /*-------------------------------------------------------------------------*/
482 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
483 // bleech -- resurfaced in 2.4.11 or 2.4.12
484 #define bitmap DeviceRemovable
487 /*-------------------------------------------------------------------------*/
491 #define RUN_CONTEXT (in_irq () ? "in_irq" \
492 : (in_interrupt () ? "in_interrupt" : "can sleep"))
495 #endif /* __KERNEL__ */