[apple/xnu.git] / osfmk / i386 / postcode.h

/*
 * Copyright (c) 2008 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef	_I386_POSTCODE_H_
#define	_I386_POSTCODE_H_

/*
 * Postcodes are no longer enabled by default in the DEBUG kernel
 * because platforms may not have builtin port 0x80 support.
 * To re-enable postcode outpout, uncomment the following define:
 */
//#define DEBUG_POSTCODE 1

/* Define this to delay about 1 sec after posting each code */
//#define POSTCODE_DELAY 1

/* The POSTCODE is port 0x80 */
#define	POSTPORT 0x80

#define	SPINCOUNT	300000000
#define CPU_PAUSE()	rep; nop

#if DEBUG_POSTCODE
/*
 * Macro to output byte value to postcode, destoying register al.
 * Additionally, if POSTCODE_DELAY, spin for about a second.
 */
#if POSTCODE_DELAY
#define POSTCODE_AL			\
        outb    %al,$(POSTPORT);	\
	movl	$(SPINCOUNT), %eax;	\
1:					\
	CPU_PAUSE();			\
	decl	%eax;			\
	jne	1b
#define POSTCODE_AX			\
        outw    %ax,$(POSTPORT);	\
	movl	$(SPINCOUNT), %eax;	\
1:					\
	CPU_PAUSE();			\
	decl	%eax;			\
	jne	1b
#else
#define POSTCODE_AL			\
        outb    %al,$(POSTPORT)
#define POSTCODE_AX			\
        outw    %ax,$(POSTPORT)
#endif /* POSTCODE_DELAY */

#define POSTCODE(XX)			\
	mov	$(XX), %al;		\
	POSTCODE_AL

#define POSTCODE2(XXXX)			\
	mov	$(XXXX), %ax;		\
	POSTCODE_AX

/* Output byte value to postcode, without destoying register eax */ 
#define	POSTCODE_SAVE_EAX(XX)		\
	push	%eax;			\
	POSTCODE(XX);			\
	pop	%eax

/*
 * Display a 32-bit value to the post card - low byte to high byte
 * Entry: value in %ebx
 * Exit: %ebx preserved; %eax destroyed
 */ 
#define POSTCODE32_EBX			\
	roll	$8, %ebx;		\
	movl	%ebx, %eax;		\
	POSTCODE_AL;			\
					\
	roll	$8, %ebx;		\
	movl	%ebx, %eax;		\
	POSTCODE_AL;			\
					\
	roll	$8, %ebx;		\
	movl	%ebx, %eax;		\
	POSTCODE_AL;			\
					\
	roll	$8, %ebx;		\
	movl	%ebx, %eax;		\
	POSTCODE_AL

#else	/* DEBUG_POSTCODE */
#define POSTCODE_AL
#define POSTCODE_AX
#define POSTCODE(X)
#define POSTCODE2(X)
#define POSTCODE_SAVE_EAX(X)
#define POSTCODE32_EBX
#endif	/* DEBUG_POSTCODE */

/*
 * The following postcodes are defined for stages of early startup:
 */

#define	PSTART_ENTRY			0xFF
#define PSTART_REBASE			0xFE
#define PSTART_BEFORE_PAGING		0xFE
#define	PSTART_VSTART			0xFD
#define VSTART_ENTRY			0xFC
#define VSTART_IDT_INIT			0xFB
#define VSTART_IDLE_PTS_INIT		0xFA
#define VSTART_PHYSMAP_INIT		0xF9
#define VSTART_DESC_ALIAS_INIT		0xF8
#define VSTART_SET_CR3			0xF7
#define VSTART_CPU_DESC_INIT		0xF6
#define VSTART_CPU_MODE_INIT		0xF5
#define VSTART_EXIT			0xF4
#define	I386_INIT_ENTRY			0xF3
#define	CPU_INIT_D			0xF2
#define	PE_INIT_PLATFORM_D		0xF1

#define	SLAVE_STARTPROG_ENTRY		0xEF
#define	SLAVE_PSTART			0xEE
#define	I386_INIT_SLAVE			0xED

#define	PANIC_DOUBLE_FAULT		0xDF	/* Double Fault exception */
#define	PANIC_MACHINE_CHECK		0xDC	/* Machine-Check */
#define	MP_KDP_ENTER			0xDB	/* Debugger Begin */
#define	MP_KDP_EXIT			0xDE	/* Debugger End */
#define	PANIC_HLT			0xD1	/* Die an early death */ 
#define	BOOT_TRAP_HLT			0xD0	/* D'oh! even earlier */ 

#define ACPI_WAKE_START_ENTRY		0xCF
#define ACPI_WAKE_PROT_ENTRY		0xCE
#define ACPI_WAKE_PAGED_ENTRY		0xCD

