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
5*d29f5a71Szhigang lu - Sun Microsystems - Beijing China  * Common Development and Distribution License (the "License").
6*d29f5a71Szhigang lu - Sun Microsystems - Beijing China  * 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*d29f5a71Szhigang lu - Sun Microsystems - Beijing China  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate #ifndef _SYS_USB_OHCI_HUB_H
277c478bd9Sstevel@tonic-gate #define	_SYS_USB_OHCI_HUB_H
307c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
317c478bd9Sstevel@tonic-gate extern "C" {
327c478bd9Sstevel@tonic-gate #endif
347c478bd9Sstevel@tonic-gate /*
357c478bd9Sstevel@tonic-gate  * Open Host Controller Driver (OHCI)
367c478bd9Sstevel@tonic-gate  *
377c478bd9Sstevel@tonic-gate  * The USB Open Host Controller driver is a software driver which interfaces
387c478bd9Sstevel@tonic-gate  * to the Universal Serial Bus layer (USBA) and the USB Open Host Controller.
397c478bd9Sstevel@tonic-gate  * The interface to USB Open Host Controller is defined by the OpenHCI  Host
407c478bd9Sstevel@tonic-gate  * Controller Interface.
417c478bd9Sstevel@tonic-gate  *
427c478bd9Sstevel@tonic-gate  * This header file describes the data structures required for the USB Open
437c478bd9Sstevel@tonic-gate  * Host Controller Driver to maintain state of USB Open Host Controller, to
447c478bd9Sstevel@tonic-gate  * perform different USB transfers and for the bandwidth allocations.
457c478bd9Sstevel@tonic-gate  */
477c478bd9Sstevel@tonic-gate /*
487c478bd9Sstevel@tonic-gate  * Root hub information structure
497c478bd9Sstevel@tonic-gate  *
507c478bd9Sstevel@tonic-gate  * The Root hub is a Universal Serial Bus hub attached directly to the
517c478bd9Sstevel@tonic-gate  * Host Controller (HC) and all the internal registers of the root hub
527c478bd9Sstevel@tonic-gate  * are exposed to the Host Controller Driver (HCD) which is responsible
537c478bd9Sstevel@tonic-gate  * for providing the proper hub-class protocol with the  USB driver and
547c478bd9Sstevel@tonic-gate  * proper control of the root hub. This structure contains information
557c478bd9Sstevel@tonic-gate  * about the root hub and its ports.
567c478bd9Sstevel@tonic-gate  */
577c478bd9Sstevel@tonic-gate typedef struct ohci_root_hub {
587c478bd9Sstevel@tonic-gate 	usb_hub_descr_t	rh_descr;	/* Copy of rh descriptor */
597c478bd9Sstevel@tonic-gate 	uint_t		rh_des_A;	/* Descriptor reg A value */
607c478bd9Sstevel@tonic-gate 	uint_t		rh_des_B;	/* Descriptor reg B value */
617c478bd9Sstevel@tonic-gate 	uint_t		rh_status;	/* Last root hub status */
637c478bd9Sstevel@tonic-gate 	/* Last state & status for each root hub port */
647c478bd9Sstevel@tonic-gate 	uint_t		rh_port_status[OHCI_MAX_RH_PORTS];
657c478bd9Sstevel@tonic-gate 	uint_t		rh_port_state[OHCI_MAX_RH_PORTS];
677c478bd9Sstevel@tonic-gate 	/* Root hub control pipe handle */
687c478bd9Sstevel@tonic-gate 	usba_pipe_handle_data_t *rh_ctrl_pipe_handle;
707c478bd9Sstevel@tonic-gate 	/* Current control request pointer */
717c478bd9Sstevel@tonic-gate 	usb_ctrl_req_t	*rh_curr_ctrl_reqp;
737c478bd9Sstevel@tonic-gate 	/* Root hub control pipe state */
747c478bd9Sstevel@tonic-gate 	uint_t		rh_ctrl_pipe_state;
767c478bd9Sstevel@tonic-gate 	/* Root hub interrupt pipe handle */
777c478bd9Sstevel@tonic-gate 	usba_pipe_handle_data_t *rh_intr_pipe_handle;
797c478bd9Sstevel@tonic-gate 	/* Current interrupt request pointer */
807c478bd9Sstevel@tonic-gate 	usb_intr_req_t	*rh_curr_intr_reqp;
827c478bd9Sstevel@tonic-gate 	/* Saved original interrupt request pointer */
837c478bd9Sstevel@tonic-gate 	usb_intr_req_t	*rh_client_intr_reqp;
857c478bd9Sstevel@tonic-gate 	/* Root hub interrupt pipe state and timer-id */
867c478bd9Sstevel@tonic-gate 	uint_t		rh_intr_pipe_state;
877c478bd9Sstevel@tonic-gate 	timeout_id_t	rh_intr_pipe_timer_id;
887c478bd9Sstevel@tonic-gate } ohci_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 downstream 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 OHCI specific operations.
1007c478bd9Sstevel@tonic-gate  * These timeout values are specified in terms of microseconds.
1017c478bd9Sstevel@tonic-gate  */
1027c478bd9Sstevel@tonic-gate #define	OHCI_RH_POLL_TIME	30000	/* Root hub polling interval */
1047c478bd9Sstevel@tonic-gate #ifdef __cplusplus
1057c478bd9Sstevel@tonic-gate }
1067c478bd9Sstevel@tonic-gate #endif
1087c478bd9Sstevel@tonic-gate #endif /* _SYS_USB_OHCI_HUB_H */