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

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

#ifndef	_I386_MISC_PROTOS_H_
#define	_I386_MISC_PROTOS_H_

#include <machine/thread.h>

struct boot_args;
struct cpu_data;

extern	boolean_t virtualized;

extern void		vstart(vm_offset_t);
extern void		i386_init(void);
extern void		x86_init_wrapper(uintptr_t, uintptr_t) __attribute__((noreturn));
extern void		i386_vm_init(
				uint64_t,
				boolean_t,
				struct boot_args *);
#ifdef __i386__
extern void		cpu_IA32e_enable(struct cpu_data *);
extern void		cpu_IA32e_disable(struct cpu_data *);
extern void		ml_load_desc64(void);
extern void		ml_64bit_lldt(int);
#endif

#if NCOPY_WINDOWS > 0
extern void             cpu_userwindow_init(int);
extern void             cpu_physwindow_init(int);
#endif

extern void		machine_startup(void);

extern void		get_root_device(void);
extern void		picinit(void);
extern void		interrupt_processor(
				int		cpu);
extern void		mp_probe_cpus(void);
extern void		panic_io_port_read(void);

extern void		remote_kdb(void);
extern void		clear_kdb_intr(void);
extern void		cpu_init(void);
#ifdef __i386__
extern void		cpu_shutdown(void);
#endif
extern void		fix_desc(
				void		* desc,
				int		num_desc);
extern void		fix_desc64(
				void		* desc,
				int		num_desc);
extern void		cnpollc(
				boolean_t	on);
extern void		form_pic_mask(void);
extern void		intnull(
				int		unit);
extern char *		i386_boot_info(
				char		*buf,
				vm_size_t	buf_len);

extern void		blkclr(
			       const char	*from,
			       int		nbytes);

#ifdef __i386__
extern unsigned int	div_scale(
				unsigned int	dividend,
				unsigned int	divisor,
				unsigned int	*scale);

extern unsigned int	mul_scale(
				unsigned int	multiplicand,
				unsigned int	multiplier,
				unsigned int	*scale);
#endif

/* Move arbitrarily-aligned data from one physical address to another */
extern void bcopy_phys(addr64_t from, addr64_t to, vm_size_t nbytes);

/* allow a function to get a quick virtual mapping of a physical page */
extern int apply_func_phys(addr64_t src64, vm_size_t bytes, int (*func)(void * buffer, vm_size_t bytes, void * arg), void * arg);

extern void ml_copy_phys(addr64_t, addr64_t, vm_size_t);

/* Flush all cachelines for a page. */
extern void cache_flush_page_phys(ppnum_t pa);

/* Flushing for incoherent I/O */
extern void dcache_incoherent_io_flush64(addr64_t pa, unsigned int count);
extern void dcache_incoherent_io_store64(addr64_t pa, unsigned int count);


extern processor_t	cpu_processor_alloc(boolean_t is_boot_cpu);
extern void		cpu_processor_free(processor_t proc);

extern void		*chudxnu_cpu_alloc(boolean_t is_boot_cpu);
extern void		chudxnu_cpu_free(void *);

extern void		sysclk_gettime_interrupts_disabled(
				mach_timespec_t *cur_time);

extern void rtc_nanotime_init_commpage(void);

extern void	rtc_sleep_wakeup(uint64_t base);

extern void	rtc_timer_start(void);

extern void	rtc_clock_stepping(
			uint32_t new_frequency,
			uint32_t old_frequency);
extern void	rtc_clock_stepped(
			uint32_t new_frequency,
			uint32_t old_frequency);
extern void	rtc_clock_napped(uint64_t, uint64_t);
extern void	rtc_clock_adjust(uint64_t);

extern void     pmap_lowmem_finalize(void);

thread_t Switch_context(thread_t, thread_continue_t, thread_t);
thread_t Shutdown_context(thread_t thread, void (*doshutdown)(processor_t),processor_t  processor);

#ifdef __x86_64__
uint64_t x86_64_pre_sleep(void);
void x86_64_post_sleep(uint64_t new_cr3);
#endif

boolean_t 
debug_state_is_valid32(x86_debug_state32_t *ds);

boolean_t 
debug_state_is_valid64(x86_debug_state64_t *ds);

void 
copy_debug_state32(x86_debug_state32_t *src, x86_debug_state32_t *target, boolean_t all);

void 
copy_debug_state64(x86_debug_state64_t *src, x86_debug_state64_t *target, boolean_t all);

extern void act_machine_switch_pcb(thread_t old, thread_t new);

/* Fast-restart parameters */
#define FULL_SLAVE_INIT	(NULL)
#define FAST_SLAVE_INIT	((void *)(uintptr_t)1)

