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 unsigned can_wakeup:1; /* hw supports wakeup? */
78 unsigned remote_wakeup:1;/* sw should use wakeup? */
79 int irq; /* irq allocated */
80 void *regs; /* device memory/io */
83 int region; /* pci region for regs */
84 u32 pci_state [16]; /* for PM state save */
87 #define HCD_BUFFER_POOLS 4
88 struct dma_pool *pool [HCD_BUFFER_POOLS];
91 # define __ACTIVE 0x01
92 # define __SUSPEND 0x04
93 # define __TRANSIENT 0x80
95 # define USB_STATE_HALT 0
96 # define USB_STATE_RUNNING (__ACTIVE)
97 # define USB_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
98 # define USB_STATE_RESUMING (__SUSPEND|__TRANSIENT)
99 # define HCD_STATE_SUSPENDED (__SUSPEND)
101 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
102 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
104 /* more shared queuing code would be good; it should support
105 * smarter scheduling, handle transaction translators, etc;
106 * input size of periodic table to an interrupt scheduler.
107 * (ohci 32, uhci 1024, ehci 256/512/1024).
111 /* 2.4 does this a bit differently ... */
112 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
118 struct hcd_dev { /* usb_device.hcpriv points to this */
119 struct list_head dev_list; /* on this hcd */
120 struct list_head urb_list; /* pending on this dev */
122 /* per-configuration HC/HCD state, such as QH or ED */
126 // urb.hcpriv is really hardware-specific
128 struct hcd_timeout { /* timeouts we allocate */
129 struct list_head timeout_list;
130 struct timer_list timer;
133 /*-------------------------------------------------------------------------*/
136 * FIXME usb_operations should vanish or become hc_driver,
137 * when usb_bus and usb_hcd become the same thing.
140 struct usb_operations {
141 int (*allocate)(struct usb_device *);
142 int (*deallocate)(struct usb_device *);
143 int (*get_frame_number) (struct usb_device *usb_dev);
144 int (*submit_urb) (struct urb *urb, int mem_flags);
145 int (*unlink_urb) (struct urb *urb, int status);
147 /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
148 void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
151 void (*buffer_free)(struct usb_bus *bus, size_t size,
152 void *addr, dma_addr_t dma);
154 void (*disable)(struct usb_device *udev, int bEndpointAddress);
156 /* global suspend/resume of bus */
157 int (*hub_suspend)(struct usb_bus *);
158 int (*hub_resume)(struct usb_bus *);
161 /* each driver provides one of these, and hardware init support */
166 const char *description; /* "ehci-hcd" etc */
169 irqreturn_t (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
172 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
173 #define HCD_USB11 0x0010 /* USB 1.1 */
174 #define HCD_USB2 0x0020 /* USB 2.0 */
176 /* called to init HCD and root hub */
177 int (*reset) (struct usb_hcd *hcd);
178 int (*start) (struct usb_hcd *hcd);
180 /* NOTE: these suspend/resume calls relate to the HC as
181 * a whole, not just the root hub; they're for bus glue.
183 /* called after all devices were suspended */
184 int (*suspend) (struct usb_hcd *hcd, u32 state);
186 /* called before any devices get resumed */
187 int (*resume) (struct usb_hcd *hcd);
189 /* cleanly make HCD stop writing memory and doing I/O */
190 void (*stop) (struct usb_hcd *hcd);
192 /* return current frame number */
193 int (*get_frame_number) (struct usb_hcd *hcd);
195 /* memory lifecycle */
196 struct usb_hcd *(*hcd_alloc) (void);
197 void (*hcd_free) (struct usb_hcd *hcd);
199 /* manage i/o requests, device state */
200 int (*urb_enqueue) (struct usb_hcd *hcd, struct urb *urb,
202 int (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
204 /* hw synch, freeing endpoint resources that urb_dequeue can't */
205 void (*endpoint_disable)(struct usb_hcd *hcd,
206 struct hcd_dev *dev, int bEndpointAddress);
208 /* root hub support */
209 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
210 int (*hub_control) (struct usb_hcd *hcd,
211 u16 typeReq, u16 wValue, u16 wIndex,
212 char *buf, u16 wLength);
213 int (*hub_suspend)(struct usb_hcd *);
214 int (*hub_resume)(struct usb_hcd *);
217 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
218 extern void usb_bus_init (struct usb_bus *bus);
219 extern int usb_rh_status_dequeue (struct usb_hcd *hcd, struct urb *urb);
223 struct pci_device_id;
224 extern int usb_hcd_pci_probe (struct pci_dev *dev,
225 const struct pci_device_id *id);
226 extern void usb_hcd_pci_remove (struct pci_dev *dev);
229 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
230 extern int usb_hcd_pci_resume (struct pci_dev *dev);
231 #endif /* CONFIG_PM */
233 #endif /* CONFIG_PCI */
235 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
236 int hcd_buffer_create (struct usb_hcd *hcd);
237 void hcd_buffer_destroy (struct usb_hcd *hcd);
239 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
240 int mem_flags, dma_addr_t *dma);
241 void hcd_buffer_free (struct usb_bus *bus, size_t size,
242 void *addr, dma_addr_t dma);
244 /* generic bus glue, needed for host controllers that don't use PCI */
245 extern struct usb_operations usb_hcd_operations;
246 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
247 extern void usb_hc_died (struct usb_hcd *hcd);
249 /* -------------------------------------------------------------------------- */
251 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
252 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
253 struct usb_bus *, unsigned port);
254 extern int usb_new_device(struct usb_device *dev);
255 extern void usb_disconnect(struct usb_device **);
257 extern int usb_get_configuration(struct usb_device *dev);
258 extern void usb_destroy_configuration(struct usb_device *dev);
260 /*-------------------------------------------------------------------------*/
263 * HCD Root Hub support
268 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
269 #define DeviceRequest \
270 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
271 #define DeviceOutRequest \
272 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
274 #define InterfaceRequest \
275 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
277 #define EndpointRequest \
278 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
279 #define EndpointOutRequest \
280 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
282 /* class requests from the USB 2.0 hub spec, table 11-15 */
283 /* GetBusState and SetHubDescriptor are optional, omitted */
284 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
285 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
286 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
287 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
288 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
289 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
290 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
293 /*-------------------------------------------------------------------------*/
296 * Generic bandwidth allocation constants/support
298 #define FRAME_TIME_USECS 1000L
299 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
300 /* Trying not to use worst-case bit-stuffing
301 of (7/6 * 8 * bytecount) = 9.33 * bytecount */
302 /* bytecount = data payload byte count */
304 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
305 /* convert & round nanoseconds to microseconds */
307 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
308 int bustime, int isoc);
309 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
313 * Full/low speed bandwidth allocation constants/support.
315 #define BW_HOST_DELAY 1000L /* nanoseconds */
316 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
317 /* 4 full-speed bit times (est.) */
319 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
320 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
321 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
323 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
326 * Ceiling microseconds (typical) for that many bytes at high speed
327 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
328 * to preallocate bandwidth)
330 #define USB2_HOST_DELAY 5 /* nsec, guess */
331 #define HS_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
332 + ((2083UL * (3167 + BitTime (bytes)))/1000) \
334 #define HS_USECS_ISO(bytes) NS_TO_US ( ((38 * 8 * 2083)/1000) \
335 + ((2083UL * (3167 + BitTime (bytes)))/1000) \
338 extern long usb_calc_bus_time (int speed, int is_input,
339 int isoc, int bytecount);
341 /*-------------------------------------------------------------------------*/
343 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
345 extern int usb_register_bus (struct usb_bus *);
346 extern void usb_deregister_bus (struct usb_bus *);
348 extern int usb_register_root_hub (struct usb_device *usb_dev,
349 struct device *parent_dev);
351 static inline int hcd_register_root (struct usb_device *usb_dev,
354 /* hcd->driver->start() reported can_wakeup, probably with
355 * assistance from board's boot firmware.
356 * NOTE: normal devices won't enable wakeup by default.
359 dev_dbg (hcd->self.controller, "supports USB remote wakeup\n");
360 hcd->remote_wakeup = hcd->can_wakeup;
362 return usb_register_root_hub (usb_dev, hcd->self.controller);
365 /*-------------------------------------------------------------------------*/
367 /* exported only within usbcore */
369 extern struct list_head usb_bus_list;
370 extern struct semaphore usb_bus_list_lock;
371 extern wait_queue_head_t usb_kill_urb_queue;
373 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
374 extern void usb_bus_put (struct usb_bus *bus);
376 extern int usb_find_interface_driver (struct usb_device *dev,
377 struct usb_interface *interface);
379 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
381 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
384 * USB device fs stuff
387 #ifdef CONFIG_USB_DEVICEFS
390 * these are expected to be called from the USB core/hub thread
391 * with the kernel lock held
393 extern void usbfs_add_bus(struct usb_bus *bus);
394 extern void usbfs_remove_bus(struct usb_bus *bus);
395 extern void usbfs_add_device(struct usb_device *dev);
396 extern void usbfs_remove_device(struct usb_device *dev);
397 extern void usbfs_update_special (void);
399 extern int usbfs_init(void);
400 extern void usbfs_cleanup(void);
402 #else /* CONFIG_USB_DEVICEFS */
404 static inline void usbfs_add_bus(struct usb_bus *bus) {}
405 static inline void usbfs_remove_bus(struct usb_bus *bus) {}
406 static inline void usbfs_add_device(struct usb_device *dev) {}
407 static inline void usbfs_remove_device(struct usb_device *dev) {}
408 static inline void usbfs_update_special (void) {}
410 static inline int usbfs_init(void) { return 0; }
411 static inline void usbfs_cleanup(void) { }
413 #endif /* CONFIG_USB_DEVICEFS */
415 /*-------------------------------------------------------------------------*/
417 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
418 // bleech -- resurfaced in 2.4.11 or 2.4.12
419 #define bitmap DeviceRemovable
422 /*-------------------------------------------------------------------------*/
426 #define RUN_CONTEXT (in_irq () ? "in_irq" \
427 : (in_interrupt () ? "in_interrupt" : "can sleep"))
430 #endif /* __KERNEL__ */