[apple/xnu.git] / osfmk / ppc / vmachmon.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*-----------------------------------------------------------------------
** vmachmon.h
**
** C routines that we are adding to the MacOS X kernel.
**
-----------------------------------------------------------------------*/

#include <ppc/exception.h>

#ifndef	_VEMULATION_H_
#define	_VEMULATION_H_

/*************************************************************************************
	External Emulation Types
**************************************************************************************/

typedef union vmm_vector_register_t {
	unsigned long			i[4];
	unsigned short			s[8];
	unsigned char			b[16];
} vmm_vector_register_t;

typedef union vmm_fp_register_t {
	double					d;
	unsigned long			i[2];
	unsigned short			s[4];
	unsigned char			b[8];
} vmm_fp_register_t;


typedef struct vmm_regs32_t {

	unsigned long			ppcPC;						/* 000 */
	unsigned long			ppcMSR;						/* 004 */

	unsigned long			ppcGPRs[32];				/* 008 */

	unsigned long			ppcCR;						/* 088 */
	unsigned long			ppcXER;						/* 08C */
	unsigned long			ppcLR;						/* 090 */
	unsigned long			ppcCTR;						/* 094 */
	unsigned long			ppcMQ;						/* 098 - Obsolete */
	unsigned long			ppcVRSave;					/* 09C */
	unsigned long			ppcRsrvd0A0[40];			/* 0A0 */
														/* 140 */
} vmm_regs32_t;

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmm_regs64_t {

	unsigned long long		ppcPC;						/* 000 */
	unsigned long long		ppcMSR;						/* 008 */

	unsigned long long		ppcGPRs[32];				/* 010 */

	unsigned long long		ppcXER;						/* 110 */
	unsigned long long		ppcLR;						/* 118 */
	unsigned long long		ppcCTR;						/* 120 */
	unsigned long			ppcCR;						/* 128 */
	unsigned long			ppcVRSave;					/* 12C */
	unsigned long			ppcRsvd130[4];				/* 130 */
														/* 140 */
} vmm_regs64_t;
#pragma pack()
	
	
#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef union vmm_regs_t {
	vmm_regs32_t			ppcRegs32;
	vmm_regs64_t			ppcRegs64;
} vmm_regs_t;
#pragma pack()

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmm_processor_state_t {
														/* 32-byte bndry */
	vmm_regs_t				ppcRegs;					/* Define registers areas */
	
/*	We must be 16-byte aligned here */

	vmm_vector_register_t	ppcVRs[32];					/* These are only valid after a kVmmGetVectorState */
	vmm_vector_register_t	ppcVSCR;					/* This is always loaded/saved at host/guest transition */
	
/*	We must be 8-byte aligned here */

	vmm_fp_register_t		ppcFPRs[32];				/* These are only valid after a kVmmGetFloatState */
	vmm_fp_register_t		ppcFPSCR;					/* This is always loaded/saved at host/guest transition */
	unsigned long			ppcReserved2[2];			/* Pad out to multiple of 16 bytes */
} vmm_processor_state_t;
#pragma pack()

typedef unsigned long vmm_return_code_t;

typedef unsigned long vmm_thread_index_t;
#define vmmTInum 0x000000FF
#define vmmTIadsp 0x0000FF00
typedef unsigned long vmm_adsp_id_t;

enum {
	kVmmCurMajorVersion					= 0x0001,
	kVmmCurMinorVersion					= 0x0006,
	kVmmMinMajorVersion					= 0x0001,
};
#define kVmmCurrentVersion ((kVmmCurMajorVersion << 16) | kVmmCurMinorVersion)

typedef unsigned long vmm_features_t;
enum {
	kVmmFeature_LittleEndian			= 0x00000001,
	kVmmFeature_Stop					= 0x00000002,
	kVmmFeature_ExtendedMapping			= 0x00000004,
	kVmmFeature_ListMapping				= 0x00000008,
	kVmmFeature_FastAssist				= 0x00000010,
	kVmmFeature_XA						= 0x00000020,
	kVmmFeature_SixtyFourBit			= 0x00000040,
	kVmmFeature_MultAddrSpace			= 0x00000080,
};
#define kVmmCurrentFeatures (kVmmFeature_LittleEndian | kVmmFeature_Stop | kVmmFeature_ExtendedMapping \
	| kVmmFeature_ListMapping | kVmmFeature_FastAssist | kVmmFeature_XA | kVmmFeature_MultAddrSpace)

enum {
	vmm64Bit							= 0x80000000,
};


typedef unsigned long vmm_version_t;

typedef struct vmm_ret_parms32_t {
	unsigned long 			return_params[4];
} vmm_ret_parms32_t;

typedef struct vmm_ret_parms64_t {
	unsigned long long		return_params[4];
} vmm_ret_parms64_t;

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef union vmm_ret_parms_t {
	vmm_ret_parms64_t		vmmrp64;		/* 64-bit flavor */
	vmm_ret_parms32_t		vmmrp32;		/* 32-bit flavor */
	unsigned int			retgas[11];		/* Force this to be 11 words long */
} vmm_ret_parms_t;
#pragma pack()

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmm_fastassist_state32_t {
	unsigned long fastassist_dispatch;
	unsigned long fastassist_refcon;

	unsigned long fastassist_dispatch_code;
	unsigned long fastassist_parameter[5];

	unsigned long guest_register[8];

	unsigned long guest_pc;
	unsigned long guest_msr;

	unsigned long fastassist_intercepts;
	unsigned long fastassist_reserved1;
} vmm_fastassist_state32_t;

