xref: /freebsd/sys/dev/usb/usb_hub.h (revision 830940567b49bb0c08dfaed40418999e76616909)
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 _USB_HUB_H_
28 #define	_USB_HUB_H_
29 
30 /*
31  * The following structure defines an USB port.
32  */
33 struct 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 };
39 
40 /*
41  * The following structure defines how many bytes are
42  * left in an 1ms USB time slot.
43  */
44 struct usb_fs_isoc_schedule {
45 	uint16_t total_bytes;
46 	uint8_t	frame_bytes;
47 	uint8_t	frame_slot;
48 };
49 
50 /*
51  * The following structure defines an USB HUB.
52  */
53 struct usb_hub {
54 #if USB_HAVE_TT_SUPPORT
55 	struct usb_fs_isoc_schedule fs_isoc_schedule[USB_ISOC_TIME_MAX];
56 #endif
57 	struct usb_device *hubudev;	/* the HUB device */
58 	usb_error_t (*explore) (struct usb_device *hub);
59 	void   *hubsoftc;
60 	usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
61 	uint16_t portpower;		/* mA per USB port */
62 	uint8_t	isoc_last_time;
63 	uint8_t	nports;
64 	struct usb_port ports[0];
65 };
66 
67 /* function prototypes */
68 
69 uint8_t	usb_intr_schedule_adjust(struct usb_device *udev, int16_t len,
70 	    uint8_t slot);
71 void	usbd_fs_isoc_schedule_init_all(struct usb_fs_isoc_schedule *fss);
72 void	usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
73 	    struct usb_device *udev, uint8_t device_index);
74 struct usb_device *usb_bus_port_get_device(struct usb_bus *bus,
75 	    struct usb_port *up);
76 void	usb_needs_explore(struct usb_bus *bus, uint8_t do_probe);
77 void	usb_needs_explore_all(void);
78 void	usb_bus_power_update(struct usb_bus *bus);
79 void	usb_bus_powerd(struct usb_bus *bus);
80 void	uhub_root_intr(struct usb_bus *, const uint8_t *, uint8_t);
81 
82 #endif					/* _USB_HUB_H_ */
83