hcd.h 26.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0+
L
Linus Torvalds 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * Copyright (c) 2001-2002 by David Brownell
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

20 21
#ifndef __USB_CORE_HCD_H
#define __USB_CORE_HCD_H
L
Linus Torvalds 已提交
22 23 24

#ifdef __KERNEL__

25
#include <linux/rwsem.h>
26
#include <linux/interrupt.h>
27
#include <linux/idr.h>
28

29 30
#define MAX_TOPO_LEVEL		6

L
Linus Torvalds 已提交
31 32 33 34 35 36 37
/* This file contains declarations of usbcore internals that are mostly
 * used or exposed by Host Controller Drivers.
 */

/*
 * USB Packet IDs (PIDs)
 */
38
#define USB_PID_EXT			0xf0	/* USB 2.0 LPM ECN */
L
Linus Torvalds 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
#define USB_PID_OUT			0xe1
#define USB_PID_ACK			0xd2
#define USB_PID_DATA0			0xc3
#define USB_PID_PING			0xb4	/* USB 2.0 */
#define USB_PID_SOF			0xa5
#define USB_PID_NYET			0x96	/* USB 2.0 */
#define USB_PID_DATA2			0x87	/* USB 2.0 */
#define USB_PID_SPLIT			0x78	/* USB 2.0 */
#define USB_PID_IN			0x69
#define USB_PID_NAK			0x5a
#define USB_PID_DATA1			0x4b
#define USB_PID_PREAMBLE		0x3c	/* Token mode */
#define USB_PID_ERR			0x3c	/* USB 2.0: handshake mode */
#define USB_PID_SETUP			0x2d
#define USB_PID_STALL			0x1e
#define USB_PID_MDATA			0x0f	/* USB 2.0 */

/*-------------------------------------------------------------------------*/

/*
 * USB Host Controller Driver (usb_hcd) framework
 *
 * Since "struct usb_bus" is so thin, you can't share much code in it.
 * This framework is a layer over that, and should be more sharable.
 */

/*-------------------------------------------------------------------------*/

67 68 69 70 71
struct giveback_urb_bh {
	bool running;
	spinlock_t lock;
	struct list_head  head;
	struct tasklet_struct bh;
72
	struct usb_host_endpoint *completing_ep;
73 74
};

75
struct usb_hcd {
L
Linus Torvalds 已提交
76 77 78 79 80

	/*
	 * housekeeping
	 */
	struct usb_bus		self;		/* hcd is-a bus */
81
	struct kref		kref;		/* reference counter */
L
Linus Torvalds 已提交
82 83

	const char		*product_desc;	/* product/vendor string */
84 85 86 87
	int			speed;		/* Speed for this roothub.
						 * May be different from
						 * hcd->driver->flags & HCD_MASK
						 */
L
Linus Torvalds 已提交
88 89
	char			irq_descr[24];	/* driver + bus # */

90 91
	struct timer_list	rh_timer;	/* drives root-hub polling */
	struct urb		*status_urb;	/* the current status urb */
92
#ifdef CONFIG_PM
93 94
	struct work_struct	wakeup_work;	/* for remote wakeup */
#endif
L
Linus Torvalds 已提交
95 96 97 98 99

	/*
	 * hardware info/state
	 */
	const struct hc_driver	*driver;	/* hw-specific hooks */
100

101 102 103 104
	/*
	 * OTG and some Host controllers need software interaction with phys;
	 * other external phys should be software-transparent
	 */
105
	struct usb_phy		*usb_phy;
106
	struct usb_phy_roothub	*phy_roothub;
107

108 109 110 111
	/* Flags that need to be manipulated atomically because they can
	 * change while the host controller is running.  Always use
	 * set_bit() or clear_bit() to change their values.
	 */
112
	unsigned long		flags;
113 114 115
#define HCD_FLAG_HW_ACCESSIBLE		0	/* at full power */
#define HCD_FLAG_POLL_RH		2	/* poll for rh status? */
#define HCD_FLAG_POLL_PENDING		3	/* status has changed? */
116
#define HCD_FLAG_WAKEUP_PENDING		4	/* root hub is resuming? */
117 118
#define HCD_FLAG_RH_RUNNING		5	/* root hub is running? */
#define HCD_FLAG_DEAD			6	/* controller has died? */
119
#define HCD_FLAG_INTF_AUTHORIZED	7	/* authorize interfaces? */
120
#define HCD_FLAG_DEV_AUTHORIZED		8	/* authorize devices? */
121 122 123 124 125 126 127