typedef struct vmm_fastassist_state64_t {
	unsigned long long fastassist_dispatch;
	unsigned long long fastassist_refcon;

	unsigned long long fastassist_dispatch_code;
	unsigned long long fastassist_parameter[5];

	unsigned long long guest_register[8];

	unsigned long long guest_pc;
	unsigned long long guest_msr;

	unsigned long fastassist_intercepts;
	unsigned long fastassist_reserved1;
} vmm_fastassist_state64_t;

typedef union vmm_fastassist_state_t {
	vmm_fastassist_state64_t		vmmfs64;		/* 64-bit flavor */
	vmm_fastassist_state32_t		vmmfs32;		/* 32-bit flavor */
} vmm_fastassist_state_t;
#pragma pack()

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmm_state_page_t {
	/* This structure must remain below 4Kb (one page) in size */
	vmm_version_t			interface_version;
	vmm_thread_index_t		thread_index;
	unsigned int			vmmStat;	/* Note: this field is identical to vmmFlags in vmmCntrlEntry */
	unsigned int			vmmCntrl;
#define vmmFloatLoad	0x80000000
#define vmmFloatLoadb	0
#define vmmVectLoad		0x40000000
#define vmmVectLoadb	1
#define vmmVectVRall	0x20000000
#define vmmVectVRallb	2
#define vmmVectVAss		0x10000000
#define vmmVectVAssb	3
#define vmmXStart		0x08000000
#define vmmXStartb		4
#define vmmKey			0x04000000
#define vmmKeyb			5
#define vmmFamEna		0x02000000
#define vmmFamEnab		6
#define vmmFamSet		0x01000000
#define vmmFamSetb		7

	vmm_return_code_t		return_code;
	vmm_ret_parms_t			vmmRet;

	/* The next portion of the structure must remain 32-byte aligned */
	vmm_processor_state_t	vmm_proc_state;

	/* The next portion of the structure must remain 16-byte aligned */
	vmm_fastassist_state_t	vmm_fastassist_state;

} vmm_state_page_t;
#pragma pack()

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmm_comm_page_t {
	union {
		vmm_state_page_t	vmcpState;					/* Reserve area for state */
		unsigned int		vmcpPad[768];				/* Reserve space for 3/4 page state area */
	} vmcpfirst;
	unsigned int			vmcpComm[256];				/* Define last 1024 bytes as a communications area - function specific */
} vmm_comm_page_t;
#pragma pack()

enum {
	/* Function Indices (passed in r3) */
	kVmmGetVersion				= 0,					/* Get VMM system version */
	kVmmvGetFeatures,									/* Get VMM supported features */
	kVmmInitContext,									/* Initialize a context */
	kVmmTearDownContext,								/* Destroy a context */
	kVmmTearDownAll,									/* Destory all contexts */
	kVmmMapPage,										/* Map a host to guest address space */
	kVmmGetPageMapping,									/* Get host address of a guest page */
	kVmmUnmapPage,										/* Unmap a guest page */
	kVmmUnmapAllPages,									/* Unmap all pages in a guest address space */
	kVmmGetPageDirtyFlag,								/* Check if guest page modified */
	kVmmGetFloatState,									/* Retrieve guest floating point context */
	kVmmGetVectorState,									/* Retrieve guest vector context */
	kVmmSetTimer,										/* Set a guest timer */
	kVmmGetTimer,										/* Get a guest timer */
	kVmmExecuteVM,										/* Launch a guest */
	kVmmProtectPage,									/* Set protection attributes for a guest page */
	kVmmMapExecute,										/* Map guest page and launch */
	kVmmProtectExecute,									/* Set prot attributes and launch */
	kVmmMapList,										/* Map a list of pages into guest address spaces */
	kVmmUnmapList,										/* Unmap a list of pages from guest address spaces */
	kvmmExitToHost,
	kvmmResumeGuest,
	kvmmGetGuestRegister,
	kvmmSetGuestRegister,
	
	kVmmSetXA,											/* Set extended architecture features for a VM */
	kVmmGetXA,											/* Get extended architecture features from a VM */

	kVmmMapPage64,										/* Map a host to guest address space - supports 64-bit */
	kVmmGetPageMapping64,								/* Get host address of a guest page - supports 64-bit  */
	kVmmUnmapPage64,									/* Unmap a guest page - supports 64-bit  */
	kVmmGetPageDirtyFlag64,								/* Check if guest page modified - supports 64-bit  */
	kVmmProtectPage64,									/* Set protection attributes for a guest page - supports 64-bit */
	kVmmMapExecute64,									/* Map guest page and launch - supports 64-bit  */
	kVmmProtectExecute64,								/* Set prot attributes and launch - supports 64-bit  */
	kVmmMapList64,										/* Map a list of pages into guest address spaces - supports 64-bit  */
	kVmmUnmapList64,									/* Unmap a list of pages from guest address spaces - supports 64-bit  */
	kVmmMaxAddr,										/* Returns the maximum virtual address that is mappable  */
};

#define kVmmReturnNull					0
#define kVmmBogusContext				1
#define kVmmStopped						2
#define kVmmReturnDataPageFault			3
#define kVmmReturnInstrPageFault		4
#define kVmmReturnAlignmentFault		6
#define kVmmReturnProgramException		7
#define kVmmReturnSystemCall			12
#define kVmmReturnTraceException		13
#define kVmmAltivecAssist				22
#define kVmmInvalidAddress				0x1000
#define kVmmInvalidAdSpace				0x1001

