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