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 const char *description; /* "ehci-hcd" etc */
68 struct timer_list rh_timer; /* drives root hub */
69 struct list_head dev_list; /* devices on this bus */
70 struct work_struct work;
75 struct hc_driver *driver; /* hw-specific hooks */
77 int irq; /* irq allocated */
78 void *regs; /* device memory/io */
81 int region; /* pci region for regs */
82 u32 pci_state [16]; /* for PM state save */
85 #define HCD_BUFFER_POOLS 4
86 struct dma_pool *pool [HCD_BUFFER_POOLS];
89 # define __ACTIVE 0x01
90 # define __SUSPEND 0x04
91 # define __TRANSIENT 0x80
93 # define USB_STATE_HALT 0
94 # define USB_STATE_RUNNING (__ACTIVE)
95 # define USB_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
96 # define USB_STATE_RESUMING (__SUSPEND|__TRANSIENT)
97 # define USB_STATE_SUSPENDED (__SUSPEND)
99 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
100 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
102 /* more shared queuing code would be good; it should support
103 * smarter scheduling, handle transaction translators, etc;
104 * input size of periodic table to an interrupt scheduler.
105 * (ohci 32, uhci 1024, ehci 256/512/1024).
109 /* 2.4 does this a bit differently ... */
110 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
116 struct hcd_dev { /* usb_device.hcpriv points to this */
117 struct list_head dev_list; /* on this hcd */
118 struct list_head urb_list; /* pending on this dev */
120 /* per-configuration HC/HCD state, such as QH or ED */
124 // urb.hcpriv is really hardware-specific
126 struct hcd_timeout { /* timeouts we allocate */
127 struct list_head timeout_list;
128 struct timer_list timer;
131 /*-------------------------------------------------------------------------*/
134 * FIXME usb_operations should vanish or become hc_driver,
135 * when usb_bus and usb_hcd become the same thing.
138 struct usb_operations {
139 int (*allocate)(struct usb_device *);
140 int (*deallocate)(struct usb_device *);
141 int (*get_frame_number) (struct usb_device *usb_dev);
142 int (*submit_urb) (struct urb *urb, int mem_flags);
143 int (*unlink_urb) (struct urb *urb);
145 /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
146 void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
149 void (*buffer_free)(struct usb_bus *bus, size_t size,
150 void *addr, dma_addr_t dma);
152 void (*disable)(struct usb_device *udev, int bEndpointAddress);
155 /* each driver provides one of these, and hardware init support */
160 const char *description; /* "ehci-hcd" etc */
163 irqreturn_t (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
166 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
167 #define HCD_USB11 0x0010 /* USB 1.1 */
168 #define HCD_USB2 0x0020 /* USB 2.0 */
170 /* called to init HCD and root hub */
171 int (*reset) (struct usb_hcd *hcd);
172 int (*start) (struct usb_hcd *hcd);
174 /* called after all devices were suspended */
175 int (*suspend) (struct usb_hcd *hcd, u32 state);
177 /* called before any devices get resumed */
178 int (*resume) (struct usb_hcd *hcd);
180 /* cleanly make HCD stop writing memory and doing I/O */
181 void (*stop) (struct usb_hcd *hcd);
183 /* return current frame number */
184 int (*get_frame_number) (struct usb_hcd *hcd);
186 /* memory lifecycle */
187 struct usb_hcd *(*hcd_alloc) (void);
188 void (*hcd_free) (struct usb_hcd *hcd);
190 /* manage i/o requests, device state */
191 int (*urb_enqueue) (struct usb_hcd *hcd, struct urb *urb,
193 int (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
195 /* hw synch, freeing endpoint resources that urb_dequeue can't */
196 void (*endpoint_disable)(struct usb_hcd *hcd,
197 struct hcd_dev *dev, int bEndpointAddress);
199 /* root hub support */
200 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
201 int (*hub_control) (struct usb_hcd *hcd,
202 u16 typeReq, u16 wValue, u16 wIndex,
203 char *buf, u16 wLength);
206 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
207 extern void usb_bus_init (struct usb_bus *bus);
208 extern void usb_rh_status_dequeue (struct usb_hcd *hcd, struct urb *urb);
212 struct pci_device_id;
213 extern int usb_hcd_pci_probe (struct pci_dev *dev,
214 const struct pci_device_id *id);
215 extern void usb_hcd_pci_remove (struct pci_dev *dev);
218 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
219 extern int usb_hcd_pci_resume (struct pci_dev *dev);
220 #endif /* CONFIG_PM */
222 #endif /* CONFIG_PCI */
224 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
225 int hcd_buffer_create (struct usb_hcd *hcd);
226 void hcd_buffer_destroy (struct usb_hcd *hcd);
228 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
229 int mem_flags, dma_addr_t *dma);
230 void hcd_buffer_free (struct usb_bus *bus, size_t size,
231 void *addr, dma_addr_t dma);
233 /* generic bus glue, needed for host controllers that don't use PCI */
234 extern struct usb_operations usb_hcd_operations;
235 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
236 extern void usb_hc_died (struct usb_hcd *hcd);
238 /* -------------------------------------------------------------------------- */
240 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
241 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
242 struct usb_bus *, unsigned port);
243 extern int usb_new_device(struct usb_device *dev);
244 extern void usb_choose_address(struct usb_device *dev);
245 extern void usb_disconnect(struct usb_device **);
247 /* exported to hub driver ONLY to support usb_reset_device () */
248 extern int usb_get_configuration(struct usb_device *dev);
249 extern void usb_destroy_configuration(struct usb_device *dev);
250 extern int usb_set_address(struct usb_device *dev);
252 /* use these only before the device's address has been set */
253 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30))
254 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | USB_DIR_IN)
256 /*-------------------------------------------------------------------------*/
259 * HCD Root Hub support
264 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
265 #define DeviceRequest \
266 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
267 #define DeviceOutRequest \
268 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
270 #define InterfaceRequest \
271 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
273 #define EndpointRequest \
274 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
275 #define EndpointOutRequest \
276 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
278 /* class requests from the USB 2.0 hub spec, table 11-15 */
279 /* GetBusState and SetHubDescriptor are optional, omitted */
280 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
281 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
282 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
283 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
284 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
285 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
286 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
289 /*-------------------------------------------------------------------------*/
292 * Generic bandwidth allocation constants/support
294 #define FRAME_TIME_USECS 1000L
295 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
296 /* Trying not to use worst-case bit-stuffing
297 of (7/6 * 8 * bytecount) = 9.33 * bytecount */
298 /* bytecount = data payload byte count */
300 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
301 /* convert & round nanoseconds to microseconds */
303 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
304 int bustime, int isoc);
305 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
309 * Full/low speed bandwidth allocation constants/support.
311 #define BW_HOST_DELAY 1000L /* nanoseconds */
312 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
313 /* 4 full-speed bit times (est.) */
315 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
316 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
317 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
319 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
322 * Ceiling microseconds (typical) for that many bytes at high speed
323 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
324 * to preallocate bandwidth)
326 #define USB2_HOST_DELAY 5 /* nsec, guess */
327 #define HS_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
328 + ((2083UL * (3167 + BitTime (bytes)))/1000) \
330 #define HS_USECS_ISO(bytes) NS_TO_US ( ((long)(38 * 8 * 2.083)) \
331 + ((2083UL * (3167 + BitTime (bytes)))/1000) \
334 extern long usb_calc_bus_time (int speed, int is_input,
335 int isoc, int bytecount);
337 /*-------------------------------------------------------------------------*/
339 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
341 extern int usb_register_bus (struct usb_bus *);
342 extern void usb_deregister_bus (struct usb_bus *);
344 extern int usb_register_root_hub (struct usb_device *usb_dev,
345 struct device *parent_dev);
347 /* for portability to 2.4, hcds should call this */
348 static inline int hcd_register_root (struct usb_hcd *hcd)
350 return usb_register_root_hub (
351 hcd_to_bus (hcd)->root_hub, hcd->self.controller);
354 /*-------------------------------------------------------------------------*/
356 /* exported only within usbcore */
358 extern struct list_head usb_bus_list;
359 extern struct semaphore usb_bus_list_lock;
361 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
362 extern void usb_bus_put (struct usb_bus *bus);
364 extern int usb_find_interface_driver (struct usb_device *dev,
365 struct usb_interface *interface);
367 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
369 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
372 * USB device fs stuff
375 #ifdef CONFIG_USB_DEVICEFS
378 * these are expected to be called from the USB core/hub thread
379 * with the kernel lock held
381 extern void usbfs_add_bus(struct usb_bus *bus);
382 extern void usbfs_remove_bus(struct usb_bus *bus);
383 extern void usbfs_add_device(struct usb_device *dev);
384 extern void usbfs_remove_device(struct usb_device *dev);
385 extern void usbfs_update_special (void);
387 extern int usbfs_init(void);
388 extern void usbfs_cleanup(void);
390 #else /* CONFIG_USB_DEVICEFS */
392 static inline void usbfs_add_bus(struct usb_bus *bus) {}
393 static inline void usbfs_remove_bus(struct usb_bus *bus) {}
394 static inline void usbfs_add_device(struct usb_device *dev) {}
395 static inline void usbfs_remove_device(struct usb_device *dev) {}
396 static inline void usbfs_update_special (void) {}
398 static inline int usbfs_init(void) { return 0; }
399 static inline void usbfs_cleanup(void) { }
401 #endif /* CONFIG_USB_DEVICEFS */
403 /*-------------------------------------------------------------------------*/
405 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
406 // bleech -- resurfaced in 2.4.11 or 2.4.12
407 #define bitmap DeviceRemovable
410 /*-------------------------------------------------------------------------*/
414 #define RUN_CONTEXT (in_irq () ? "in_irq" \
415 : (in_interrupt () ? "in_interrupt" : "can sleep"))
418 #endif /* __KERNEL__ */