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