projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[PATCH] USB: remove LINUX_VERSION_CODE macro usage
[linux-2.6-block.git] / drivers / usb / core / hcd.h
CommitLineData
1da177e4
LT		 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 { /* usb_bus.hcpriv points to this */
59
60 /*
61 * housekeeping
62 */
63 struct usb_bus self; /* hcd is-a bus */
64
65 const char *product_desc; /* product/vendor string */
66 char irq_descr[24]; /* driver + bus # */
67
d5926ae7
AS		 68 struct timer_list rh_timer; /* drives root-hub polling */
69 struct urb *status_urb; /* the current status urb */
1da177e4
LT		 70
71 /*
72 * hardware info/state
73 */
74 const struct hc_driver *driver; /* hw-specific hooks */
8de98402
BH		 75
76 /* Flags that need to be manipulated atomically */
77 unsigned long flags;
78#define HCD_FLAG_HW_ACCESSIBLE 0x00000001
79#define HCD_FLAG_SAW_IRQ 0x00000002
80
1da177e4
LT		 81 unsigned can_wakeup:1; /* hw supports wakeup? */
82 unsigned remote_wakeup:1;/* sw should use wakeup? */
83 unsigned rh_registered:1;/* is root hub registered? */
84
d5926ae7
AS		 85 /* The next flag is a stopgap, to be removed when all the HCDs
86 * support the new root-hub polling mechanism. */
87 unsigned uses_new_polling:1;
88 unsigned poll_rh:1; /* poll for rh status? */
89 unsigned poll_pending:1; /* status has changed? */
90
1da177e4
LT		 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 */
7d35b929 95 unsigned power_budget; /* in mA, 0 = no limit */
1da177e4
LT		 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
133
134// urb.hcpriv is really hardware-specific
135
136struct hcd_timeout { /* timeouts we allocate */
137 struct list_head timeout_list;
138 struct timer_list timer;
139};
140
141/*-------------------------------------------------------------------------*/
142
143/*
144 * FIXME usb_operations should vanish or become hc_driver,
145 * when usb_bus and usb_hcd become the same thing.
146 */
147
148struct usb_operations {
149 int (*get_frame_number) (struct usb_device *usb_dev);
55016f10 150 int (*submit_urb) (struct urb *urb, gfp_t mem_flags);
1da177e4
LT		 151 int (*unlink_urb) (struct urb *urb, int status);
152
153 /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
154 void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
55016f10 155 gfp_t mem_flags,
1da177e4
LT		 156 dma_addr_t *dma);
157 void (*buffer_free)(struct usb_bus *bus, size_t size,
158 void *addr, dma_addr_t dma);
159
160 void (*disable)(struct usb_device *udev,
161 struct usb_host_endpoint *ep);
1da177e4
LT		 162};
163
164/* each driver provides one of these, and hardware init support */
165
166struct pt_regs;
167
168struct hc_driver {
169 const char *description; /* "ehci-hcd" etc */
170 const char *product_desc; /* product/vendor string */
171 size_t hcd_priv_size; /* size of private data */
172
173 /* irq handler */
174 irqreturn_t (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
175
176 int flags;
177#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
178#define HCD_USB11 0x0010 /* USB 1.1 */
179#define HCD_USB2 0x0020 /* USB 2.0 */
180
181 /* called to init HCD and root hub */
182 int (*reset) (struct usb_hcd *hcd);
183 int (*start) (struct usb_hcd *hcd);
184
185 /* NOTE: these suspend/resume calls relate to the HC as
5f827ea3 186 * a whole, not just the root hub; they're for PCI bus glue.
1da177e4 187 */
5f827ea3 188 /* called after suspending the hub, before entering D3 etc */
9a5d3e98 189 int (*suspend) (struct usb_hcd *hcd, pm_message_t message);
1da177e4 190
5f827ea3 191 /* called after entering D0 (etc), before resuming the hub */
1da177e4
LT		 192 int (*resume) (struct usb_hcd *hcd);
193
194 /* cleanly make HCD stop writing memory and doing I/O */
195 void (*stop) (struct usb_hcd *hcd);
196
197 /* return current frame number */
198 int (*get_frame_number) (struct usb_hcd *hcd);
199
200 /* manage i/o requests, device state */
201 int (*urb_enqueue) (struct usb_hcd *hcd,
202 struct usb_host_endpoint *ep,
203 struct urb *urb,
55016f10 204 gfp_t mem_flags);
1da177e4
LT		 205 int (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
206
207 /* hw synch, freeing endpoint resources that urb_dequeue can't */
208 void (*endpoint_disable)(struct usb_hcd *hcd,
209 struct usb_host_endpoint *ep);
210
211 /* root hub support */
212 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
213 int (*hub_control) (struct usb_hcd *hcd,
214 u16 typeReq, u16 wValue, u16 wIndex,
215 char *buf, u16 wLength);
0c0382e3
AS		 216 int (*bus_suspend)(struct usb_hcd *);
217 int (*bus_resume)(struct usb_hcd *);
1da177e4 218 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
d5926ae7
AS		 219 void (*hub_irq_enable)(struct usb_hcd *);
220 /* Needed only if port-change IRQs are level-triggered */
1da177e4
LT		 221};
222
223extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
224
225extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
226 struct device *dev, char *bus_name);
227extern void usb_put_hcd (struct usb_hcd *hcd);
228extern int usb_add_hcd(struct usb_hcd *hcd,
229 unsigned int irqnum, unsigned long irqflags);
230extern void usb_remove_hcd(struct usb_hcd *hcd);
231
232#ifdef CONFIG_PCI
233struct pci_dev;
234struct pci_device_id;
235extern int usb_hcd_pci_probe (struct pci_dev *dev,
236 const struct pci_device_id *id);
237extern void usb_hcd_pci_remove (struct pci_dev *dev);
238
239#ifdef CONFIG_PM
9a5d3e98 240extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state);
1da177e4
LT		 241extern int usb_hcd_pci_resume (struct pci_dev *dev);
242#endif /* CONFIG_PM */
243
244#endif /* CONFIG_PCI */
245
246/* pci-ish (pdev null is ok) buffer alloc/mapping support */
247int hcd_buffer_create (struct usb_hcd *hcd);
248void hcd_buffer_destroy (struct usb_hcd *hcd);
249
250void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
55016f10 251 gfp_t mem_flags, dma_addr_t *dma);
1da177e4
LT		 252void hcd_buffer_free (struct usb_bus *bus, size_t size,
253 void *addr, dma_addr_t dma);
254
255/* generic bus glue, needed for host controllers that don't use PCI */
256extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
d5926ae7 257
1da177e4 258extern void usb_hc_died (struct usb_hcd *hcd);
d5926ae7 259extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4
LT		 260
261/* -------------------------------------------------------------------------- */
262
263/* Enumeration is only for the hub driver, or HCD virtual root hubs */
264extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
265 struct usb_bus *, unsigned port);
266extern int usb_new_device(struct usb_device *dev);
267extern void usb_disconnect(struct usb_device **);
268
269extern int usb_get_configuration(struct usb_device *dev);
270extern void usb_destroy_configuration(struct usb_device *dev);
271
272/*-------------------------------------------------------------------------*/
273
274/*
275 * HCD Root Hub support
276 */
277
278#include "hub.h"
279
280/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
281#define DeviceRequest \
282 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
283#define DeviceOutRequest \
284 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
285
286#define InterfaceRequest \
287 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
288
289#define EndpointRequest \
290 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
291#define EndpointOutRequest \
292 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
293
294/* class requests from the USB 2.0 hub spec, table 11-15 */
295/* GetBusState and SetHubDescriptor are optional, omitted */
296#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
297#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
298#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
299#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
300#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
301#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
302#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
303
304
305/*-------------------------------------------------------------------------*/
306
307/*
308 * Generic bandwidth allocation constants/support
309 */
310#define FRAME_TIME_USECS 1000L
311#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
312 /* Trying not to use worst-case bit-stuffing
313 of (7/6 * 8 * bytecount) = 9.33 * bytecount */
314 /* bytecount = data payload byte count */
315
316#define NS_TO_US(ns) ((ns + 500L) / 1000L)
317 /* convert & round nanoseconds to microseconds */
318
319extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
320 int bustime, int isoc);
321extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
322 int isoc);
323
324/*
325 * Full/low speed bandwidth allocation constants/support.
326 */
327#define BW_HOST_DELAY 1000L /* nanoseconds */
328#define BW_HUB_LS_SETUP 333L /* nanoseconds */
329 /* 4 full-speed bit times (est.) */
330
331#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
332#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
333#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
334
335extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
336
337/*
498f78e6 338 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4
LT		 339 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
340 * to preallocate bandwidth)
341 */
342#define USB2_HOST_DELAY 5 /* nsec, guess */
f956e7cd 343#define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
344 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 345 + USB2_HOST_DELAY)
f956e7cd 346#define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
347 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 348 + USB2_HOST_DELAY)
498f78e6
DS		 349#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
350#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
1da177e4
LT		 351
352extern long usb_calc_bus_time (int speed, int is_input,
353 int isoc, int bytecount);
354
355/*-------------------------------------------------------------------------*/
356
357extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
358
1da177e4
LT		 359extern void usb_set_device_state(struct usb_device *udev,
360 enum usb_device_state new_state);
361
362/*-------------------------------------------------------------------------*/
363
364/* exported only within usbcore */
365
366extern struct list_head usb_bus_list;
367extern struct semaphore usb_bus_list_lock;
368extern wait_queue_head_t usb_kill_urb_queue;
369
370extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
371extern void usb_bus_put (struct usb_bus *bus);
372
d5926ae7
AS		 373extern void usb_enable_root_hub_irq (struct usb_bus *bus);
374
1da177e4
LT		 375extern int usb_find_interface_driver (struct usb_device *dev,
376 struct usb_interface *interface);
377
378#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
379
0c0382e3 380#ifdef CONFIG_PM
db2d55b7
AM		 381extern void usb_hcd_suspend_root_hub (struct usb_hcd *hcd);
382extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
1c50c317 383extern void usb_root_hub_lost_power (struct usb_device *rhdev);
0c0382e3
AS		 384extern int hcd_bus_suspend (struct usb_bus *bus);
385extern int hcd_bus_resume (struct usb_bus *bus);
386#else
db2d55b7
AM		 387static inline void usb_hcd_suspend_root_hub(struct usb_hcd *hcd)
388{
389 return;
390}
391
392static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
393{
394 return;
395}
396
0c0382e3
AS		 397static inline int hcd_bus_suspend(struct usb_bus *bus)
398{
399 return 0;
400}
401
402static inline int hcd_bus_resume (struct usb_bus *bus)
403{
404 return 0;
405}
406#endif /* CONFIG_PM */
407
1da177e4
LT		 408/*
409 * USB device fs stuff
410 */
411
412#ifdef CONFIG_USB_DEVICEFS
413
414/*
415 * these are expected to be called from the USB core/hub thread
416 * with the kernel lock held
417 */
1da177e4 418extern void usbfs_update_special (void);
1da177e4
LT		 419extern int usbfs_init(void);
420extern void usbfs_cleanup(void);
421
422#else /* CONFIG_USB_DEVICEFS */
423
1da177e4 424static inline void usbfs_update_special (void) {}
1da177e4
LT		 425static inline int usbfs_init(void) { return 0; }
426static inline void usbfs_cleanup(void) { }
427
428#endif /* CONFIG_USB_DEVICEFS */
429
430/*-------------------------------------------------------------------------*/
431
4749f32d 432#if defined(CONFIG_USB_MON)
1da177e4
LT		 433
434struct usb_mon_operations {
435 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
436 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
437 void (*urb_complete)(struct usb_bus *bus, struct urb *urb);
438 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
1da177e4
LT		 439};
440
441extern struct usb_mon_operations *mon_ops;
442
443static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
444{
445 if (bus->monitored)
446 (*mon_ops->urb_submit)(bus, urb);
447}
448
449static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
450 int error)
451{
452 if (bus->monitored)
453 (*mon_ops->urb_submit_error)(bus, urb, error);
454}
455
456static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb)
457{
458 if (bus->monitored)
459 (*mon_ops->urb_complete)(bus, urb);
460}
1da177e4
LT		 461
462int usb_mon_register(struct usb_mon_operations *ops);
463void usb_mon_deregister(void);
464
465#else
466
467static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
468static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
469 int error) {}
470static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {}
1da177e4
LT		 471
472#endif /* CONFIG_USB_MON */
473
474/*-------------------------------------------------------------------------*/
475
476/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
477// bleech -- resurfaced in 2.4.11 or 2.4.12
478#define bitmap DeviceRemovable
479
480
481/*-------------------------------------------------------------------------*/
482
483/* random stuff */
484
485#define RUN_CONTEXT (in_irq () ? "in_irq" \
486 : (in_interrupt () ? "in_interrupt" : "can sleep"))
487
488
489#endif /* __KERNEL__ */
490
Linux 6.x block layer and io_uring tree(s)