1*7c478bd9Sstevel@tonic-gate /* 2*7c478bd9Sstevel@tonic-gate * CDDL HEADER START 3*7c478bd9Sstevel@tonic-gate * 4*7c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*7c478bd9Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*7c478bd9Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*7c478bd9Sstevel@tonic-gate * with the License. 8*7c478bd9Sstevel@tonic-gate * 9*7c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*7c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*7c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 12*7c478bd9Sstevel@tonic-gate * and limitations under the License. 13*7c478bd9Sstevel@tonic-gate * 14*7c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*7c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*7c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*7c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*7c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*7c478bd9Sstevel@tonic-gate * 20*7c478bd9Sstevel@tonic-gate * CDDL HEADER END 21*7c478bd9Sstevel@tonic-gate */ 22*7c478bd9Sstevel@tonic-gate /* 23*7c478bd9Sstevel@tonic-gate * Copyright (c) 1998-1999 by Sun Microsystems, Inc. 24*7c478bd9Sstevel@tonic-gate * All rights reserved. 25*7c478bd9Sstevel@tonic-gate */ 26*7c478bd9Sstevel@tonic-gate 27*7c478bd9Sstevel@tonic-gate #ifndef _SYS_POLLED_IO_H 28*7c478bd9Sstevel@tonic-gate #define _SYS_POLLED_IO_H 29*7c478bd9Sstevel@tonic-gate 30*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 31*7c478bd9Sstevel@tonic-gate extern "C" { 32*7c478bd9Sstevel@tonic-gate #endif 33*7c478bd9Sstevel@tonic-gate 34*7c478bd9Sstevel@tonic-gate typedef struct polled_device { 35*7c478bd9Sstevel@tonic-gate /* 36*7c478bd9Sstevel@tonic-gate * This lock is only used to lock writing from 37*7c478bd9Sstevel@tonic-gate * the fields on the structure. The values in the 38*7c478bd9Sstevel@tonic-gate * structure can be read under obp, so the lock 39*7c478bd9Sstevel@tonic-gate * isn't valid then. 40*7c478bd9Sstevel@tonic-gate */ 41*7c478bd9Sstevel@tonic-gate kmutex_t polled_device_lock; 42*7c478bd9Sstevel@tonic-gate 43*7c478bd9Sstevel@tonic-gate /* 44*7c478bd9Sstevel@tonic-gate * When we switch over the console, this is the old value 45*7c478bd9Sstevel@tonic-gate * so that we can restore it later. 46*7c478bd9Sstevel@tonic-gate */ 47*7c478bd9Sstevel@tonic-gate uint64_t polled_old_handle; 48*7c478bd9Sstevel@tonic-gate 49*7c478bd9Sstevel@tonic-gate /* 50*7c478bd9Sstevel@tonic-gate * Pointer to registerd polled I/O callbacks. 51*7c478bd9Sstevel@tonic-gate */ 52*7c478bd9Sstevel@tonic-gate cons_polledio_t *polled_io; 53*7c478bd9Sstevel@tonic-gate 54*7c478bd9Sstevel@tonic-gate } polled_device_t; 55*7c478bd9Sstevel@tonic-gate 56*7c478bd9Sstevel@tonic-gate _NOTE(MUTEX_PROTECTS_DATA(polled_device_t::polled_device_lock, 57*7c478bd9Sstevel@tonic-gate polled_device_t)) 58*7c478bd9Sstevel@tonic-gate 59*7c478bd9Sstevel@tonic-gate /* 60*7c478bd9Sstevel@tonic-gate * The lower layers did not find any characters. 61*7c478bd9Sstevel@tonic-gate */ 62*7c478bd9Sstevel@tonic-gate #define CIF_NO_CHARACTERS ((uint_t)-2) 63*7c478bd9Sstevel@tonic-gate 64*7c478bd9Sstevel@tonic-gate /* 65*7c478bd9Sstevel@tonic-gate * Every CIF has at least 3 arguments: 0 (name), 1 (in args), and 2 (out args). 66*7c478bd9Sstevel@tonic-gate */ 67*7c478bd9Sstevel@tonic-gate #define CIF_MIN_SIZE 3 68*7c478bd9Sstevel@tonic-gate 69*7c478bd9Sstevel@tonic-gate #define CIF_NAME 0 /* name of function */ 70*7c478bd9Sstevel@tonic-gate #define CIF_NUMBER_IN_ARGS 1 /* number of arguments passed in */ 71*7c478bd9Sstevel@tonic-gate #define CIF_NUMBER_OUT_ARGS 2 /* number of arguments for return */ 72*7c478bd9Sstevel@tonic-gate #define CIF_BUFFER_ADDRESS 3 /* address to write data */ 73*7c478bd9Sstevel@tonic-gate #define CIF_BUFFER_LENGTH 4 /* length of BUFFER_ADDRESS */ 74*7c478bd9Sstevel@tonic-gate #define CIF_RETURN_VALUE 5 /* return status of operation */ 75*7c478bd9Sstevel@tonic-gate 76*7c478bd9Sstevel@tonic-gate 77*7c478bd9Sstevel@tonic-gate /* 78*7c478bd9Sstevel@tonic-gate * This is the size of the structure that we are expecting to be passed 79*7c478bd9Sstevel@tonic-gate * in. This is based on CIF_MIN_SIZE + address + length + value (see above) 80*7c478bd9Sstevel@tonic-gate */ 81*7c478bd9Sstevel@tonic-gate #define CIF_SIZE 6 /* size of cif structure */ 82*7c478bd9Sstevel@tonic-gate 83*7c478bd9Sstevel@tonic-gate /* 84*7c478bd9Sstevel@tonic-gate * These are the types of polled I/O that this module handles. 85*7c478bd9Sstevel@tonic-gate */ 86*7c478bd9Sstevel@tonic-gate typedef enum polled_io_console_type { 87*7c478bd9Sstevel@tonic-gate POLLED_IO_CONSOLE_INPUT = 0, 88*7c478bd9Sstevel@tonic-gate POLLED_IO_CONSOLE_OUTPUT = 1 89*7c478bd9Sstevel@tonic-gate } polled_io_console_type_t; 90*7c478bd9Sstevel@tonic-gate 91*7c478bd9Sstevel@tonic-gate /* 92*7c478bd9Sstevel@tonic-gate * Initialize the polled I/O kernel structures 93*7c478bd9Sstevel@tonic-gate */ 94*7c478bd9Sstevel@tonic-gate void polled_io_init(void); 95*7c478bd9Sstevel@tonic-gate 96*7c478bd9Sstevel@tonic-gate /* 97*7c478bd9Sstevel@tonic-gate * De-initialize the polled I/O kernel structures 98*7c478bd9Sstevel@tonic-gate */ 99*7c478bd9Sstevel@tonic-gate void polled_io_fini(void); 100*7c478bd9Sstevel@tonic-gate 101*7c478bd9Sstevel@tonic-gate /* 102*7c478bd9Sstevel@tonic-gate * Register a device to be used as a console for OBP. 103*7c478bd9Sstevel@tonic-gate */ 104*7c478bd9Sstevel@tonic-gate int polled_io_register_callbacks(cons_polledio_t *, int); 105*7c478bd9Sstevel@tonic-gate 106*7c478bd9Sstevel@tonic-gate /* 107*7c478bd9Sstevel@tonic-gate * Unregister a device to be used as a console for OBP. 108*7c478bd9Sstevel@tonic-gate */ 109*7c478bd9Sstevel@tonic-gate int polled_io_unregister_callbacks(cons_polledio_t *, int); 110*7c478bd9Sstevel@tonic-gate 111*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 112*7c478bd9Sstevel@tonic-gate } 113*7c478bd9Sstevel@tonic-gate #endif 114*7c478bd9Sstevel@tonic-gate 115*7c478bd9Sstevel@tonic-gate #endif /* _SYS_POLLED_IO_H */ 116