24a62a2ff86dd38b11dd3494069b99a8bd9882b2
[linux-2.6.git] / drivers / usb / core / hcd.h
1 /*
2  * Copyright (c) 2001-2002 by David Brownell
3  *
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.
8  *
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
12  * for more details.
13  *
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.
17  */
18
19
20 #ifdef __KERNEL__
21
22 /* This file contains declarations of usbcore internals that are mostly
23  * used or exposed by Host Controller Drivers.
24  */
25
26 /*
27  * USB Packet IDs (PIDs)
28  */
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 */
46
47 /*-------------------------------------------------------------------------*/
48
49 /*
50  * USB Host Controller Driver (usb_hcd) framework
51  *
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.
54  */
55
56 /*-------------------------------------------------------------------------*/
57
58 struct usb_hcd {        /* usb_bus.hcpriv points to this */
59
60         /*
61          * housekeeping
62          */
63         struct usb_bus          self;           /* hcd is-a bus */
64
65         const char              *product_desc;  /* product/vendor string */
66         char                    irq_descr[24];  /* driver + bus # */
67
68         struct timer_list       rh_timer;       /* drives root-hub polling */
69         struct urb              *status_urb;    /* the current status urb */
70
71         /*
72          * hardware info/state
73          */
74         const struct hc_driver  *driver;        /* hw-specific hooks */
75         unsigned                saw_irq : 1;
76         unsigned                can_wakeup:1;   /* hw supports wakeup? */
77         unsigned                remote_wakeup:1;/* sw should use wakeup? */
78         unsigned                rh_registered:1;/* is root hub registered? */
79
80         /* The next flag is a stopgap, to be removed when all the HCDs
81          * support the new root-hub polling mechanism. */
82         unsigned                uses_new_polling:1;
83         unsigned                poll_rh:1;      /* poll for rh status? */
84         unsigned                poll_pending:1; /* status has changed? */
85
86         int                     irq;            /* irq allocated */
87         void __iomem            *regs;          /* device memory/io */
88         u64                     rsrc_start;     /* memory/io resource start */
89         u64                     rsrc_len;       /* memory/io resource length */
90         unsigned                power_budget;   /* in mA, 0 = no limit */
91
92 #define HCD_BUFFER_POOLS        4
93         struct dma_pool         *pool [HCD_BUFFER_POOLS];
94
95         int                     state;
96 #       define  __ACTIVE                0x01
97 #       define  __SUSPEND               0x04
98 #       define  __TRANSIENT             0x80
99
100 #       define  HC_STATE_HALT           0
101 #       define  HC_STATE_RUNNING        (__ACTIVE)
102 #       define  HC_STATE_QUIESCING      (__SUSPEND|__TRANSIENT|__ACTIVE)
103 #       define  HC_STATE_RESUMING       (__SUSPEND|__TRANSIENT)
104 #       define  HC_STATE_SUSPENDED      (__SUSPEND)
105
106 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
107 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
108
109         /* more shared queuing code would be good; it should support
110          * smarter scheduling, handle transaction translators, etc;
111          * input size of periodic table to an interrupt scheduler. 
112          * (ohci 32, uhci 1024, ehci 256/512/1024).
113          */
114
115         /* The HC driver's private data is stored at the end of
116          * this structure.
117          */
118         unsigned long hcd_priv[0]
119                         __attribute__ ((aligned (sizeof(unsigned long))));
120 };
121
122 /* 2.4 does this a bit differently ... */
123 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
124 {
125         return &hcd->self;
126 }
127
128
129 // urb.hcpriv is really hardware-specific
130
131 struct hcd_timeout {    /* timeouts we allocate */
132         struct list_head        timeout_list;
133         struct timer_list       timer;
134 };
135
136 /*-------------------------------------------------------------------------*/
137
138 /*
139  * FIXME usb_operations should vanish or become hc_driver,
140  * when usb_bus and usb_hcd become the same thing.
141  */
142
143 struct usb_operations {
144         int (*get_frame_number) (struct usb_device *usb_dev);
145         int (*submit_urb) (struct urb *urb, gfp_t mem_flags);
146         int (*unlink_urb) (struct urb *urb, int status);
147
148         /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
149         void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
150                         gfp_t mem_flags,
151                         dma_addr_t *dma);
152         void (*buffer_free)(struct usb_bus *bus, size_t size,
153                         void *addr, dma_addr_t dma);
154
155         void (*disable)(struct usb_device *udev,
156                         struct usb_host_endpoint *ep);
157 };
158
159 /* each driver provides one of these, and hardware init support */
160
161 struct pt_regs;
162
163 struct hc_driver {
164         const char      *description;   /* "ehci-hcd" etc */
165         const char      *product_desc;  /* product/vendor string */
166         size_t          hcd_priv_size;  /* size of private data */
167
168         /* irq handler */
169         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
170
171         int     flags;
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 */
175
176         /* called to init HCD and root hub */
177         int     (*reset) (struct usb_hcd *hcd);
178         int     (*start) (struct usb_hcd *hcd);
179
180         /* NOTE:  these suspend/resume calls relate to the HC as
181          * a whole, not just the root hub; they're for PCI bus glue.
182          */
183         /* called after suspending the hub, before entering D3 etc */
184         int     (*suspend) (struct usb_hcd *hcd, pm_message_t message);
185
186         /* called after entering D0 (etc), before resuming the hub */
187         int     (*resume) (struct usb_hcd *hcd);
188
189         /* cleanly make HCD stop writing memory and doing I/O */
190         void    (*stop) (struct usb_hcd *hcd);
191
192         /* return current frame number */
193         int     (*get_frame_number) (struct usb_hcd *hcd);
194
195         /* manage i/o requests, device state */
196         int     (*urb_enqueue) (struct usb_hcd *hcd,
197                                         struct usb_host_endpoint *ep,
198                                         struct urb *urb,
199                                         gfp_t mem_flags);
200         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
201
202         /* hw synch, freeing endpoint resources that urb_dequeue can't */
203         void    (*endpoint_disable)(struct usb_hcd *hcd,
204                         struct usb_host_endpoint *ep);
205
206         /* root hub support */
207         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
208         int             (*hub_control) (struct usb_hcd *hcd,
209                                 u16 typeReq, u16 wValue, u16 wIndex,
210                                 char *buf, u16 wLength);
211         int             (*bus_suspend)(struct usb_hcd *);
212         int             (*bus_resume)(struct usb_hcd *);
213         int             (*start_port_reset)(struct usb_hcd *, unsigned port_num);
214         void            (*hub_irq_enable)(struct usb_hcd *);
215                 /* Needed only if port-change IRQs are level-triggered */
216 };
217
218 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
219
220 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
221                 struct device *dev, char *bus_name);
222 extern void usb_put_hcd (struct usb_hcd *hcd);
223 extern int usb_add_hcd(struct usb_hcd *hcd,
224                 unsigned int irqnum, unsigned long irqflags);
225 extern void usb_remove_hcd(struct usb_hcd *hcd);
226
227 #ifdef CONFIG_PCI
228 struct pci_dev;
229 struct pci_device_id;
230 extern int usb_hcd_pci_probe (struct pci_dev *dev,
231                                 const struct pci_device_id *id);
232 extern void usb_hcd_pci_remove (struct pci_dev *dev);
233
234 #ifdef CONFIG_PM
235 extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state);
236 extern int usb_hcd_pci_resume (struct pci_dev *dev);
237 #endif /* CONFIG_PM */
238
239 #endif /* CONFIG_PCI */
240
241 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
242 int hcd_buffer_create (struct usb_hcd *hcd);
243 void hcd_buffer_destroy (struct usb_hcd *hcd);
244
245 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
246         gfp_t mem_flags, dma_addr_t *dma);
247 void hcd_buffer_free (struct usb_bus *bus, size_t size,
248         void *addr, dma_addr_t dma);
249
250 /* generic bus glue, needed for host controllers that don't use PCI */
251 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
252
253 extern void usb_hc_died (struct usb_hcd *hcd);
254 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
255
256 /* -------------------------------------------------------------------------- */
257
258 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
259 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
260                                         struct usb_bus *, unsigned port);
261 extern int usb_new_device(struct usb_device *dev);
262 extern void usb_disconnect(struct usb_device **);
263
264 extern int usb_get_configuration(struct usb_device *dev);
265 extern void usb_destroy_configuration(struct usb_device *dev);
266
267 /*-------------------------------------------------------------------------*/
268
269 /*
270  * HCD Root Hub support
271  */
272
273 #include "hub.h"
274
275 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
276 #define DeviceRequest \
277         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
278 #define DeviceOutRequest \
279         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
280
281 #define InterfaceRequest \
282         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
283
284 #define EndpointRequest \
285         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
286 #define EndpointOutRequest \
287         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
288
289 /* class requests from the USB 2.0 hub spec, table 11-15 */
290 /* GetBusState and SetHubDescriptor are optional, omitted */
291 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
292 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
293 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
294 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
295 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
296 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
297 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
298
299
300 /*-------------------------------------------------------------------------*/
301
302 /*
303  * Generic bandwidth allocation constants/support
304  */
305 #define FRAME_TIME_USECS        1000L
306 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
307                 /* Trying not to use worst-case bit-stuffing
308                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
309                 /* bytecount = data payload byte count */
310
311 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
312                         /* convert & round nanoseconds to microseconds */
313
314 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
315                 int bustime, int isoc);
316 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
317                 int isoc);
318
319 /*
320  * Full/low speed bandwidth allocation constants/support.
321  */
322 #define BW_HOST_DELAY   1000L           /* nanoseconds */
323 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
324                         /* 4 full-speed bit times (est.) */
325
326 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
327 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
328 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
329
330 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
331
332 /*
333  * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
334  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
335  * to preallocate bandwidth)
336  */
337 #define USB2_HOST_DELAY 5       /* nsec, guess */
338 #define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
339         + (2083UL * (3 + BitTime(bytes))))/1000 \
340         + USB2_HOST_DELAY)
341 #define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
342         + (2083UL * (3 + BitTime(bytes))))/1000 \
343         + USB2_HOST_DELAY)
344 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
345 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
346
347 extern long usb_calc_bus_time (int speed, int is_input,
348                         int isoc, int bytecount);
349
350 /*-------------------------------------------------------------------------*/
351
352 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
353
354 extern void usb_set_device_state(struct usb_device *udev,
355                 enum usb_device_state new_state);
356
357 /*-------------------------------------------------------------------------*/
358
359 /* exported only within usbcore */
360
361 extern struct list_head usb_bus_list;
362 extern struct semaphore usb_bus_list_lock;
363 extern wait_queue_head_t usb_kill_urb_queue;
364
365 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
366 extern void usb_bus_put (struct usb_bus *bus);
367
368 extern void usb_enable_root_hub_irq (struct usb_bus *bus);
369
370 extern int usb_find_interface_driver (struct usb_device *dev,
371         struct usb_interface *interface);
372
373 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
374
375 #ifdef CONFIG_PM
376 extern void usb_hcd_suspend_root_hub (struct usb_hcd *hcd);
377 extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
378 extern int hcd_bus_suspend (struct usb_bus *bus);
379 extern int hcd_bus_resume (struct usb_bus *bus);
380 #else
381 static inline void usb_hcd_suspend_root_hub(struct usb_hcd *hcd)
382 {
383         return;
384 }
385
386 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
387 {
388         return;
389 }
390
391 static inline int hcd_bus_suspend(struct usb_bus *bus)
392 {
393         return 0;
394 }
395
396 static inline int hcd_bus_resume (struct usb_bus *bus)
397 {
398         return 0;
399 }
400 #endif /* CONFIG_PM */
401
402 /*
403  * USB device fs stuff
404  */
405
406 #ifdef CONFIG_USB_DEVICEFS
407
408 /*
409  * these are expected to be called from the USB core/hub thread
410  * with the kernel lock held
411  */
412 extern void usbfs_update_special (void);
413 extern int usbfs_init(void);
414 extern void usbfs_cleanup(void);
415
416 #else /* CONFIG_USB_DEVICEFS */
417
418 static inline void usbfs_update_special (void) {}
419 static inline int usbfs_init(void) { return 0; }
420 static inline void usbfs_cleanup(void) { }
421
422 #endif /* CONFIG_USB_DEVICEFS */
423
424 /*-------------------------------------------------------------------------*/
425
426 #if defined(CONFIG_USB_MON)
427
428 struct usb_mon_operations {
429         void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
430         void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
431         void (*urb_complete)(struct usb_bus *bus, struct urb *urb);
432         /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
433 };
434
435 extern struct usb_mon_operations *mon_ops;
436
437 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
438 {
439         if (bus->monitored)
440                 (*mon_ops->urb_submit)(bus, urb);
441 }
442
443 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
444     int error)
445 {
446         if (bus->monitored)
447                 (*mon_ops->urb_submit_error)(bus, urb, error);
448 }
449
450 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb)
451 {
452         if (bus->monitored)
453                 (*mon_ops->urb_complete)(bus, urb);
454 }
455
456 int usb_mon_register(struct usb_mon_operations *ops);
457 void usb_mon_deregister(void);
458
459 #else
460
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,
463     int error) {}
464 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {}
465
466 #endif /* CONFIG_USB_MON */
467
468 /*-------------------------------------------------------------------------*/
469
470 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
471 // bleech -- resurfaced in 2.4.11 or 2.4.12
472 #define bitmap  DeviceRemovable
473
474
475 /*-------------------------------------------------------------------------*/
476
477 /* random stuff */
478
479 #define RUN_CONTEXT (in_irq () ? "in_irq" \
480                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
481
482
483 #endif /* __KERNEL__ */
484