/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_SYS_USB_EHCI_POLLED_H
#define	_SYS_USB_EHCI_POLLED_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Enchanced Host Controller Driver (EHCI)
 *
 * The EHCI driver is a software driver which interfaces to the Universal
 * Serial Bus layer (USBA) and the Host Controller (HC). The interface to
 * the Host Controller is defined by the EHCI Host Controller Interface.
 *
 * This header file describes the data structures required for the EHCI
 * Driver to work in POLLED mode which will be  either OBP mode for Sparc
 * architecture or PC PROM mode for X86 architecture
 */

#define	POLLED_RAW_BUF_SIZE	8

/*
 * These two  flags are used to determine if this structure is already
 * in use.
 */
#define	POLLED_INPUT_MODE		0x01

/*
 * These two flags are used to determine if this structure is already in
 * use. We should only save off the controller state information once,
 * restore it once.  These flags are used for the ehci_polled_flags below.
 */
#define	POLLED_INPUT_MODE_INUSE		0x04
#define	MAX_NUM_FOR_KEYBOARD		0x8
/*
 * State structure for the POLLED switch off
 */
typedef struct ehci_polled {
	/*
	 * Pointer to the ehcip structure for the device that is to  be
	 * used as input in polled mode.
	 */
	ehci_state_t	*ehci_polled_ehcip;

	/*
	 * Pipe handle for the pipe that is to be used as input device
	 * in POLLED mode.
	 */
	usba_pipe_handle_data_t  *ehci_polled_input_pipe_handle;

	/* Dummy endpoint descriptor */
	ehci_qh_t	*ehci_polled_dummy_qh;

	/* Interrupt Endpoint descriptor */
	ehci_qh_t	*ehci_polled_qh;	/* Interrupt endpoint */

	/*
	 * The buffer that the usb scancodes are copied into.
	 */
	uchar_t		*ehci_polled_buf;

	/*
	 * This flag is used to determine if the state of the controller
	 * has already been saved (enter) or doesn't need to be restored
	 * yet (exit).
	 */
	uint_t		ehci_polled_flags;

	/*
	 * List of QTD inserted into polled mode periodic schedule list.
	 */
	ehci_qtd_t	*ehci_polled_active_intr_qtd_list;

	/*
	 * ehci_hcdi_polled_input_enter() may be called
	 * multiple times before the ehci_hcdi_polled_input_exit() is called.
	 * For example, the system may:
	 *	- go down to kmdb (ehci_hcdi_polled_input_enter())
	 *	- down to the ok prompt, $q (ehci_hcdi_polled_input_enter())
	 *	- back to kmdb, "go" (ehci_hcdi_polled_input_exit())
	 *	- back to the OS, :c at kmdb (ehci_hcdi_polled_input_exit())
	 *
	 * polled_entry keeps track of how  many times
	 * ehci_polled_input_enter/ehci_polled_input_exit have been
	 * called so that the host controller isn't switched back to OS mode
	 * prematurely.
	 */
	uint_t		ehci_polled_entry;

	/*
	 * Save the pointer usb device structure and the endpoint number
	 * during the polled initilization.
	 */
	usba_device_t	*ehci_polled_usb_dev;	/* USB device */

	uint8_t		ehci_polled_ep_addr;

	boolean_t	ehci_polled_no_sync_flag; /* For schizo bug */
} ehci_polled_t;

_NOTE(SCHEME_PROTECTS_DATA("Only accessed in POLLED mode",
	ehci_polled_t::ehci_polled_flags))
_NOTE(DATA_READABLE_WITHOUT_LOCK(ehci_polled_t::ehci_polled_ehcip))
_NOTE(SCHEME_PROTECTS_DATA("Only accessed in POLLED mode",
	ehci_polled_t::ehci_polled_entry))

/*
 * Time waits for the different EHCI specific polled operations.
 * These timeout values are specified in terms of microseconds.
 */
#define	EHCI_POLLED_TIMEWAIT	2000	/* General polled time wait */


#ifdef __cplusplus
}
#endif

#endif	/* _SYS_USB_EHCI_POLLED_H */