/*
 *	Notes on guest address spaces.
 *
 *	Address spaces are loosely coupled to virtual machines.  The default is for
 *	a guest with an index of 1 to use address space 1, 2 to use 2, etc.  However,
 *	any guest may be launched using any address space and any address space may be the
 *	target for a map or unmap function.  Note that the (un)map list functions may pass in
 *	an address space ID on a page-by-page basis.
 *	
 *	An address space is instantiated either explicitly by mapping something into it, or 
 *	implicitly by launching a guest with it.
 *
 *	An address space is destroyed explicitly by kVmmTearDownAll or kVmmUnmapAllPages.  It is
 *	destroyed implicitly by kVmmTearDownContext.  The latter is done in order to remain
 *	backwards compatible with the previous implementation, which does not have decoupled
 *	guests and address spaces.
 *
 *	An address space supports the maximum virtual address supported by the processor.  
 *	The 64-bit variant of the mapping functions can be used on non-64-bit machines.  If an
 *	unmappable address (e.g., an address larger than 4GB-1 on a 32-bit machine) is requested, 
 *	the operation fails with a kVmmInvalidAddress return code.
 *
 *	Note that for 64-bit calls, both host and guest are specified at 64-bit values.
 *
 */


/*
 *	Storage Extended Protection modes
 *	Notes:
 *		To keep compatibility, vmmKey and the PPC key have reversed meanings,
 *		i.e., vmmKey 0 is PPC key 1 and vice versa.
 *
 *	    vmmKey										Notes
 *	Mode			0				1
 *
 *	kVmmProtNARW	not accessible	read/write		VM_PROT_NONE (not settable via VM calls)
 *	kVmmProtRORW	read only		read/write		
 *	kVmmProtRWRW	read/write		read/write		VM_PROT_WRITE or (VM_PROT_WRITE | VM_PROT_READ)
 *	kVmmProtRORO	read only		read only		VM_PROT_READ
 
 */
 
#define kVmmProtXtnd 0x00000008
#define kVmmProtNARW (kVmmProtXtnd | 0x00000000)
#define kVmmProtRORW (kVmmProtXtnd | 0x00000001)
#define kVmmProtRWRW (kVmmProtXtnd | 0x00000002)
#define kVmmProtRORO (kVmmProtXtnd | 0x00000003)

/*
 *	Map list formats
 *	The last 12 bits in the guest virtual address is used as flags as follows:
 *		0x007 - for the map calls, this is the key to set
 *		0x3F0 - for both map and unmap, this is the address space ID upon which to operate.
 *				Note that if 0, the address space ID from the function call is used instead.
 */

typedef struct vmmMList {
	unsigned int	vmlva;			/* Virtual address in host address space */
	unsigned int	vmlava;			/* Virtual address in guest address space */
} vmmMList;

typedef struct vmmMList64 {
	unsigned long long	vmlva;		/* Virtual address in host address space */
	unsigned long long	vmlava;		/* Virtual address in guest address space */
} vmmMList64;

typedef struct vmmUMList {
	unsigned int	vmlava;			/* Virtual address in guest address space */
} vmmUMList;

typedef struct vmmUMList64 {
	unsigned long long	vmlava;		/* Virtual address in guest address space */
} vmmUMList64;

#define vmmlFlgs 0x00000FFF			/* Flags passed in in vmlava low order 12 bits */
#define vmmlProt 0x00000007			/* Protection flags for the page */
#define vmmlAdID 0x000003F0			/* Guest address space ID - used only if non-zero */
#define vmmlRsvd 0x00000C08			/* Reserved for future */

/*************************************************************************************
	Internal Emulation Types
**************************************************************************************/

#define kVmmMaxContexts					32
#define kVmmMaxUnmapPages				64
#define kVmmMaxMapPages					64

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmmCntrlEntry {						/* Virtual Machine Monitor control table entry */
	unsigned int	vmmFlags;						/* Assorted control flags */
#define vmmInUse 		0x80000000
#define vmmInUseb 		0
#define vmmFloatCngd	0x40000000
#define vmmFloatCngdb	1
#define vmmVectCngd		0x20000000
#define vmmVectCngdb	2
#define vmmTimerPop		0x10000000
#define vmmTimerPopb	3
#define vmmFAMmode		0x04000000
#define vmmFAMmodeb		5
#define vmmXStop		0x00800000
#define vmmXStopb		8
#define vmmSpfSave		0x000000FF
#define vmmSpfSaveb		24
	unsigned int	vmmXAFlgs;						/* Extended Architecture flags */
	vmm_state_page_t *vmmContextKern;				/* Kernel address of context communications area */
	ppnum_t			vmmContextPhys;				/* Physical address of context communications area */
	vmm_state_page_t *vmmContextUser;				/* User address of context communications area */
	facility_context vmmFacCtx;						/* Header for vector and floating point contexts */
	pmap_t			vmmPmap;						/* Last dispatched pmap */
	uint64_t		vmmTimer;						/* Last set timer value. Zero means unset */
	unsigned int	vmmFAMintercept;				/* FAM intercepted exceptions */
} vmmCntrlEntry;
#pragma pack()

#pragma pack(4)							/* Make sure the structure stays as we defined it */
typedef struct vmmCntrlTable {						/* Virtual Machine Monitor Control table */
	unsigned int	vmmGFlags;						/* Global flags */
#define vmmLastAdSp 0xFF							/* Remember the address space that was mapped last */
	addr64_t		vmmLastMap;						/* Last vaddr mapping made */
	vmmCntrlEntry	vmmc[kVmmMaxContexts];			/* One entry for each possible Virtual Machine Monitor context */
	pmap_t			vmmAdsp[kVmmMaxContexts];		/* Guest address space pmaps */
} vmmCntrlTable;
#pragma pack()

