/*
 * Copyright (c) 2003 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@
 */

#ifndef	_I386_POSTCODE_H_
#define	_I386_POSTCODE_H_

#ifndef DEBUG
#include <debug.h>
#endif

/* 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	100000000
#define CPU_PAUSE()	rep; nop

#if DEBUG
/*
 * 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
#else
#define POSTCODE_AL			\
        outb    %al,$(POSTPORT)
#endif /* POSTCODE_DELAY */

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

/* 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 */
#define POSTCODE_AL
#define POSTCODE(X)
#define POSTCODE32_EBX
#endif	/* DEBUG */

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

#define	PSTART_ENTRY		0xFF
#define PSTART_PAGE_TABLES	0xFE
#define PSTART_BEFORE_PAGING	0xFD
#define VSTART_ENTRY		0xFC
#define VSTART_STACK_SWITCH	0xFB
#define VSTART_EXIT		0xFA
#define	I386_INIT_ENTRY		0xF9
#define	CPU_INIT_D		0xF8
#define	PROCESSOR_BOOTSTRAP_D	0xF7
#define	PE_INIT_PLATFORM_D	0xF6
#define	THREAD_BOOTSTRAP_D	0xF5

#define	SLAVE_PSTART_ENTRY	0xEF
#define	REAL_TO_PROT_ENTRY	0xEE
#define	REAL_TO_PROT_EXIT	0xED
#define	STARTPROG_ENTRY		0xEC
#define	STARTPROG_EXIT		0xEB
#define	SLAVE_START_ENTRY	0xEA
#define	SLAVE_START_EXIT	0xE9
#define	SVSTART_ENTRY		0xE8
#define	SVSTART_DESC_INIT	0xE7
#define	SVSTART_STACK_SWITCH	0xE6
#define	SVSTART_EXIT		0xE5
#define	I386_INIT_SLAVE		0xE4

#define	MP_KDP_ENTER		0xDB		/* Machine in kdp DeBugger */
#define	PANIC_HLT		0xD1		/* Die an early death */ 

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

#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));
}
#if	DEBUG
inline static void
postcode(uint8_t	xx)
{
	_postcode(xx);
#if	POSTCODE_DELAY
	_postcode_delay(SPINCOUNT);
#endif
}
#else
#define postcode(xx)
#endif
#endif

#endif /* _I386_POSTCODE_H_ */