xref: /freebsd/sys/dev/usb/usb_hub.h (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
1 /* $FreeBSD$ */
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 _USB2_HUB_H_
28 #define	_USB2_HUB_H_
29 
30 /*
31  * The following structure defines an USB port.
32  */
33 struct usb2_port {
34 	uint8_t	restartcnt;
35 #define	USB_RESTART_MAX 5
36 	uint8_t	device_index;		/* zero means not valid */
37 	uint8_t	usb2_mode:1;		/* current USB mode */
38 	uint8_t	unused:7;
39 };
40 
41 /*
42  * The following structure defines how many bytes are
43  * left in an 1ms USB time slot.
44  */
45 struct usb2_fs_isoc_schedule {
46 	uint16_t total_bytes;
47 	uint8_t	frame_bytes;
48 	uint8_t	frame_slot;
49 };
50 
51 /*
52  * The following structure defines an USB HUB.
53  */
54 struct usb2_hub {
55 	struct usb2_fs_isoc_schedule fs_isoc_schedule[USB_ISOC_TIME_MAX];
56 	struct usb2_device *hubudev;	/* the HUB device */
57 	usb2_error_t (*explore) (struct usb2_device *hub);
58 	void   *hubsoftc;
59 	uint32_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
60 	uint16_t portpower;		/* mA per USB port */
61 	uint8_t	isoc_last_time;
62 	uint8_t	nports;
63 	struct usb2_port ports[0];
64 };
65 
66 /* function prototypes */
67 
68 uint8_t	usb2_intr_schedule_adjust(struct usb2_device *udev, int16_t len,
69 	    uint8_t slot);
70 void	usb2_fs_isoc_schedule_init_all(struct usb2_fs_isoc_schedule *fss);
71 void	usb2_bus_port_set_device(struct usb2_bus *bus, struct usb2_port *up,
72 	    struct usb2_device *udev, uint8_t device_index);
73 struct usb2_device *usb2_bus_port_get_device(struct usb2_bus *bus,
74 	    struct usb2_port *up);
75 void	usb2_needs_explore(struct usb2_bus *bus, uint8_t do_probe);
76 void	usb2_needs_explore_all(void);
77 void	usb2_bus_power_update(struct usb2_bus *bus);
78 void	usb2_bus_powerd(struct usb2_bus *bus);
79 
80 #endif					/* _USB2_HUB_H_ */
81