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