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

/*
* ========== Copyright Header Begin ==========================================
*
* Hypervisor Software File: cyclic.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 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _CYCLIC_H
#define	_CYCLIC_H

#pragma ident	"@(#)cyclic.h	1.4	07/03/23 SMI"

#ifdef __cplusplus
extern "C" {
#endif


/*
 * HStick Interrupt:
 */
#define	N_CB		16		/* # callback array elements */

#define	RETURN_HANDLER_ADDRESS(scr1)	/* relocation independent code */  \
	rd	%pc, scr1		/* handler starts after these */;  \
	jmp	%g7 + SZ_INSTR		/*  three instructions */;	   \
	inc	3 * SZ_INSTR, scr1

/*
 * HStick Interrupt execution times.
 *
 * These are used in an attempt to exit hypervisor to guest code
 * and make some progress before the next interrupt. It is a fail-safe that
 * prevents a runaway callback from totally consuming the strand.
 *
 * Number ticks needed to:
 */
#define	EXIT_NTICK	0x800	/* exit to guest: measured @ 240 - 3f0 */
#define	HSTICK_RET	0x100	/* set new hstick_cmpr & return */

/*
 * Maximum delay time allowed
 */
#define	CYCLIC_MAX_DAYS		367		/* 1 yr + 1 day */


#ifndef _ASM

/*
 * hstick interrupt support:
 *
 * This struct holds the registered handler & number of ticks required
 * to delay, and two args to be passed to the callback handler.
 *
 * Note: handlers that take a long time are not acounted for (yet?).
 */
struct callback {
	uint64_t		tick;		/* delta tick	   */
	uint64_t		handler;	/* handler address */
	uint64_t		arg0;		/* handler args	   */
	uint64_t		arg1;		/*	..	   */
};

struct cyclic {
	uint64_t		t0;		/* absolute time reference  */
	struct callback		cb[N_CB+1];	/* cyclic callback handlers */
	uint64_t		tick;		/* tmp storage		    */
	uint64_t		handler;	/*	..		    */
	uint64_t		arg0;		/*	..		    */
	uint64_t		arg1;		/*	..		    */
};


#endif /* !_ASM */

#ifdef __cplusplus
}
#endif

#endif /* _CYCLIC_H */
Commit	Line	Data
920dae64 AT	1	/*
	2	* ========== Copyright Header Begin ==========================================
	3	*
	4	* Hypervisor Software File: cyclic.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 2006 Sun Microsystems, Inc. All rights reserved.
	46	* Use is subject to license terms.
	47	*/
	48
	49	#ifndef _CYCLIC_H
	50	#define _CYCLIC_H
	51
	52	#pragma ident "@(#)cyclic.h 1.4 07/03/23 SMI"
	53
	54	#ifdef __cplusplus
	55	extern "C" {
	56	#endif
	57
	58
	59	/*
	60	* HStick Interrupt:
	61	*/
	62	#define N_CB 16 /* # callback array elements */
	63
	64	#define RETURN_HANDLER_ADDRESS(scr1) /* relocation independent code */ \
65	rd %pc, scr1 /* handler starts after these */; \
66	jmp %g7 + SZ_INSTR /* three instructions */; \
67	inc 3 * SZ_INSTR, scr1
68
69	/*
70	* HStick Interrupt execution times.
71	*
72	* These are used in an attempt to exit hypervisor to guest code
73	* and make some progress before the next interrupt. It is a fail-safe that
74	* prevents a runaway callback from totally consuming the strand.
75	*
76	* Number ticks needed to:
77	*/
78	#define EXIT_NTICK 0x800 /* exit to guest: measured @ 240 - 3f0 */
79	#define HSTICK_RET 0x100 /* set new hstick_cmpr & return */
80
81	/*
82	* Maximum delay time allowed
83	*/
84	#define CYCLIC_MAX_DAYS 367 /* 1 yr + 1 day */
85
86
87	#ifndef _ASM
88
89	/*
90	* hstick interrupt support:
91	*
92	* This struct holds the registered handler & number of ticks required
93	* to delay, and two args to be passed to the callback handler.
94	*
95	* Note: handlers that take a long time are not acounted for (yet?).
96	*/
97	struct callback {
98	uint64_t tick; /* delta tick */
99	uint64_t handler; /* handler address */
100	uint64_t arg0; /* handler args */
101	uint64_t arg1; /* .. */
102	};
103
104	struct cyclic {
105	uint64_t t0; /* absolute time reference */
106	struct callback cb[N_CB+1]; /* cyclic callback handlers */
107	uint64_t tick; /* tmp storage */
108	uint64_t handler; /* .. */
109	uint64_t arg0; /* .. */
110	uint64_t arg1; /* .. */
111	};
112
113
114	#endif /* !_ASM */
115
116	#ifdef __cplusplus
117	}
118	#endif
119
120	#endif /* _CYCLIC_H */