17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
57cf28e56Sgc  * Common Development and Distribution License (the "License").
67cf28e56Sgc  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22*3d89ea2cSpengcheng chen - Sun Microsystems - Beijing China  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate #ifndef _SYS_USB_EHCI_HUB_H
277c478bd9Sstevel@tonic-gate #define	_SYS_USB_EHCI_HUB_H
307c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
317c478bd9Sstevel@tonic-gate extern "C" {
327c478bd9Sstevel@tonic-gate #endif
347c478bd9Sstevel@tonic-gate /*
357c478bd9Sstevel@tonic-gate  * Enchanced Host Controller Driver (EHCI)
367c478bd9Sstevel@tonic-gate  *
377c478bd9Sstevel@tonic-gate  * The EHCI driver is a software driver which interfaces to the Universal
387c478bd9Sstevel@tonic-gate  * Serial Bus layer (USBA) and the Host Controller (HC). The interface to
397c478bd9Sstevel@tonic-gate  * the Host Controller is defined by the EHCI Host Controller Interface.
407c478bd9Sstevel@tonic-gate  *
417c478bd9Sstevel@tonic-gate  * This header file describes the data structures required by the EHCI
427c478bd9Sstevel@tonic-gate  * Driver for the root hub operations.
437c478bd9Sstevel@tonic-gate  */
457c478bd9Sstevel@tonic-gate /*
467c478bd9Sstevel@tonic-gate  * Root hub information structure
477c478bd9Sstevel@tonic-gate  *
487c478bd9Sstevel@tonic-gate  * The Root hub is a Universal Serial Bus hub attached directly to the
497c478bd9Sstevel@tonic-gate  * Host Controller (HC) and all the internal registers of the root hub
507c478bd9Sstevel@tonic-gate  * are exposed to the Host Controller Driver (HCD) which is responsible
517c478bd9Sstevel@tonic-gate  * for providing the proper hub-class protocol with the  USB driver and
527c478bd9Sstevel@tonic-gate  * proper control of the root hub. This structure contains information
537c478bd9Sstevel@tonic-gate  * about the root hub and its ports.
547c478bd9Sstevel@tonic-gate  */
557c478bd9Sstevel@tonic-gate typedef struct ehci_root_hub {
567c478bd9Sstevel@tonic-gate 	/* Copy of the Root Hub descriptor */
577c478bd9Sstevel@tonic-gate 	usb_hub_descr_t		rh_descr;
597c478bd9Sstevel@tonic-gate 	/* Number of Companion Controllers */
607c478bd9Sstevel@tonic-gate 	uint_t			rh_companion_controllers;
627c478bd9Sstevel@tonic-gate 	/* Last state & status for each root hub port */
637c478bd9Sstevel@tonic-gate 	uint_t			rh_port_status[EHCI_MAX_RH_PORTS];
647c478bd9Sstevel@tonic-gate 	uint_t			rh_port_state[EHCI_MAX_RH_PORTS];
667c478bd9Sstevel@tonic-gate 	/* Root hub control pipe handle */
677c478bd9Sstevel@tonic-gate 	usba_pipe_handle_data_t	*rh_ctrl_pipe_handle;
697c478bd9Sstevel@tonic-gate 	/* Current control request pointer */
707c478bd9Sstevel@tonic-gate 	usb_ctrl_req_t		*rh_curr_ctrl_reqp;
727c478bd9Sstevel@tonic-gate 	/* Root hub control pipe state */
737c478bd9Sstevel@tonic-gate 	uint_t			rh_ctrl_pipe_state;
757c478bd9Sstevel@tonic-gate 	/* Root hub interrupt pipe handle */
767c478bd9Sstevel@tonic-gate 	usba_pipe_handle_data_t	*rh_intr_pipe_handle;
787c478bd9Sstevel@tonic-gate 	/* Current interrupt request pointer */
797c478bd9Sstevel@tonic-gate 	usb_intr_req_t		*rh_curr_intr_reqp;
817c478bd9Sstevel@tonic-gate 	/* Saved original interrupt request pointer */
827c478bd9Sstevel@tonic-gate 	usb_intr_req_t		*rh_client_intr_reqp;
847c478bd9Sstevel@tonic-gate 	/* Root hub interrupt pipe state and timer-id */
857c478bd9Sstevel@tonic-gate 	uint_t			rh_intr_pipe_state;
867c478bd9Sstevel@tonic-gate 	usb_port_mask_t		rh_intr_pending_status;
877c478bd9Sstevel@tonic-gate 	timeout_id_t		rh_intr_pipe_timer_id;
887c478bd9Sstevel@tonic-gate } ehci_root_hub_t;
907c478bd9Sstevel@tonic-gate /* Port States */
917c478bd9Sstevel@tonic-gate #define	UNINIT		0x00	/* Uninitialized port */
927c478bd9Sstevel@tonic-gate #define	POWERED_OFF	0x01	/* Port has no power */
937c478bd9Sstevel@tonic-gate #define	DISCONNECTED	0x02	/* Port has power, no dev */
947c478bd9Sstevel@tonic-gate #define	DISABLED	0x03	/* Dev connected, no data */
957c478bd9Sstevel@tonic-gate #define	ENABLED		0x04	/* Downstream data is enabled */
967c478bd9Sstevel@tonic-gate #define	SUSPEND		0x05	/* Suspended port */
987c478bd9Sstevel@tonic-gate /*
997c478bd9Sstevel@tonic-gate  * Time waits for the different EHCI Root Hub specific operations.
1007c478bd9Sstevel@tonic-gate  * These timeout values are specified in terms of microseconds.
1017c478bd9Sstevel@tonic-gate  */
1024f71203dSzl #define	EHCI_RH_POLL_TIME		256000	/* RH polling interval */
103*3d89ea2cSpengcheng chen - Sun Microsystems - Beijing China #define	EHCI_PORT_RESET_TIMEWAIT	50000	/* RH port reset time */
1047c478bd9Sstevel@tonic-gate #define	EHCI_PORT_RESET_COMP_TIMEWAIT	2000	/* RH port reset complete */
1057c478bd9Sstevel@tonic-gate #define	EHCI_PORT_SUSPEND_TIMEWAIT	10000	/* RH port suspend time */
1067c478bd9Sstevel@tonic-gate #define	EHCI_PORT_RESUME_TIMEWAIT	20000	/* RH port resume time */
1077c478bd9Sstevel@tonic-gate #define	EHCI_PORT_RESUME_COMP_TIMEWAIT	2000	/* RH port resume complete */
108*3d89ea2cSpengcheng chen - Sun Microsystems - Beijing China #define	EHCI_PORT_RESET_RETRY_MAX	10	/* RH port reset retry max */
109*3d89ea2cSpengcheng chen - Sun Microsystems - Beijing China #define	EHCI_PORT_RESUME_RETRY_MAX	10	/* RH port resume retry max */
1117c478bd9Sstevel@tonic-gate #ifdef __cplusplus
1127c478bd9Sstevel@tonic-gate }
1137c478bd9Sstevel@tonic-gate #endif
1157c478bd9Sstevel@tonic-gate #endif /* _SYS_USB_EHCI_HUB_H */