	/* The flags can be tested using these macros; they are likely to
	 * be slightly faster than test_bit().
	 */
#define HCD_HW_ACCESSIBLE(hcd)	((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
#define HCD_POLL_RH(hcd)	((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
#define HCD_POLL_PENDING(hcd)	((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
128
#define HCD_WAKEUP_PENDING(hcd)	((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
129 130
#define HCD_RH_RUNNING(hcd)	((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
#define HCD_DEAD(hcd)		((hcd)->flags & (1U << HCD_FLAG_DEAD))
131

132 133 134 135 136 137 138 139
	/*
	 * Specifies if interfaces are authorized by default
	 * or they require explicit user space authorization; this bit is
	 * settable through /sys/class/usb_host/X/interface_authorized_default
	 */
#define HCD_INTF_AUTHORIZED(hcd) \
	((hcd)->flags & (1U << HCD_FLAG_INTF_AUTHORIZED))

140 141 142 143 144 145 146 147
	/*
	 * Specifies if devices are authorized by default
	 * or they require explicit user space authorization; this bit is
	 * settable through /sys/class/usb_host/X/authorized_default
	 */
#define HCD_DEV_AUTHORIZED(hcd) \
	((hcd)->flags & (1U << HCD_FLAG_DEV_AUTHORIZED))

148
	/* Flags that get set only during HCD registration or removal. */
L
Linus Torvalds 已提交
149
	unsigned		rh_registered:1;/* is root hub registered? */
150
	unsigned		rh_pollable:1;	/* may we poll the root hub? */
151
	unsigned		msix_enabled:1;	/* driver has MSI-X enabled? */
152
	unsigned		msi_enabled:1;	/* driver has MSI enabled? */
153 154 155 156 157 158
	/*
	 * do not manage the PHY state in the HCD core, instead let the driver
	 * handle this (for example if the PHY can only be turned on after a
	 * specific event)
	 */
	unsigned		skip_phy_initialization:1;
L
Linus Torvalds 已提交
159

160 161 162
	/* The next flag is a stopgap, to be removed when all the HCDs
	 * support the new root-hub polling mechanism. */
	unsigned		uses_new_polling:1;
163
	unsigned		wireless:1;	/* Wireless USB HCD */
164
	unsigned		has_tt:1;	/* Integrated TT in root hub */
165
	unsigned		amd_resume_bug:1; /* AMD remote wakeup quirk */
166
	unsigned		can_do_streams:1; /* HC supports streams */
P
Peter Chen 已提交
167
	unsigned		tpl_support:1; /* OTG & EH TPL support */
168 169
	unsigned		cant_recv_wakeups:1;
			/* wakeup requests from downstream aren't received */
170

171
	unsigned int		irq;		/* irq allocated */
L
Linus Torvalds 已提交
172
	void __iomem		*regs;		/* device memory/io */
173 174
	resource_size_t		rsrc_start;	/* memory/io resource start */
	resource_size_t		rsrc_len;	/* memory/io resource length */
175
	unsigned		power_budget;	/* in mA, 0 = no limit */
L
Linus Torvalds 已提交
176

177 178 179
	struct giveback_urb_bh  high_prio_bh;
	struct giveback_urb_bh  low_prio_bh;

180 181 182 183 184 185 186 187 188 189 190
	/* bandwidth_mutex should be taken before adding or removing
	 * any new bus bandwidth constraints:
	 *   1. Before adding a configuration for a new device.
	 *   2. Before removing the configuration to put the device into
	 *      the addressed state.
	 *   3. Before selecting a different configuration.
	 *   4. Before selecting an alternate interface setting.
	 *
	 * bandwidth_mutex should be dropped after a successful control message
	 * to the device, or resetting the bandwidth after a failed attempt.
	 */
191
	struct mutex		*address0_mutex;
192
	struct mutex		*bandwidth_mutex;
193 194
	struct usb_hcd		*shared_hcd;
	struct usb_hcd		*primary_hcd;
195 196


L
Linus Torvalds 已提交
197
#define HCD_BUFFER_POOLS	4
198
	struct dma_pool		*pool[HCD_BUFFER_POOLS];
L
Linus Torvalds 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