uint64_t ml_early_random(void);
#endif /* _I386_MISC_PROTOS_H_ */
Commit	Line	Data
1c79356b	1	/*
0b4c1975	2	* Copyright (c) 2000-2010 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31
0c530ab8 A	32	#ifndef _I386_MISC_PROTOS_H_
	33	#define _I386_MISC_PROTOS_H_
	34
b0d623f7	35	#include <machine/thread.h>
1c79356b	36
0c530ab8 A	37	struct boot_args;
	38	struct cpu_data;
	39
316670eb A	40	extern boolean_t virtualized;
316670eb A	41
b0d623f7	42	extern void vstart(vm_offset_t);
7ddcb079	43	extern void i386_init(void);
316670eb	44	extern void x86_init_wrapper(uintptr_t, uintptr_t) __attribute__((noreturn));
0c530ab8	45	extern void i386_vm_init(
2d21ac55 A	46	uint64_t,
	47	boolean_t,
	48	struct boot_args *);
b0d623f7	49	#ifdef __i386__
0c530ab8 A	50	extern void cpu_IA32e_enable(struct cpu_data *);
	51	extern void cpu_IA32e_disable(struct cpu_data *);
	52	extern void ml_load_desc64(void);
0c530ab8	53	extern void ml_64bit_lldt(int);
b0d623f7 A	54	#endif
	55
	56	#if NCOPY_WINDOWS > 0
2d21ac55 A	57	extern void cpu_userwindow_init(int);
2d21ac55 A	58	extern void cpu_physwindow_init(int);
b0d623f7	59	#endif
91447636 A	60
	61	extern void machine_startup(void);
	62
1c79356b A	63	extern void get_root_device(void);
1c79356b A	64	extern void picinit(void);
1c79356b A	65	extern void interrupt_processor(
	66	int cpu);
	67	extern void mp_probe_cpus(void);
0c530ab8	68	extern void panic_io_port_read(void);
2d21ac55	69
1c79356b A	70	extern void remote_kdb(void);
1c79356b A	71	extern void clear_kdb_intr(void);
91447636	72	extern void cpu_init(void);
b0d623f7	73	#ifdef __i386__
1c79356b	74	extern void cpu_shutdown(void);
b0d623f7	75	#endif
1c79356b A	76	extern void fix_desc(
	77	void * desc,
	78	int num_desc);
0c530ab8 A	79	extern void fix_desc64(
	80	void * desc,
	81	int num_desc);
1c79356b A	82	extern void cnpollc(
	83	boolean_t on);
	84	extern void form_pic_mask(void);
	85	extern void intnull(
	86	int unit);
	87	extern char * i386_boot_info(
	88	char *buf,
	89	vm_size_t buf_len);
	90
	91	extern void blkclr(
	92	const char *from,
	93	int nbytes);
	94
b0d623f7	95	#ifdef __i386__
1c79356b A	96	extern unsigned int div_scale(
	97	unsigned int dividend,
	98	unsigned int divisor,
	99	unsigned int *scale);
	100
	101	extern unsigned int mul_scale(
	102	unsigned int multiplicand,
	103	unsigned int multiplier,
	104	unsigned int *scale);
b0d623f7	105	#endif
0b4e3aa0 A	106
0b4e3aa0 A	107	/* Move arbitrarily-aligned data from one physical address to another */
55e303ae A	108	extern void bcopy_phys(addr64_t from, addr64_t to, vm_size_t nbytes);
55e303ae A	109
6d2010ae A	110	/* allow a function to get a quick virtual mapping of a physical page */
	111	extern int apply_func_phys(addr64_t src64, vm_size_t bytes, int (func)(void buffer, vm_size_t bytes, void * arg), void * arg);
	112
b0d623f7 A	113	extern void ml_copy_phys(addr64_t, addr64_t, vm_size_t);
b0d623f7 A	114
91447636 A	115	/* Flush all cachelines for a page. */
	116	extern void cache_flush_page_phys(ppnum_t pa);
	117
	118	/* Flushing for incoherent I/O */
	119	extern void dcache_incoherent_io_flush64(addr64_t pa, unsigned int count);
	120	extern void dcache_incoherent_io_store64(addr64_t pa, unsigned int count);
	121
	122
	123	extern processor_t cpu_processor_alloc(boolean_t is_boot_cpu);
	124	extern void cpu_processor_free(processor_t proc);
	125
0c530ab8 A	126	extern void *chudxnu_cpu_alloc(boolean_t is_boot_cpu);
	127	extern void chudxnu_cpu_free(void *);
	128
91447636 A	129	extern void sysclk_gettime_interrupts_disabled(
	130	mach_timespec_t *cur_time);
	131
0c530ab8	132	extern void rtc_nanotime_init_commpage(void);
6601e61a	133
0c530ab8	134	extern void rtc_sleep_wakeup(uint64_t base);
91447636	135
060df5ea	136	extern void rtc_timer_start(void);
91447636 A	137
	138	extern void rtc_clock_stepping(
	139	uint32_t new_frequency,
	140	uint32_t old_frequency);
	141	extern void rtc_clock_stepped(
	142	uint32_t new_frequency,
	143	uint32_t old_frequency);
4a3eedf9	144	extern void rtc_clock_napped(uint64_t, uint64_t);
0b4c1975	145	extern void rtc_clock_adjust(uint64_t);
91447636	146
b0d623f7	147	extern void pmap_lowmem_finalize(void);
0c530ab8	148
2d21ac55	149	thread_t Switch_context(thread_t, thread_continue_t, thread_t);
b0d623f7 A	150	thread_t Shutdown_context(thread_t thread, void (*doshutdown)(processor_t),processor_t processor);
	151
	152	#ifdef __x86_64__
	153	uint64_t x86_64_pre_sleep(void);
	154	void x86_64_post_sleep(uint64_t new_cr3);
	155	#endif
	156
	157	boolean_t
	158	debug_state_is_valid32(x86_debug_state32_t *ds);
	159
	160	boolean_t
	161	debug_state_is_valid64(x86_debug_state64_t *ds);
	162
	163	void
	164	copy_debug_state32(x86_debug_state32_t src, x86_debug_state32_t target, boolean_t all);
	165
	166	void
	167	copy_debug_state64(x86_debug_state64_t src, x86_debug_state64_t target, boolean_t all);
	168
6d2010ae A	169	extern void act_machine_switch_pcb(thread_t old, thread_t new);
6d2010ae A	170
b0d623f7 A	171	/* Fast-restart parameters */
	172	#define FULL_SLAVE_INIT (NULL)
	173	#define FAST_SLAVE_INIT ((void *)(uintptr_t)1)
0c530ab8	174
316670eb	175	uint64_t ml_early_random(void);
2d21ac55	176	#endif /* _I386_MISC_PROTOS_H_ */