1184610Salfred/* $FreeBSD$ */
2184610Salfred/*-
3184610Salfred * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4184610Salfred *
5184610Salfred * Redistribution and use in source and binary forms, with or without
6184610Salfred * modification, are permitted provided that the following conditions
7184610Salfred * are met:
8184610Salfred * 1. Redistributions of source code must retain the above copyright
9184610Salfred *    notice, this list of conditions and the following disclaimer.
10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright
11184610Salfred *    notice, this list of conditions and the following disclaimer in the
12184610Salfred *    documentation and/or other materials provided with the distribution.
13184610Salfred *
14184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17184610Salfred * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24184610Salfred * SUCH DAMAGE.
25184610Salfred */
26184610Salfred
27194230Sthompsa#ifndef _USB_HUB_H_
28194230Sthompsa#define	_USB_HUB_H_
29184610Salfred
30184610Salfred/*
31190754Sthompsa * The following structure defines an USB port.
32184610Salfred */
33192984Sthompsastruct usb_port {
34184610Salfred	uint8_t	restartcnt;
35184610Salfred#define	USB_RESTART_MAX 5
36184610Salfred	uint8_t	device_index;		/* zero means not valid */
37192499Sthompsa	enum usb_hc_mode usb_mode;	/* host or device mode */
38261106Shselasky#if USB_HAVE_TT_SUPPORT
39261106Shselasky	struct usb_device_request req_reset_tt __aligned(4);
40261106Shselasky#endif
41184610Salfred};
42184610Salfred
43184610Salfred/*
44184610Salfred * The following structure defines an USB HUB.
45184610Salfred */
46192984Sthompsastruct usb_hub {
47192984Sthompsa	struct usb_device *hubudev;	/* the HUB device */
48193045Sthompsa	usb_error_t (*explore) (struct usb_device *hub);
49184610Salfred	void   *hubsoftc;
50261106Shselasky#if USB_HAVE_TT_SUPPORT
51261106Shselasky	struct usb_udev_msg tt_msg[2];
52261106Shselasky#endif
53193074Sthompsa	usb_size_t uframe_usage[USB_HS_MICRO_FRAMES_MAX];
54184610Salfred	uint16_t portpower;		/* mA per USB port */
55184610Salfred	uint8_t	isoc_last_time;
56184610Salfred	uint8_t	nports;
57192984Sthompsa	struct usb_port ports[0];
58184610Salfred};
59184610Salfred
60184610Salfred/* function prototypes */
61184610Salfred
62199672Sthompsavoid	usb_hs_bandwidth_alloc(struct usb_xfer *xfer);
63199672Sthompsavoid	usb_hs_bandwidth_free(struct usb_xfer *xfer);
64194228Sthompsavoid	usb_bus_port_set_device(struct usb_bus *bus, struct usb_port *up,
65192984Sthompsa	    struct usb_device *udev, uint8_t device_index);
66194228Sthompsastruct usb_device *usb_bus_port_get_device(struct usb_bus *bus,
67192984Sthompsa	    struct usb_port *up);
68194228Sthompsavoid	usb_needs_explore(struct usb_bus *bus, uint8_t do_probe);
69194228Sthompsavoid	usb_needs_explore_all(void);
70194228Sthompsavoid	usb_bus_power_update(struct usb_bus *bus);
71194228Sthompsavoid	usb_bus_powerd(struct usb_bus *bus);
72192984Sthompsavoid	uhub_root_intr(struct usb_bus *, const uint8_t *, uint8_t);
73213435Shselaskyusb_error_t uhub_query_info(struct usb_device *, uint8_t *, uint8_t *);
74267350Shselaskyvoid	uhub_explore_handle_re_enumerate(struct usb_device *);
75184610Salfred
76194230Sthompsa#endif					/* _USB_HUB_H_ */
77