	int			state;
#	define	__ACTIVE		0x01
#	define	__SUSPEND		0x04
#	define	__TRANSIENT		0x80

#	define	HC_STATE_HALT		0
#	define	HC_STATE_RUNNING	(__ACTIVE)
#	define	HC_STATE_QUIESCING	(__SUSPEND|__TRANSIENT|__ACTIVE)
#	define	HC_STATE_RESUMING	(__SUSPEND|__TRANSIENT)
#	define	HC_STATE_SUSPENDED	(__SUSPEND)

#define	HC_IS_RUNNING(state) ((state) & __ACTIVE)
#define	HC_IS_SUSPENDED(state) ((state) & __SUSPEND)

214 215 216
	/* memory pool for HCs having local memory, or %NULL */
	struct gen_pool         *localmem_pool;

L
Linus Torvalds 已提交
217 218
	/* more shared queuing code would be good; it should support
	 * smarter scheduling, handle transaction translators, etc;
219
	 * input size of periodic table to an interrupt scheduler.
L
Linus Torvalds 已提交
220 221 222 223 224 225 226
	 * (ohci 32, uhci 1024, ehci 256/512/1024).
	 */

	/* The HC driver's private data is stored at the end of
	 * this structure.
	 */
	unsigned long hcd_priv[0]
H
Harro Haan 已提交
227
			__attribute__ ((aligned(sizeof(s64))));
L
Linus Torvalds 已提交
228 229 230
};

/* 2.4 does this a bit differently ... */
231
static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
L
Linus Torvalds 已提交
232 233 234 235
{
	return &hcd->self;
}

236
static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
237 238 239
{
	return container_of(bus, struct usb_hcd, self);
}
L
Linus Torvalds 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

struct hcd_timeout {	/* timeouts we allocate */
	struct list_head	timeout_list;
	struct timer_list	timer;
};

/*-------------------------------------------------------------------------*/


struct hc_driver {
	const char	*description;	/* "ehci-hcd" etc */
	const char	*product_desc;	/* product/vendor string */
	size_t		hcd_priv_size;	/* size of private data */

	/* irq handler */
255
	irqreturn_t	(*irq) (struct usb_hcd *hcd);
L
Linus Torvalds 已提交
256 257 258

	int	flags;
#define	HCD_MEMORY	0x0001		/* HC regs use memory (else I/O) */
M
Magnus Damm 已提交
259
#define	HCD_LOCAL_MEM	0x0002		/* HC needs local memory */
260
#define	HCD_SHARED	0x0004		/* Two (or more) usb_hcds share HW */
L
Linus Torvalds 已提交
261 262
#define	HCD_USB11	0x0010		/* USB 1.1 */
#define	HCD_USB2	0x0020		/* USB 2.0 */
263
#define	HCD_USB25	0x0030		/* Wireless USB 1.0 (USB 2.5)*/
264
#define	HCD_USB3	0x0040		/* USB 3.0 */
265
#define	HCD_USB31	0x0050		/* USB 3.1 */
266
#define	HCD_USB32	0x0060		/* USB 3.2 */
267
#define	HCD_MASK	0x0070
268
#define	HCD_BH		0x0100		/* URB complete in BH context */
L
Linus Torvalds 已提交
269 270 271 272 273 274

