[apple/xnu.git] / osfmk / i386 / pal_routines.c

/*
 * Copyright (c) 2009-2010 Apple 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@
 */

/*
 * file: pal_routines.c
 *       Platform Abstraction Layer routines for bare-metal i386 and x86_64
 */


#include <kern/kern_types.h>
#include <mach/mach_types.h>
#include <kern/thread.h>
#include <kern/simple_lock.h>

#include <sys/kdebug.h>
#include <machine/pal_routines.h>
#include <i386/serial_io.h>
#include <i386/lapic.h>
#include <i386/proc_reg.h>
#include <i386/misc_protos.h>
#include <i386/machine_routines.h>
#include <i386/pmap.h>

//#define PAL_DEBUG 1
#ifdef PAL_DEBUG
#define DBG(x...)       kprintf("PAL_DBG: " x)
#else
#define DBG(x...)
#endif /* PAL_DEBUG */

extern void *gPEEFIRuntimeServices;
extern void *gPEEFISystemTable;

/* nanotime conversion information */
pal_rtc_nanotime_t pal_rtc_nanotime_info = {0,0,0,0,1,0};

/* APIC kext may use this to access xnu internal state */
struct pal_apic_table *apic_table = NULL;

decl_simple_lock_data(static , pal_efi_lock);
#ifdef __x86_64__
static pml4_entry_t IDPML4[PTE_PER_PAGE] __attribute__ ((aligned (4096)));
uint64_t	pal_efi_saved_cr0;
uint64_t	pal_efi_saved_cr3;
#endif


/* Serial routines */
int
pal_serial_init(void)
{
	return serial_init();
}

void
pal_serial_putc(char c)
{
	serial_putc(c);
}

int
pal_serial_getc(void)
{
	return serial_getc();
}


/* Generic routines */
void
pal_i386_init(void)
{
    simple_lock_init(&pal_efi_lock, 0);
}

void
pal_get_control_registers( pal_cr_t *cr0, pal_cr_t *cr2, 
			   pal_cr_t *cr3, pal_cr_t *cr4 )
{
	*cr0 = get_cr0();
	*cr2 = get_cr2();
	*cr3 = get_cr3_raw();
	*cr4 = get_cr4();
}


/*
 * define functions below here to ensure we have symbols for these,
 * even though they're not used on this platform.
 */
#undef pal_dbg_page_fault
void
pal_dbg_page_fault( thread_t thread __unused,
		    user_addr_t vaddr __unused,
		    kern_return_t kr __unused )
{
}

#undef pal_dbg_set_task_name
void
pal_dbg_set_task_name( task_t task __unused )
{
}

#undef pal_set_signal_delivery
void
pal_set_signal_delivery(thread_t thread __unused)
{
}

/* EFI thunks */
extern void
_pal_efi_call_in_64bit_mode_asm(uint64_t func,
                                struct pal_efi_registers *efi_reg,
                                void *stack_contents,
                                size_t stack_contents_size);

kern_return_t
pal_efi_call_in_64bit_mode(uint64_t func,
                           struct pal_efi_registers *efi_reg,
                           void *stack_contents,
                           size_t stack_contents_size, /* 16-byte multiple */
                           uint64_t *efi_status)
{
    DBG("pal_efi_call_in_64bit_mode(0x%016llx, %p, %p, %lu, %p)\n",
        func, efi_reg, stack_contents, stack_contents_size, efi_status);

    if (func == 0) {
        return KERN_INVALID_ADDRESS;
    }

    if ((efi_reg == NULL)
        || (stack_contents == NULL)
        || (stack_contents_size % 16 != 0)) {
        return KERN_INVALID_ARGUMENT;
    }

    if (!gPEEFISystemTable || !gPEEFIRuntimeServices) {
        return KERN_NOT_SUPPORTED;
    }

    if (func < VM_MIN_KERNEL_ADDRESS) {
        /*
         * EFI Runtime Services must be mapped in our address
         * space at an appropriate location.
         */
        return KERN_INVALID_ADDRESS;
    }

    _pal_efi_call_in_64bit_mode_asm(func,
                                    efi_reg,
                                    stack_contents,
                                    stack_contents_size);

    *efi_status = efi_reg->rax;

    return KERN_SUCCESS;
}

extern void
_pal_efi_call_in_32bit_mode_asm(uint32_t func,
                                struct pal_efi_registers *efi_reg,
                                void *stack_contents,
                                size_t stack_contents_size);