#define CPU_DESC_LOAD_ENTRY		0xBF
#define CPU_DESC_LOAD_GS_BASE		0xBE
#define CPU_DESC_LOAD_KERNEL_GS_BASE	0xBD
#define CPU_DESC_LOAD_GDT		0xBC
#define CPU_DESC_LOAD_IDT		0xBB
#define CPU_DESC_LOAD_LDT		0xBA
#define CPU_DESC_LOAD_TSS		0xB9
#define CPU_DESC_LOAD_EXIT		0xB7

#ifndef ASSEMBLER
inline static void
_postcode_delay(uint32_t	spincount)
{
	asm volatile("1:			\n\t"
	             "  rep; nop;		\n\t"	
		     "  decl %%eax;		\n\t"
		     "  jne 1b"
		     : : "a" (spincount));
}
inline static void
_postcode(uint8_t	xx)
{
	asm volatile("outb %0, %1" : : "a" (xx), "N" (POSTPORT));
}
inline static void
_postcode2(uint16_t	xxxx)
{
	asm volatile("outw %0, %1" : : "a" (xxxx), "N" (POSTPORT));
}
#if	DEBUG_POSTCODE
inline static void
postcode(uint8_t	xx)
{
	_postcode(xx);
#if	POSTCODE_DELAY
	_postcode_delay(SPINCOUNT);
#endif
}
inline static void
postcode2(uint8_t	xxxx)
{
	_postcode2(xxxx);
#if	POSTCODE_DELAY
	_postcode_delay(SPINCOUNT);
#endif
}
#else
#define postcode(xx) do {} while(0)
#define postcode2(xxxx) do {} while(0)
#endif
#endif

#endif /* _I386_POSTCODE_H_ */
Commit	Line	Data
91447636	1	/*
b0d623f7	2	* Copyright (c) 2008 Apple Computer, Inc. All rights reserved.
91447636	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636 A	27	*/
	28
	29	#ifndef _I386_POSTCODE_H_
	30	#define _I386_POSTCODE_H_
	31
15129b1c A	32	/*
	33	* Postcodes are no longer enabled by default in the DEBUG kernel
	34	* because platforms may not have builtin port 0x80 support.
	35	* To re-enable postcode outpout, uncomment the following define:
	36	*/
	37	//#define DEBUG_POSTCODE 1
	38
91447636	39	/* Define this to delay about 1 sec after posting each code */
2d21ac55	40	//#define POSTCODE_DELAY 1
91447636 A	41
	42	/* The POSTCODE is port 0x80 */
	43	#define POSTPORT 0x80
	44
0c530ab8	45	#define SPINCOUNT 300000000
91447636 A	46	#define CPU_PAUSE() rep; nop
91447636 A	47
15129b1c	48	#if DEBUG_POSTCODE
91447636 A	49	/*
	50	* Macro to output byte value to postcode, destoying register al.
	51	* Additionally, if POSTCODE_DELAY, spin for about a second.
	52	*/
	53	#if POSTCODE_DELAY
	54	#define POSTCODE_AL \
	55	outb %al,$(POSTPORT); \
	56	movl $(SPINCOUNT), %eax; \
	57	1: \
	58	CPU_PAUSE(); \
	59	decl %eax; \
	60	jne 1b
b0d623f7 A	61	#define POSTCODE_AX \
	62	outw %ax,$(POSTPORT); \
	63	movl $(SPINCOUNT), %eax; \
	64	1: \
	65	CPU_PAUSE(); \
	66	decl %eax; \
	67	jne 1b
91447636 A	68	#else
	69	#define POSTCODE_AL \
	70	outb %al,$(POSTPORT)
b0d623f7 A	71	#define POSTCODE_AX \
b0d623f7 A	72	outw %ax,$(POSTPORT)
91447636 A	73	#endif /* POSTCODE_DELAY */
	74
	75	#define POSTCODE(XX) \
	76	mov $(XX), %al; \
	77	POSTCODE_AL
	78
b0d623f7 A	79	#define POSTCODE2(XXXX) \
	80	mov $(XXXX), %ax; \
	81	POSTCODE_AX
	82
91447636 A	83	/* Output byte value to postcode, without destoying register eax */
	84	#define POSTCODE_SAVE_EAX(XX) \
	85	push %eax; \
	86	POSTCODE(XX); \
	87	pop %eax
	88
	89	/*
	90	* Display a 32-bit value to the post card - low byte to high byte
	91	* Entry: value in %ebx
	92	* Exit: %ebx preserved; %eax destroyed
	93	*/
	94	#define POSTCODE32_EBX \
	95	roll $8, %ebx; \
	96	movl %ebx, %eax; \
	97	POSTCODE_AL; \
	98	\
	99	roll $8, %ebx; \
	100	movl %ebx, %eax; \
	101	POSTCODE_AL; \
	102	\
	103	roll $8, %ebx; \
	104	movl %ebx, %eax; \
	105	POSTCODE_AL; \
	106	\
	107	roll $8, %ebx; \
	108	movl %ebx, %eax; \
	109	POSTCODE_AL
	110
