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