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