15129b1c	111	#else /* DEBUG_POSTCODE */
91447636	112	#define POSTCODE_AL
b0d623f7	113	#define POSTCODE_AX
91447636	114	#define POSTCODE(X)
b0d623f7 A	115	#define POSTCODE2(X)
b0d623f7 A	116	#define POSTCODE_SAVE_EAX(X)
91447636	117	#define POSTCODE32_EBX
15129b1c	118	#endif /* DEBUG_POSTCODE */
91447636 A	119
	120	/*
	121	* The following postcodes are defined for stages of early startup:
	122	*/
	123
316670eb A	124	#define PSTART_ENTRY 0xFF
	125	#define PSTART_REBASE 0xFE
	126	#define PSTART_BEFORE_PAGING 0xFE
	127	#define PSTART_VSTART 0xFD
	128	#define VSTART_ENTRY 0xFC
5ba3f43e A	129	#define VSTART_IDT_INIT 0xFB
	130	#define VSTART_IDLE_PTS_INIT 0xFA
	131	#define VSTART_PHYSMAP_INIT 0xF9
	132	#define VSTART_DESC_ALIAS_INIT 0xF8
	133	#define VSTART_SET_CR3 0xF7
	134	#define VSTART_CPU_DESC_INIT 0xF6
	135	#define VSTART_CPU_MODE_INIT 0xF5
	136	#define VSTART_EXIT 0xF4
	137	#define I386_INIT_ENTRY 0xF3
	138	#define CPU_INIT_D 0xF2
	139	#define PE_INIT_PLATFORM_D 0xF1
316670eb A	140
	141	#define SLAVE_STARTPROG_ENTRY 0xEF
	142	#define SLAVE_PSTART 0xEE
	143	#define I386_INIT_SLAVE 0xED
0c530ab8 A	144
0c530ab8 A	145	#define PANIC_DOUBLE_FAULT 0xDF /* Double Fault exception */
5ba3f43e A	146	#define PANIC_MACHINE_CHECK 0xDC /* Machine-Check */
	147	#define MP_KDP_ENTER 0xDB /* Debugger Begin */
	148	#define MP_KDP_EXIT 0xDE /* Debugger End */
0c530ab8	149	#define PANIC_HLT 0xD1 /* Die an early death */
5ba3f43e	150	#define BOOT_TRAP_HLT 0xD0 /* D'oh! even earlier */
0c530ab8 A	151
	152	#define ACPI_WAKE_START_ENTRY 0xCF
	153	#define ACPI_WAKE_PROT_ENTRY 0xCE
	154	#define ACPI_WAKE_PAGED_ENTRY 0xCD
	155
5ba3f43e A	156	#define CPU_DESC_LOAD_ENTRY 0xBF
	157	#define CPU_DESC_LOAD_GS_BASE 0xBE
	158	#define CPU_DESC_LOAD_KERNEL_GS_BASE 0xBD
	159	#define CPU_DESC_LOAD_GDT 0xBC
	160	#define CPU_DESC_LOAD_IDT 0xBB
	161	#define CPU_DESC_LOAD_LDT 0xBA
	162	#define CPU_DESC_LOAD_TSS 0xB9
	163	#define CPU_DESC_LOAD_EXIT 0xB7
91447636 A	164
	165	#ifndef ASSEMBLER
	166	inline static void
	167	_postcode_delay(uint32_t spincount)
	168	{
	169	asm volatile("1: \n\t"
	170	" rep; nop; \n\t"
	171	" decl %%eax; \n\t"
	172	" jne 1b"
	173	: : "a" (spincount));
	174	}
	175	inline static void
	176	_postcode(uint8_t xx)
	177	{
	178	asm volatile("outb %0, %1" : : "a" (xx), "N" (POSTPORT));
	179	}
b0d623f7 A	180	inline static void
	181	_postcode2(uint16_t xxxx)
	182	{
	183	asm volatile("outw %0, %1" : : "a" (xxxx), "N" (POSTPORT));
	184	}
15129b1c	185	#if DEBUG_POSTCODE
91447636 A	186	inline static void
	187	postcode(uint8_t xx)
	188	{
	189	_postcode(xx);
	190	#if POSTCODE_DELAY
	191	_postcode_delay(SPINCOUNT);
	192	#endif
	193	}
b0d623f7 A	194	inline static void
	195	postcode2(uint8_t xxxx)
	196	{
	197	_postcode2(xxxx);
	198	#if POSTCODE_DELAY
	199	_postcode_delay(SPINCOUNT);
	200	#endif
	201	}
91447636	202	#else
2d21ac55	203	#define postcode(xx) do {} while(0)
b0d623f7	204	#define postcode2(xxxx) do {} while(0)
91447636 A	205	#endif
	206	#endif
	207
	208	#endif /* _I386_POSTCODE_H_ */