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.
55 * @authorized_default: Specifies if new devices are authorized to
56 * connect by default or they require explicit
57 * user space authorization; this bit is settable
58 * through /sys/class/usb_host/X/authorized_default.
59 * For the rest is RO, so we don't lock to r/w it.
62 /*-------------------------------------------------------------------------*/
69 struct usb_bus self; /* hcd is-a bus */
70 struct kref kref; /* reference counter */
72 const char *product_desc; /* product/vendor string */
73 char irq_descr[24]; /* driver + bus # */
75 struct timer_list rh_timer; /* drives root-hub polling */
76 struct urb *status_urb; /* the current status urb */
78 struct work_struct wakeup_work; /* for remote wakeup */
84 const struct hc_driver *driver; /* hw-specific hooks */
86 /* Flags that need to be manipulated atomically */
88 #define HCD_FLAG_HW_ACCESSIBLE 0x00000001
89 #define HCD_FLAG_SAW_IRQ 0x00000002
91 unsigned rh_registered:1;/* is root hub registered? */
93 /* The next flag is a stopgap, to be removed when all the HCDs
94 * support the new root-hub polling mechanism. */
95 unsigned uses_new_polling:1;
96 unsigned poll_rh:1; /* poll for rh status? */
97 unsigned poll_pending:1; /* status has changed? */
98 unsigned wireless:1; /* Wireless USB HCD */
99 unsigned authorized_default:1;
101 int irq; /* irq allocated */
102 void __iomem *regs; /* device memory/io */
103 u64 rsrc_start; /* memory/io resource start */
104 u64 rsrc_len; /* memory/io resource length */
105 unsigned power_budget; /* in mA, 0 = no limit */
107 #define HCD_BUFFER_POOLS 4
108 struct dma_pool *pool [HCD_BUFFER_POOLS];
111 # define __ACTIVE 0x01
112 # define __SUSPEND 0x04
113 # define __TRANSIENT 0x80
115 # define HC_STATE_HALT 0
116 # define HC_STATE_RUNNING (__ACTIVE)
117 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
118 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
119 # define HC_STATE_SUSPENDED (__SUSPEND)
121 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
122 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
124 /* more shared queuing code would be good; it should support
125 * smarter scheduling, handle transaction translators, etc;
126 * input size of periodic table to an interrupt scheduler.
127 * (ohci 32, uhci 1024, ehci 256/512/1024).
130 /* The HC driver's private data is stored at the end of
133 unsigned long hcd_priv[0]
134 __attribute__ ((aligned (sizeof(unsigned long))));
137 /* 2.4 does this a bit differently ... */
138 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
143 static inline struct usb_hcd *bus_to_hcd (struct usb_bus *bus)
145 return container_of(bus, struct usb_hcd, self);
148 struct hcd_timeout { /* timeouts we allocate */
149 struct list_head timeout_list;
150 struct timer_list timer;
153 /*-------------------------------------------------------------------------*/
157 const char *description; /* "ehci-hcd" etc */
158 const char *product_desc; /* product/vendor string */
159 size_t hcd_priv_size; /* size of private data */
162 irqreturn_t (*irq) (struct usb_hcd *hcd);
165 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
166 #define HCD_USB11 0x0010 /* USB 1.1 */
167 #define HCD_USB2 0x0020 /* USB 2.0 */
169 /* called to init HCD and root hub */
170 int (*reset) (struct usb_hcd *hcd);
171 int (*start) (struct usb_hcd *hcd);
173 /* NOTE: these suspend/resume calls relate to the HC as
174 * a whole, not just the root hub; they're for PCI bus glue.
176 /* called after suspending the hub, before entering D3 etc */
177 int (*suspend) (struct usb_hcd *hcd, pm_message_t message);
179 /* called after entering D0 (etc), before resuming the hub */
180 int (*resume) (struct usb_hcd *hcd);
182 /* cleanly make HCD stop writing memory and doing I/O */
183 void (*stop) (struct usb_hcd *hcd);
186 void (*shutdown) (struct usb_hcd *hcd);
188 /* return current frame number */
189 int (*get_frame_number) (struct usb_hcd *hcd);
191 /* manage i/o requests, device state */
192 int (*urb_enqueue)(struct usb_hcd *hcd,
193 struct urb *urb, gfp_t mem_flags);
194 int (*urb_dequeue)(struct usb_hcd *hcd,
195 struct urb *urb, int status);
197 /* hw synch, freeing endpoint resources that urb_dequeue can't */
198 void (*endpoint_disable)(struct usb_hcd *hcd,
199 struct usb_host_endpoint *ep);
201 /* root hub support */
202 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
203 int (*hub_control) (struct usb_hcd *hcd,
204 u16 typeReq, u16 wValue, u16 wIndex,
205 char *buf, u16 wLength);
206 int (*bus_suspend)(struct usb_hcd *);
207 int (*bus_resume)(struct usb_hcd *);
208 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
209 void (*hub_irq_enable)(struct usb_hcd *);
210 /* Needed only if port-change IRQs are level-triggered */
213 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
214 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
216 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
218 extern int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags);
219 extern int usb_hcd_unlink_urb (struct urb *urb, int status);
220 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb);
221 extern void usb_hcd_endpoint_disable (struct usb_device *udev,
222 struct usb_host_endpoint *ep);
223 extern int usb_hcd_get_frame_number (struct usb_device *udev);
225 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
226 struct device *dev, char *bus_name);
227 extern struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd);
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);
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 */
327 * Full/low speed bandwidth allocation constants/support.
329 #define BW_HOST_DELAY 1000L /* nanoseconds */
330 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
331 /* 4 full-speed bit times (est.) */
333 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
334 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
335 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
338 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
339 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
340 * to preallocate bandwidth)
342 #define USB2_HOST_DELAY 5 /* nsec, guess */
343 #define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
344 + (2083UL * (3 + BitTime(bytes))))/1000 \
346 #define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
347 + (2083UL * (3 + BitTime(bytes))))/1000 \
349 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
350 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
352 extern long usb_calc_bus_time (int speed, int is_input,
353 int isoc, int bytecount);
355 /*-------------------------------------------------------------------------*/
357 extern void usb_set_device_state(struct usb_device *udev,
358 enum usb_device_state new_state);
360 /*-------------------------------------------------------------------------*/
362 /* exported only within usbcore */
364 extern struct list_head usb_bus_list;
365 extern struct mutex usb_bus_list_lock;
366 extern wait_queue_head_t usb_kill_urb_queue;
368 extern void usb_enable_root_hub_irq (struct usb_bus *bus);
370 extern int usb_find_interface_driver (struct usb_device *dev,
371 struct usb_interface *interface);
373 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
376 extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
377 extern void usb_root_hub_lost_power (struct usb_device *rhdev);
378 extern int hcd_bus_suspend(struct usb_device *rhdev);
379 extern int hcd_bus_resume(struct usb_device *rhdev);
381 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
385 #endif /* CONFIG_PM */
388 * USB device fs stuff
391 #ifdef CONFIG_USB_DEVICEFS
394 * these are expected to be called from the USB core/hub thread
395 * with the kernel lock held
397 extern void usbfs_update_special (void);
398 extern int usbfs_init(void);
399 extern void usbfs_cleanup(void);
401 #else /* CONFIG_USB_DEVICEFS */
403 static inline void usbfs_update_special (void) {}
404 static inline int usbfs_init(void) { return 0; }
405 static inline void usbfs_cleanup(void) { }
407 #endif /* CONFIG_USB_DEVICEFS */
409 /*-------------------------------------------------------------------------*/
411 #if defined(CONFIG_USB_MON)
413 struct usb_mon_operations {
414 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
415 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
416 void (*urb_complete)(struct usb_bus *bus, struct urb *urb);
417 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
420 extern struct usb_mon_operations *mon_ops;
422 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
425 (*mon_ops->urb_submit)(bus, urb);
428 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
432 (*mon_ops->urb_submit_error)(bus, urb, error);
435 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb)
438 (*mon_ops->urb_complete)(bus, urb);
441 int usb_mon_register(struct usb_mon_operations *ops);
442 void usb_mon_deregister(void);
446 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
447 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
449 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {}
451 #endif /* CONFIG_USB_MON */
453 /*-------------------------------------------------------------------------*/
455 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
456 // bleech -- resurfaced in 2.4.11 or 2.4.12
457 #define bitmap DeviceRemovable
460 /*-------------------------------------------------------------------------*/
464 #define RUN_CONTEXT (in_irq () ? "in_irq" \
465 : (in_interrupt () ? "in_interrupt" : "can sleep"))
468 #endif /* __KERNEL__ */