[apple/xnu.git] / osfmk / ppc / atomic_switch.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@
 */
typedef unsigned char	UInt8;
typedef unsigned short	UInt16;
typedef unsigned long	UInt32;


/* Support firmware CallPseudoKernel architectural extension */

struct CallPseudoKernelDescriptor {
	UInt32				pc;
	UInt32				gpr0;
	UInt32				intControlAddr;
	UInt32				newState;
	UInt32				intStateMask;
	UInt32				intCR2Mask;
	UInt32				intCR2Shift;
	UInt32				sysContextState;
};
typedef struct CallPseudoKernelDescriptor CallPseudoKernelDescriptor;
typedef CallPseudoKernelDescriptor * CallPseudoKernelDescriptorPtr;
typedef CallPseudoKernelDescriptor CPKD_t;


/* Support firmware ExitPseudoKernel architectural extension */

struct ExitPseudoKernelDescriptor {
	UInt32				pc;
	UInt32				sp;
	UInt32				gpr0;
	UInt32				gpr3;
	UInt32				cr;
	UInt32				intControlAddr;
	UInt32				newState;
	UInt32				intStateMask;
	UInt32				intCR2Mask;
	UInt32				intCR2Shift;
	UInt32				sysContextState;
	UInt32				intPendingMask;
	UInt32				intPendingPC;
	UInt32				msrUpdate;
};
typedef struct ExitPseudoKernelDescriptor ExitPseudoKernelDescriptor;
typedef ExitPseudoKernelDescriptor * ExitPseudoKernelDescriptorPtr;
typedef ExitPseudoKernelDescriptor EPKD_t;


struct EmulatorDescriptor {
	UInt8		regMap[16];		// table mapping 68K D0..D7, A0..A7 register to PowerPC registers
	UInt32		bootstrapVersionOffset;	// offset within emulator data page of the bootstrap version string
	UInt32		ecbOffset;		// offset within emulator data page of the ECB
	UInt32		intModeLevelOffset;	// offset within emulator data page of the interrupt mode level
	UInt32		entryAddress;		// offset within text of the emulator's main entry point
	UInt32		kcallTrapTableOffset;	// offset within text of the nanokernel(!) call trap table
	UInt32		postIntMask;		// post interrupt mask
	UInt32		clearIntMask;		// clear interrupt mask
	UInt32		testIntMask;		// test interrupt mask
	UInt32		codeSize;		// total size of emulator object code (interpretive + DR)
	UInt32		hashTableSize;		// size of DR emulator's hash table
	UInt32		drCodeStartOffset;	// offset within text of the DR emulator's object code
	UInt32		drInitOffset;		// offset within DR emulator of its initialization entry point
	UInt32		drAllocateCache;	// offset within DR emulator of its cache allocation entry point
	UInt32		dispatchTableOffset;	// offset within text of the encoded instruction dispatch table 
};
typedef struct EmulatorDescriptor EmulatorDescriptor;
typedef EmulatorDescriptor *EmulatorDescriptorPtr;

	
enum {
											// The following define the UInt32 gInterruptState
	kInUninitialized	=	0,			// State not yet initialized
	kInPseudoKernel		=	1,			// Currently executing within pseudo kernel
	kInSystemContext	=	2,			// Currently executing within the system (emulator) context
	kInAlternateContext	=	3,			// Currently executing within an alternate (native) context
	kInExceptionHandler	=	4,			// Currently executing an exception handler
	kOutsideMain		=	5,			// Currently executing outside of the main thread
	kNotifyPending		=	6,			// Pending Notify Interrupt

	kInterruptStateMask	=	0x000F0000,	// Mask to extract interrupt state from gInterruptState
	kInterruptStateShift	=	16,			// Shift count to align interrupt state

	kBackupCR2Mask		=	0x0000000F,	// Mask to extract backup CR2 from gInterruptState
	kCR2ToBackupShift	=	31-11,		// Shift count to align CR2 into the backup CR2 of gInterruptState
											//  (and vice versa)
	kCR2Mask		=	0x00F00000  // Mask to extract CR2 from the PPC CR register 
};


enum {
	kcReturnFromException		= 0,	
	kcRunAlternateContext		= 1,
	kcResetSystem				= 2,
	kcVMDispatch				= 3,
	kcPrioritizeInterrupts		= 4,
	kcPowerDispatch				= 5,
	kcRTASDispatch				= 6,
	kcGetAdapterProcPtrsPPC		= 12,
	kcGetAdapterProcPtrs		= 13,
	kcCallAdapterProc			= 14,
	kcSystemCrash				= 15
};

