~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/usb/hcd.h

Version: ~ [ linux-5.4-rc3 ] ~ [ linux-5.3.6 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.79 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.149 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.196 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.196 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.75 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp