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