	/* called to init HCD and root hub */
	int	(*reset) (struct usb_hcd *hcd);
	int	(*start) (struct usb_hcd *hcd);

	/* NOTE:  these suspend/resume calls relate to the HC as
275
	 * a whole, not just the root hub; they're for PCI bus glue.
L
Linus Torvalds 已提交
276
	 */
277
	/* called after suspending the hub, before entering D3 etc */
278
	int	(*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
L
Linus Torvalds 已提交
279

280
	/* called after entering D0 (etc), before resuming the hub */
281
	int	(*pci_resume)(struct usb_hcd *hcd, bool hibernated);
L
Linus Torvalds 已提交
282 283 284 285

	/* cleanly make HCD stop writing memory and doing I/O */
	void	(*stop) (struct usb_hcd *hcd);

286 287 288
	/* shutdown HCD */
	void	(*shutdown) (struct usb_hcd *hcd);

L
Linus Torvalds 已提交
289 290 291 292
	/* return current frame number */
	int	(*get_frame_number) (struct usb_hcd *hcd);

	/* manage i/o requests, device state */
293 294 295 296
	int	(*urb_enqueue)(struct usb_hcd *hcd,
				struct urb *urb, gfp_t mem_flags);
	int	(*urb_dequeue)(struct usb_hcd *hcd,
				struct urb *urb, int status);
L
Linus Torvalds 已提交
297

298 299 300 301 302 303 304 305 306 307 308 309 310
	/*
	 * (optional) these hooks allow an HCD to override the default DMA
	 * mapping and unmapping routines.  In general, they shouldn't be
	 * necessary unless the host controller has special DMA requirements,
	 * such as alignment contraints.  If these are not specified, the
	 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
	 * (and it may be a good idea to call these functions in your HCD
	 * implementation)
	 */
	int	(*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
				   gfp_t mem_flags);
	void    (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);

L
Linus Torvalds 已提交
311
	/* hw synch, freeing endpoint resources that urb_dequeue can't */
312
	void	(*endpoint_disable)(struct usb_hcd *hcd,
L
Linus Torvalds 已提交
313 314
			struct usb_host_endpoint *ep);

315 316
	/* (optional) reset any endpoint state such as sequence number
	   and current window */
317
	void	(*endpoint_reset)(struct usb_hcd *hcd,
318 319
			struct usb_host_endpoint *ep);

L
Linus Torvalds 已提交
320
	/* root hub support */
321 322
	int	(*hub_status_data) (struct usb_hcd *hcd, char *buf);
	int	(*hub_control) (struct usb_hcd *hcd,
L
Linus Torvalds 已提交
323 324
				u16 typeReq, u16 wValue, u16 wIndex,
				char *buf, u16 wLength);
325 326 327
	int	(*bus_suspend)(struct usb_hcd *);
	int	(*bus_resume)(struct usb_hcd *);
	int	(*start_port_reset)(struct usb_hcd *, unsigned port_num);
328
	unsigned long	(*get_resuming_ports)(struct usb_hcd *);
329 330

		/* force handover of high-speed port to full-speed companion */
331
	void	(*relinquish_port)(struct usb_hcd *, int);
332 333
		/* has a port been handed over to a companion? */
	int	(*port_handed_over)(struct usb_hcd *, int);
334

335 336 337 338
		/* CLEAR_TT_BUFFER completion callback */
	void	(*clear_tt_buffer_complete)(struct usb_hcd *,
				struct usb_host_endpoint *);

339 340 341
	/* xHCI specific functions */
		/* Called by usb_alloc_dev to alloc HC device structures */
	int	(*alloc_dev)(struct usb_hcd *, struct usb_device *);
342
		/* Called by usb_disconnect to free HC device structures */
343
	void	(*free_dev)(struct usb_hcd *, struct usb_device *);
344 345 346 347 348 349 350 351 352 353
	/* Change a group of bulk endpoints to support multiple stream IDs */
	int	(*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
		struct usb_host_endpoint **eps, unsigned int num_eps,
		unsigned int num_streams, gfp_t mem_flags);
	/* Reverts a group of bulk endpoints back to not using stream IDs.
	 * Can fail if we run out of memory.
	 */
	int	(*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
		struct usb_host_endpoint **eps, unsigned int num_eps,
		gfp_t mem_flags);
354 355 356 357 358

	/* Bandwidth computation functions */
	/* Note that add_endpoint() can only be called once per endpoint before
	 * check_bandwidth() or reset_bandwidth() must be called.
	 * drop_endpoint() can only be called once per endpoint also.
359 360 361 362 363
	 * A call to xhci_drop_endpoint() followed by a call to
	 * xhci_add_endpoint() will add the endpoint to the schedule with
	 * possibly new parameters denoted by a different endpoint descriptor
	 * in usb_host_endpoint.  A call to xhci_add_endpoint() followed by a
	 * call to xhci_drop_endpoint() is not allowed.
364 365
	 */
		/* Allocate endpoint resources and add them to a new schedule */
366 367
	int	(*add_endpoint)(struct usb_hcd *, struct usb_device *,
				struct usb_host_endpoint *);
368
		/* Drop an endpoint from a new schedule */
369 370
	int	(*drop_endpoint)(struct usb_hcd *, struct usb_device *,
				 struct usb_host_endpoint *);
371 372 373 374 375 376 377 378 379 380 381 382 383 384
		/* Check that a new hardware configuration, set using
		 * endpoint_enable and endpoint_disable, does not exceed bus
		 * bandwidth.  This must be called before any set configuration
		 * or set interface requests are sent to the device.
		 */
	int	(*check_bandwidth)(struct usb_hcd *, struct usb_device *);
		/* Reset the device schedule to the last known good schedule,
		 * which was set from a previous successful call to
		 * check_bandwidth().  This reverts any add_endpoint() and
		 * drop_endpoint() calls since that last successful call.
		 * Used for when a check_bandwidth() call fails due to resource
		 * or bandwidth constraints.
		 */
	void	(*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
385 386
		/* Returns the hardware-chosen device address */
	int	(*address_device)(struct usb_hcd *, struct usb_device *udev);
387 388
		/* prepares the hardware to send commands to the device */
	int	(*enable_device)(struct usb_hcd *, struct usb_device *udev);
389 390 391 392 393
		/* Notifies the HCD after a hub descriptor is fetched.
		 * Will block.
		 */
	int	(*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
			struct usb_tt *tt, gfp_t mem_flags);
394
	int	(*reset_device)(struct usb_hcd *, struct usb_device *);
395 396 397 398
		/* Notifies the HCD after a device is connected and its
		 * address is set
		 */
	int	(*update_device)(struct usb_hcd *, struct usb_device *);
A
Andiry Xu 已提交
399
	int	(*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
400 401 402 403 404 405 406 407 408
	/* USB 3.0 Link Power Management */
		/* Returns the USB3 hub-encoded value for the U1/U2 timeout. */
	int	(*enable_usb3_lpm_timeout)(struct usb_hcd *,
			struct usb_device *, enum usb3_link_state state);
		/* The xHCI host controller can still fail the command to
		 * disable the LPM timeouts, so this can return an error code.
		 */
	int	(*disable_usb3_lpm_timeout)(struct usb_hcd *,
			struct usb_device *, enum usb3_link_state state);
409
	int	(*find_raw_port_number)(struct usb_hcd *, int);
410 411 412
	/* Call for power on/off the port if necessary */
	int	(*port_power)(struct usb_hcd *hcd, int portnum, bool enable);

L
Linus Torvalds 已提交
413 414
};

415 416 417 418 419
static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd)
{
	return hcd->driver->flags & HCD_BH;
}

420 421 422 423 424 425
static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd,
		struct usb_host_endpoint *ep)
{
	return hcd->high_prio_bh.completing_ep == ep;
}

426 427 428 429 430
extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
		int status);
extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);

431 432
extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
extern int usb_hcd_unlink_urb(struct urb *urb, int status);
A
Alan Stern 已提交
433 434
extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
		int status);
435 436
extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
		gfp_t mem_flags);
437 438
extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
439 440 441
extern void usb_hcd_flush_endpoint(struct usb_device *udev,
		struct usb_host_endpoint *ep);
extern void usb_hcd_disable_endpoint(struct usb_device *udev,
A
Alan Stern 已提交
442
		struct usb_host_endpoint *ep);
443 444
extern void usb_hcd_reset_endpoint(struct usb_device *udev,
		struct usb_host_endpoint *ep);
445
extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
446
extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
447
		struct usb_host_config *new_config,
448 449
		struct usb_host_interface *old_alt,
		struct usb_host_interface *new_alt);
450
extern int usb_hcd_get_frame_number(struct usb_device *udev);
L
Linus Torvalds 已提交
451

452 453 454
struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
		struct device *sysdev, struct device *dev, const char *bus_name,
		struct usb_hcd *primary_hcd);
455
extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
456
		struct device *dev, const char *bus_name);
457 458 459
extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
		struct device *dev, const char *bus_name,
		struct usb_hcd *shared_hcd);
460 461
extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
extern void usb_put_hcd(struct usb_hcd *hcd);
462
extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
L
Linus Torvalds 已提交
463 464 465
extern int usb_add_hcd(struct usb_hcd *hcd,
		unsigned int irqnum, unsigned long irqflags);
