usb_hub.h revision 331722 
1/* $FreeBSD: stable/11/sys/dev/usb/usb_hub.h 331722 2018-03-29 02:50:57Z eadler $ */
2/*-
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef _USB_HUB_H_
28#define	_USB_HUB_H_
29
30/*
31 * The following structure defines an USB port.
32 */
33struct usb_port {
34	uint8_t	restartcnt;
35#define	USB_RESTART_MAX 5
36	uint8_t	device_index;		/* zero means not valid */
37	enum usb_hc_mode usb_mode;	/* host or device mode */
38#if USB_HAVE_TT_SUPPORT
39	struct usb_device_request req_reset_tt __aligned(4);
40#endif
41};
42
43/*
44 * The following structure defines an USB HUB.
45 */
46struct usb_hub {
47	struct usb_device *hubudev;	/* the HUB device */
48	usb_error_t (*explore) (struct usb_device *hub);
49	void   *hubsoftc;
50#if USB_HAVE_TT_SUPPORT
51	struct usb_udev_msg tt_msg[2];
52#endif
53	usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
54	uint16_t portpower;		/* mA per USB port */
55	uint8_t	isoc_last_time;
56	uint8_t	nports;
57#if (USB_HAVE_FIXED_PORT == 0)
58	struct usb_port ports[0];
59#else
60	struct usb_port ports[USB_MAX_PORTS];
61#endif
62};
63
64/* function prototypes */
65
66void	usb_hs_bandwidth_alloc(struct usb_xfer *xfer);
67void	usb_hs_bandwidth_free(struct usb_xfer *xfer);
68void	usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
69	    struct usb_device *udev, uint8_t device_index);
70struct usb_device *usb_bus_port_get_device(struct usb_bus *bus,
71	    struct usb_port *up);
72void	usb_needs_explore(struct usb_bus *bus, uint8_t do_probe);
73void	usb_needs_explore_all(void);
74void	usb_bus_power_update(struct usb_bus *bus);
75void	usb_bus_powerd(struct usb_bus *bus);
76void	uhub_root_intr(struct usb_bus *, const uint8_t *, uint8_t);
77usb_error_t uhub_query_info(struct usb_device *, uint8_t *, uint8_t *);
78void	uhub_explore_handle_re_enumerate(struct usb_device *);
79
80#endif					/* _USB_HUB_H_ */
81