[OpenSPARC-T2-SAM] / hypervisor / src / greatlakes / common / include / vdev_console.h

/*
* ========== Copyright Header Begin ==========================================
*
* Hypervisor Software File: vdev_console.h
* 
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* 
*  - Do no alter or remove copyright notices
* 
*  - Redistribution and use of this software in source and binary forms, with 
*    or without modification, are permitted provided that the following 
*    conditions are met: 
* 
*  - Redistribution of source code must retain the above copyright notice, 
*    this list of conditions and the following disclaimer.
* 
*  - Redistribution in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution. 
* 
*    Neither the name of Sun Microsystems, Inc. or the names of contributors 
* may be used to endorse or promote products derived from this software 
* without specific prior written permission. 
* 
*     This software is provided "AS IS," without a warranty of any kind. 
* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, 
* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A 
* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN 
* MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR 
* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR 
* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN 
* OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR 
* FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE 
* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, 
* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF 
* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
* 
* You acknowledge that this software is not designed, licensed or
* intended for use in the design, construction, operation or maintenance of
* any nuclear facility. 
* 
* ========== Copyright Header End ============================================
*/
/*
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _VDEV_CONSOLE_H
#define	_VDEV_CONSOLE_H

#pragma ident	"@(#)vdev_console.h	1.7	07/05/03 SMI"

#ifdef __cplusplus
extern "C" {
#endif

#define	CONS_TYPE_UNCONFIG	0x0
#define	CONS_TYPE_LDC		0x1
#ifdef CONFIG_CN_UART
#define	CONS_TYPE_UART		0x2
#endif

/*
 * LDC based console status values
 *   The status field is a bit field where each bit
 *   corresponds to a state
 */
#define	LDC_CONS_READY		0x1
#define	LDC_CONS_BREAK		0x2
#define	LDC_CONS_HUP		0x4

#define	CONS_INBUF_ENTRIES	64
#define	CONS_INBUF_SIZE		(CONS_INBUF_ENTRIES*8)

/*
 * LDC console pkt format
 *
 *             6                      3             1 1
 *             3                      2             6 5      8 7     0
 *            +------------------------+-------------+--------+-------+
 *  word 0:   |        ctrl_msg        |    unused   |  size  | type  |
 *            +------------------------+-------------+--------+-------+
 *  word 1-6: |                    payload                            |
 *            +-------------------------------------------------------+
 */

/*
 * LDC Console msg type
 */
#define	LDC_CONSOLE_CONTROL	0x1
#define	LDC_CONSOLE_DATA	0x2

#define	LDC_CONS_PAYLOAD_SZ	56

#ifndef _ASM
struct ldc_conspkt {
	uint8_t		type;		/* packet type */
	uint8_t		size;		/* num chars in payload */
	uint16_t	rsvd;
	uint32_t	ctrl_msg;	/* control message */
	uint8_t		payload[LDC_CONS_PAYLOAD_SZ];
};


/*
 * Info to help with (re)configuration
 */

typedef struct {
	resource_t	res;
	uint8_t		type;
	uint8_t		ino;	/* virtual device ino */
	int		ldc_channel;
#ifdef CONFIG_CN_UART
	uint64_t	uartbase;
#endif
} console_parse_info_t;


/*
 * Guest console structure
 */
struct console {
	uint8_t		type;		/* type of console */

	console_parse_info_t	pip;
#ifdef CONFIG_CN_UART
	/*
	 * UART based console (primarily for Legion at this point)
	 */
	uint64_t	uartbase;		/* console base address */
#endif
	/*
	 * LDC based console
	 */
	uint8_t		status;				/* Console status */
	uint64_t	endpt;				/* HV LDC Endpt */
	uint64_t	in_head;			/* Incoming buf head */
	uint64_t	in_tail;			/* Incoming buf tail */
	vdev_mapreg_t	*vintr_mapreg;			/* for guest intr */
	uint64_t	in_buf[CONS_INBUF_ENTRIES];	/* Incoming buffer */
};

	/*
	 * Support functions for console resource
	 */

extern void init_consoles();

#endif /* !_ASM */

#ifdef __cplusplus
}
#endif