extern void usb_remove_hcd(struct usb_hcd *hcd);
466
extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1);
467 468
int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
			    dma_addr_t dma, size_t size);
L
Linus Torvalds 已提交
469

470
struct platform_device;
471
extern void usb_hcd_platform_shutdown(struct platform_device *dev);
472

473
#ifdef CONFIG_USB_PCI
L
Linus Torvalds 已提交
474 475
struct pci_dev;
struct pci_device_id;
476
extern int usb_hcd_pci_probe(struct pci_dev *dev,
L
Linus Torvalds 已提交
477
				const struct pci_device_id *id);
478 479
extern void usb_hcd_pci_remove(struct pci_dev *dev);
extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
480

481 482
extern int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *dev);

483
#ifdef CONFIG_PM
484
extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
485
#endif
486
#endif /* CONFIG_USB_PCI */
L
Linus Torvalds 已提交
487 488

/* pci-ish (pdev null is ok) buffer alloc/mapping support */
489
void usb_init_pool_max(void);
490 491
int hcd_buffer_create(struct usb_hcd *hcd);
void hcd_buffer_destroy(struct usb_hcd *hcd);
L
Linus Torvalds 已提交
492

493
void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
A
Al Viro 已提交
494
	gfp_t mem_flags, dma_addr_t *dma);
495
void hcd_buffer_free(struct usb_bus *bus, size_t size,
L
Linus Torvalds 已提交
496 497 498
	void *addr, dma_addr_t dma);

/* generic bus glue, needed for host controllers that don't use PCI */
499
extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
500

501
extern void usb_hc_died(struct usb_hcd *hcd);
502
extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
503 504
extern void usb_wakeup_notification(struct usb_device *hdev,
		unsigned int portnum);
L
Linus Torvalds 已提交
505

506 507 508
extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum);
extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum);

509 510 511 512 513 514 515
/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
#define	usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << (ep)))
#define usb_settoggle(dev, ep, out, bit) \
		((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
		 ((bit) << (ep)))

L
Linus Torvalds 已提交
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
/* -------------------------------------------------------------------------- */

/* Enumeration is only for the hub driver, or HCD virtual root hubs */
extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
					struct usb_bus *, unsigned port);
extern int usb_new_device(struct usb_device *dev);
extern void usb_disconnect(struct usb_device **);

extern int usb_get_configuration(struct usb_device *dev);
extern void usb_destroy_configuration(struct usb_device *dev);

/*-------------------------------------------------------------------------*/

/*
 * HCD Root Hub support
 */

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
#include <linux/usb/ch11.h>