kern_return_t
pal_efi_call_in_32bit_mode(uint32_t func,
                           struct pal_efi_registers *efi_reg,
                           void *stack_contents,
                           size_t stack_contents_size, /* 16-byte multiple */
                           uint32_t *efi_status)
{
    DBG("pal_efi_call_in_32bit_mode(0x%08x, %p, %p, %lu, %p)\n",
	func, efi_reg, stack_contents, stack_contents_size, efi_status);

    if (func == 0) {
        return KERN_INVALID_ADDRESS;
    }

    if ((efi_reg == NULL)
        || (stack_contents == NULL)
        || (stack_contents_size % 16 != 0)) {
        return KERN_INVALID_ARGUMENT;
    }

    if (!gPEEFISystemTable || !gPEEFIRuntimeServices) {
        return KERN_NOT_SUPPORTED;
    }

    DBG("pal_efi_call_in_32bit_mode() efi_reg:\n");
    DBG("  rcx: 0x%016llx\n", efi_reg->rcx);
    DBG("  rdx: 0x%016llx\n", efi_reg->rdx);
    DBG("   r8: 0x%016llx\n", efi_reg->r8);
    DBG("   r9: 0x%016llx\n", efi_reg->r9);
    DBG("  rax: 0x%016llx\n", efi_reg->rax);

    DBG("pal_efi_call_in_32bit_mode() stack:\n");
#if PAL_DEBUG
    size_t i;
    for (i = 0; i < stack_contents_size; i += sizeof(uint32_t)) {
	uint32_t *p = (uint32_t *) ((uintptr_t)stack_contents + i);
	DBG("  %p: 0x%08x\n", p, *p);
    } 
#endif

#ifdef __x86_64__
    /*
     * Ensure no interruptions.
     * Taking a spinlock for serialization is technically unnecessary
     * because the EFIRuntime kext should serialize.
     */
    boolean_t istate = ml_set_interrupts_enabled(FALSE);
    simple_lock(&pal_efi_lock);

    /*
     * Switch to special page tables with the entire high kernel space
     * double-mapped into the bottom 4GB.
     *
     * NB: We assume that all data passed exchanged with RuntimeServices is
     * located in the 4GB of KVA based at VM_MIN_ADDRESS. In particular, kexts
     * loaded the basement (below VM_MIN_ADDRESS) cannot pass static data.
     * Kernel stack and heap space is OK.
     */
    MARK_CPU_IDLE(cpu_number());
    pal_efi_saved_cr3 = get_cr3_raw();
    pal_efi_saved_cr0 = get_cr0();
    IDPML4[KERNEL_PML4_INDEX] = IdlePML4[KERNEL_PML4_INDEX];
    IDPML4[0]		      = IdlePML4[KERNEL_PML4_INDEX];
    clear_ts();
    set_cr3_raw((uint64_t) ID_MAP_VTOP(IDPML4));
    
    swapgs();			/* Save kernel's GS base */

    /* Set segment state ready for compatibility mode */
    set_gs(NULL_SEG);
    set_fs(NULL_SEG);
    set_es(KERNEL_DS);
    set_ds(KERNEL_DS);
    set_ss(KERNEL_DS);

    _pal_efi_call_in_32bit_mode_asm(func,
                                    efi_reg,
                                    stack_contents,
                                    stack_contents_size);
    
    /* Restore NULL segment state */
    set_ss(NULL_SEG);
    set_es(NULL_SEG);
    set_ds(NULL_SEG);

    swapgs();			/* Restore kernel's GS base */

    /* Restore the 64-bit user GS base we just destroyed */
    wrmsr64(MSR_IA32_KERNEL_GS_BASE,
	    current_cpu_datap()->cpu_uber.cu_user_gs_base);

    /* End of mapping games */
    set_cr3_raw(pal_efi_saved_cr3);
    set_cr0(pal_efi_saved_cr0);
    MARK_CPU_ACTIVE(cpu_number());
    
    simple_unlock(&pal_efi_lock);
    ml_set_interrupts_enabled(istate);
#else
    _pal_efi_call_in_32bit_mode_asm(func,
                                    efi_reg,
                                    stack_contents,
                                    stack_contents_size);
#endif

    *efi_status = (uint32_t)efi_reg->rax;
    DBG("pal_efi_call_in_32bit_mode() efi_status: 0x%x\n", *efi_status);

    return KERN_SUCCESS;
}