/* function decls for kernel level routines... */
extern void vmm_execute_vm(thread_act_t act, vmm_thread_index_t index);
extern vmmCntrlEntry *vmm_get_entry(thread_act_t act, vmm_thread_index_t index);
extern kern_return_t vmm_tear_down_context(thread_act_t act, vmm_thread_index_t index);
extern kern_return_t vmm_get_float_state(thread_act_t act, vmm_thread_index_t index);
extern kern_return_t vmm_get_vector_state(thread_act_t act, vmm_thread_index_t index);
extern kern_return_t vmm_set_timer(thread_act_t act, vmm_thread_index_t index, unsigned int timerhi, unsigned int timerlo);
extern kern_return_t vmm_get_timer(thread_act_t act, vmm_thread_index_t index);
extern void vmm_tear_down_all(thread_act_t act);
extern kern_return_t vmm_map_page(thread_act_t act, vmm_thread_index_t hindex, addr64_t cva,
	addr64_t ava, vm_prot_t prot);
extern vmm_return_code_t vmm_map_execute(thread_act_t act, vmm_thread_index_t hindex, addr64_t cva,
	addr64_t ava, vm_prot_t prot);
extern kern_return_t vmm_protect_page(thread_act_t act, vmm_thread_index_t hindex, addr64_t va,
	vm_prot_t prot);
extern vmm_return_code_t vmm_protect_execute(thread_act_t act, vmm_thread_index_t hindex, addr64_t va,
	vm_prot_t prot);
extern addr64_t vmm_get_page_mapping(thread_act_t act, vmm_thread_index_t index,
	addr64_t va);
extern kern_return_t vmm_unmap_page(thread_act_t act, vmm_thread_index_t index, addr64_t va);
extern void vmm_unmap_all_pages(thread_act_t act, vmm_thread_index_t index);
extern boolean_t vmm_get_page_dirty_flag(thread_act_t act, vmm_thread_index_t index,
	addr64_t va, unsigned int reset);