/*
 * As of USB 2.0, full/low speed devices are segregated into trees.
 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
 * The other type grows from high speed hubs when they connect to
 * full/low speed devices using "Transaction Translators" (TTs).
 *
 * TTs should only be known to the hub driver, and high speed bus
 * drivers (only EHCI for now).  They affect periodic scheduling and
 * sometimes control/bulk error recovery.
 */

struct usb_device;

struct usb_tt {
	struct usb_device	*hub;	/* upstream highspeed hub */
	int			multi;	/* true means one TT per port */
	unsigned		think_time;	/* think time in ns */
552
	void			*hcpriv;	/* HCD private data */
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

	/* for control/bulk error recovery (CLEAR_TT_BUFFER) */
	spinlock_t		lock;
	struct list_head	clear_list;	/* of usb_tt_clear */
	struct work_struct	clear_work;
};

struct usb_tt_clear {
	struct list_head	clear_list;
	unsigned		tt;
	u16			devinfo;
	struct usb_hcd		*hcd;
	struct usb_host_endpoint	*ep;
};

extern int usb_hub_clear_tt_buffer(struct urb *urb);
extern void usb_ep0_reinit(struct usb_device *);
L
Linus Torvalds 已提交
570 571 572 573 574 575 576 577 578 579 580

/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
#define DeviceRequest \
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
#define DeviceOutRequest \
	((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)

#define InterfaceRequest \
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)

#define EndpointRequest \
581
	((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
L
Linus Torvalds 已提交
582
#define EndpointOutRequest \
583
	((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
L
Linus Torvalds 已提交
584 585

/* class requests from the USB 2.0 hub spec, table 11-15 */
586
#define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request))
L
Linus Torvalds 已提交
587
/* GetBusState and SetHubDescriptor are optional, omitted */
588 589 590 591 592 593 594
#define ClearHubFeature		HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_CLEAR_FEATURE)
#define ClearPortFeature	HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_CLEAR_FEATURE)
#define GetHubDescriptor	HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_DESCRIPTOR)
#define GetHubStatus		HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_STATUS)
#define GetPortStatus		HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, USB_REQ_GET_STATUS)
#define SetHubFeature		HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_SET_FEATURE)
#define SetPortFeature		HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_SET_FEATURE)
L
Linus Torvalds 已提交
595 596 597


/*-------------------------------------------------------------------------*/
T
Tatyana Brokhman 已提交
598

599
/* class requests from USB 3.1 hub spec, table 10-7 */
600 601
#define SetHubDepth		HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, HUB_SET_DEPTH)
#define GetPortErrorCount	HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_PORT_ERR_COUNT)
L
Linus Torvalds 已提交
602 603 604 605 606

/*
 * Generic bandwidth allocation constants/support
 */
#define FRAME_TIME_USECS	1000L
607
#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
L
Linus Torvalds 已提交
608
		/* Trying not to use worst-case bit-stuffing
609
		 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
L
Linus Torvalds 已提交
610 611
		/* bytecount = data payload byte count */

A
Alan Stern 已提交
612 613
#define NS_TO_US(ns)	DIV_ROUND_UP(ns, 1000L)
			/* convert nanoseconds to microseconds, rounding up */
L
Linus Torvalds 已提交
614 615 616 617 618 619

/*
 * Full/low speed bandwidth allocation constants/support.
 */
#define BW_HOST_DELAY	1000L		/* nanoseconds */
#define BW_HUB_LS_SETUP	333L		/* nanoseconds */
620
			/* 4 full-speed bit times (est.) */
L
Linus Torvalds 已提交
621

622
#define FRAME_TIME_BITS			12000L	/* frame = 1 millisecond */
L
Linus Torvalds 已提交
623 624 625 626
#define FRAME_TIME_MAX_BITS_ALLOC	(90L * FRAME_TIME_BITS / 100L)
#define FRAME_TIME_MAX_USECS_ALLOC	(90L * FRAME_TIME_USECS / 100L)

/*
627
 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
L
Linus Torvalds 已提交
628 629 630 631
 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 * to preallocate bandwidth)
 */
#define USB2_HOST_DELAY	5	/* nsec, guess */
632
#define HS_NSECS(bytes) (((55 * 8 * 2083) \
633
	+ (2083UL * (3 + BitTime(bytes))))/1000 \
L
Linus Torvalds 已提交
634
	+ USB2_HOST_DELAY)
635
#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
636
	+ (2083UL * (3 + BitTime(bytes))))/1000 \
L
Linus Torvalds 已提交
637
	+ USB2_HOST_DELAY)
