1*0Sstevel@tonic-gate /* 2*0Sstevel@tonic-gate * CDDL HEADER START 3*0Sstevel@tonic-gate * 4*0Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*0Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*0Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*0Sstevel@tonic-gate * with the License. 8*0Sstevel@tonic-gate * 9*0Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*0Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*0Sstevel@tonic-gate * See the License for the specific language governing permissions 12*0Sstevel@tonic-gate * and limitations under the License. 13*0Sstevel@tonic-gate * 14*0Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*0Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*0Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*0Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*0Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*0Sstevel@tonic-gate * 20*0Sstevel@tonic-gate * CDDL HEADER END 21*0Sstevel@tonic-gate */ 22*0Sstevel@tonic-gate /* 23*0Sstevel@tonic-gate * Copyright 2004 Sun Microsystems, Inc. All rights reserved. 24*0Sstevel@tonic-gate * Use is subject to license terms. 25*0Sstevel@tonic-gate */ 26*0Sstevel@tonic-gate 27*0Sstevel@tonic-gate #ifndef _SYS_USB_HUB_H 28*0Sstevel@tonic-gate #define _SYS_USB_HUB_H 29*0Sstevel@tonic-gate 30*0Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 31*0Sstevel@tonic-gate 32*0Sstevel@tonic-gate #ifdef __cplusplus 33*0Sstevel@tonic-gate extern "C" { 34*0Sstevel@tonic-gate #endif 35*0Sstevel@tonic-gate 36*0Sstevel@tonic-gate #define USB_DESCR_TYPE_SETUP_HUB 0x2900 37*0Sstevel@tonic-gate 38*0Sstevel@tonic-gate /* 39*0Sstevel@tonic-gate * Section 11.11.2.1 allows up to 255 ports. 40*0Sstevel@tonic-gate * For simplicity, only a maximum of 31 ports is currently allowed 41*0Sstevel@tonic-gate */ 42*0Sstevel@tonic-gate #define MAX_PORTS 31 43*0Sstevel@tonic-gate 44*0Sstevel@tonic-gate typedef struct usb_hub_descr { 45*0Sstevel@tonic-gate uchar_t bDescLength; /* size of descriptor */ 46*0Sstevel@tonic-gate uchar_t bDescriptorType; /* descriptor type */ 47*0Sstevel@tonic-gate uchar_t bNbrPorts; /* number of ports */ 48*0Sstevel@tonic-gate uint16_t wHubCharacteristics; /* hub characteristics */ 49*0Sstevel@tonic-gate uchar_t bPwrOn2PwrGood; /* time in ms from the time */ 50*0Sstevel@tonic-gate /* power on sequence begins on a port */ 51*0Sstevel@tonic-gate /* until power is good on that port */ 52*0Sstevel@tonic-gate uchar_t bHubContrCurrent; /* max current requirements */ 53*0Sstevel@tonic-gate uchar_t DeviceRemovable; 54*0Sstevel@tonic-gate /* removable device attached */ 55*0Sstevel@tonic-gate uchar_t PortPwrCtrlMask; 56*0Sstevel@tonic-gate /* power control mask */ 57*0Sstevel@tonic-gate } usb_hub_descr_t; 58*0Sstevel@tonic-gate 59*0Sstevel@tonic-gate #define ROOT_HUB_DESCRIPTOR_LENGTH 9 60*0Sstevel@tonic-gate #define ROOT_HUB_DESCRIPTOR_TYPE 0x29 61*0Sstevel@tonic-gate #define ROOT_HUB_ADDR 0x01 /* address of root hub */ 62*0Sstevel@tonic-gate 63*0Sstevel@tonic-gate /* Values for wHubCharacteristics */ 64*0Sstevel@tonic-gate #define HUB_CHARS_POWER_SWITCHING_MODE 0x03 65*0Sstevel@tonic-gate #define HUB_CHARS_GANGED_POWER 0x00 66*0Sstevel@tonic-gate #define HUB_CHARS_INDIVIDUAL_PORT_POWER 0x01 67*0Sstevel@tonic-gate #define HUB_CHARS_NO_POWER_SWITCHING 0x02 68*0Sstevel@tonic-gate #define HUB_CHARS_COMPOUND_DEV 0x04 69*0Sstevel@tonic-gate #define HUB_CHARS_GLOBAL_OVER_CURRENT 0x00 70*0Sstevel@tonic-gate #define HUB_CHARS_INDIV_OVER_CURRENT 0x08 71*0Sstevel@tonic-gate #define HUB_CHARS_NO_OVER_CURRENT 0x10 72*0Sstevel@tonic-gate #define HUB_CHARS_TT_THINK_TIME 0x60 73*0Sstevel@tonic-gate #define HUB_CHARS_TT_16FS_TIME 0x20 74*0Sstevel@tonic-gate #define HUB_CHARS_TT_24FS_TIME 0x40 75*0Sstevel@tonic-gate #define HUB_CHARS_TT_32FS_TIME 0x60 76*0Sstevel@tonic-gate #define HUB_CHARS_PORT_INDICATOR 0x80 77*0Sstevel@tonic-gate 78*0Sstevel@tonic-gate /* Default Power On to Power Good time */ 79*0Sstevel@tonic-gate #define HUB_DEFAULT_POPG 10 80*0Sstevel@tonic-gate 81*0Sstevel@tonic-gate /* Hub Status */ 82*0Sstevel@tonic-gate #define HUB_CHANGE_STATUS 0x01 83*0Sstevel@tonic-gate 84*0Sstevel@tonic-gate /* Class Specific bmRequestType values Table 11-10 */ 85*0Sstevel@tonic-gate #define HANDLE_PORT_FEATURE (USB_DEV_REQ_HOST_TO_DEV \ 86*0Sstevel@tonic-gate |USB_DEV_REQ_TYPE_CLASS \ 87*0Sstevel@tonic-gate |USB_DEV_REQ_RCPT_OTHER) 88*0Sstevel@tonic-gate 89*0Sstevel@tonic-gate #define GET_PORT_STATUS (USB_DEV_REQ_DEV_TO_HOST \ 90*0Sstevel@tonic-gate |USB_DEV_REQ_TYPE_CLASS \ 91*0Sstevel@tonic-gate |USB_DEV_REQ_RCPT_OTHER) 92*0Sstevel@tonic-gate 93*0Sstevel@tonic-gate #define HUB_CLASS_REQ (USB_DEV_REQ_DEV_TO_HOST \ 94*0Sstevel@tonic-gate |USB_DEV_REQ_TYPE_CLASS) 95*0Sstevel@tonic-gate 96*0Sstevel@tonic-gate /* Port Status Field Bits - Table 11-15 */ 97*0Sstevel@tonic-gate #define PORT_STATUS_CCS 0x0001 /* port connection status */ 98*0Sstevel@tonic-gate #define PORT_STATUS_PES 0x0002 /* port enable status */ 99*0Sstevel@tonic-gate #define PORT_STATUS_PSS 0x0004 /* port suspend status */ 100*0Sstevel@tonic-gate #define PORT_STATUS_POCI 0x0008 /* port over current indicator */ 101*0Sstevel@tonic-gate #define PORT_STATUS_PRS 0x0010 /* port reset status */ 102*0Sstevel@tonic-gate #define PORT_STATUS_PPS 0x0100 /* port power status */ 103*0Sstevel@tonic-gate #define PORT_STATUS_LSDA 0x0200 /* low speed device */ 104*0Sstevel@tonic-gate #define PORT_STATUS_HSDA 0x0400 /* high speed device */ 105*0Sstevel@tonic-gate #define PORT_STATUS_PIC 0x1000 /* port indicator control */ 106*0Sstevel@tonic-gate 107*0Sstevel@tonic-gate #define PORT_STATUS_MASK 0x171f 108*0Sstevel@tonic-gate #define PORT_STATUS_OK 0x103 /* connected, enabled, power */ 109*0Sstevel@tonic-gate 110*0Sstevel@tonic-gate /* Port Change Field Bits - Table 11-16 */ 111*0Sstevel@tonic-gate #define PORT_CHANGE_CSC 0x0001 /* connect status change */ 112*0Sstevel@tonic-gate #define PORT_CHANGE_PESC 0x0002 /* port enable change */ 113*0Sstevel@tonic-gate #define PORT_CHANGE_PSSC 0x0004 /* port suspend change */ 114*0Sstevel@tonic-gate #define PORT_CHANGE_OCIC 0x0008 /* over current change */ 115*0Sstevel@tonic-gate #define PORT_CHANGE_PRSC 0x0010 /* port reset change */ 116*0Sstevel@tonic-gate 117*0Sstevel@tonic-gate #define PORT_CHANGE_MASK 0x001f 118*0Sstevel@tonic-gate 119*0Sstevel@tonic-gate /* Hub status Field Bits - Table 11-14 */ 120*0Sstevel@tonic-gate #define HUB_LOCAL_POWER_STATUS 0x0001 /* state of the power supply */ 121*0Sstevel@tonic-gate #define HUB_OVER_CURRENT 0x0002 /* global hub OC condition */ 122*0Sstevel@tonic-gate 123*0Sstevel@tonic-gate /* Hub change clear feature selectors - Table 11-15 */ 124*0Sstevel@tonic-gate #define C_HUB_LOCAL_POWER_STATUS 0x0001 /* state of the power supply */ 125*0Sstevel@tonic-gate #define C_HUB_OVER_CURRENT 0x0002 /* global hub OC condition */ 126*0Sstevel@tonic-gate 127*0Sstevel@tonic-gate /* hub class feature selectors - Table 11-12 */ 128*0Sstevel@tonic-gate #define CFS_C_HUB_LOCAL_POWER 0 129*0Sstevel@tonic-gate #define CFS_C_HUB_OVER_CURRENT 1 130*0Sstevel@tonic-gate #define CFS_PORT_CONNECTION 0 131*0Sstevel@tonic-gate #define CFS_PORT_ENABLE 1 132*0Sstevel@tonic-gate #define CFS_PORT_SUSPEND 2 133*0Sstevel@tonic-gate #define CFS_PORT_OVER_CURRENT 3 134*0Sstevel@tonic-gate #define CFS_PORT_RESET 4 135*0Sstevel@tonic-gate #define CFS_PORT_POWER 8 136*0Sstevel@tonic-gate #define CFS_PORT_LOW_SPEED 9 137*0Sstevel@tonic-gate #define CFS_C_PORT_CONNECTION 16 138*0Sstevel@tonic-gate #define CFS_C_PORT_ENABLE 17 139*0Sstevel@tonic-gate #define CFS_C_PORT_SUSPEND 18 140*0Sstevel@tonic-gate #define CFS_C_PORT_OVER_CURRENT 19 141*0Sstevel@tonic-gate #define CFS_C_PORT_RESET 20 142*0Sstevel@tonic-gate 143*0Sstevel@tonic-gate #ifdef __cplusplus 144*0Sstevel@tonic-gate } 145*0Sstevel@tonic-gate #endif 146*0Sstevel@tonic-gate 147*0Sstevel@tonic-gate #endif /* _SYS_USB_HUB_H */ 148