#define bbMaxCode 16
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	typedef unsigned char UInt8;
	23	typedef unsigned short UInt16;
	24	typedef unsigned long UInt32;
	25
	26
	27	/* Support firmware CallPseudoKernel architectural extension */
	28
	29	struct CallPseudoKernelDescriptor {
	30	UInt32 pc;
	31	UInt32 gpr0;
	32	UInt32 intControlAddr;
	33	UInt32 newState;
	34	UInt32 intStateMask;
	35	UInt32 intCR2Mask;
	36	UInt32 intCR2Shift;
	37	UInt32 sysContextState;
	38	};
	39	typedef struct CallPseudoKernelDescriptor CallPseudoKernelDescriptor;
	40	typedef CallPseudoKernelDescriptor * CallPseudoKernelDescriptorPtr;
	41	typedef CallPseudoKernelDescriptor CPKD_t;
	42
	43
	44
	45	/* Support firmware ExitPseudoKernel architectural extension */
	46
	47	struct ExitPseudoKernelDescriptor {
	48	UInt32 pc;
	49	UInt32 sp;
	50	UInt32 gpr0;
	51	UInt32 gpr3;
	52	UInt32 cr;
	53	UInt32 intControlAddr;
	54	UInt32 newState;
	55	UInt32 intStateMask;
	56	UInt32 intCR2Mask;
	57	UInt32 intCR2Shift;
	58	UInt32 sysContextState;
	59	UInt32 intPendingMask;
	60	UInt32 intPendingPC;
	61	UInt32 msrUpdate;
	62	};
	63	typedef struct ExitPseudoKernelDescriptor ExitPseudoKernelDescriptor;
	64	typedef ExitPseudoKernelDescriptor * ExitPseudoKernelDescriptorPtr;
	65	typedef ExitPseudoKernelDescriptor EPKD_t;
	66
	67
	68	struct EmulatorDescriptor {
	69	UInt8 regMap[16]; // table mapping 68K D0..D7, A0..A7 register to PowerPC registers
	70	UInt32 bootstrapVersionOffset; // offset within emulator data page of the bootstrap version string
	71	UInt32 ecbOffset; // offset within emulator data page of the ECB
	72	UInt32 intModeLevelOffset; // offset within emulator data page of the interrupt mode level
	73	UInt32 entryAddress; // offset within text of the emulator's main entry point
	74	UInt32 kcallTrapTableOffset; // offset within text of the nanokernel(!) call trap table
	75	UInt32 postIntMask; // post interrupt mask
	76	UInt32 clearIntMask; // clear interrupt mask
	77	UInt32 testIntMask; // test interrupt mask
	78	UInt32 codeSize; // total size of emulator object code (interpretive + DR)
	79	UInt32 hashTableSize; // size of DR emulator's hash table
	80	UInt32 drCodeStartOffset; // offset within text of the DR emulator's object code
	81	UInt32 drInitOffset; // offset within DR emulator of its initialization entry point
	82	UInt32 drAllocateCache; // offset within DR emulator of its cache allocation entry point
83	UInt32 dispatchTableOffset; // offset within text of the encoded instruction dispatch table
84	};
85	typedef struct EmulatorDescriptor EmulatorDescriptor;
86	typedef EmulatorDescriptor *EmulatorDescriptorPtr;
87
88
89	enum {
90	// The following define the UInt32 gInterruptState
91	kInUninitialized = 0, // State not yet initialized
92	kInPseudoKernel = 1, // Currently executing within pseudo kernel
93	kInSystemContext = 2, // Currently executing within the system (emulator) context
94	kInAlternateContext = 3, // Currently executing within an alternate (native) context
95	kInExceptionHandler = 4, // Currently executing an exception handler
96	kOutsideMain = 5, // Currently executing outside of the main thread
97	kNotifyPending = 6, // Pending Notify Interrupt
98
99	kInterruptStateMask = 0x000F0000, // Mask to extract interrupt state from gInterruptState
100	kInterruptStateShift = 16, // Shift count to align interrupt state
101
102	kBackupCR2Mask = 0x0000000F, // Mask to extract backup CR2 from gInterruptState
103	kCR2ToBackupShift = 31-11, // Shift count to align CR2 into the backup CR2 of gInterruptState
104	// (and vice versa)
105	kCR2Mask = 0x00F00000 // Mask to extract CR2 from the PPC CR register
106	};
107
108
109	enum {
110	kcReturnFromException = 0,
111	kcRunAlternateContext = 1,
112	kcResetSystem = 2,
113	kcVMDispatch = 3,
114	kcPrioritizeInterrupts = 4,
115	kcPowerDispatch = 5,
116	kcRTASDispatch = 6,
117	kcGetAdapterProcPtrsPPC = 12,
118	kcGetAdapterProcPtrs = 13,
119	kcCallAdapterProc = 14,
120	kcSystemCrash = 15
121	};
122
123	#define bbMaxCode 16
124