Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0+
2 : : /*
3 : : * Copyright (c) 2001-2002 by David Brownell
4 : : *
5 : : * This program is free software; you can redistribute it and/or modify it
6 : : * under the terms of the GNU General Public License as published by the
7 : : * Free Software Foundation; either version 2 of the License, or (at your
8 : : * option) any later version.
9 : : *
10 : : * This program is distributed in the hope that it will be useful, but
11 : : * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 : : * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 : : * for more details.
14 : : *
15 : : * You should have received a copy of the GNU General Public License
16 : : * along with this program; if not, write to the Free Software Foundation,
17 : : * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 : : */
19 : :
20 : : #ifndef __USB_CORE_HCD_H
21 : : #define __USB_CORE_HCD_H
22 : :
23 : : #ifdef __KERNEL__
24 : :
25 : : #include <linux/rwsem.h>
26 : : #include <linux/interrupt.h>
27 : : #include <linux/idr.h>
28 : :
29 : : #define MAX_TOPO_LEVEL 6
30 : :
31 : : /* This file contains declarations of usbcore internals that are mostly
32 : : * used or exposed by Host Controller Drivers.
33 : : */
34 : :
35 : : /*
36 : : * USB Packet IDs (PIDs)
37 : : */
38 : : #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
39 : : #define USB_PID_OUT 0xe1
40 : : #define USB_PID_ACK 0xd2
41 : : #define USB_PID_DATA0 0xc3
42 : : #define USB_PID_PING 0xb4 /* USB 2.0 */
43 : : #define USB_PID_SOF 0xa5
44 : : #define USB_PID_NYET 0x96 /* USB 2.0 */
45 : : #define USB_PID_DATA2 0x87 /* USB 2.0 */
46 : : #define USB_PID_SPLIT 0x78 /* USB 2.0 */
47 : : #define USB_PID_IN 0x69
48 : : #define USB_PID_NAK 0x5a
49 : : #define USB_PID_DATA1 0x4b
50 : : #define USB_PID_PREAMBLE 0x3c /* Token mode */
51 : : #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
52 : : #define USB_PID_SETUP 0x2d
53 : : #define USB_PID_STALL 0x1e
54 : : #define USB_PID_MDATA 0x0f /* USB 2.0 */
55 : :
56 : : /*-------------------------------------------------------------------------*/
57 : :
58 : : /*
59 : : * USB Host Controller Driver (usb_hcd) framework
60 : : *
61 : : * Since "struct usb_bus" is so thin, you can't share much code in it.
62 : : * This framework is a layer over that, and should be more sharable.
63 : : */
64 : :
65 : : /*-------------------------------------------------------------------------*/
66 : :
67 : : struct giveback_urb_bh {
68 : : bool running;
69 : : spinlock_t lock;
70 : : struct list_head head;
71 : : struct tasklet_struct bh;
72 : : struct usb_host_endpoint *completing_ep;
73 : : };
74 : :
75 : : enum usb_dev_authorize_policy {
76 : : USB_DEVICE_AUTHORIZE_NONE = 0,
77 : : USB_DEVICE_AUTHORIZE_ALL = 1,
78 : : USB_DEVICE_AUTHORIZE_INTERNAL = 2,
79 : : };
80 : :
81 : : struct usb_hcd {
82 : :
83 : : /*
84 : : * housekeeping
85 : : */
86 : : struct usb_bus self; /* hcd is-a bus */
87 : : struct kref kref; /* reference counter */
88 : :
89 : : const char *product_desc; /* product/vendor string */
90 : : int speed; /* Speed for this roothub.
91 : : * May be different from
92 : : * hcd->driver->flags & HCD_MASK
93 : : */
94 : : char irq_descr[24]; /* driver + bus # */
95 : :
96 : : struct timer_list rh_timer; /* drives root-hub polling */
97 : : struct urb *status_urb; /* the current status urb */
98 : : #ifdef CONFIG_PM
99 : : struct work_struct wakeup_work; /* for remote wakeup */
100 : : #endif
101 : : struct work_struct died_work; /* for when the device dies */
102 : :
103 : : /*
104 : : * hardware info/state
105 : : */
106 : : const struct hc_driver *driver; /* hw-specific hooks */
107 : :
108 : : /*
109 : : * OTG and some Host controllers need software interaction with phys;
110 : : * other external phys should be software-transparent
111 : : */
112 : : struct usb_phy *usb_phy;
113 : : struct usb_phy_roothub *phy_roothub;
114 : :
115 : : /* Flags that need to be manipulated atomically because they can
116 : : * change while the host controller is running. Always use
117 : : * set_bit() or clear_bit() to change their values.
118 : : */
119 : : unsigned long flags;
120 : : #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
121 : : #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
122 : : #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
123 : : #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
124 : : #define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */
125 : : #define HCD_FLAG_DEAD 6 /* controller has died? */
126 : : #define HCD_FLAG_INTF_AUTHORIZED 7 /* authorize interfaces? */
127 : :
128 : : /* The flags can be tested using these macros; they are likely to
129 : : * be slightly faster than test_bit().
130 : : */
131 : : #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
132 : : #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
133 : : #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
134 : : #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
135 : : #define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
136 : : #define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
137 : :
138 : : /*
139 : : * Specifies if interfaces are authorized by default
140 : : * or they require explicit user space authorization; this bit is
141 : : * settable through /sys/class/usb_host/X/interface_authorized_default
142 : : */
143 : : #define HCD_INTF_AUTHORIZED(hcd) \
144 : : ((hcd)->flags & (1U << HCD_FLAG_INTF_AUTHORIZED))
145 : :
146 : : /*
147 : : * Specifies if devices are authorized by default
148 : : * or they require explicit user space authorization; this bit is
149 : : * settable through /sys/class/usb_host/X/authorized_default
150 : : */
151 : : enum usb_dev_authorize_policy dev_policy;
152 : :
153 : : /* Flags that get set only during HCD registration or removal. */
154 : : unsigned rh_registered:1;/* is root hub registered? */
155 : : unsigned rh_pollable:1; /* may we poll the root hub? */
156 : : unsigned msix_enabled:1; /* driver has MSI-X enabled? */
157 : : unsigned msi_enabled:1; /* driver has MSI enabled? */
158 : : /*
159 : : * do not manage the PHY state in the HCD core, instead let the driver
160 : : * handle this (for example if the PHY can only be turned on after a
161 : : * specific event)
162 : : */
163 : : unsigned skip_phy_initialization:1;
164 : :
165 : : /* The next flag is a stopgap, to be removed when all the HCDs
166 : : * support the new root-hub polling mechanism. */
167 : : unsigned uses_new_polling:1;
168 : : unsigned wireless:1; /* Wireless USB HCD */
169 : : unsigned has_tt:1; /* Integrated TT in root hub */
170 : : unsigned amd_resume_bug:1; /* AMD remote wakeup quirk */
171 : : unsigned can_do_streams:1; /* HC supports streams */
172 : : unsigned tpl_support:1; /* OTG & EH TPL support */
173 : : unsigned cant_recv_wakeups:1;
174 : : /* wakeup requests from downstream aren't received */
175 : :
176 : : unsigned int irq; /* irq allocated */
177 : : void __iomem *regs; /* device memory/io */
178 : : resource_size_t rsrc_start; /* memory/io resource start */
179 : : resource_size_t rsrc_len; /* memory/io resource length */
180 : : unsigned power_budget; /* in mA, 0 = no limit */
181 : :
182 : : struct giveback_urb_bh high_prio_bh;
183 : : struct giveback_urb_bh low_prio_bh;
184 : :
185 : : /* bandwidth_mutex should be taken before adding or removing
186 : : * any new bus bandwidth constraints:
187 : : * 1. Before adding a configuration for a new device.
188 : : * 2. Before removing the configuration to put the device into
189 : : * the addressed state.
190 : : * 3. Before selecting a different configuration.
191 : : * 4. Before selecting an alternate interface setting.
192 : : *
193 : : * bandwidth_mutex should be dropped after a successful control message
194 : : * to the device, or resetting the bandwidth after a failed attempt.
195 : : */
196 : : struct mutex *address0_mutex;
197 : : struct mutex *bandwidth_mutex;
198 : : struct usb_hcd *shared_hcd;
199 : : struct usb_hcd *primary_hcd;
200 : :
201 : :
202 : : #define HCD_BUFFER_POOLS 4
203 : : struct dma_pool *pool[HCD_BUFFER_POOLS];
204 : :
205 : : int state;
206 : : # define __ACTIVE 0x01
207 : : # define __SUSPEND 0x04
208 : : # define __TRANSIENT 0x80
209 : :
210 : : # define HC_STATE_HALT 0
211 : : # define HC_STATE_RUNNING (__ACTIVE)
212 : : # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
213 : : # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
214 : : # define HC_STATE_SUSPENDED (__SUSPEND)
215 : :
216 : : #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
217 : : #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
218 : :
219 : : /* memory pool for HCs having local memory, or %NULL */
220 : : struct gen_pool *localmem_pool;
221 : :
222 : : /* more shared queuing code would be good; it should support
223 : : * smarter scheduling, handle transaction translators, etc;
224 : : * input size of periodic table to an interrupt scheduler.
225 : : * (ohci 32, uhci 1024, ehci 256/512/1024).
226 : : */
227 : :
228 : : /* The HC driver's private data is stored at the end of
229 : : * this structure.
230 : : */
231 : : unsigned long hcd_priv[0]
232 : : __attribute__ ((aligned(sizeof(s64))));
233 : : };
234 : :
235 : : /* 2.4 does this a bit differently ... */
236 : : static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
237 : : {
238 : : return &hcd->self;
239 : : }
240 : :
241 : 0 : static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
242 : : {
243 [ # # # # : 0 : return container_of(bus, struct usb_hcd, self);
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
244 : : }
245 : :
246 : : /*-------------------------------------------------------------------------*/
247 : :
248 : :
249 : : struct hc_driver {
250 : : const char *description; /* "ehci-hcd" etc */
251 : : const char *product_desc; /* product/vendor string */
252 : : size_t hcd_priv_size; /* size of private data */
253 : :
254 : : /* irq handler */
255 : : irqreturn_t (*irq) (struct usb_hcd *hcd);
256 : :
257 : : int flags;
258 : : #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
259 : : #define HCD_DMA 0x0002 /* HC uses DMA */
260 : : #define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
261 : : #define HCD_USB11 0x0010 /* USB 1.1 */
262 : : #define HCD_USB2 0x0020 /* USB 2.0 */
263 : : #define HCD_USB25 0x0030 /* Wireless USB 1.0 (USB 2.5)*/
264 : : #define HCD_USB3 0x0040 /* USB 3.0 */
265 : : #define HCD_USB31 0x0050 /* USB 3.1 */
266 : : #define HCD_USB32 0x0060 /* USB 3.2 */
267 : : #define HCD_MASK 0x0070
268 : : #define HCD_BH 0x0100 /* URB complete in BH context */
269 : :
270 : : /* called to init HCD and root hub */
271 : : int (*reset) (struct usb_hcd *hcd);
272 : : int (*start) (struct usb_hcd *hcd);
273 : :
274 : : /* NOTE: these suspend/resume calls relate to the HC as
275 : : * a whole, not just the root hub; they're for PCI bus glue.
276 : : */
277 : : /* called after suspending the hub, before entering D3 etc */
278 : : int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
279 : :
280 : : /* called after entering D0 (etc), before resuming the hub */
281 : : int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
282 : :
283 : : /* cleanly make HCD stop writing memory and doing I/O */
284 : : void (*stop) (struct usb_hcd *hcd);
285 : :
286 : : /* shutdown HCD */
287 : : void (*shutdown) (struct usb_hcd *hcd);
288 : :
289 : : /* return current frame number */
290 : : int (*get_frame_number) (struct usb_hcd *hcd);
291 : :
292 : : /* manage i/o requests, device state */
293 : : int (*urb_enqueue)(struct usb_hcd *hcd,
294 : : struct urb *urb, gfp_t mem_flags);
295 : : int (*urb_dequeue)(struct usb_hcd *hcd,
296 : : struct urb *urb, int status);
297 : :
298 : : /*
299 : : * (optional) these hooks allow an HCD to override the default DMA
300 : : * mapping and unmapping routines. In general, they shouldn't be
301 : : * necessary unless the host controller has special DMA requirements,
302 : : * such as alignment contraints. If these are not specified, the
303 : : * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
304 : : * (and it may be a good idea to call these functions in your HCD
305 : : * implementation)
306 : : */
307 : : int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
308 : : gfp_t mem_flags);
309 : : void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
310 : :
311 : : /* hw synch, freeing endpoint resources that urb_dequeue can't */
312 : : void (*endpoint_disable)(struct usb_hcd *hcd,
313 : : struct usb_host_endpoint *ep);
314 : :
315 : : /* (optional) reset any endpoint state such as sequence number
316 : : and current window */
317 : : void (*endpoint_reset)(struct usb_hcd *hcd,
318 : : struct usb_host_endpoint *ep);
319 : :
320 : : /* root hub support */
321 : : int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
322 : : int (*hub_control) (struct usb_hcd *hcd,
323 : : u16 typeReq, u16 wValue, u16 wIndex,
324 : : char *buf, u16 wLength);
325 : : int (*bus_suspend)(struct usb_hcd *);
326 : : int (*bus_resume)(struct usb_hcd *);
327 : : int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
328 : : unsigned long (*get_resuming_ports)(struct usb_hcd *);
329 : :
330 : : /* force handover of high-speed port to full-speed companion */
331 : : void (*relinquish_port)(struct usb_hcd *, int);
332 : : /* has a port been handed over to a companion? */
333 : : int (*port_handed_over)(struct usb_hcd *, int);
334 : :
335 : : /* CLEAR_TT_BUFFER completion callback */
336 : : void (*clear_tt_buffer_complete)(struct usb_hcd *,
337 : : struct usb_host_endpoint *);
338 : :
339 : : /* xHCI specific functions */
340 : : /* Called by usb_alloc_dev to alloc HC device structures */
341 : : int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
342 : : /* Called by usb_disconnect to free HC device structures */
343 : : void (*free_dev)(struct usb_hcd *, struct usb_device *);
344 : : /* Change a group of bulk endpoints to support multiple stream IDs */
345 : : int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
346 : : struct usb_host_endpoint **eps, unsigned int num_eps,
347 : : unsigned int num_streams, gfp_t mem_flags);
348 : : /* Reverts a group of bulk endpoints back to not using stream IDs.
349 : : * Can fail if we run out of memory.
350 : : */
351 : : int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
352 : : struct usb_host_endpoint **eps, unsigned int num_eps,
353 : : gfp_t mem_flags);
354 : :
355 : : /* Bandwidth computation functions */
356 : : /* Note that add_endpoint() can only be called once per endpoint before
357 : : * check_bandwidth() or reset_bandwidth() must be called.
358 : : * drop_endpoint() can only be called once per endpoint also.
359 : : * A call to xhci_drop_endpoint() followed by a call to
360 : : * xhci_add_endpoint() will add the endpoint to the schedule with
361 : : * possibly new parameters denoted by a different endpoint descriptor
362 : : * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
363 : : * call to xhci_drop_endpoint() is not allowed.
364 : : */
365 : : /* Allocate endpoint resources and add them to a new schedule */
366 : : int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
367 : : struct usb_host_endpoint *);
368 : : /* Drop an endpoint from a new schedule */
369 : : int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
370 : : struct usb_host_endpoint *);
371 : : /* Check that a new hardware configuration, set using
372 : : * endpoint_enable and endpoint_disable, does not exceed bus
373 : : * bandwidth. This must be called before any set configuration
374 : : * or set interface requests are sent to the device.
375 : : */
376 : : int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
377 : : /* Reset the device schedule to the last known good schedule,
378 : : * which was set from a previous successful call to
379 : : * check_bandwidth(). This reverts any add_endpoint() and
380 : : * drop_endpoint() calls since that last successful call.
381 : : * Used for when a check_bandwidth() call fails due to resource
382 : : * or bandwidth constraints.
383 : : */
384 : : void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
385 : : /* Returns the hardware-chosen device address */
386 : : int (*address_device)(struct usb_hcd *, struct usb_device *udev);
387 : : /* prepares the hardware to send commands to the device */
388 : : int (*enable_device)(struct usb_hcd *, struct usb_device *udev);
389 : : /* Notifies the HCD after a hub descriptor is fetched.
390 : : * Will block.
391 : : */
392 : : int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
393 : : struct usb_tt *tt, gfp_t mem_flags);
394 : : int (*reset_device)(struct usb_hcd *, struct usb_device *);
395 : : /* Notifies the HCD after a device is connected and its
396 : : * address is set
397 : : */
398 : : int (*update_device)(struct usb_hcd *, struct usb_device *);
399 : : int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
400 : : /* USB 3.0 Link Power Management */
401 : : /* Returns the USB3 hub-encoded value for the U1/U2 timeout. */
402 : : int (*enable_usb3_lpm_timeout)(struct usb_hcd *,
403 : : struct usb_device *, enum usb3_link_state state);
404 : : /* The xHCI host controller can still fail the command to
405 : : * disable the LPM timeouts, so this can return an error code.
406 : : */
407 : : int (*disable_usb3_lpm_timeout)(struct usb_hcd *,
408 : : struct usb_device *, enum usb3_link_state state);
409 : : int (*find_raw_port_number)(struct usb_hcd *, int);
410 : : /* Call for power on/off the port if necessary */
411 : : int (*port_power)(struct usb_hcd *hcd, int portnum, bool enable);
412 : :
413 : : };
414 : :
415 : 0 : static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd)
416 : : {
417 [ # # ]: 0 : return hcd->driver->flags & HCD_BH;
418 : : }
419 : :
420 : 0 : static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd,
421 : : struct usb_host_endpoint *ep)
422 : : {
423 [ # # ]: 0 : return hcd->high_prio_bh.completing_ep == ep;
424 : : }
425 : :
426 : 0 : static inline bool hcd_uses_dma(struct usb_hcd *hcd)
427 : : {
428 [ # # # # : 0 : return IS_ENABLED(CONFIG_HAS_DMA) && (hcd->driver->flags & HCD_DMA);
# # ]
429 : : }
430 : :
431 : : extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
432 : : extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
433 : : int status);
434 : : extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
435 : :
436 : : extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
437 : : extern int usb_hcd_unlink_urb(struct urb *urb, int status);
438 : : extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
439 : : int status);
440 : : extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
441 : : gfp_t mem_flags);
442 : : extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
443 : : extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
444 : : extern void usb_hcd_flush_endpoint(struct usb_device *udev,
445 : : struct usb_host_endpoint *ep);
446 : : extern void usb_hcd_disable_endpoint(struct usb_device *udev,
447 : : struct usb_host_endpoint *ep);
448 : : extern void usb_hcd_reset_endpoint(struct usb_device *udev,
449 : : struct usb_host_endpoint *ep);
450 : : extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
451 : : extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
452 : : struct usb_host_config *new_config,
453 : : struct usb_host_interface *old_alt,
454 : : struct usb_host_interface *new_alt);
455 : : extern int usb_hcd_get_frame_number(struct usb_device *udev);
456 : :
457 : : struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
458 : : struct device *sysdev, struct device *dev, const char *bus_name,
459 : : struct usb_hcd *primary_hcd);
460 : : extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
461 : : struct device *dev, const char *bus_name);
462 : : extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
463 : : struct device *dev, const char *bus_name,
464 : : struct usb_hcd *shared_hcd);
465 : : extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
466 : : extern void usb_put_hcd(struct usb_hcd *hcd);
467 : : extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
468 : : extern int usb_add_hcd(struct usb_hcd *hcd,
469 : : unsigned int irqnum, unsigned long irqflags);
470 : : extern void usb_remove_hcd(struct usb_hcd *hcd);
471 : : extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1);
472 : : int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
473 : : dma_addr_t dma, size_t size);
474 : :
475 : : struct platform_device;
476 : : extern void usb_hcd_platform_shutdown(struct platform_device *dev);
477 : :
478 : : #ifdef CONFIG_USB_PCI
479 : : struct pci_dev;
480 : : struct pci_device_id;
481 : : extern int usb_hcd_pci_probe(struct pci_dev *dev,
482 : : const struct pci_device_id *id);
483 : : extern void usb_hcd_pci_remove(struct pci_dev *dev);
484 : : extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
485 : :
486 : : extern int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *dev);
487 : :
488 : : #ifdef CONFIG_PM
489 : : extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
490 : : #endif
491 : : #endif /* CONFIG_USB_PCI */
492 : :
493 : : /* pci-ish (pdev null is ok) buffer alloc/mapping support */
494 : : void usb_init_pool_max(void);
495 : : int hcd_buffer_create(struct usb_hcd *hcd);
496 : : void hcd_buffer_destroy(struct usb_hcd *hcd);
497 : :
498 : : void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
499 : : gfp_t mem_flags, dma_addr_t *dma);
500 : : void hcd_buffer_free(struct usb_bus *bus, size_t size,
501 : : void *addr, dma_addr_t dma);
502 : :
503 : : /* generic bus glue, needed for host controllers that don't use PCI */
504 : : extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
505 : :
506 : : extern void usb_hc_died(struct usb_hcd *hcd);
507 : : extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
508 : : extern void usb_wakeup_notification(struct usb_device *hdev,
509 : : unsigned int portnum);
510 : :
511 : : extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum);
512 : : extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum);
513 : :
514 : : /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
515 : : #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
516 : : #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
517 : : #define usb_settoggle(dev, ep, out, bit) \
518 : : ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
519 : : ((bit) << (ep)))
520 : :
521 : : /* -------------------------------------------------------------------------- */
522 : :
523 : : /* Enumeration is only for the hub driver, or HCD virtual root hubs */
524 : : extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
525 : : struct usb_bus *, unsigned port);
526 : : extern int usb_new_device(struct usb_device *dev);
527 : : extern void usb_disconnect(struct usb_device **);
528 : :
529 : : extern int usb_get_configuration(struct usb_device *dev);
530 : : extern void usb_destroy_configuration(struct usb_device *dev);
531 : :
532 : : /*-------------------------------------------------------------------------*/
533 : :
534 : : /*
535 : : * HCD Root Hub support
536 : : */
537 : :
538 : : #include <linux/usb/ch11.h>
539 : :
540 : : /*
541 : : * As of USB 2.0, full/low speed devices are segregated into trees.
542 : : * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
543 : : * The other type grows from high speed hubs when they connect to
544 : : * full/low speed devices using "Transaction Translators" (TTs).
545 : : *
546 : : * TTs should only be known to the hub driver, and high speed bus
547 : : * drivers (only EHCI for now). They affect periodic scheduling and
548 : : * sometimes control/bulk error recovery.
549 : : */
550 : :
551 : : struct usb_device;
552 : :
553 : : struct usb_tt {
554 : : struct usb_device *hub; /* upstream highspeed hub */
555 : : int multi; /* true means one TT per port */
556 : : unsigned think_time; /* think time in ns */
557 : : void *hcpriv; /* HCD private data */
558 : :
559 : : /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
560 : : spinlock_t lock;
561 : : struct list_head clear_list; /* of usb_tt_clear */
562 : : struct work_struct clear_work;
563 : : };
564 : :
565 : : struct usb_tt_clear {
566 : : struct list_head clear_list;
567 : : unsigned tt;
568 : : u16 devinfo;
569 : : struct usb_hcd *hcd;
570 : : struct usb_host_endpoint *ep;
571 : : };
572 : :
573 : : extern int usb_hub_clear_tt_buffer(struct urb *urb);
574 : : extern void usb_ep0_reinit(struct usb_device *);
575 : :
576 : : /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
577 : : #define DeviceRequest \
578 : : ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
579 : : #define DeviceOutRequest \
580 : : ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
581 : :
582 : : #define InterfaceRequest \
583 : : ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
584 : :
585 : : #define EndpointRequest \
586 : : ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
587 : : #define EndpointOutRequest \
588 : : ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
589 : :
590 : : /* class requests from the USB 2.0 hub spec, table 11-15 */
591 : : #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request))
592 : : /* GetBusState and SetHubDescriptor are optional, omitted */
593 : : #define ClearHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_CLEAR_FEATURE)
594 : : #define ClearPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_CLEAR_FEATURE)
595 : : #define GetHubDescriptor HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_DESCRIPTOR)
596 : : #define GetHubStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_STATUS)
597 : : #define GetPortStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, USB_REQ_GET_STATUS)
598 : : #define SetHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_SET_FEATURE)
599 : : #define SetPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_SET_FEATURE)
600 : : #define ClearTTBuffer HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_CLEAR_TT_BUFFER)
601 : : #define ResetTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_RESET_TT)
602 : : #define GetTTState HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_TT_STATE)
603 : : #define StopTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_STOP_TT)
604 : :
605 : :
606 : : /*-------------------------------------------------------------------------*/
607 : :
608 : : /* class requests from USB 3.1 hub spec, table 10-7 */
609 : : #define SetHubDepth HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, HUB_SET_DEPTH)
610 : : #define GetPortErrorCount HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_PORT_ERR_COUNT)
611 : :
612 : : /*
613 : : * Generic bandwidth allocation constants/support
614 : : */
615 : : #define FRAME_TIME_USECS 1000L
616 : : #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
617 : : /* Trying not to use worst-case bit-stuffing
618 : : * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
619 : : /* bytecount = data payload byte count */
620 : :
621 : : #define NS_TO_US(ns) DIV_ROUND_UP(ns, 1000L)
622 : : /* convert nanoseconds to microseconds, rounding up */
623 : :
624 : : /*
625 : : * Full/low speed bandwidth allocation constants/support.
626 : : */
627 : : #define BW_HOST_DELAY 1000L /* nanoseconds */
628 : : #define BW_HUB_LS_SETUP 333L /* nanoseconds */
629 : : /* 4 full-speed bit times (est.) */
630 : :
631 : : #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
632 : : #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
633 : : #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
634 : :
635 : : /*
636 : : * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
637 : : * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
638 : : * to preallocate bandwidth)
639 : : */
640 : : #define USB2_HOST_DELAY 5 /* nsec, guess */
641 : : #define HS_NSECS(bytes) (((55 * 8 * 2083) \
642 : : + (2083UL * (3 + BitTime(bytes))))/1000 \
643 : : + USB2_HOST_DELAY)
644 : : #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
645 : : + (2083UL * (3 + BitTime(bytes))))/1000 \
646 : : + USB2_HOST_DELAY)
647 : : #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
648 : : #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
649 : :
650 : : extern long usb_calc_bus_time(int speed, int is_input,
651 : : int isoc, int bytecount);
652 : :
653 : : /*-------------------------------------------------------------------------*/
654 : :
655 : : extern void usb_set_device_state(struct usb_device *udev,
656 : : enum usb_device_state new_state);
657 : :
658 : : /*-------------------------------------------------------------------------*/
659 : :
660 : : /* exported only within usbcore */
661 : :
662 : : extern struct idr usb_bus_idr;
663 : : extern struct mutex usb_bus_idr_lock;
664 : : extern wait_queue_head_t usb_kill_urb_queue;
665 : :
666 : :
667 : : #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
668 : :
669 : : #ifdef CONFIG_PM
670 : : extern unsigned usb_wakeup_enabled_descendants(struct usb_device *udev);
671 : : extern void usb_root_hub_lost_power(struct usb_device *rhdev);
672 : : extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
673 : : extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
674 : : extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
675 : : #else
676 : : static inline unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
677 : : {
678 : : return 0;
679 : : }
680 : : static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
681 : : {
682 : : return;
683 : : }
684 : : #endif /* CONFIG_PM */
685 : :
686 : : /*-------------------------------------------------------------------------*/
687 : :
688 : : #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
689 : :
690 : : struct usb_mon_operations {
691 : : void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
692 : : void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
693 : : void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
694 : : /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
695 : : };
696 : :
697 : : extern const struct usb_mon_operations *mon_ops;
698 : :
699 : 0 : static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
700 : : {
701 [ # # ]: 0 : if (bus->monitored)
702 : 0 : (*mon_ops->urb_submit)(bus, urb);
703 : : }
704 : :
705 : 0 : static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
706 : : int error)
707 : : {
708 [ # # ]: 0 : if (bus->monitored)
709 : 0 : (*mon_ops->urb_submit_error)(bus, urb, error);
710 : : }
711 : :
712 : 0 : static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
713 : : int status)
714 : : {
715 [ # # ]: 0 : if (bus->monitored)
716 : 0 : (*mon_ops->urb_complete)(bus, urb, status);
717 : : }
718 : :
719 : : int usb_mon_register(const struct usb_mon_operations *ops);
720 : : void usb_mon_deregister(void);
721 : :
722 : : #else
723 : :
724 : : static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
725 : : static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
726 : : int error) {}
727 : : static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
728 : : int status) {}
729 : :
730 : : #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
731 : :
732 : : /*-------------------------------------------------------------------------*/
733 : :
734 : : /* random stuff */
735 : :
736 : : #define RUN_CONTEXT (in_irq() ? "in_irq" \
737 : : : (in_interrupt() ? "in_interrupt" : "can sleep"))
738 : :
739 : :
740 : : /* This rwsem is for use only by the hub driver and ehci-hcd.
741 : : * Nobody else should touch it.
742 : : */
743 : : extern struct rw_semaphore ehci_cf_port_reset_rwsem;
744 : :
745 : : /* Keep track of which host controller drivers are loaded */
746 : : #define USB_UHCI_LOADED 0
747 : : #define USB_OHCI_LOADED 1
748 : : #define USB_EHCI_LOADED 2
749 : : extern unsigned long usb_hcds_loaded;
750 : :
751 : : #endif /* __KERNEL__ */
752 : :
753 : : #endif /* __USB_CORE_HCD_H */
|
