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