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