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