1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19#ifndef __USB_CORE_HCD_H
20#define __USB_CORE_HCD_H
21
22#ifdef __KERNEL__
23
24#include <linux/rwsem.h>
25
26#define MAX_TOPO_LEVEL 6
27
28
29
30
31
32
33
34
35#define USB_PID_EXT 0xf0
36#define USB_PID_OUT 0xe1
37#define USB_PID_ACK 0xd2
38#define USB_PID_DATA0 0xc3
39#define USB_PID_PING 0xb4
40#define USB_PID_SOF 0xa5
41#define USB_PID_NYET 0x96
42#define USB_PID_DATA2 0x87
43#define USB_PID_SPLIT 0x78
44#define USB_PID_IN 0x69
45#define USB_PID_NAK 0x5a
46#define USB_PID_DATA1 0x4b
47#define USB_PID_PREAMBLE 0x3c
48#define USB_PID_ERR 0x3c
49#define USB_PID_SETUP 0x2d
50#define USB_PID_STALL 0x1e
51#define USB_PID_MDATA 0x0f
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70struct usb_hcd {
71
72
73
74
75 struct usb_bus self;
76 struct kref kref;
77
78 const char *product_desc;
79 int speed;
80
81
82
83 char irq_descr[24];
84
85 struct timer_list rh_timer;
86 struct urb *status_urb;
87#ifdef CONFIG_USB_SUSPEND
88 struct work_struct wakeup_work;
89#endif
90
91
92
93
94 const struct hc_driver *driver;
95
96
97
98
99
100 unsigned long flags;
101#define HCD_FLAG_HW_ACCESSIBLE 0
102#define HCD_FLAG_SAW_IRQ 1
103#define HCD_FLAG_POLL_RH 2
104#define HCD_FLAG_POLL_PENDING 3
105#define HCD_FLAG_WAKEUP_PENDING 4
106#define HCD_FLAG_RH_RUNNING 5
107#define HCD_FLAG_DEAD 6
108
109
110
111
112#define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
113#define HCD_SAW_IRQ(hcd) ((hcd)->flags & (1U << HCD_FLAG_SAW_IRQ))
114#define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
115#define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
116#define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
117#define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
118#define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
119
120
121 unsigned rh_registered:1;
122 unsigned rh_pollable:1;
123 unsigned msix_enabled:1;
124
125
126
127 unsigned uses_new_polling:1;
128 unsigned wireless:1;
129 unsigned authorized_default:1;
130 unsigned has_tt:1;
131
132 int irq;
133 void __iomem *regs;
134 u64 rsrc_start;
135 u64 rsrc_len;
136 unsigned power_budget;
137
138
139
140
141
142
143
144
145
146
147
148
149 struct mutex *bandwidth_mutex;
150 struct usb_hcd *shared_hcd;
151 struct usb_hcd *primary_hcd;
152
153
154#define HCD_BUFFER_POOLS 4
155 struct dma_pool *pool[HCD_BUFFER_POOLS];
156
157 int state;
158# define __ACTIVE 0x01
159# define __SUSPEND 0x04
160# define __TRANSIENT 0x80
161
162# define HC_STATE_HALT 0
163# define HC_STATE_RUNNING (__ACTIVE)
164# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
165# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
166# define HC_STATE_SUSPENDED (__SUSPEND)
167
168#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
169#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
170
171
172
173
174
175
176
177
178
179
180 unsigned long hcd_priv[0]
181 __attribute__ ((aligned(sizeof(unsigned long))));
182};
183
184
185static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
186{
187 return &hcd->self;
188}
189
190static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
191{
192 return container_of(bus, struct usb_hcd, self);
193}
194
195struct hcd_timeout {
196 struct list_head timeout_list;
197 struct timer_list timer;
198};
199
200
201
202
203struct hc_driver {
204 const char *description;
205 const char *product_desc;
206 size_t hcd_priv_size;
207
208
209 irqreturn_t (*irq) (struct usb_hcd *hcd);
210
211 int flags;
212#define HCD_MEMORY 0x0001
213#define HCD_LOCAL_MEM 0x0002
214#define HCD_SHARED 0x0004
215#define HCD_USB11 0x0010
216#define HCD_USB2 0x0020
217#define HCD_USB3 0x0040
218#define HCD_MASK 0x0070
219
220
221 int (*reset) (struct usb_hcd *hcd);
222 int (*start) (struct usb_hcd *hcd);
223
224
225
226
227
228 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
229
230
231 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
232
233
234 void (*stop) (struct usb_hcd *hcd);
235
236
237 void (*shutdown) (struct usb_hcd *hcd);
238
239
240 int (*get_frame_number) (struct usb_hcd *hcd);
241
242
243 int (*urb_enqueue)(struct usb_hcd *hcd,
244 struct urb *urb, gfp_t mem_flags);
245 int (*urb_dequeue)(struct usb_hcd *hcd,
246 struct urb *urb, int status);
247
248
249
250
251
252
253
254
255
256
257 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
258 gfp_t mem_flags);
259 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
260
261
262 void (*endpoint_disable)(struct usb_hcd *hcd,
263 struct usb_host_endpoint *ep);
264
265
266
267 void (*endpoint_reset)(struct usb_hcd *hcd,
268 struct usb_host_endpoint *ep);
269
270
271 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
272 int (*hub_control) (struct usb_hcd *hcd,
273 u16 typeReq, u16 wValue, u16 wIndex,
274 char *buf, u16 wLength);
275 int (*bus_suspend)(struct usb_hcd *);
276 int (*bus_resume)(struct usb_hcd *);
277 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
278
279
280 void (*relinquish_port)(struct usb_hcd *, int);
281
282 int (*port_handed_over)(struct usb_hcd *, int);
283
284
285 void (*clear_tt_buffer_complete)(struct usb_hcd *,
286 struct usb_host_endpoint *);
287
288
289
290 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
291
292 void (*free_dev)(struct usb_hcd *, struct usb_device *);
293
294 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
295 struct usb_host_endpoint **eps, unsigned int num_eps,
296 unsigned int num_streams, gfp_t mem_flags);
297
298
299
300 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
301 struct usb_host_endpoint **eps, unsigned int num_eps,
302 gfp_t mem_flags);
303
304
305
306
307
308
309
310
311
312
313
314
315 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
316 struct usb_host_endpoint *);
317
318 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
319 struct usb_host_endpoint *);
320
321
322
323
324
325 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
326
327
328
329
330
331
332
333 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
334
335 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
336
337
338
339 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
340 struct usb_tt *tt, gfp_t mem_flags);
341 int (*reset_device)(struct usb_hcd *, struct usb_device *);
342
343
344
345 int (*update_device)(struct usb_hcd *, struct usb_device *);
346};
347
348extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
349extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
350 int status);
351extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
352
353extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
354extern int usb_hcd_unlink_urb(struct urb *urb, int status);
355extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
356 int status);
357extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
358 gfp_t mem_flags);
359extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
360extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
361extern void usb_hcd_flush_endpoint(struct usb_device *udev,
362 struct usb_host_endpoint *ep);
363extern void usb_hcd_disable_endpoint(struct usb_device *udev,
364 struct usb_host_endpoint *ep);
365extern void usb_hcd_reset_endpoint(struct usb_device *udev,
366 struct usb_host_endpoint *ep);
367extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
368extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
369 struct usb_host_config *new_config,
370 struct usb_host_interface *old_alt,
371 struct usb_host_interface *new_alt);
372extern int usb_hcd_get_frame_number(struct usb_device *udev);
373
374extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
375 struct device *dev, const char *bus_name);
376extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
377 struct device *dev, const char *bus_name,
378 struct usb_hcd *shared_hcd);
379extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
380extern void usb_put_hcd(struct usb_hcd *hcd);
381extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
382extern int usb_add_hcd(struct usb_hcd *hcd,
383 unsigned int irqnum, unsigned long irqflags);
384extern void usb_remove_hcd(struct usb_hcd *hcd);
385
386struct platform_device;
387extern void usb_hcd_platform_shutdown(struct platform_device *dev);
388
389#ifdef CONFIG_PCI
390struct pci_dev;
391struct pci_device_id;
392extern int usb_hcd_pci_probe(struct pci_dev *dev,
393 const struct pci_device_id *id);
394extern void usb_hcd_pci_remove(struct pci_dev *dev);
395extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
396
397#ifdef CONFIG_PM_SLEEP
398extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
399#endif
400#endif
401
402
403int hcd_buffer_create(struct usb_hcd *hcd);
404void hcd_buffer_destroy(struct usb_hcd *hcd);
405
406void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
407 gfp_t mem_flags, dma_addr_t *dma);
408void hcd_buffer_free(struct usb_bus *bus, size_t size,
409 void *addr, dma_addr_t dma);
410
411
412extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
413
414extern void usb_hc_died(struct usb_hcd *hcd);
415extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
416
417
418#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
419#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
420#define usb_settoggle(dev, ep, out, bit) \
421 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
422 ((bit) << (ep)))
423
424
425
426
427extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
428 struct usb_bus *, unsigned port);
429extern int usb_new_device(struct usb_device *dev);
430extern void usb_disconnect(struct usb_device **);
431
432extern int usb_get_configuration(struct usb_device *dev);
433extern void usb_destroy_configuration(struct usb_device *dev);
434
435
436
437
438
439
440
441#include <linux/usb/ch11.h>
442
443
444
445
446
447
448
449
450
451
452
453
454struct usb_device;
455
456struct usb_tt {
457 struct usb_device *hub;
458 int multi;
459 unsigned think_time;
460
461
462 spinlock_t lock;
463 struct list_head clear_list;
464 struct work_struct clear_work;
465};
466
467struct usb_tt_clear {
468 struct list_head clear_list;
469 unsigned tt;
470 u16 devinfo;
471 struct usb_hcd *hcd;
472 struct usb_host_endpoint *ep;
473};
474
475extern int usb_hub_clear_tt_buffer(struct urb *urb);
476extern void usb_ep0_reinit(struct usb_device *);
477
478
479#define DeviceRequest \
480 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
481#define DeviceOutRequest \
482 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
483
484#define InterfaceRequest \
485 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
486
487#define EndpointRequest \
488 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
489#define EndpointOutRequest \
490 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
491
492
493
494#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
495#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
496#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
497#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
498#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
499#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
500#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
501
502
503
504
505
506#define SetHubDepth (0x3000 | HUB_SET_DEPTH)
507#define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
508
509
510
511
512#define FRAME_TIME_USECS 1000L
513#define BitTime(bytecount) (7 * 8 * bytecount / 6)
514
515
516
517
518#define NS_TO_US(ns) ((ns + 500L) / 1000L)
519
520
521
522
523
524
525#define BW_HOST_DELAY 1000L
526#define BW_HUB_LS_SETUP 333L
527
528
529#define FRAME_TIME_BITS 12000L
530#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
531#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
532
533
534
535
536
537
538#define USB2_HOST_DELAY 5
539#define HS_NSECS(bytes) (((55 * 8 * 2083) \
540 + (2083UL * (3 + BitTime(bytes))))/1000 \
541 + USB2_HOST_DELAY)
542#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
543 + (2083UL * (3 + BitTime(bytes))))/1000 \
544 + USB2_HOST_DELAY)
545#define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
546#define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
547
548extern long usb_calc_bus_time(int speed, int is_input,
549 int isoc, int bytecount);
550
551
552
553extern void usb_set_device_state(struct usb_device *udev,
554 enum usb_device_state new_state);
555
556
557
558
559
560extern struct list_head usb_bus_list;
561extern struct mutex usb_bus_list_lock;
562extern wait_queue_head_t usb_kill_urb_queue;
563
564extern int usb_find_interface_driver(struct usb_device *dev,
565 struct usb_interface *interface);
566
567#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
568
569#ifdef CONFIG_PM
570extern void usb_root_hub_lost_power(struct usb_device *rhdev);
571extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
572extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
573#endif
574
575#ifdef CONFIG_USB_SUSPEND
576extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
577#else
578static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
579{
580 return;
581}
582#endif
583
584
585
586
587
588
589#ifdef CONFIG_USB_DEVICEFS
590
591
592
593
594
595extern void usbfs_update_special(void);
596extern int usbfs_init(void);
597extern void usbfs_cleanup(void);
598
599#else
600
601static inline void usbfs_update_special(void) {}
602static inline int usbfs_init(void) { return 0; }
603static inline void usbfs_cleanup(void) { }
604
605#endif
606
607
608
609#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
610
611struct usb_mon_operations {
612 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
613 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
614 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
615
616};
617
618extern struct usb_mon_operations *mon_ops;
619
620static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
621{
622 if (bus->monitored)
623 (*mon_ops->urb_submit)(bus, urb);
624}
625
626static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
627 int error)
628{
629 if (bus->monitored)
630 (*mon_ops->urb_submit_error)(bus, urb, error);
631}
632
633static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
634 int status)
635{
636 if (bus->monitored)
637 (*mon_ops->urb_complete)(bus, urb, status);
638}
639
640int usb_mon_register(struct usb_mon_operations *ops);
641void usb_mon_deregister(void);
642
643#else
644
645static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
646static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
647 int error) {}
648static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
649 int status) {}
650
651#endif
652
653
654
655
656
657#define RUN_CONTEXT (in_irq() ? "in_irq" \
658 : (in_interrupt() ? "in_interrupt" : "can sleep"))
659
660
661
662
663
664extern struct rw_semaphore ehci_cf_port_reset_rwsem;
665
666
667#define USB_UHCI_LOADED 0
668#define USB_OHCI_LOADED 1
669#define USB_EHCI_LOADED 2
670extern unsigned long usb_hcds_loaded;
671
672#endif
673
674#endif
675