/* wind-back a syscall instruction */
void
pal_syscall_restart(thread_t thread __unused, x86_saved_state_t *state)
{
	/* work out which flavour thread it is */
	if( is_saved_state32(state) )
	{
		x86_saved_state32_t	*regs32;
		regs32 = saved_state32(state);

		if (regs32->cs == SYSENTER_CS || regs32->cs == SYSENTER_TF_CS)
			regs32->eip -= 5;
		else
			regs32->eip -= 2;
	}
	else
	{
		x86_saved_state64_t	*regs64;

		assert( is_saved_state64(state) );
		regs64 = saved_state64(state);

		/* Only one instruction for 64-bit threads */
		regs64->isf.rip -= 2;
	}

}

/* Helper function to put the machine to sleep (or shutdown) */

boolean_t
pal_machine_sleep(uint8_t type_a __unused, uint8_t type_b __unused, uint32_t bit_position __unused, 
		uint32_t disable_mask __unused, uint32_t enable_mask __unused)
{
	return 0;
}


/* shouldn't be used on native */
void
pal_get_kern_regs( x86_saved_state_t *state )
{
	panic( "pal_get_kern_regs called. state %p\n", state );
}

void
pal_preemption_assert(void)
{
}

void
hibernate_pal_prepare(void)
{
}
Commit	Line	Data
6d2010ae A	1	/*
	2	* Copyright (c) 2009-2010 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	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.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	/*
	30	* file: pal_routines.c
	31	* Platform Abstraction Layer routines for bare-metal i386 and x86_64
	32	*/
	33
	34
	35	#include <kern/kern_types.h>
	36	#include <mach/mach_types.h>
	37	#include <kern/thread.h>
	38	#include <kern/simple_lock.h>
	39
	40	#include <sys/kdebug.h>
	41	#include <machine/pal_routines.h>
	42	#include <i386/serial_io.h>
	43	#include <i386/lapic.h>
	44	#include <i386/proc_reg.h>
	45	#include <i386/misc_protos.h>
	46	#include <i386/machine_routines.h>
	47	#include <i386/pmap.h>
	48
	49	//#define PAL_DEBUG 1
	50	#ifdef PAL_DEBUG
	51	#define DBG(x...) kprintf("PAL_DBG: " x)
	52	#else
	53	#define DBG(x...)
	54	#endif /* PAL_DEBUG */
	55
	56	extern void *gPEEFIRuntimeServices;
	57	extern void *gPEEFISystemTable;
	58
	59	/* nanotime conversion information */
	60	pal_rtc_nanotime_t pal_rtc_nanotime_info = {0,0,0,0,1,0};
	61
	62	/* APIC kext may use this to access xnu internal state */
	63	struct pal_apic_table *apic_table = NULL;
	64
65	decl_simple_lock_data(static , pal_efi_lock);
66	#ifdef __x86_64__
316670eb	67	static pml4_entry_t IDPML4[PTE_PER_PAGE] __attribute__ ((aligned (4096)));
6d2010ae A	68	uint64_t pal_efi_saved_cr0;
	69	uint64_t pal_efi_saved_cr3;
	70	#endif
	71
	72
	73	/* Serial routines */
	74	int
	75	pal_serial_init(void)
	76	{
	77	return serial_init();
	78	}
	79
	80	void
	81	pal_serial_putc(char c)
	82	{
	83	serial_putc(c);
	84	}
	85
	86	int
	87	pal_serial_getc(void)
	88	{
	89	return serial_getc();
	90	}
	91
	92
	93	/* Generic routines */
	94	void
	95	pal_i386_init(void)
	96	{
	97	simple_lock_init(&pal_efi_lock, 0);
	98	}
	99
	100	void
	101	pal_get_control_registers( pal_cr_t cr0, pal_cr_t cr2,
	102	pal_cr_t cr3, pal_cr_t cr4 )
	103	{
	104	*cr0 = get_cr0();
	105	*cr2 = get_cr2();
	106	*cr3 = get_cr3_raw();
	107	*cr4 = get_cr4();
	108	}
	109
	110
	111	/*
	112	* define functions below here to ensure we have symbols for these,
	113	* even though they're not used on this platform.
	114	*/
	115	#undef pal_dbg_page_fault
	116	void
	117	pal_dbg_page_fault( thread_t thread __unused,
	118	user_addr_t vaddr __unused,
	119	kern_return_t kr __unused )
	120	{
	121	}
	122
	123	#undef pal_dbg_set_task_name
	124	void
	125	pal_dbg_set_task_name( task_t task __unused )
	126	{
	127	}
	128
	129	#undef pal_set_signal_delivery
	130	void
	131	pal_set_signal_delivery(thread_t thread __unused)
