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 (c) 1999 by Sun Microsystems, Inc. 24*0Sstevel@tonic-gate * All rights reserved. 25*0Sstevel@tonic-gate */ 26*0Sstevel@tonic-gate 27*0Sstevel@tonic-gate #ifndef _SYS_USB_CONSOLE_INPUT_H 28*0Sstevel@tonic-gate #define _SYS_USB_CONSOLE_INPUT_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 /* 37*0Sstevel@tonic-gate * Opaque handle which is used above the usba level. 38*0Sstevel@tonic-gate */ 39*0Sstevel@tonic-gate typedef struct usb_console_info *usb_console_info_t; 40*0Sstevel@tonic-gate 41*0Sstevel@tonic-gate /* 42*0Sstevel@tonic-gate * Opaque handle which is used above the ohci level. 43*0Sstevel@tonic-gate */ 44*0Sstevel@tonic-gate typedef struct usb_console_info_private *usb_console_info_private_t; 45*0Sstevel@tonic-gate 46*0Sstevel@tonic-gate /* 47*0Sstevel@tonic-gate * This is the structure definition for the console input handle. 48*0Sstevel@tonic-gate * This structure is passed down from hid and is used keep track 49*0Sstevel@tonic-gate * of state information for the USB OBP support. 50*0Sstevel@tonic-gate */ 51*0Sstevel@tonic-gate typedef struct usb_console_info_impl { 52*0Sstevel@tonic-gate /* 53*0Sstevel@tonic-gate * The dip for the device that is going to be used as input. 54*0Sstevel@tonic-gate */ 55*0Sstevel@tonic-gate dev_info_t *uci_dip; 56*0Sstevel@tonic-gate 57*0Sstevel@tonic-gate /* 58*0Sstevel@tonic-gate * Private data that ohci uses for state information. 59*0Sstevel@tonic-gate */ 60*0Sstevel@tonic-gate usb_console_info_private_t uci_private; 61*0Sstevel@tonic-gate } usb_console_info_impl_t; 62*0Sstevel@tonic-gate 63*0Sstevel@tonic-gate _NOTE(SCHEME_PROTECTS_DATA("Data only written during attach", 64*0Sstevel@tonic-gate usb_console_info_impl_t::uci_private)) 65*0Sstevel@tonic-gate _NOTE(SCHEME_PROTECTS_DATA("Data only written during attach", 66*0Sstevel@tonic-gate usb_console_info_impl_t::uci_dip)) 67*0Sstevel@tonic-gate 68*0Sstevel@tonic-gate /* 69*0Sstevel@tonic-gate * The initialization routine for handling the USB keyboard in OBP mode. 70*0Sstevel@tonic-gate * This routine saves off state information and calls down to the lower 71*0Sstevel@tonic-gate * layers to initialize any state information. 72*0Sstevel@tonic-gate */ 73*0Sstevel@tonic-gate int usb_console_input_init( 74*0Sstevel@tonic-gate dev_info_t *dip, 75*0Sstevel@tonic-gate usb_pipe_handle_t pipe_handle, 76*0Sstevel@tonic-gate uchar_t **obp_buf, 77*0Sstevel@tonic-gate usb_console_info_t *console_info_handle 78*0Sstevel@tonic-gate ); 79*0Sstevel@tonic-gate 80*0Sstevel@tonic-gate /* 81*0Sstevel@tonic-gate * Free up any resources that we allocated in the above initialization 82*0Sstevel@tonic-gate * routine. 83*0Sstevel@tonic-gate */ 84*0Sstevel@tonic-gate int usb_console_input_fini( 85*0Sstevel@tonic-gate usb_console_info_t console_input_info 86*0Sstevel@tonic-gate ); 87*0Sstevel@tonic-gate 88*0Sstevel@tonic-gate /* 89*0Sstevel@tonic-gate * This is the routine that OBP calls to save the USB state information 90*0Sstevel@tonic-gate * before using the USB keyboard as an input device. This routine, 91*0Sstevel@tonic-gate * and all of the routines that it calls, are responsible for saving 92*0Sstevel@tonic-gate * any state information so that it can be restored when OBP mode is 93*0Sstevel@tonic-gate * over. 94*0Sstevel@tonic-gate */ 95*0Sstevel@tonic-gate int usb_console_input_enter( 96*0Sstevel@tonic-gate usb_console_info_t console_info_handle 97*0Sstevel@tonic-gate ); 98*0Sstevel@tonic-gate 99*0Sstevel@tonic-gate /* 100*0Sstevel@tonic-gate * This is the routine that OBP calls when it wants to read a character. 101*0Sstevel@tonic-gate * We will call to the lower layers to see if there is any input data 102*0Sstevel@tonic-gate * available. 103*0Sstevel@tonic-gate */ 104*0Sstevel@tonic-gate int usb_console_read( 105*0Sstevel@tonic-gate usb_console_info_t console_info_handle, 106*0Sstevel@tonic-gate uint_t *num_characters 107*0Sstevel@tonic-gate ); 108*0Sstevel@tonic-gate 109*0Sstevel@tonic-gate /* 110*0Sstevel@tonic-gate * This is the routine that OBP calls when it is giving up control of the 111*0Sstevel@tonic-gate * USB keyboard. This routine, and the lower layer routines that it calls, 112*0Sstevel@tonic-gate * are responsible for restoring the controller state to the state it was 113*0Sstevel@tonic-gate * in before OBP took control. 114*0Sstevel@tonic-gate */ 115*0Sstevel@tonic-gate int usb_console_input_exit( 116*0Sstevel@tonic-gate usb_console_info_t console_info_handle 117*0Sstevel@tonic-gate ); 118*0Sstevel@tonic-gate 119*0Sstevel@tonic-gate #ifdef __cplusplus 120*0Sstevel@tonic-gate } 121*0Sstevel@tonic-gate #endif 122*0Sstevel@tonic-gate 123*0Sstevel@tonic-gate #endif /* _SYS_USB_CONSOLE_INPUT_H */ 124