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 #include <linux/rwsem.h>
24 #define MAX_TOPO_LEVEL 6
26 /* This file contains declarations of usbcore internals that are mostly
27 * used or exposed by Host Controller Drivers.
31 * USB Packet IDs (PIDs)
33 #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
34 #define USB_PID_OUT 0xe1
35 #define USB_PID_ACK 0xd2
36 #define USB_PID_DATA0 0xc3
37 #define USB_PID_PING 0xb4 /* USB 2.0 */
38 #define USB_PID_SOF 0xa5
39 #define USB_PID_NYET 0x96 /* USB 2.0 */
40 #define USB_PID_DATA2 0x87 /* USB 2.0 */
41 #define USB_PID_SPLIT 0x78 /* USB 2.0 */
42 #define USB_PID_IN 0x69
43 #define USB_PID_NAK 0x5a
44 #define USB_PID_DATA1 0x4b
45 #define USB_PID_PREAMBLE 0x3c /* Token mode */
46 #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
47 #define USB_PID_SETUP 0x2d
48 #define USB_PID_STALL 0x1e
49 #define USB_PID_MDATA 0x0f /* USB 2.0 */
51 /*-------------------------------------------------------------------------*/
54 * USB Host Controller Driver (usb_hcd) framework
56 * Since "struct usb_bus" is so thin, you can't share much code in it.
57 * This framework is a layer over that, and should be more sharable.
59 * @authorized_default: Specifies if new devices are authorized to
60 * connect by default or they require explicit
61 * user space authorization; this bit is settable
62 * through /sys/class/usb_host/X/authorized_default.
63 * For the rest is RO, so we don't lock to r/w it.
66 /*-------------------------------------------------------------------------*/
73 struct usb_bus self
; /* hcd is-a bus */
74 struct kref kref
; /* reference counter */
76 const char *product_desc
; /* product/vendor string */
77 char irq_descr
[24]; /* driver + bus # */
79 struct timer_list rh_timer
; /* drives root-hub polling */
80 struct urb
*status_urb
; /* the current status urb */
82 struct work_struct wakeup_work
; /* for remote wakeup */
88 const struct hc_driver
*driver
; /* hw-specific hooks */
90 /* Flags that need to be manipulated atomically */
92 #define HCD_FLAG_HW_ACCESSIBLE 0x00000001
93 #define HCD_FLAG_SAW_IRQ 0x00000002
95 unsigned rh_registered
:1;/* is root hub registered? */
97 /* The next flag is a stopgap, to be removed when all the HCDs
98 * support the new root-hub polling mechanism. */
99 unsigned uses_new_polling
:1;
100 unsigned poll_rh
:1; /* poll for rh status? */
101 unsigned poll_pending
:1; /* status has changed? */
102 unsigned wireless
:1; /* Wireless USB HCD */
103 unsigned authorized_default
:1;
104 unsigned has_tt
:1; /* Integrated TT in root hub */
106 int irq
; /* irq allocated */
107 void __iomem
*regs
; /* device memory/io */
108 u64 rsrc_start
; /* memory/io resource start */
109 u64 rsrc_len
; /* memory/io resource length */
110 unsigned power_budget
; /* in mA, 0 = no limit */
112 #define HCD_BUFFER_POOLS 4
113 struct dma_pool
*pool
[HCD_BUFFER_POOLS
];
116 # define __ACTIVE 0x01
117 # define __SUSPEND 0x04
118 # define __TRANSIENT 0x80
120 # define HC_STATE_HALT 0
121 # define HC_STATE_RUNNING (__ACTIVE)
122 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
123 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
124 # define HC_STATE_SUSPENDED (__SUSPEND)
126 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
127 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
129 /* more shared queuing code would be good; it should support
130 * smarter scheduling, handle transaction translators, etc;
131 * input size of periodic table to an interrupt scheduler.
132 * (ohci 32, uhci 1024, ehci 256/512/1024).
135 /* The HC driver's private data is stored at the end of
138 unsigned long hcd_priv
[0]
139 __attribute__ ((aligned(sizeof(unsigned long))));
142 /* 2.4 does this a bit differently ... */
143 static inline struct usb_bus
*hcd_to_bus(struct usb_hcd
*hcd
)
148 static inline struct usb_hcd
*bus_to_hcd(struct usb_bus
*bus
)
150 return container_of(bus
, struct usb_hcd
, self
);
153 struct hcd_timeout
{ /* timeouts we allocate */
154 struct list_head timeout_list
;
155 struct timer_list timer
;
158 /*-------------------------------------------------------------------------*/
162 const char *description
; /* "ehci-hcd" etc */
163 const char *product_desc
; /* product/vendor string */
164 size_t hcd_priv_size
; /* size of private data */
167 irqreturn_t (*irq
) (struct usb_hcd
*hcd
);
170 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
171 #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
172 #define HCD_USB11 0x0010 /* USB 1.1 */
173 #define HCD_USB2 0x0020 /* USB 2.0 */
175 /* called to init HCD and root hub */
176 int (*reset
) (struct usb_hcd
*hcd
);
177 int (*start
) (struct usb_hcd
*hcd
);
179 /* NOTE: these suspend/resume calls relate to the HC as
180 * a whole, not just the root hub; they're for PCI bus glue.
182 /* called after suspending the hub, before entering D3 etc */
183 int (*pci_suspend
) (struct usb_hcd
*hcd
, pm_message_t message
);
185 /* called after entering D0 (etc), before resuming the hub */
186 int (*pci_resume
) (struct usb_hcd
*hcd
);
188 /* cleanly make HCD stop writing memory and doing I/O */
189 void (*stop
) (struct usb_hcd
*hcd
);
192 void (*shutdown
) (struct usb_hcd
*hcd
);
194 /* return current frame number */
195 int (*get_frame_number
) (struct usb_hcd
*hcd
);
197 /* manage i/o requests, device state */
198 int (*urb_enqueue
)(struct usb_hcd
*hcd
,
199 struct urb
*urb
, gfp_t mem_flags
);
200 int (*urb_dequeue
)(struct usb_hcd
*hcd
,
201 struct urb
*urb
, int status
);
203 /* hw synch, freeing endpoint resources that urb_dequeue can't */
204 void (*endpoint_disable
)(struct usb_hcd
*hcd
,
205 struct usb_host_endpoint
*ep
);
207 /* root hub support */
208 int (*hub_status_data
) (struct usb_hcd
*hcd
, char *buf
);
209 int (*hub_control
) (struct usb_hcd
*hcd
,
210 u16 typeReq
, u16 wValue
, u16 wIndex
,
211 char *buf
, u16 wLength
);
212 int (*bus_suspend
)(struct usb_hcd
*);
213 int (*bus_resume
)(struct usb_hcd
*);
214 int (*start_port_reset
)(struct usb_hcd
*, unsigned port_num
);
215 void (*hub_irq_enable
)(struct usb_hcd
*);
216 /* Needed only if port-change IRQs are level-triggered */
218 /* force handover of high-speed port to full-speed companion */
219 void (*relinquish_port
)(struct usb_hcd
*, int);
220 /* has a port been handed over to a companion? */
221 int (*port_handed_over
)(struct usb_hcd
*, int);
224 extern int usb_hcd_link_urb_to_ep(struct usb_hcd
*hcd
, struct urb
*urb
);
225 extern int usb_hcd_check_unlink_urb(struct usb_hcd
*hcd
, struct urb
*urb
,
227 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd
*hcd
, struct urb
*urb
);
229 extern int usb_hcd_submit_urb(struct urb
*urb
, gfp_t mem_flags
);
230 extern int usb_hcd_unlink_urb(struct urb
*urb
, int status
);
231 extern void usb_hcd_giveback_urb(struct usb_hcd
*hcd
, struct urb
*urb
,
233 extern void usb_hcd_flush_endpoint(struct usb_device
*udev
,
234 struct usb_host_endpoint
*ep
);
235 extern void usb_hcd_disable_endpoint(struct usb_device
*udev
,
236 struct usb_host_endpoint
*ep
);
237 extern int usb_hcd_get_frame_number(struct usb_device
*udev
);
239 extern struct usb_hcd
*usb_create_hcd(const struct hc_driver
*driver
,
240 struct device
*dev
, const char *bus_name
);
241 extern struct usb_hcd
*usb_get_hcd(struct usb_hcd
*hcd
);
242 extern void usb_put_hcd(struct usb_hcd
*hcd
);
243 extern int usb_add_hcd(struct usb_hcd
*hcd
,
244 unsigned int irqnum
, unsigned long irqflags
);
245 extern void usb_remove_hcd(struct usb_hcd
*hcd
);
247 struct platform_device
;
248 extern void usb_hcd_platform_shutdown(struct platform_device
*dev
);
252 struct pci_device_id
;
253 extern int usb_hcd_pci_probe(struct pci_dev
*dev
,
254 const struct pci_device_id
*id
);
255 extern void usb_hcd_pci_remove(struct pci_dev
*dev
);
258 extern int usb_hcd_pci_suspend(struct pci_dev
*dev
, pm_message_t state
);
259 extern int usb_hcd_pci_resume(struct pci_dev
*dev
);
260 #endif /* CONFIG_PM */
262 extern void usb_hcd_pci_shutdown(struct pci_dev
*dev
);
264 #endif /* CONFIG_PCI */
266 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
267 int hcd_buffer_create(struct usb_hcd
*hcd
);
268 void hcd_buffer_destroy(struct usb_hcd
*hcd
);
270 void *hcd_buffer_alloc(struct usb_bus
*bus
, size_t size
,
271 gfp_t mem_flags
, dma_addr_t
*dma
);
272 void hcd_buffer_free(struct usb_bus
*bus
, size_t size
,
273 void *addr
, dma_addr_t dma
);
275 /* generic bus glue, needed for host controllers that don't use PCI */
276 extern irqreturn_t
usb_hcd_irq(int irq
, void *__hcd
);
278 extern void usb_hc_died(struct usb_hcd
*hcd
);
279 extern void usb_hcd_poll_rh_status(struct usb_hcd
*hcd
);
281 /* -------------------------------------------------------------------------- */
283 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
284 extern struct usb_device
*usb_alloc_dev(struct usb_device
*parent
,
285 struct usb_bus
*, unsigned port
);
286 extern int usb_new_device(struct usb_device
*dev
);
287 extern void usb_disconnect(struct usb_device
**);
289 extern int usb_get_configuration(struct usb_device
*dev
);
290 extern void usb_destroy_configuration(struct usb_device
*dev
);
292 /*-------------------------------------------------------------------------*/
295 * HCD Root Hub support
300 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
301 #define DeviceRequest \
302 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
303 #define DeviceOutRequest \
304 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
306 #define InterfaceRequest \
307 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
309 #define EndpointRequest \
310 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
311 #define EndpointOutRequest \
312 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
314 /* class requests from the USB 2.0 hub spec, table 11-15 */
315 /* GetBusState and SetHubDescriptor are optional, omitted */
316 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
317 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
318 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
319 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
320 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
321 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
322 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
325 /*-------------------------------------------------------------------------*/
328 * Generic bandwidth allocation constants/support
330 #define FRAME_TIME_USECS 1000L
331 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
332 /* Trying not to use worst-case bit-stuffing
333 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
334 /* bytecount = data payload byte count */
336 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
337 /* convert & round nanoseconds to microseconds */
341 * Full/low speed bandwidth allocation constants/support.
343 #define BW_HOST_DELAY 1000L /* nanoseconds */
344 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
345 /* 4 full-speed bit times (est.) */
347 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
348 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
349 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
352 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
353 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
354 * to preallocate bandwidth)
356 #define USB2_HOST_DELAY 5 /* nsec, guess */
357 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
358 + (2083UL * (3 + BitTime(bytes))))/1000 \
360 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
361 + (2083UL * (3 + BitTime(bytes))))/1000 \
363 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
364 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
366 extern long usb_calc_bus_time(int speed
, int is_input
,
367 int isoc
, int bytecount
);
369 /*-------------------------------------------------------------------------*/
371 extern void usb_set_device_state(struct usb_device
*udev
,
372 enum usb_device_state new_state
);
374 /*-------------------------------------------------------------------------*/
376 /* exported only within usbcore */
378 extern struct list_head usb_bus_list
;
379 extern struct mutex usb_bus_list_lock
;
380 extern wait_queue_head_t usb_kill_urb_queue
;
382 extern void usb_enable_root_hub_irq(struct usb_bus
*bus
);
384 extern int usb_find_interface_driver(struct usb_device
*dev
,
385 struct usb_interface
*interface
);
387 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
390 extern void usb_hcd_resume_root_hub(struct usb_hcd
*hcd
);
391 extern void usb_root_hub_lost_power(struct usb_device
*rhdev
);
392 extern int hcd_bus_suspend(struct usb_device
*rhdev
);
393 extern int hcd_bus_resume(struct usb_device
*rhdev
);
395 static inline void usb_hcd_resume_root_hub(struct usb_hcd
*hcd
)
399 #endif /* CONFIG_PM */
402 * USB device fs stuff
405 #ifdef CONFIG_USB_DEVICEFS
408 * these are expected to be called from the USB core/hub thread
409 * with the kernel lock held
411 extern void usbfs_update_special(void);
412 extern int usbfs_init(void);
413 extern void usbfs_cleanup(void);
415 #else /* CONFIG_USB_DEVICEFS */
417 static inline void usbfs_update_special(void) {}
418 static inline int usbfs_init(void) { return 0; }
419 static inline void usbfs_cleanup(void) { }
421 #endif /* CONFIG_USB_DEVICEFS */
423 /*-------------------------------------------------------------------------*/
425 #if defined(CONFIG_USB_MON)
427 struct usb_mon_operations
{
428 void (*urb_submit
)(struct usb_bus
*bus
, struct urb
*urb
);
429 void (*urb_submit_error
)(struct usb_bus
*bus
, struct urb
*urb
, int err
);
430 void (*urb_complete
)(struct usb_bus
*bus
, struct urb
*urb
, int status
);
431 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
434 extern struct usb_mon_operations
*mon_ops
;
436 static inline void usbmon_urb_submit(struct usb_bus
*bus
, struct urb
*urb
)
439 (*mon_ops
->urb_submit
)(bus
, urb
);
442 static inline void usbmon_urb_submit_error(struct usb_bus
*bus
, struct urb
*urb
,
446 (*mon_ops
->urb_submit_error
)(bus
, urb
, error
);
449 static inline void usbmon_urb_complete(struct usb_bus
*bus
, struct urb
*urb
,
453 (*mon_ops
->urb_complete
)(bus
, urb
, status
);
456 int usb_mon_register(struct usb_mon_operations
*ops
);
457 void usb_mon_deregister(void);
461 static inline void usbmon_urb_submit(struct usb_bus
*bus
, struct urb
*urb
) {}
462 static inline void usbmon_urb_submit_error(struct usb_bus
*bus
, struct urb
*urb
,
464 static inline void usbmon_urb_complete(struct usb_bus
*bus
, struct urb
*urb
,
467 #endif /* CONFIG_USB_MON */
469 /*-------------------------------------------------------------------------*/
471 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
472 /* bleech -- resurfaced in 2.4.11 or 2.4.12 */
473 #define bitmap DeviceRemovable
476 /*-------------------------------------------------------------------------*/
480 #define RUN_CONTEXT (in_irq() ? "in_irq" \
481 : (in_interrupt() ? "in_interrupt" : "can sleep"))
484 /* This rwsem is for use only by the hub driver and ehci-hcd.
485 * Nobody else should touch it.
487 extern struct rw_semaphore ehci_cf_port_reset_rwsem
;
489 #endif /* __KERNEL__ */