usb_hub.h revision 184610
1184610Salfred/* $FreeBSD: head/sys/dev/usb2/core/usb2_hub.h 184610 2008-11-04 02:31:03Z alfred $ */ 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 27184610Salfred#ifndef _USB2_HUB_H_ 28184610Salfred#define _USB2_HUB_H_ 29184610Salfred 30184610Salfred/* 31184610Salfred * The following structure defines an USB port. 32184610Salfred */ 33184610Salfredstruct usb2_port { 34184610Salfred uint8_t restartcnt; 35184610Salfred#define USB_RESTART_MAX 5 36184610Salfred uint8_t device_index; /* zero means not valid */ 37184610Salfred uint8_t usb2_mode:1; /* current USB mode */ 38184610Salfred uint8_t unused:7; 39184610Salfred}; 40184610Salfred 41184610Salfred/* 42184610Salfred * The following structure defines how many bytes are 43184610Salfred * left in an 1ms USB time slot. 44184610Salfred */ 45184610Salfredstruct usb2_fs_isoc_schedule { 46184610Salfred uint16_t total_bytes; 47184610Salfred uint8_t frame_bytes; 48184610Salfred uint8_t frame_slot; 49184610Salfred}; 50184610Salfred 51184610Salfred/* 52184610Salfred * The following structure defines an USB HUB. 53184610Salfred */ 54184610Salfredstruct usb2_hub { 55184610Salfred struct usb2_fs_isoc_schedule fs_isoc_schedule[USB_ISOC_TIME_MAX]; 56184610Salfred struct usb2_device *hubudev; /* the HUB device */ 57184610Salfred usb2_error_t (*explore) (struct usb2_device *hub); 58184610Salfred void *hubsoftc; 59184610Salfred uint32_t uframe_usage[USB_HS_MICRO_FRAMES_MAX]; 60184610Salfred uint16_t portpower; /* mA per USB port */ 61184610Salfred uint8_t isoc_last_time; 62184610Salfred uint8_t nports; 63184610Salfred struct usb2_port ports[0]; 64184610Salfred}; 65184610Salfred 66184610Salfred/* function prototypes */ 67184610Salfred 68184610Salfreduint8_t usb2_intr_schedule_adjust(struct usb2_device *udev, int16_t len, uint8_t slot); 69184610Salfredvoid usb2_fs_isoc_schedule_init_all(struct usb2_fs_isoc_schedule *fss); 70184610Salfredvoid usb2_bus_port_set_device(struct usb2_bus *bus, struct usb2_port *up, struct usb2_device *udev, uint8_t device_index); 71184610Salfredstruct usb2_device *usb2_bus_port_get_device(struct usb2_bus *bus, struct usb2_port *up); 72184610Salfredvoid usb2_needs_explore(struct usb2_bus *bus, uint8_t do_probe); 73184610Salfredvoid usb2_needs_explore_all(void); 74184610Salfred 75184610Salfred#endif /* _USB2_HUB_H_ */ 76