projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branches 'topic/slob/cleanups', 'topic/slob/fixes', 'topic/slub/core', 'topic...
[linux-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
aa459e6a
AV		 19#ifndef __USB_CORE_HCD_H
20#define __USB_CORE_HCD_H
1da177e4
LT		 21
22#ifdef __KERNEL__
23
32fe0198
AS		 24#include <linux/rwsem.h>
25
38f3ad5e
FB		 26#define MAX_TOPO_LEVEL 6
27
1da177e4
LT		 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 */
dbe0dbb7 35#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
1da177e4
LT		 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.
5234ce1b
IPG		 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.
1da177e4
LT		 66 */
67
68/*-------------------------------------------------------------------------*/
69
17200583 70struct usb_hcd {
1da177e4
LT		 71
72 /*
73 * housekeeping
74 */
75 struct usb_bus self; /* hcd is-a bus */
17200583 76 struct kref kref; /* reference counter */
1da177e4
LT		 77
78 const char *product_desc; /* product/vendor string */
79 char irq_descr[24]; /* driver + bus # */
80
d5926ae7
AS		 81 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
6b157c9b
AS		 83#ifdef CONFIG_PM
84 struct work_struct wakeup_work; /* for remote wakeup */
85#endif
1da177e4
LT		 86
87 /*
88 * hardware info/state
89 */
90 const struct hc_driver *driver; /* hw-specific hooks */
8de98402
BH		 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
1da177e4
LT		 97 unsigned rh_registered:1;/* is root hub registered? */
98
d5926ae7
AS		 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? */
0165de09 104 unsigned wireless:1; /* Wireless USB HCD */
5234ce1b 105 unsigned authorized_default:1;
7329e211 106 unsigned has_tt:1; /* Integrated TT in root hub */
d5926ae7 107
1da177e4
LT		 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 */
7d35b929 112 unsigned power_budget; /* in mA, 0 = no limit */
1da177e4
LT		 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;
84cca820 133 * input size of periodic table to an interrupt scheduler.
1da177e4
LT		 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]
84cca820 141 __attribute__ ((aligned(sizeof(unsigned long))));
1da177e4
LT		 142};
143
144/* 2.4 does this a bit differently ... */
84cca820 145static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
1da177e4
LT		 146{
147 return &hcd->self;
148}
149
84cca820 150static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
17200583
AS		 151{
152 return container_of(bus, struct usb_hcd, self);
153}
1da177e4
LT		 154
155struct hcd_timeout { /* timeouts we allocate */
156 struct list_head timeout_list;
157 struct timer_list timer;
158};
159
160/*-------------------------------------------------------------------------*/
161
1da177e4 162
1da177e4
LT		 163struct 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 */
7d12e780 169 irqreturn_t (*irq) (struct usb_hcd *hcd);
1da177e4
LT		 170
171 int flags;
172#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
b3476675 173#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
1da177e4
LT		 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
5f827ea3 182 * a whole, not just the root hub; they're for PCI bus glue.
1da177e4 183 */
5f827ea3 184 /* called after suspending the hub, before entering D3 etc */
7be7d741 185 int (*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);
1da177e4 186
5f827ea3 187 /* called after entering D0 (etc), before resuming the hub */
7be7d741 188 int (*pci_resume) (struct usb_hcd *hcd);
1da177e4
LT		 189
190 /* cleanly make HCD stop writing memory and doing I/O */
191 void (*stop) (struct usb_hcd *hcd);
192
64a21d02
AG		 193 /* shutdown HCD */
194 void (*shutdown) (struct usb_hcd *hcd);
195
1da177e4
LT		 196 /* return current frame number */
197 int (*get_frame_number) (struct usb_hcd *hcd);
198
199 /* manage i/o requests, device state */
e9df41c5
AS		 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);
1da177e4
LT		 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 */
84cca820
GKH		 210 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
211 int (*hub_control) (struct usb_hcd *hcd,
1da177e4
LT		 212 u16 typeReq, u16 wValue, u16 wIndex,
213 char *buf, u16 wLength);
84cca820
GKH		 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);
90da096e
BR		 217
218 /* force handover of high-speed port to full-speed companion */
84cca820 219 void (*relinquish_port)(struct usb_hcd *, int);
3a31155c
AS		 220 /* has a port been handed over to a companion? */
221 int (*port_handed_over)(struct usb_hcd *, int);
1da177e4
LT		 222};
223
e9df41c5
AS		 224extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
225extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
226 int status);
227extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
228
84cca820
GKH		 229extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
230extern int usb_hcd_unlink_urb(struct urb *urb, int status);
4a00027d
AS		 231extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
232 int status);
95cf82f9
AS		 233extern void usb_hcd_flush_endpoint(struct usb_device *udev,
234 struct usb_host_endpoint *ep);
235extern void usb_hcd_disable_endpoint(struct usb_device *udev,
a6d2bb9f 236 struct usb_host_endpoint *ep);
cde217a5 237extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
84cca820 238extern int usb_hcd_get_frame_number(struct usb_device *udev);
1da177e4 239
84cca820 240extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
1b26da15 241 struct device *dev, const char *bus_name);
84cca820
GKH		 242extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
243extern void usb_put_hcd(struct usb_hcd *hcd);
1da177e4
LT		 244extern int usb_add_hcd(struct usb_hcd *hcd,
245 unsigned int irqnum, unsigned long irqflags);
246extern void usb_remove_hcd(struct usb_hcd *hcd);
247
64a21d02 248struct platform_device;
84cca820 249extern void usb_hcd_platform_shutdown(struct platform_device *dev);
64a21d02 250
1da177e4
LT		 251#ifdef CONFIG_PCI
252struct pci_dev;
253struct pci_device_id;
84cca820 254extern int usb_hcd_pci_probe(struct pci_dev *dev,
1da177e4 255 const struct pci_device_id *id);
84cca820 256extern void usb_hcd_pci_remove(struct pci_dev *dev);
1da177e4
LT		 257
258#ifdef CONFIG_PM
a0d4922d 259extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t msg);
84cca820 260extern int usb_hcd_pci_resume(struct pci_dev *dev);
1da177e4
LT		 261#endif /* CONFIG_PM */
262
84cca820 263extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
64a21d02 264
1da177e4
LT		 265#endif /* CONFIG_PCI */
266
267/* pci-ish (pdev null is ok) buffer alloc/mapping support */
84cca820
GKH		 268int hcd_buffer_create(struct usb_hcd *hcd);
269void hcd_buffer_destroy(struct usb_hcd *hcd);
1da177e4 270
84cca820 271void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
55016f10 272 gfp_t mem_flags, dma_addr_t *dma);
84cca820 273void hcd_buffer_free(struct usb_bus *bus, size_t size,
1da177e4
LT		 274 void *addr, dma_addr_t dma);
275
276/* generic bus glue, needed for host controllers that don't use PCI */
84cca820 277extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
d5926ae7 278
84cca820 279extern void usb_hc_died(struct usb_hcd *hcd);
d5926ae7 280extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4
LT		 281
282/* -------------------------------------------------------------------------- */
283
284/* Enumeration is only for the hub driver, or HCD virtual root hubs */
285extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
286 struct usb_bus *, unsigned port);
287extern int usb_new_device(struct usb_device *dev);
288extern void usb_disconnect(struct usb_device **);
289
290extern int usb_get_configuration(struct usb_device *dev);
291extern 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
84cca820 332#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
1da177e4 333 /* Trying not to use worst-case bit-stuffing
84cca820 334 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
1da177e4
LT		 335 /* bytecount = data payload byte count */
336
337#define NS_TO_US(ns) ((ns + 500L) / 1000L)
338 /* convert & round nanoseconds to microseconds */
339
1da177e4
LT		 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 */
84cca820 346 /* 4 full-speed bit times (est.) */
1da177e4 347
84cca820 348#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
1da177e4
LT		 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
1da177e4 352/*
498f78e6 353 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4
LT		 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 */
84cca820 358#define HS_NSECS(bytes) (((55 * 8 * 2083) \
f956e7cd 359 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 360 + USB2_HOST_DELAY)
84cca820 361#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
f956e7cd 362 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 363 + USB2_HOST_DELAY)
498f78e6
DS		 364#define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
365#define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
1da177e4 366
84cca820 367extern long usb_calc_bus_time(int speed, int is_input,
1da177e4
LT		 368 int isoc, int bytecount);
369
370/*-------------------------------------------------------------------------*/
371
1da177e4
LT		 372extern 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
379extern struct list_head usb_bus_list;
4186ecf8 380extern struct mutex usb_bus_list_lock;
1da177e4
LT		 381extern wait_queue_head_t usb_kill_urb_queue;
382
84cca820 383extern int usb_find_interface_driver(struct usb_device *dev,
1da177e4
LT		 384 struct usb_interface *interface);
385
386#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
387
0c0382e3 388#ifdef CONFIG_PM
84cca820
GKH		 389extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
390extern void usb_root_hub_lost_power(struct usb_device *rhdev);
65bfd296
AS		 391extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
392extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
0c0382e3 393#else
db2d55b7
AM		 394static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
395{
396 return;
397}
0c0382e3
AS		 398#endif /* CONFIG_PM */
399
1da177e4
LT		 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 */
84cca820 410extern void usbfs_update_special(void);
1da177e4
LT		 411extern int usbfs_init(void);
412extern void usbfs_cleanup(void);
413
414#else /* CONFIG_USB_DEVICEFS */
415
84cca820 416static inline void usbfs_update_special(void) {}
1da177e4
LT		 417static inline int usbfs_init(void) { return 0; }
418static inline void usbfs_cleanup(void) { }
419
420#endif /* CONFIG_USB_DEVICEFS */
421
422/*-------------------------------------------------------------------------*/
423
f150fa1a 424#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1da177e4
LT		 425
426struct 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);
9347d51c 429 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
1da177e4 430 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
1da177e4
LT		 431};
432
433extern struct usb_mon_operations *mon_ops;
434
435static 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
441static 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
9347d51c
AS		 448static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
449 int status)
1da177e4
LT		 450{
451 if (bus->monitored)
9347d51c 452 (*mon_ops->urb_complete)(bus, urb, status);
1da177e4 453}
1da177e4
LT		 454
455int usb_mon_register(struct usb_mon_operations *ops);
456void usb_mon_deregister(void);
457
458#else
459
460static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
461static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
462 int error) {}
9347d51c
AS		 463static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
464 int status) {}
1da177e4 465
f150fa1a 466#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
1da177e4
LT		 467
468/*-------------------------------------------------------------------------*/
469
470/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
84cca820 471/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
1da177e4
LT		 472#define bitmap DeviceRemovable
473
474
475/*-------------------------------------------------------------------------*/
476
477/* random stuff */
478
84cca820
GKH		 479#define RUN_CONTEXT (in_irq() ? "in_irq" \
480 : (in_interrupt() ? "in_interrupt" : "can sleep"))
1da177e4
LT		 481
482
32fe0198
AS		 483/* This rwsem is for use only by the hub driver and ehci-hcd.
484 * Nobody else should touch it.
485 */
486extern struct rw_semaphore ehci_cf_port_reset_rwsem;
1da177e4 487
9beeee65
AS		 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
492extern unsigned long usb_hcds_loaded;
493
32fe0198 494#endif /* __KERNEL__ */
aa459e6a
AV		 495
496#endif /* __USB_CORE_HCD_H */
Linux 6.x block layer and io_uring tree(s)