#endif /* _VDEV_CONSOLE_H */
Commit	Line	Data
920dae64 AT	1	/*
	2	* ========== Copyright Header Begin ==========================================
	3	*
	4	* Hypervisor Software File: vdev_console.h
	5	*
	6	* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
	7	*
	8	* - Do no alter or remove copyright notices
	9	*
	10	* - Redistribution and use of this software in source and binary forms, with
	11	* or without modification, are permitted provided that the following
	12	* conditions are met:
	13	*
	14	* - Redistribution of source code must retain the above copyright notice,
	15	* this list of conditions and the following disclaimer.
	16	*
	17	* - Redistribution in binary form must reproduce the above copyright notice,
	18	* this list of conditions and the following disclaimer in the
	19	* documentation and/or other materials provided with the distribution.
	20	*
	21	* Neither the name of Sun Microsystems, Inc. or the names of contributors
	22	* may be used to endorse or promote products derived from this software
	23	* without specific prior written permission.
	24	*
	25	* This software is provided "AS IS," without a warranty of any kind.
	26	* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
	27	* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
	28	* PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
	29	* MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
	30	* ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
	31	* DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
	32	* OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
	33	* FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
	34	* DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
	35	* ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
	36	* SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
	37	*
	38	* You acknowledge that this software is not designed, licensed or
	39	* intended for use in the design, construction, operation or maintenance of
	40	* any nuclear facility.
	41	*
	42	* ========== Copyright Header End ============================================
	43	*/
	44	/*
	45	* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
	46	* Use is subject to license terms.
	47	*/
	48
	49	#ifndef _VDEV_CONSOLE_H
	50	#define _VDEV_CONSOLE_H
	51
	52	#pragma ident "@(#)vdev_console.h 1.7 07/05/03 SMI"
	53
	54	#ifdef __cplusplus
	55	extern "C" {
	56	#endif
	57
	58	#define CONS_TYPE_UNCONFIG 0x0
	59	#define CONS_TYPE_LDC 0x1
	60	#ifdef CONFIG_CN_UART
	61	#define CONS_TYPE_UART 0x2
	62	#endif
	63
	64	/*
65	* LDC based console status values
66	* The status field is a bit field where each bit
67	* corresponds to a state
68	*/
69	#define LDC_CONS_READY 0x1
70	#define LDC_CONS_BREAK 0x2
71	#define LDC_CONS_HUP 0x4
72
73	#define CONS_INBUF_ENTRIES 64
74	#define CONS_INBUF_SIZE (CONS_INBUF_ENTRIES*8)
75
76	/*
77	* LDC console pkt format
78	*
79	* 6 3 1 1
80	* 3 2 6 5 8 7 0
81	* +------------------------+-------------+--------+-------+
82	* word 0: \| ctrl_msg \| unused \| size \| type \|
83	* +------------------------+-------------+--------+-------+
84	* word 1-6: \| payload \|
85	* +-------------------------------------------------------+
86	*/
87
88	/*
89	* LDC Console msg type
90	*/
91	#define LDC_CONSOLE_CONTROL 0x1
92	#define LDC_CONSOLE_DATA 0x2
93
94	#define LDC_CONS_PAYLOAD_SZ 56
95
96	#ifndef _ASM
97	struct ldc_conspkt {
98	uint8_t type; /* packet type */
99	uint8_t size; /* num chars in payload */
100	uint16_t rsvd;
101	uint32_t ctrl_msg; /* control message */
102	uint8_t payload[LDC_CONS_PAYLOAD_SZ];
103	};
104
105
106	/*
107	* Info to help with (re)configuration
108	*/
109
110	typedef struct {
111	resource_t res;
112	uint8_t type;
113	uint8_t ino; /* virtual device ino */
114	int ldc_channel;
115	#ifdef CONFIG_CN_UART
116	uint64_t uartbase;
117	#endif
118	} console_parse_info_t;
119
120
121	/*
122	* Guest console structure
123	*/
124	struct console {
125	uint8_t type; /* type of console */
126
127	console_parse_info_t pip;
128	#ifdef CONFIG_CN_UART
129	/*
130	* UART based console (primarily for Legion at this point)
131	*/
132	uint64_t uartbase; /* console base address */
133	#endif
134	/*
135	* LDC based console
136	*/
137	uint8_t status; /* Console status */
138	uint64_t endpt; /* HV LDC Endpt */
139	uint64_t in_head; /* Incoming buf head */
140	uint64_t in_tail; /* Incoming buf tail */
141	vdev_mapreg_t vintr_mapreg; / for guest intr */
142	uint64_t in_buf[CONS_INBUF_ENTRIES]; /* Incoming buffer */
143	};
144
145	/*
146	* Support functions for console resource
147	*/
148
149	extern void init_consoles();
150
151	#endif /* !_ASM */
152
153	#ifdef __cplusplus
154	}
155	#endif
156
157	#endif /* _VDEV_CONSOLE_H */