132	{
133	}
134
135	/* EFI thunks */
136	extern void
137	_pal_efi_call_in_64bit_mode_asm(uint64_t func,
138	struct pal_efi_registers *efi_reg,
139	void *stack_contents,
140	size_t stack_contents_size);
141
142	kern_return_t
143	pal_efi_call_in_64bit_mode(uint64_t func,
144	struct pal_efi_registers *efi_reg,
145	void *stack_contents,
146	size_t stack_contents_size, /* 16-byte multiple */
147	uint64_t *efi_status)
148	{
149	DBG("pal_efi_call_in_64bit_mode(0x%016llx, %p, %p, %lu, %p)\n",
150	func, efi_reg, stack_contents, stack_contents_size, efi_status);
151
152	if (func == 0) {
153	return KERN_INVALID_ADDRESS;
154	}
155
156	if ((efi_reg == NULL)
157	\|\| (stack_contents == NULL)
158	\|\| (stack_contents_size % 16 != 0)) {
159	return KERN_INVALID_ARGUMENT;
160	}
161
162	if (!gPEEFISystemTable \|\| !gPEEFIRuntimeServices) {
163	return KERN_NOT_SUPPORTED;
164	}
165
316670eb A	166	if (func < VM_MIN_KERNEL_ADDRESS) {
	167	/*
	168	* EFI Runtime Services must be mapped in our address
	169	* space at an appropriate location.
	170	*/
	171	return KERN_INVALID_ADDRESS;
	172	}
	173
6d2010ae A	174	_pal_efi_call_in_64bit_mode_asm(func,
	175	efi_reg,
	176	stack_contents,
	177	stack_contents_size);
	178
	179	*efi_status = efi_reg->rax;
	180
	181	return KERN_SUCCESS;
	182	}
	183
	184	extern void
	185	_pal_efi_call_in_32bit_mode_asm(uint32_t func,
	186	struct pal_efi_registers *efi_reg,
	187	void *stack_contents,
	188	size_t stack_contents_size);
	189
	190	kern_return_t
	191	pal_efi_call_in_32bit_mode(uint32_t func,
	192	struct pal_efi_registers *efi_reg,
	193	void *stack_contents,
	194	size_t stack_contents_size, /* 16-byte multiple */
	195	uint32_t *efi_status)
	196	{
	197	DBG("pal_efi_call_in_32bit_mode(0x%08x, %p, %p, %lu, %p)\n",
	198	func, efi_reg, stack_contents, stack_contents_size, efi_status);
	199
	200	if (func == 0) {
	201	return KERN_INVALID_ADDRESS;
	202	}
	203
	204	if ((efi_reg == NULL)
	205	\|\| (stack_contents == NULL)
	206	\|\| (stack_contents_size % 16 != 0)) {
	207	return KERN_INVALID_ARGUMENT;
	208	}
	209
	210	if (!gPEEFISystemTable \|\| !gPEEFIRuntimeServices) {
	211	return KERN_NOT_SUPPORTED;
	212	}
	213
	214	DBG("pal_efi_call_in_32bit_mode() efi_reg:\n");
	215	DBG(" rcx: 0x%016llx\n", efi_reg->rcx);
	216	DBG(" rdx: 0x%016llx\n", efi_reg->rdx);
	217	DBG(" r8: 0x%016llx\n", efi_reg->r8);
	218	DBG(" r9: 0x%016llx\n", efi_reg->r9);
	219	DBG(" rax: 0x%016llx\n", efi_reg->rax);
	220
	221	DBG("pal_efi_call_in_32bit_mode() stack:\n");
	222	#if PAL_DEBUG
	223	size_t i;
	224	for (i = 0; i < stack_contents_size; i += sizeof(uint32_t)) {
	225	uint32_t p = (uint32_t ) ((uintptr_t)stack_contents + i);
	226	DBG(" %p: 0x%08x\n", p, *p);
	227	}
	228	#endif
	229
	230	#ifdef __x86_64__
	231	/*
	232	* Ensure no interruptions.
	233	* Taking a spinlock for serialization is technically unnecessary
	234	* because the EFIRuntime kext should serialize.
	235	*/
	236	boolean_t istate = ml_set_interrupts_enabled(FALSE);
	237	simple_lock(&pal_efi_lock);
238
239	/*
240	* Switch to special page tables with the entire high kernel space
241	* double-mapped into the bottom 4GB.
242	*
243	* NB: We assume that all data passed exchanged with RuntimeServices is
244	* located in the 4GB of KVA based at VM_MIN_ADDRESS. In particular, kexts
245	* loaded the basement (below VM_MIN_ADDRESS) cannot pass static data.
246	* Kernel stack and heap space is OK.
247	*/
248	MARK_CPU_IDLE(cpu_number());
249	pal_efi_saved_cr3 = get_cr3_raw();
250	pal_efi_saved_cr0 = get_cr0();
316670eb A	251	IDPML4[KERNEL_PML4_INDEX] = IdlePML4[KERNEL_PML4_INDEX];
316670eb A	252	IDPML4[0] = IdlePML4[KERNEL_PML4_INDEX];
6d2010ae A	253	clear_ts();
	254	set_cr3_raw((uint64_t) ID_MAP_VTOP(IDPML4));
	255
	256	swapgs(); /* Save kernel's GS base */
	257
	258	/* Set segment state ready for compatibility mode */
	259	set_gs(NULL_SEG);
	260	set_fs(NULL_SEG);
	261	set_es(KERNEL_DS);
	262	set_ds(KERNEL_DS);
	263	set_ss(KERNEL_DS);
	264
	265	_pal_efi_call_in_32bit_mode_asm(func,
	266	efi_reg,
	267	stack_contents,
	268	stack_contents_size);
	269
	270	/* Restore NULL segment state */
	271	set_ss(NULL_SEG);
	272	set_es(NULL_SEG);
	273	set_ds(NULL_SEG);
	274
	275	swapgs(); /* Restore kernel's GS base */
	276
	277	/* Restore the 64-bit user GS base we just destroyed */
	278	wrmsr64(MSR_IA32_KERNEL_GS_BASE,
	279	current_cpu_datap()->cpu_uber.cu_user_gs_base);
	280
	281	/* End of mapping games */
	282	set_cr3_raw(pal_efi_saved_cr3);
	283	set_cr0(pal_efi_saved_cr0);
	284	MARK_CPU_ACTIVE(cpu_number());
	285
	286	simple_unlock(&pal_efi_lock);
	287	ml_set_interrupts_enabled(istate);
	288	#else
	289	_pal_efi_call_in_32bit_mode_asm(func,
	290	efi_reg,
	291	stack_contents,
	292	stack_contents_size);
	293	#endif
	294
	295	*efi_status = (uint32_t)efi_reg->rax;
	296	DBG("pal_efi_call_in_32bit_mode() efi_status: 0x%x\n", *efi_status);
	297
	298	return KERN_SUCCESS;
	299	}
	300
	301	/* wind-back a syscall instruction */
	302	void
	303	pal_syscall_restart(thread_t thread __unused, x86_saved_state_t *state)
	304	{
	305	/* work out which flavour thread it is */
	306	if( is_saved_state32(state) )
	307	{
	308	x86_saved_state32_t *regs32;
	309	regs32 = saved_state32(state);
	310
	311	if (regs32->cs == SYSENTER_CS \|\| regs32->cs == SYSENTER_TF_CS)
	312	regs32->eip -= 5;
	313	else
	314	regs32->eip -= 2;
	315	}
	316	else
317	{
318	x86_saved_state64_t *regs64;
319
320	assert( is_saved_state64(state) );
321	regs64 = saved_state64(state);
322
323	/* Only one instruction for 64-bit threads */
324	regs64->isf.rip -= 2;
325	}
326
327	}
328
329	/* Helper function to put the machine to sleep (or shutdown) */
330
331	boolean_t
332	pal_machine_sleep(uint8_t type_a __unused, uint8_t type_b __unused, uint32_t bit_position __unused,
333	uint32_t disable_mask __unused, uint32_t enable_mask __unused)
334	{
335	return 0;
336	}
337
338
339	/* shouldn't be used on native */
340	void
341	pal_get_kern_regs( x86_saved_state_t *state )
342	{
343	panic( "pal_get_kern_regs called. state %p\n", state );
344	}
345
346	void
347	pal_preemption_assert(void)
348	{
349	}
350
351	void
352	hibernate_pal_prepare(void)
353	{
354	}