1 /*
2 * Copyright (c) 2001-2002 by David Brownell
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
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 /* This file contains declarations of usbcore internals that are mostly
29 * used or exposed by Host Controller Drivers.
30 */
31
32 /*
33 * USB Packet IDs (PIDs)
34 */
35 #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
36 #define USB_PID_OUT 0xe1
37 #define USB_PID_ACK 0xd2
38 #define USB_PID_DATA0 0xc3
39 #define USB_PID_PING 0xb4 /* USB 2.0 */
40 #define USB_PID_SOF 0xa5
41 #define USB_PID_NYET 0x96 /* USB 2.0 */
42 #define USB_PID_DATA2 0x87 /* USB 2.0 */
43 #define USB_PID_SPLIT 0x78 /* USB 2.0 */
44 #define USB_PID_IN 0x69
45 #define USB_PID_NAK 0x5a
46 #define USB_PID_DATA1 0x4b
47 #define USB_PID_PREAMBLE 0x3c /* Token mode */
48 #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
49 #define USB_PID_SETUP 0x2d
50 #define USB_PID_STALL 0x1e
51 #define USB_PID_MDATA 0x0f /* USB 2.0 */
52
53 /*-------------------------------------------------------------------------*/
54
55 /*
56 * USB Host Controller Driver (usb_hcd) framework
57 *
58 * Since "struct usb_bus" is so thin, you can't share much code in it.
59 * This framework is a layer over that, and should be more sharable.
60 *
61 * @authorized_default: Specifies if new devices are authorized to
62 * connect by default or they require explicit
63 * user space authorization; this bit is settable
64 * through /sys/class/usb_host/X/authorized_default.
65 * For the rest is RO, so we don't lock to r/w it.
66 */
67
68 /*-------------------------------------------------------------------------*/
69
70 struct usb_hcd {
71
72 /*
73 * housekeeping
74 */
75 struct usb_bus self; /* hcd is-a bus */
76 struct kref kref; /* reference counter */
77
78 const char *product_desc; /* product/vendor string */
79 char irq_descr[24]; /* driver + bus # */
80
81 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
83 #ifdef CONFIG_PM
84 struct work_struct wakeup_work; /* for remote wakeup */
85 #endif
86
87 /*
88 * hardware info/state
89 */
90 const struct hc_driver *driver; /* hw-specific hooks */
91
92 /* Flags that need to be manipulated atomically */
93 unsigned long flags;
94 #define HCD_FLAG_HW_ACCESSIBLE 0x00000001
95 #define HCD_FLAG_SAW_IRQ 0x00000002
96
97 unsigned rh_registered:1;/* is root hub registered? */
98
99 /* The next flag is a stopgap, to be removed when all the HCDs
100 * support the new root-hub polling mechanism. */
101 unsigned uses_new_polling:1;
102 unsigned poll_rh:1; /* poll for rh status? */
103 unsigned poll_pending:1; /* status has changed? */
104 unsigned wireless:1; /* Wireless USB HCD */
105 unsigned authorized_default:1;
106 unsigned has_tt:1; /* Integrated TT in root hub */
107
108 int irq; /* irq allocated */
109 void __iomem *regs; /* device memory/io */
110 u64 rsrc_start; /* memory/io resource start */
111 u64 rsrc_len; /* memory/io resource length */
112 unsigned power_budget; /* in mA, 0 = no limit */
113
114 #define HCD_BUFFER_POOLS 4
115 struct dma_pool *pool [HCD_BUFFER_POOLS];
116
117 int state;
118 # define __ACTIVE 0x01
119 # define __SUSPEND 0x04
120 # define __TRANSIENT 0x80
121
122 # define HC_STATE_HALT 0
123 # define HC_STATE_RUNNING (__ACTIVE)
124 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
125 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
126 # define HC_STATE_SUSPENDED (__SUSPEND)
127
128 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
129 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
130
131 /* more shared queuing code would be good; it should support
132 * smarter scheduling, handle transaction translators, etc;
133 * input size of periodic table to an interrupt scheduler.
134 * (ohci 32, uhci 1024, ehci 256/512/1024).
135 */
136
137 /* The HC driver's private data is stored at the end of
138 * this structure.
139 */
140 unsigned long hcd_priv[0]
141 __attribute__ ((aligned(sizeof(unsigned long))));
142 };
143
144 /* 2.4 does this a bit differently ... */
hcd_to_bus(struct usb_hcd * hcd)145 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
146 {
147 return &hcd->self;
148 }
149
bus_to_hcd(struct usb_bus * bus)150 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
151 {
152 return container_of(bus, struct usb_hcd, self);
153 }
154
155 struct hcd_timeout { /* timeouts we allocate */
156 struct list_head timeout_list;
157 struct timer_list timer;
158 };
159
160 /*-------------------------------------------------------------------------*/
161
162
163 struct hc_driver {
164 const char *description; /* "ehci-hcd" etc */
165 const char *product_desc; /* product/vendor string */
166 size_t hcd_priv_size; /* size of private data */
167
168 /* irq handler */
169 irqreturn_t (*irq) (struct usb_hcd *hcd);
170
171 int flags;
172 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
173 #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
174 #define HCD_USB11 0x0010 /* USB 1.1 */
175 #define HCD_USB2 0x0020 /* USB 2.0 */
176
177 /* called to init HCD and root hub */
178 int (*reset) (struct usb_hcd *hcd);
179 int (*start) (struct usb_hcd *hcd);
180
181 /* NOTE: these suspend/resume calls relate to the HC as
182 * a whole, not just the root hub; they're for PCI bus glue.
183 */
184 /* called after suspending the hub, before entering D3 etc */
185 int (*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);
186
187 /* called after entering D0 (etc), before resuming the hub */
188 int (*pci_resume) (struct usb_hcd *hcd);
189
190 /* cleanly make HCD stop writing memory and doing I/O */
191 void (*stop) (struct usb_hcd *hcd);
192
193 /* shutdown HCD */
194 void (*shutdown) (struct usb_hcd *hcd);
195
196 /* return current frame number */
197 int (*get_frame_number) (struct usb_hcd *hcd);
198
199 /* manage i/o requests, device state */
200 int (*urb_enqueue)(struct usb_hcd *hcd,
201 struct urb *urb, gfp_t mem_flags);
202 int (*urb_dequeue)(struct usb_hcd *hcd,
203 struct urb *urb, int status);
204
205 /* hw synch, freeing endpoint resources that urb_dequeue can't */
206 void (*endpoint_disable)(struct usb_hcd *hcd,
207 struct usb_host_endpoint *ep);
208
209 /* root hub support */
210 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
211 int (*hub_control) (struct usb_hcd *hcd,
212 u16 typeReq, u16 wValue, u16 wIndex,
213 char *buf, u16 wLength);
214 int (*bus_suspend)(struct usb_hcd *);
215 int (*bus_resume)(struct usb_hcd *);
216 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
217
218 /* force handover of high-speed port to full-speed companion */
219 void (*relinquish_port)(struct usb_hcd *, int);
220 /* has a port been handed over to a companion? */
221 int (*port_handed_over)(struct usb_hcd *, int);
222 };
223
224 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
225 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
226 int status);
227 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
228
229 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
230 extern int usb_hcd_unlink_urb(struct urb *urb, int status);
231 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
232 int status);
233 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
234 struct usb_host_endpoint *ep);
235 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
236 struct usb_host_endpoint *ep);
237 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
238 extern int usb_hcd_get_frame_number(struct usb_device *udev);
239
240 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
241 struct device *dev, const char *bus_name);
242 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
243 extern void usb_put_hcd(struct usb_hcd *hcd);
244 extern int usb_add_hcd(struct usb_hcd *hcd,
245 unsigned int irqnum, unsigned long irqflags);
246 extern void usb_remove_hcd(struct usb_hcd *hcd);
247
248 struct platform_device;
249 extern void usb_hcd_platform_shutdown(struct platform_device *dev);
250
251 #ifdef CONFIG_PCI
252 struct pci_dev;
253 struct pci_device_id;
254 extern int usb_hcd_pci_probe(struct pci_dev *dev,
255 const struct pci_device_id *id);
256 extern void usb_hcd_pci_remove(struct pci_dev *dev);
257
258 #ifdef CONFIG_PM
259 extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t msg);
260 extern int usb_hcd_pci_resume(struct pci_dev *dev);
261 #endif /* CONFIG_PM */
262
263 extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
264
265 #endif /* CONFIG_PCI */
266
267 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
268 int hcd_buffer_create(struct usb_hcd *hcd);
269 void hcd_buffer_destroy(struct usb_hcd *hcd);
270
271 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
272 gfp_t mem_flags, dma_addr_t *dma);
273 void hcd_buffer_free(struct usb_bus *bus, size_t size,
274 void *addr, dma_addr_t dma);
275
276 /* generic bus glue, needed for host controllers that don't use PCI */
277 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
278
279 extern void usb_hc_died(struct usb_hcd *hcd);
280 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
281
282 /* -------------------------------------------------------------------------- */
283
284 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
285 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
286 struct usb_bus *, unsigned port);
287 extern int usb_new_device(struct usb_device *dev);
288 extern void usb_disconnect(struct usb_device **);
289
290 extern int usb_get_configuration(struct usb_device *dev);
291 extern void usb_destroy_configuration(struct usb_device *dev);
292
293 /*-------------------------------------------------------------------------*/
294
295 /*
296 * HCD Root Hub support
297 */
298
299 #include "hub.h"
300
301 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
302 #define DeviceRequest \
303 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
304 #define DeviceOutRequest \
305 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
306
307 #define InterfaceRequest \
308 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
309
310 #define EndpointRequest \
311 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
312 #define EndpointOutRequest \
313 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
314
315 /* class requests from the USB 2.0 hub spec, table 11-15 */
316 /* GetBusState and SetHubDescriptor are optional, omitted */
317 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
318 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
319 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
320 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
321 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
322 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
323 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
324
325
326 /*-------------------------------------------------------------------------*/
327
328 /*
329 * Generic bandwidth allocation constants/support
330 */
331 #define FRAME_TIME_USECS 1000L
332 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
333 /* Trying not to use worst-case bit-stuffing
334 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
335 /* bytecount = data payload byte count */
336
337 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
338 /* convert & round nanoseconds to microseconds */
339
340
341 /*
342 * Full/low speed bandwidth allocation constants/support.
343 */
344 #define BW_HOST_DELAY 1000L /* nanoseconds */
345 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
346 /* 4 full-speed bit times (est.) */
347
348 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
349 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
350 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
351
352 /*
353 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
354 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
355 * to preallocate bandwidth)
356 */
357 #define USB2_HOST_DELAY 5 /* nsec, guess */
358 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
359 + (2083UL * (3 + BitTime(bytes))))/1000 \
360 + USB2_HOST_DELAY)
361 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
362 + (2083UL * (3 + BitTime(bytes))))/1000 \
363 + USB2_HOST_DELAY)
364 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
365 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
366
367 extern long usb_calc_bus_time(int speed, int is_input,
368 int isoc, int bytecount);
369
370 /*-------------------------------------------------------------------------*/
371
372 extern void usb_set_device_state(struct usb_device *udev,
373 enum usb_device_state new_state);
374
375 /*-------------------------------------------------------------------------*/
376
377 /* exported only within usbcore */
378
379 extern struct list_head usb_bus_list;
380 extern struct mutex usb_bus_list_lock;
381 extern wait_queue_head_t usb_kill_urb_queue;
382
383 extern int usb_find_interface_driver(struct usb_device *dev,
384 struct usb_interface *interface);
385
386 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
387
388 #ifdef CONFIG_PM
389 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
390 extern void usb_root_hub_lost_power(struct usb_device *rhdev);
391 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
392 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
393 #else
usb_hcd_resume_root_hub(struct usb_hcd * hcd)394 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
395 {
396 return;
397 }
398 #endif /* CONFIG_PM */
399
400 /*
401 * USB device fs stuff
402 */
403
404 #ifdef CONFIG_USB_DEVICEFS
405
406 /*
407 * these are expected to be called from the USB core/hub thread
408 * with the kernel lock held
409 */
410 extern void usbfs_update_special(void);
411 extern int usbfs_init(void);
412 extern void usbfs_cleanup(void);
413
414 #else /* CONFIG_USB_DEVICEFS */
415
usbfs_update_special(void)416 static inline void usbfs_update_special(void) {}
usbfs_init(void)417 static inline int usbfs_init(void) { return 0; }
usbfs_cleanup(void)418 static inline void usbfs_cleanup(void) { }
419
420 #endif /* CONFIG_USB_DEVICEFS */
421
422 /*-------------------------------------------------------------------------*/
423
424 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
425
426 struct usb_mon_operations {
427 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
428 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
429 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
430 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
431 };
432
433 extern struct usb_mon_operations *mon_ops;
434
usbmon_urb_submit(struct usb_bus * bus,struct urb * urb)435 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
436 {
437 if (bus->monitored)
438 (*mon_ops->urb_submit)(bus, urb);
439 }
440
usbmon_urb_submit_error(struct usb_bus * bus,struct urb * urb,int error)441 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
442 int error)
443 {
444 if (bus->monitored)
445 (*mon_ops->urb_submit_error)(bus, urb, error);
446 }
447
usbmon_urb_complete(struct usb_bus * bus,struct urb * urb,int status)448 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
449 int status)
450 {
451 if (bus->monitored)
452 (*mon_ops->urb_complete)(bus, urb, status);
453 }
454
455 int usb_mon_register(struct usb_mon_operations *ops);
456 void usb_mon_deregister(void);
457
458 #else
459
usbmon_urb_submit(struct usb_bus * bus,struct urb * urb)460 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
usbmon_urb_submit_error(struct usb_bus * bus,struct urb * urb,int error)461 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
462 int error) {}
usbmon_urb_complete(struct usb_bus * bus,struct urb * urb,int status)463 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
464 int status) {}
465
466 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
467
468 /*-------------------------------------------------------------------------*/
469
470 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
471 /* bleech -- resurfaced in 2.4.11 or 2.4.12 */
472 #define bitmap DeviceRemovable
473
474
475 /*-------------------------------------------------------------------------*/
476
477 /* random stuff */
478
479 #define RUN_CONTEXT (in_irq() ? "in_irq" \
480 : (in_interrupt() ? "in_interrupt" : "can sleep"))
481
482
483 /* This rwsem is for use only by the hub driver and ehci-hcd.
484 * Nobody else should touch it.
485 */
486 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
487
488 /* Keep track of which host controller drivers are loaded */
489 #define USB_UHCI_LOADED 0
490 #define USB_OHCI_LOADED 1
491 #define USB_EHCI_LOADED 2
492 extern unsigned long usb_hcds_loaded;
493
494 #endif /* __KERNEL__ */
495
496 #endif /* __USB_CORE_HCD_H */
497