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