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