extern kern_return_t vmm_set_XA(thread_act_t act, vmm_thread_index_t index, unsigned int xaflags);
extern unsigned int vmm_get_XA(thread_act_t act, vmm_thread_index_t index);
extern int vmm_get_features(struct savearea *);
extern int vmm_get_version(struct savearea *);
extern int vmm_init_context(struct savearea *);
extern int vmm_dispatch(struct savearea *);
extern int vmm_exit(thread_act_t act, struct savearea *);
extern void vmm_force_exit(thread_act_t act, struct savearea *);
extern int vmm_stop_vm(struct savearea *save);
extern void vmm_timer_pop(thread_act_t act);
extern void vmm_interrupt(ReturnHandler *rh, thread_act_t act);
extern kern_return_t vmm_map_list(thread_act_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
extern kern_return_t vmm_unmap_list(thread_act_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
extern vmm_return_code_t vmm_resume_guest(vmm_thread_index_t index, unsigned long pc, 
	unsigned long vmmCntrl, unsigned long vmmCntrMaskl);
extern vmm_return_code_t vmm_exit_to_host(vmm_thread_index_t index);
extern unsigned long vmm_get_guest_register(vmm_thread_index_t index, unsigned long reg_index);
extern vmm_return_code_t vmm_set_guest_register(vmm_thread_index_t index, unsigned long reg_index, unsigned long reg_value);
extern addr64_t vmm_max_addr(thread_act_t act);

#endif
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*-----------------------------------------------------------------------
	23	** vmachmon.h
	24	**
	25	** C routines that we are adding to the MacOS X kernel.
	26	**
1c79356b A	27	-----------------------------------------------------------------------*/
	28
	29	#include <ppc/exception.h>
	30
	31	#ifndef _VEMULATION_H_
	32	#define _VEMULATION_H_
	33
	34	/*************************************************************************************
	35	External Emulation Types
	36	**************************************************************************************/
	37
	38	typedef union vmm_vector_register_t {
	39	unsigned long i[4];
	40	unsigned short s[8];
	41	unsigned char b[16];
	42	} vmm_vector_register_t;
	43
	44	typedef union vmm_fp_register_t {
	45	double d;
	46	unsigned long i[2];
	47	unsigned short s[4];
	48	unsigned char b[8];
	49	} vmm_fp_register_t;
	50
9bccf70c	51
55e303ae	52	typedef struct vmm_regs32_t {
d7e50217	53
55e303ae A	54	unsigned long ppcPC; /* 000 */
55e303ae A	55	unsigned long ppcMSR; /* 004 */
d7e50217	56
55e303ae A	57	unsigned long ppcGPRs[32]; /* 008 */
	58
	59	unsigned long ppcCR; /* 088 */
	60	unsigned long ppcXER; /* 08C */
	61	unsigned long ppcLR; /* 090 */
	62	unsigned long ppcCTR; /* 094 */
	63	unsigned long ppcMQ; /* 098 - Obsolete */
	64	unsigned long ppcVRSave; /* 09C */
	65	unsigned long ppcRsrvd0A0[40]; /* 0A0 */
	66	/* 140 */
	67	} vmm_regs32_t;
	68
	69	#pragma pack(4) /* Make sure the structure stays as we defined it */
	70	typedef struct vmm_regs64_t {
	71
	72	unsigned long long ppcPC; /* 000 */
	73	unsigned long long ppcMSR; /* 008 */
	74
	75	unsigned long long ppcGPRs[32]; /* 010 */
	76
	77	unsigned long long ppcXER; /* 110 */
	78	unsigned long long ppcLR; /* 118 */
	79	unsigned long long ppcCTR; /* 120 */
	80	unsigned long ppcCR; /* 128 */
	81	unsigned long ppcVRSave; /* 12C */
	82	unsigned long ppcRsvd130[4]; /* 130 */
	83	/* 140 */
	84	} vmm_regs64_t;
	85	#pragma pack()
de355530	86
55e303ae A	87
	88	#pragma pack(4) /* Make sure the structure stays as we defined it */
	89	typedef union vmm_regs_t {
	90	vmm_regs32_t ppcRegs32;
	91	vmm_regs64_t ppcRegs64;
	92	} vmm_regs_t;
	93	#pragma pack()
	94
	95	#pragma pack(4) /* Make sure the structure stays as we defined it */
	96	typedef struct vmm_processor_state_t {
	97	/* 32-byte bndry */
	98	vmm_regs_t ppcRegs; /* Define registers areas */
1c79356b A	99
	100	/* We must be 16-byte aligned here */
	101
55e303ae A	102	vmm_vector_register_t ppcVRs[32]; /* These are only valid after a kVmmGetVectorState */
55e303ae A	103	vmm_vector_register_t ppcVSCR; /* This is always loaded/saved at host/guest transition */
1c79356b A	104
	105	/* We must be 8-byte aligned here */
	106
55e303ae A	107	vmm_fp_register_t ppcFPRs[32]; /* These are only valid after a kVmmGetFloatState */
55e303ae A	108	vmm_fp_register_t ppcFPSCR; /* This is always loaded/saved at host/guest transition */
1c79356b A	109	unsigned long ppcReserved2[2]; /* Pad out to multiple of 16 bytes */
1c79356b A	110	} vmm_processor_state_t;
55e303ae	111	#pragma pack()
1c79356b A	112
	113	typedef unsigned long vmm_return_code_t;
	114
	115	typedef unsigned long vmm_thread_index_t;
55e303ae A	116	#define vmmTInum 0x000000FF
	117	#define vmmTIadsp 0x0000FF00
	118	typedef unsigned long vmm_adsp_id_t;
0b4e3aa0	119
1c79356b	120	enum {
0b4e3aa0	121	kVmmCurMajorVersion = 0x0001,
55e303ae	122	kVmmCurMinorVersion = 0x0006,
0b4e3aa0	123	kVmmMinMajorVersion = 0x0001,
1c79356b	124	};
0b4e3aa0	125	#define kVmmCurrentVersion ((kVmmCurMajorVersion << 16) \| kVmmCurMinorVersion)
1c79356b A	126
	127	typedef unsigned long vmm_features_t;
	128	enum {
0b4e3aa0 A	129	kVmmFeature_LittleEndian = 0x00000001,
	130	kVmmFeature_Stop = 0x00000002,
	131	kVmmFeature_ExtendedMapping = 0x00000004,
9bccf70c	132	kVmmFeature_ListMapping = 0x00000008,
d7e50217	133	kVmmFeature_FastAssist = 0x00000010,
55e303ae A	134	kVmmFeature_XA = 0x00000020,
	135	kVmmFeature_SixtyFourBit = 0x00000040,
	136	kVmmFeature_MultAddrSpace = 0x00000080,
	137	};
	138	#define kVmmCurrentFeatures (kVmmFeature_LittleEndian \| kVmmFeature_Stop \| kVmmFeature_ExtendedMapping \
	139	\| kVmmFeature_ListMapping \| kVmmFeature_FastAssist \| kVmmFeature_XA \| kVmmFeature_MultAddrSpace)
	140
	141	enum {
	142	vmm64Bit = 0x80000000,
1c79356b	143	};
d7e50217	144
1c79356b A	145
	146	typedef unsigned long vmm_version_t;
	147
55e303ae A	148	typedef struct vmm_ret_parms32_t {
	149	unsigned long return_params[4];
	150	} vmm_ret_parms32_t;
	151
	152	typedef struct vmm_ret_parms64_t {
	153	unsigned long long return_params[4];
	154	} vmm_ret_parms64_t;
	155
	156	#pragma pack(4) /* Make sure the structure stays as we defined it */
	157	typedef union vmm_ret_parms_t {
	158	vmm_ret_parms64_t vmmrp64; /* 64-bit flavor */
	159	vmm_ret_parms32_t vmmrp32; /* 32-bit flavor */
	160	unsigned int retgas[11]; /* Force this to be 11 words long */
	161	} vmm_ret_parms_t;
	162	#pragma pack()
	163
	164	#pragma pack(4) /* Make sure the structure stays as we defined it */
	165	typedef struct vmm_fastassist_state32_t {
d7e50217 A	166	unsigned long fastassist_dispatch;
	167	unsigned long fastassist_refcon;
	168
	169	unsigned long fastassist_dispatch_code;
	170	unsigned long fastassist_parameter[5];
	171
	172	unsigned long guest_register[8];
	173
	174	unsigned long guest_pc;
	175	unsigned long guest_msr;
	176
	177	unsigned long fastassist_intercepts;
	178	unsigned long fastassist_reserved1;
55e303ae A	179	} vmm_fastassist_state32_t;
	180
	181	typedef struct vmm_fastassist_state64_t {
	182	unsigned long long fastassist_dispatch;
	183	unsigned long long fastassist_refcon;
	184
	185	unsigned long long fastassist_dispatch_code;
	186	unsigned long long fastassist_parameter[5];
	187
	188	unsigned long long guest_register[8];
	189
	190	unsigned long long guest_pc;
	191	unsigned long long guest_msr;
	192
	193	unsigned long fastassist_intercepts;
	194	unsigned long fastassist_reserved1;
	195	} vmm_fastassist_state64_t;
	196
	197	typedef union vmm_fastassist_state_t {
	198	vmm_fastassist_state64_t vmmfs64; /* 64-bit flavor */
	199	vmm_fastassist_state32_t vmmfs32; /* 32-bit flavor */
d7e50217	200	} vmm_fastassist_state_t;
55e303ae	201	#pragma pack()
d7e50217	202
55e303ae	203	#pragma pack(4) /* Make sure the structure stays as we defined it */
1c79356b A	204	typedef struct vmm_state_page_t {
	205	/* This structure must remain below 4Kb (one page) in size */
	206	vmm_version_t interface_version;
	207	vmm_thread_index_t thread_index;
	208	unsigned int vmmStat; /* Note: this field is identical to vmmFlags in vmmCntrlEntry */
	209	unsigned int vmmCntrl;
	210	#define vmmFloatLoad 0x80000000
	211	#define vmmFloatLoadb 0
	212	#define vmmVectLoad 0x40000000
	213	#define vmmVectLoadb 1
	214	#define vmmVectVRall 0x20000000
	215	#define vmmVectVRallb 2
	216	#define vmmVectVAss 0x10000000
	217	#define vmmVectVAssb 3
0b4e3aa0 A	218	#define vmmXStart 0x08000000
	219	#define vmmXStartb 4
	220	#define vmmKey 0x04000000
	221	#define vmmKeyb 5
d7e50217 A	222	#define vmmFamEna 0x02000000
	223	#define vmmFamEnab 6
	224	#define vmmFamSet 0x01000000
	225	#define vmmFamSetb 7
	226
1c79356b	227	vmm_return_code_t return_code;
55e303ae	228	vmm_ret_parms_t vmmRet;
1c79356b A	229
	230	/* The next portion of the structure must remain 32-byte aligned */
	231	vmm_processor_state_t vmm_proc_state;
	232
d7e50217 A	233	/* The next portion of the structure must remain 16-byte aligned */
	234	vmm_fastassist_state_t vmm_fastassist_state;
	235
1c79356b	236	} vmm_state_page_t;
55e303ae	237	#pragma pack()
1c79356b	238
55e303ae	239	#pragma pack(4) /* Make sure the structure stays as we defined it */
9bccf70c A	240	typedef struct vmm_comm_page_t {
	241	union {
	242	vmm_state_page_t vmcpState; /* Reserve area for state */
	243	unsigned int vmcpPad[768]; /* Reserve space for 3/4 page state area */
	244	} vmcpfirst;
	245	unsigned int vmcpComm[256]; /* Define last 1024 bytes as a communications area - function specific */
	246	} vmm_comm_page_t;
55e303ae	247	#pragma pack()
9bccf70c	248
1c79356b A	249	enum {
1c79356b A	250	/* Function Indices (passed in r3) */
55e303ae A	251	kVmmGetVersion = 0, /* Get VMM system version */
	252	kVmmvGetFeatures, /* Get VMM supported features */
	253	kVmmInitContext, /* Initialize a context */
	254	kVmmTearDownContext, /* Destroy a context */
	255	kVmmTearDownAll, /* Destory all contexts */
	256	kVmmMapPage, /* Map a host to guest address space */
	257	kVmmGetPageMapping, /* Get host address of a guest page */
	258	kVmmUnmapPage, /* Unmap a guest page */
	259	kVmmUnmapAllPages, /* Unmap all pages in a guest address space */
	260	kVmmGetPageDirtyFlag, /* Check if guest page modified */
	261	kVmmGetFloatState, /* Retrieve guest floating point context */
	262	kVmmGetVectorState, /* Retrieve guest vector context */
	263	kVmmSetTimer, /* Set a guest timer */
	264	kVmmGetTimer, /* Get a guest timer */
	265	kVmmExecuteVM, /* Launch a guest */
	266	kVmmProtectPage, /* Set protection attributes for a guest page */
	267	kVmmMapExecute, /* Map guest page and launch */
	268	kVmmProtectExecute, /* Set prot attributes and launch */
	269	kVmmMapList, /* Map a list of pages into guest address spaces */
	270	kVmmUnmapList, /* Unmap a list of pages from guest address spaces */
d7e50217 A	271	kvmmExitToHost,
	272	kvmmResumeGuest,
	273	kvmmGetGuestRegister,
	274	kvmmSetGuestRegister,
55e303ae A	275
	276	kVmmSetXA, /* Set extended architecture features for a VM */
	277	kVmmGetXA, /* Get extended architecture features from a VM */
	278
	279	kVmmMapPage64, /* Map a host to guest address space - supports 64-bit */
	280	kVmmGetPageMapping64, /* Get host address of a guest page - supports 64-bit */
	281	kVmmUnmapPage64, /* Unmap a guest page - supports 64-bit */
	282	kVmmGetPageDirtyFlag64, /* Check if guest page modified - supports 64-bit */
	283	kVmmProtectPage64, /* Set protection attributes for a guest page - supports 64-bit */
	284	kVmmMapExecute64, /* Map guest page and launch - supports 64-bit */
	285	kVmmProtectExecute64, /* Set prot attributes and launch - supports 64-bit */
	286	kVmmMapList64, /* Map a list of pages into guest address spaces - supports 64-bit */
	287	kVmmUnmapList64, /* Unmap a list of pages from guest address spaces - supports 64-bit */
	288	kVmmMaxAddr, /* Returns the maximum virtual address that is mappable */
1c79356b A	289	};
	290
	291	#define kVmmReturnNull 0
	292	#define kVmmBogusContext 1
0b4e3aa0	293	#define kVmmStopped 2
1c79356b A	294	#define kVmmReturnDataPageFault 3
	295	#define kVmmReturnInstrPageFault 4
	296	#define kVmmReturnAlignmentFault 6
	297	#define kVmmReturnProgramException 7
	298	#define kVmmReturnSystemCall 12
	299	#define kVmmReturnTraceException 13
	300	#define kVmmAltivecAssist 22
55e303ae A	301	#define kVmmInvalidAddress 0x1000
	302	#define kVmmInvalidAdSpace 0x1001
	303
	304	/*
	305	* Notes on guest address spaces.
	306	*
	307	* Address spaces are loosely coupled to virtual machines. The default is for
	308	* a guest with an index of 1 to use address space 1, 2 to use 2, etc. However,
	309	* any guest may be launched using any address space and any address space may be the
	310	* target for a map or unmap function. Note that the (un)map list functions may pass in
	311	* an address space ID on a page-by-page basis.
	312	*
	313	* An address space is instantiated either explicitly by mapping something into it, or
	314	* implicitly by launching a guest with it.
	315	*
	316	* An address space is destroyed explicitly by kVmmTearDownAll or kVmmUnmapAllPages. It is
	317	* destroyed implicitly by kVmmTearDownContext. The latter is done in order to remain
	318	* backwards compatible with the previous implementation, which does not have decoupled
	319	* guests and address spaces.
	320	*
	321	* An address space supports the maximum virtual address supported by the processor.
	322	* The 64-bit variant of the mapping functions can be used on non-64-bit machines. If an
	323	* unmappable address (e.g., an address larger than 4GB-1 on a 32-bit machine) is requested,
	324	* the operation fails with a kVmmInvalidAddress return code.
	325	*
	326	* Note that for 64-bit calls, both host and guest are specified at 64-bit values.
	327	*
	328	*/
	329
	330
	331
1c79356b	332
0b4e3aa0 A	333	/*
	334	* Storage Extended Protection modes
	335	* Notes:
	336	* To keep compatibility, vmmKey and the PPC key have reversed meanings,
	337	* i.e., vmmKey 0 is PPC key 1 and vice versa.
	338	*
	339	* vmmKey Notes
	340	* Mode 0 1
	341	*
	342	* kVmmProtNARW not accessible read/write VM_PROT_NONE (not settable via VM calls)
	343	* kVmmProtRORW read only read/write
	344	* kVmmProtRWRW read/write read/write VM_PROT_WRITE or (VM_PROT_WRITE \| VM_PROT_READ)
	345	* kVmmProtRORO read only read only VM_PROT_READ
	346
	347	*/
	348
	349	#define kVmmProtXtnd 0x00000008
	350	#define kVmmProtNARW (kVmmProtXtnd \| 0x00000000)
	351	#define kVmmProtRORW (kVmmProtXtnd \| 0x00000001)
	352	#define kVmmProtRWRW (kVmmProtXtnd \| 0x00000002)
	353	#define kVmmProtRORO (kVmmProtXtnd \| 0x00000003)
1c79356b	354
9bccf70c	355	/*
55e303ae A	356	* Map list formats
	357	* The last 12 bits in the guest virtual address is used as flags as follows:
	358	* 0x007 - for the map calls, this is the key to set
	359	* 0x3F0 - for both map and unmap, this is the address space ID upon which to operate.
	360	* Note that if 0, the address space ID from the function call is used instead.
9bccf70c A	361	*/
9bccf70c A	362
55e303ae A	363	typedef struct vmmMList {
	364	unsigned int vmlva; /* Virtual address in host address space */
	365	unsigned int vmlava; /* Virtual address in guest address space */
	366	} vmmMList;
	367
	368	typedef struct vmmMList64 {
	369	unsigned long long vmlva; /* Virtual address in host address space */
	370	unsigned long long vmlava; /* Virtual address in guest address space */
	371	} vmmMList64;
	372
	373	typedef struct vmmUMList {
	374	unsigned int vmlava; /* Virtual address in guest address space */
	375	} vmmUMList;
	376
	377	typedef struct vmmUMList64 {
	378	unsigned long long vmlava; /* Virtual address in guest address space */
	379	} vmmUMList64;
9bccf70c	380
55e303ae A	381	#define vmmlFlgs 0x00000FFF /* Flags passed in in vmlava low order 12 bits */
	382	#define vmmlProt 0x00000007 /* Protection flags for the page */
	383	#define vmmlAdID 0x000003F0 /* Guest address space ID - used only if non-zero */
	384	#define vmmlRsvd 0x00000C08 /* Reserved for future */
9bccf70c	385
1c79356b A	386	/*************************************************************************************
	387	Internal Emulation Types
	388	**************************************************************************************/
	389
55e303ae	390	#define kVmmMaxContexts 32
9bccf70c A	391	#define kVmmMaxUnmapPages 64
9bccf70c A	392	#define kVmmMaxMapPages 64
1c79356b	393
55e303ae	394	#pragma pack(4) /* Make sure the structure stays as we defined it */
1c79356b A	395	typedef struct vmmCntrlEntry { /* Virtual Machine Monitor control table entry */
	396	unsigned int vmmFlags; /* Assorted control flags */
	397	#define vmmInUse 0x80000000
	398	#define vmmInUseb 0
	399	#define vmmFloatCngd 0x40000000
	400	#define vmmFloatCngdb 1
	401	#define vmmVectCngd 0x20000000
	402	#define vmmVectCngdb 2
	403	#define vmmTimerPop 0x10000000
	404	#define vmmTimerPopb 3
d7e50217 A	405	#define vmmFAMmode 0x04000000
d7e50217 A	406	#define vmmFAMmodeb 5
0b4e3aa0 A	407	#define vmmXStop 0x00800000
0b4e3aa0 A	408	#define vmmXStopb 8
1c79356b A	409	#define vmmSpfSave 0x000000FF
1c79356b A	410	#define vmmSpfSaveb 24
55e303ae	411	unsigned int vmmXAFlgs; /* Extended Architecture flags */
1c79356b	412	vmm_state_page_t vmmContextKern; / Kernel address of context communications area */
55e303ae	413	ppnum_t vmmContextPhys; /* Physical address of context communications area */
1c79356b	414	vmm_state_page_t vmmContextUser; / User address of context communications area */
9bccf70c	415	facility_context vmmFacCtx; /* Header for vector and floating point contexts */
55e303ae	416	pmap_t vmmPmap; /* Last dispatched pmap */
0b4e3aa0	417	uint64_t vmmTimer; /* Last set timer value. Zero means unset */
d7e50217	418	unsigned int vmmFAMintercept; /* FAM intercepted exceptions */
1c79356b	419	} vmmCntrlEntry;
55e303ae	420	#pragma pack()
1c79356b	421
55e303ae	422	#pragma pack(4) /* Make sure the structure stays as we defined it */
1c79356b	423	typedef struct vmmCntrlTable { /* Virtual Machine Monitor Control table */
55e303ae A	424	unsigned int vmmGFlags; /* Global flags */
	425	#define vmmLastAdSp 0xFF /* Remember the address space that was mapped last */
	426	addr64_t vmmLastMap; /* Last vaddr mapping made */
	427	vmmCntrlEntry vmmc[kVmmMaxContexts]; /* One entry for each possible Virtual Machine Monitor context */
	428	pmap_t vmmAdsp[kVmmMaxContexts]; /* Guest address space pmaps */
1c79356b	429	} vmmCntrlTable;
55e303ae	430	#pragma pack()
1c79356b A	431
1c79356b A	432	/* function decls for kernel level routines... */
0b4e3aa0	433	extern void vmm_execute_vm(thread_act_t act, vmm_thread_index_t index);
1c79356b A	434	extern vmmCntrlEntry *vmm_get_entry(thread_act_t act, vmm_thread_index_t index);
	435	extern kern_return_t vmm_tear_down_context(thread_act_t act, vmm_thread_index_t index);
	436	extern kern_return_t vmm_get_float_state(thread_act_t act, vmm_thread_index_t index);
	437	extern kern_return_t vmm_get_vector_state(thread_act_t act, vmm_thread_index_t index);
	438	extern kern_return_t vmm_set_timer(thread_act_t act, vmm_thread_index_t index, unsigned int timerhi, unsigned int timerlo);
	439	extern kern_return_t vmm_get_timer(thread_act_t act, vmm_thread_index_t index);
	440	extern void vmm_tear_down_all(thread_act_t act);
55e303ae A	441	extern kern_return_t vmm_map_page(thread_act_t act, vmm_thread_index_t hindex, addr64_t cva,
	442	addr64_t ava, vm_prot_t prot);
	443	extern vmm_return_code_t vmm_map_execute(thread_act_t act, vmm_thread_index_t hindex, addr64_t cva,
	444	addr64_t ava, vm_prot_t prot);
	445	extern kern_return_t vmm_protect_page(thread_act_t act, vmm_thread_index_t hindex, addr64_t va,
0b4e3aa0	446	vm_prot_t prot);
55e303ae	447	extern vmm_return_code_t vmm_protect_execute(thread_act_t act, vmm_thread_index_t hindex, addr64_t va,
0b4e3aa0	448	vm_prot_t prot);
55e303ae A	449	extern addr64_t vmm_get_page_mapping(thread_act_t act, vmm_thread_index_t index,
	450	addr64_t va);
	451	extern kern_return_t vmm_unmap_page(thread_act_t act, vmm_thread_index_t index, addr64_t va);
1c79356b A	452	extern void vmm_unmap_all_pages(thread_act_t act, vmm_thread_index_t index);
1c79356b A	453	extern boolean_t vmm_get_page_dirty_flag(thread_act_t act, vmm_thread_index_t index,
55e303ae A	454	addr64_t va, unsigned int reset);
	455	extern kern_return_t vmm_set_XA(thread_act_t act, vmm_thread_index_t index, unsigned int xaflags);
	456	extern unsigned int vmm_get_XA(thread_act_t act, vmm_thread_index_t index);
1c79356b A	457	extern int vmm_get_features(struct savearea *);
	458	extern int vmm_get_version(struct savearea *);
	459	extern int vmm_init_context(struct savearea *);
	460	extern int vmm_dispatch(struct savearea *);
	461	extern int vmm_exit(thread_act_t act, struct savearea *);
	462	extern void vmm_force_exit(thread_act_t act, struct savearea *);
0b4e3aa0 A	463	extern int vmm_stop_vm(struct savearea *save);
	464	extern void vmm_timer_pop(thread_act_t act);
	465	extern void vmm_interrupt(ReturnHandler *rh, thread_act_t act);
55e303ae A	466	extern kern_return_t vmm_map_list(thread_act_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
55e303ae A	467	extern kern_return_t vmm_unmap_list(thread_act_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
d7e50217 A	468	extern vmm_return_code_t vmm_resume_guest(vmm_thread_index_t index, unsigned long pc,
	469	unsigned long vmmCntrl, unsigned long vmmCntrMaskl);
	470	extern vmm_return_code_t vmm_exit_to_host(vmm_thread_index_t index);
	471	extern unsigned long vmm_get_guest_register(vmm_thread_index_t index, unsigned long reg_index);
	472	extern vmm_return_code_t vmm_set_guest_register(vmm_thread_index_t index, unsigned long reg_index, unsigned long reg_value);
55e303ae	473	extern addr64_t vmm_max_addr(thread_act_t act);
1c79356b A	474
	475	#endif
	476