xref: /onnv-gate/usr/src/uts/intel/sys/polled_io.h (revision 0:68f95e015346)
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) 1998-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_POLLED_IO_H
28*0Sstevel@tonic-gate #define	_SYS_POLLED_IO_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 typedef struct polled_device {
37*0Sstevel@tonic-gate 	/*
38*0Sstevel@tonic-gate 	 * This lock is only used to lock writing from
39*0Sstevel@tonic-gate 	 * the fields on the structure.  The values in the
40*0Sstevel@tonic-gate 	 * structure can be read under obp, so the lock
41*0Sstevel@tonic-gate 	 * isn't valid then.
42*0Sstevel@tonic-gate 	 */
43*0Sstevel@tonic-gate 	kmutex_t	polled_device_lock;
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate 	/*
46*0Sstevel@tonic-gate 	 * When we switch over the console, this is the old value
47*0Sstevel@tonic-gate 	 * so that we can restore it later.
48*0Sstevel@tonic-gate 	 */
49*0Sstevel@tonic-gate 	uint64_t	polled_old_handle;
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate 	/*
52*0Sstevel@tonic-gate 	 * Pointer to registerd polled I/O callbacks.
53*0Sstevel@tonic-gate 	 */
54*0Sstevel@tonic-gate 	cons_polledio_t	*polled_io;
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate } polled_device_t;
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate _NOTE(MUTEX_PROTECTS_DATA(polled_device_t::polled_device_lock,
59*0Sstevel@tonic-gate 	polled_device_t))
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate /*
62*0Sstevel@tonic-gate  * The lower layers did not find any characters.
63*0Sstevel@tonic-gate  */
64*0Sstevel@tonic-gate #define	CIF_NO_CHARACTERS	((uint_t)-2)
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate /*
67*0Sstevel@tonic-gate  * Every CIF has at least 3 arguments:  0 (name), 1 (in args), and 2 (out args).
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate #define	CIF_MIN_SIZE		3
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate #define	CIF_NAME		0	/* name of function */
72*0Sstevel@tonic-gate #define	CIF_NUMBER_IN_ARGS	1	/* number of arguments passed in */
73*0Sstevel@tonic-gate #define	CIF_NUMBER_OUT_ARGS	2	/* number of arguments for return */
74*0Sstevel@tonic-gate #define	CIF_BUFFER_ADDRESS	3	/* address to write data */
75*0Sstevel@tonic-gate #define	CIF_BUFFER_LENGTH	4	/* length of BUFFER_ADDRESS */
76*0Sstevel@tonic-gate #define	CIF_RETURN_VALUE	5	/* return status of operation */
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate /*
80*0Sstevel@tonic-gate  * This is the size of the structure that we are expecting to be passed
81*0Sstevel@tonic-gate  * in.  This is based on CIF_MIN_SIZE + address + length + value (see above)
82*0Sstevel@tonic-gate  */
83*0Sstevel@tonic-gate #define	CIF_SIZE		6	/* size of cif structure */
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate /*
86*0Sstevel@tonic-gate  * These are the types of polled I/O that this module handles.
87*0Sstevel@tonic-gate  */
88*0Sstevel@tonic-gate typedef enum polled_io_console_type {
89*0Sstevel@tonic-gate 	POLLED_IO_CONSOLE_INPUT = 0,
90*0Sstevel@tonic-gate 	POLLED_IO_CONSOLE_OUTPUT = 1
91*0Sstevel@tonic-gate } polled_io_console_type_t;
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate /*
94*0Sstevel@tonic-gate  * Initialize the polled I/O kernel structures
95*0Sstevel@tonic-gate  */
96*0Sstevel@tonic-gate void	polled_io_init(void);
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate /*
99*0Sstevel@tonic-gate  * De-initialize the polled I/O kernel structures
100*0Sstevel@tonic-gate  */
101*0Sstevel@tonic-gate void	polled_io_fini(void);
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate /*
104*0Sstevel@tonic-gate  * Register a device to be used as a console for OBP.
105*0Sstevel@tonic-gate  */
106*0Sstevel@tonic-gate int	polled_io_register_callbacks(cons_polledio_t *, int);
107*0Sstevel@tonic-gate 
108*0Sstevel@tonic-gate /*
109*0Sstevel@tonic-gate  * Unregister a device to be used as a console for OBP.
110*0Sstevel@tonic-gate  */
111*0Sstevel@tonic-gate int	polled_io_unregister_callbacks(cons_polledio_t *, int);
112*0Sstevel@tonic-gate 
113*0Sstevel@tonic-gate #ifdef	__cplusplus
114*0Sstevel@tonic-gate }
115*0Sstevel@tonic-gate #endif
116*0Sstevel@tonic-gate 
117*0Sstevel@tonic-gate #endif	/* _SYS_POLLED_IO_H */
118