638 639
#define HS_USECS(bytes)		NS_TO_US(HS_NSECS(bytes))
#define HS_USECS_ISO(bytes)	NS_TO_US(HS_NSECS_ISO(bytes))
L
Linus Torvalds 已提交
640

641
extern long usb_calc_bus_time(int speed, int is_input,
L
Linus Torvalds 已提交
642 643 644 645 646 647 648 649 650 651 652
			int isoc, int bytecount);

/*-------------------------------------------------------------------------*/

extern void usb_set_device_state(struct usb_device *udev,
		enum usb_device_state new_state);

/*-------------------------------------------------------------------------*/

/* exported only within usbcore */

653
extern struct idr usb_bus_idr;
654
extern struct mutex usb_bus_idr_lock;
L
Linus Torvalds 已提交
655 656 657 658 659
extern wait_queue_head_t usb_kill_urb_queue;


#define usb_endpoint_out(ep_dir)	(!((ep_dir) & USB_DIR_IN))

660
#ifdef CONFIG_PM
661
extern void usb_root_hub_lost_power(struct usb_device *rhdev);
A
Alan Stern 已提交
662 663
extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
664
extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
665
#else
666 667 668 669
static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
{
	return;
}
670
#endif /* CONFIG_PM */
671

L
Linus Torvalds 已提交
672 673
/*-------------------------------------------------------------------------*/

674
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
675 676 677 678

struct usb_mon_operations {
	void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
	void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
679
	void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
L
Linus Torvalds 已提交
680 681 682
	/* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
};

683
extern const struct usb_mon_operations *mon_ops;
L
Linus Torvalds 已提交
684 685 686 687 688 689 690 691 692 693 694 695 696 697

static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
{
	if (bus->monitored)
		(*mon_ops->urb_submit)(bus, urb);
}

static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
    int error)
{
	if (bus->monitored)
		(*mon_ops->urb_submit_error)(bus, urb, error);
}

698 699
static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
		int status)
L
Linus Torvalds 已提交
700 701
{
	if (bus->monitored)
702
		(*mon_ops->urb_complete)(bus, urb, status);
L
Linus Torvalds 已提交
703 704
}

705
int usb_mon_register(const struct usb_mon_operations *ops);
L
Linus Torvalds 已提交
706 707 708 709 710 711 712
void usb_mon_deregister(void);

#else

static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
    int error) {}
713 714
static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
		int status) {}
L
Linus Torvalds 已提交
715

716
#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
L
Linus Torvalds 已提交
717 718 719 720 721

/*-------------------------------------------------------------------------*/

/* random stuff */

722 723
#define	RUN_CONTEXT (in_irq() ? "in_irq" \
		: (in_interrupt() ? "in_interrupt" : "can sleep"))
L
Linus Torvalds 已提交
724 725


726 727 728 729
/* This rwsem is for use only by the hub driver and ehci-hcd.
 * Nobody else should touch it.
 */
extern struct rw_semaphore ehci_cf_port_reset_rwsem;
L
Linus Torvalds 已提交
730

731 732 733 734 735 736
/* Keep track of which host controller drivers are loaded */
#define USB_UHCI_LOADED		0
#define USB_OHCI_LOADED		1
#define USB_EHCI_LOADED		2
extern unsigned long usb_hcds_loaded;

737
#endif /* __KERNEL__ */
738 739

#endif /* __USB_CORE_HCD_H */