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

/*
 * Copyright (c) 2000-2009 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_MACHINE_ROUTINES_H_
#define	_I386_MACHINE_ROUTINES_H_

#include <mach/mach_types.h>
#include <mach/boolean.h>
#include <kern/kern_types.h>
#include <pexpert/pexpert.h>

#include <sys/cdefs.h>
#include <sys/appleapiopts.h>

__BEGIN_DECLS

#ifdef XNU_KERNEL_PRIVATE

/* are we a 64 bit platform ? */

boolean_t ml_is64bit(void);

/* is this a 64bit thread? */

boolean_t ml_thread_is64bit(thread_t);

/* is this a 64bit thread? */

boolean_t ml_state_is64bit(void *);

/* set state of fpu save area for signal handling */

void	ml_fp_setvalid(boolean_t);

void	ml_cpu_set_ldt(int);

/* Interrupt handling */

/* Initialize Interrupts */
void    ml_init_interrupt(void);

/* Generate a fake interrupt */
void ml_cause_interrupt(void);

/* Initialize Interrupts */
void ml_install_interrupt_handler(
    void *nub,
    int source,
    void *target,
    IOInterruptHandler handler,
    void *refCon);

void ml_get_timebase(unsigned long long *timestamp);
void ml_init_lock_timeout(void); 

vm_offset_t
ml_static_ptovirt(
	vm_offset_t);

void ml_static_mfree(
	vm_offset_t,
	vm_size_t);

/* boot memory allocation */
vm_offset_t ml_static_malloc(
	vm_size_t size);

/* virtual to physical on wired pages */
vm_offset_t ml_vtophys(
	vm_offset_t vaddr);

vm_size_t ml_nofault_copy(
	vm_offset_t virtsrc, vm_offset_t virtdst, vm_size_t size);

/* Machine topology info */
uint64_t ml_cpu_cache_size(unsigned int level);	
uint64_t ml_cpu_cache_sharing(unsigned int level);	

/* Initialize the maximum number of CPUs */
void ml_init_max_cpus(
	unsigned long max_cpus);

extern void	ml_cpu_up(void);
extern void	ml_cpu_down(void);

void bzero_phys_nc(
				   addr64_t phys_address,
				   uint32_t length);

#if	defined(PEXPERT_KERNEL_PRIVATE) || defined(MACH_KERNEL_PRIVATE)
/* IO memory map services */

/* Map memory map IO space */
vm_offset_t ml_io_map(
	vm_offset_t phys_addr, 
	vm_size_t size);


void	ml_get_bouncepool_info(
			       vm_offset_t *phys_addr,
			       vm_size_t   *size);
/* Indicates if spinlock, IPI and other timeouts should be suspended */
boolean_t machine_timeout_suspended(void);
#endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE  */

/* Warm up a CPU to receive an interrupt */
kern_return_t ml_interrupt_prewarm(uint64_t deadline);

#endif /* XNU_KERNEL_PRIVATE */

#ifdef KERNEL_PRIVATE

/* Type for the Time Base Enable function */
typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);

/* Type for the IPI Hander */
typedef void (*ipi_handler_t)(void);

/* Struct for ml_processor_register */
struct ml_processor_info {
	cpu_id_t			cpu_id;
	boolean_t			boot_cpu;
	vm_offset_t			start_paddr;
	boolean_t			supports_nap;
	unsigned long		l2cr_value;
	time_base_enable_t	time_base_enable;
};

typedef struct ml_processor_info ml_processor_info_t;


/* Register a processor */
kern_return_t
ml_processor_register(
        cpu_id_t        cpu_id,
        uint32_t        lapic_id,
        processor_t     *processor_out,
        boolean_t       boot_cpu,
	boolean_t       start );

/* PCI config cycle probing */
boolean_t ml_probe_read(
	vm_offset_t paddr,
	unsigned int *val);
boolean_t ml_probe_read_64(
	addr64_t paddr,
	unsigned int *val);

/* Read physical address byte */
unsigned int ml_phys_read_byte(
	vm_offset_t paddr);
unsigned int ml_phys_read_byte_64(
	addr64_t paddr);

/* Read physical address half word */
unsigned int ml_phys_read_half(
	vm_offset_t paddr);
unsigned int ml_phys_read_half_64(
	addr64_t paddr);

/* Read physical address word*/
unsigned int ml_phys_read(
	vm_offset_t paddr);
unsigned int ml_phys_read_64(
	addr64_t paddr);
unsigned int ml_phys_read_word(
	vm_offset_t paddr);
unsigned int ml_phys_read_word_64(
	addr64_t paddr);

/* Read physical address double word */
unsigned long long ml_phys_read_double(
	vm_offset_t paddr);
unsigned long long ml_phys_read_double_64(
	addr64_t paddr);

/* Write physical address byte */
void ml_phys_write_byte(
	vm_offset_t paddr, unsigned int data);
void ml_phys_write_byte_64(
	addr64_t paddr, unsigned int data);

/* Write physical address half word */
void ml_phys_write_half(
	vm_offset_t paddr, unsigned int data);
void ml_phys_write_half_64(
	addr64_t paddr, unsigned int data);

/* Write physical address word */
void ml_phys_write(
	vm_offset_t paddr, unsigned int data);
void ml_phys_write_64(
	addr64_t paddr, unsigned int data);
void ml_phys_write_word(
	vm_offset_t paddr, unsigned int data);
void ml_phys_write_word_64(
	addr64_t paddr, unsigned int data);

/* Write physical address double word */
void ml_phys_write_double(
	vm_offset_t paddr, unsigned long long data);
void ml_phys_write_double_64(
	addr64_t paddr, unsigned long long data);

/* Struct for ml_cpu_get_info */
struct ml_cpu_info {
	uint32_t	vector_unit;
	uint32_t	cache_line_size;
	uint32_t	l1_icache_size;
	uint32_t	l1_dcache_size;
	uint32_t	l2_settings;
	uint32_t	l2_cache_size;
	uint32_t	l3_settings;
	uint32_t	l3_cache_size;
};

typedef struct ml_cpu_info ml_cpu_info_t;

/* Get processor info */
void ml_cpu_get_info(ml_cpu_info_t *ml_cpu_info);

void ml_thread_policy(
	thread_t thread,
	unsigned policy_id,
	unsigned policy_info);

#define MACHINE_GROUP					0x00000001
#define MACHINE_NETWORK_GROUP			0x10000000
#define MACHINE_NETWORK_WORKLOOP		0x00000001
#define MACHINE_NETWORK_NETISR			0x00000002

/* Return the maximum number of CPUs set by ml_init_max_cpus() */
int ml_get_max_cpus(
	void);

/*
 * The following are in pmCPU.c not machine_routines.c.
 */
extern void ml_set_maxsnoop(uint32_t maxdelay);
extern unsigned ml_get_maxsnoop(void);
extern void ml_set_maxbusdelay(uint32_t mdelay);
extern uint32_t ml_get_maxbusdelay(void);
extern void ml_set_maxintdelay(uint64_t mdelay);
extern uint64_t ml_get_maxintdelay(void);
extern boolean_t ml_get_interrupt_prewake_applicable(void);


extern uint64_t tmrCvt(uint64_t time, uint64_t conversion);

extern uint64_t ml_cpu_int_event_time(void);

#endif /* KERNEL_PRIVATE */

/* Get Interrupts Enabled */
boolean_t ml_get_interrupts_enabled(void);

/* Set Interrupts Enabled */
boolean_t ml_set_interrupts_enabled(boolean_t enable);

/* Check if running at interrupt context */
boolean_t ml_at_interrupt_context(void);

/* Zero bytes starting at a physical address */
void bzero_phys(
	addr64_t phys_address,
	uint32_t length);

/* Bytes available on current stack */
vm_offset_t ml_stack_remaining(void);

#if CONFIG_COUNTERS
void ml_get_csw_threads(thread_t * /*old*/, thread_t * /*new*/);
#endif /* CONFIG_COUNTERS */

__END_DECLS

#ifdef	XNU_KERNEL_PRIVATE
boolean_t ml_fpu_avx_enabled(void);
void interrupt_latency_tracker_setup(void);
void interrupt_reset_latency_stats(void);
void interrupt_populate_latency_stats(char *, unsigned);

#endif /* XNU_KERNEL_PRIVATE */
#endif /* _I386_MACHINE_ROUTINES_H_ */
Commit	Line	Data
1c79356b	1	/*
b0d623f7	2	* Copyright (c) 2000-2009 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
	32	#ifndef _I386_MACHINE_ROUTINES_H_
	33	#define _I386_MACHINE_ROUTINES_H_
	34
	35	#include <mach/mach_types.h>
	36	#include <mach/boolean.h>
	37	#include <kern/kern_types.h>
	38	#include <pexpert/pexpert.h>
	39
91447636	40	#include <sys/cdefs.h>
9bccf70c	41	#include <sys/appleapiopts.h>
1c79356b	42
91447636 A	43	__BEGIN_DECLS
91447636 A	44
b0d623f7 A	45	#ifdef XNU_KERNEL_PRIVATE
b0d623f7 A	46
0c530ab8 A	47	/* are we a 64 bit platform ? */
	48
	49	boolean_t ml_is64bit(void);
	50
	51	/* is this a 64bit thread? */
	52
	53	boolean_t ml_thread_is64bit(thread_t);
	54
	55	/* is this a 64bit thread? */
	56
	57	boolean_t ml_state_is64bit(void *);
	58
	59	/* set state of fpu save area for signal handling */
	60
	61	void ml_fp_setvalid(boolean_t);
	62
	63	void ml_cpu_set_ldt(int);
	64
1c79356b A	65	/* Interrupt handling */
1c79356b A	66
55e303ae A	67	/* Initialize Interrupts */
	68	void ml_init_interrupt(void);
	69
1c79356b A	70	/* Generate a fake interrupt */
	71	void ml_cause_interrupt(void);
	72
b0d623f7 A	73	/* Initialize Interrupts */
	74	void ml_install_interrupt_handler(
	75	void *nub,
	76	int source,
	77	void *target,
	78	IOInterruptHandler handler,
	79	void *refCon);
	80
9bccf70c	81	void ml_get_timebase(unsigned long long *timestamp);
0c530ab8	82	void ml_init_lock_timeout(void);
d52fe63f	83
b0d623f7 A	84	vm_offset_t
	85	ml_static_ptovirt(
	86	vm_offset_t);
	87
	88	void ml_static_mfree(
	89	vm_offset_t,
	90	vm_size_t);
	91
	92	/* boot memory allocation */
	93	vm_offset_t ml_static_malloc(
	94	vm_size_t size);
	95
	96	/* virtual to physical on wired pages */
	97	vm_offset_t ml_vtophys(
	98	vm_offset_t vaddr);
	99
	100	vm_size_t ml_nofault_copy(
	101	vm_offset_t virtsrc, vm_offset_t virtdst, vm_size_t size);
	102
	103	/* Machine topology info */
	104	uint64_t ml_cpu_cache_size(unsigned int level);
	105	uint64_t ml_cpu_cache_sharing(unsigned int level);
	106
	107	/* Initialize the maximum number of CPUs */
	108	void ml_init_max_cpus(
	109	unsigned long max_cpus);
	110
	111	extern void ml_cpu_up(void);
	112	extern void ml_cpu_down(void);
	113
	114	void bzero_phys_nc(
	115	addr64_t phys_address,
	116	uint32_t length);
	117
	118	#if defined(PEXPERT_KERNEL_PRIVATE) \|\| defined(MACH_KERNEL_PRIVATE)
	119	/* IO memory map services */
	120
	121	/* Map memory map IO space */
	122	vm_offset_t ml_io_map(
	123	vm_offset_t phys_addr,
	124	vm_size_t size);
	125
b0d623f7 A	126
	127	void ml_get_bouncepool_info(
	128	vm_offset_t *phys_addr,
	129	vm_size_t *size);
060df5ea A	130	/* Indicates if spinlock, IPI and other timeouts should be suspended */
060df5ea A	131	boolean_t machine_timeout_suspended(void);
b0d623f7 A	132	#endif /* PEXPERT_KERNEL_PRIVATE \|\| MACH_KERNEL_PRIVATE */
b0d623f7 A	133
6d2010ae A	134	/* Warm up a CPU to receive an interrupt */
6d2010ae A	135	kern_return_t ml_interrupt_prewarm(uint64_t deadline);
060df5ea	136
b0d623f7 A	137	#endif /* XNU_KERNEL_PRIVATE */
	138
	139	#ifdef KERNEL_PRIVATE
	140
55e303ae A	141	/* Type for the Time Base Enable function */
	142	typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);
	143
9bccf70c A	144	/* Type for the IPI Hander */
	145	typedef void (*ipi_handler_t)(void);
	146
55e303ae A	147	/* Struct for ml_processor_register */
	148	struct ml_processor_info {
	149	cpu_id_t cpu_id;
	150	boolean_t boot_cpu;
	151	vm_offset_t start_paddr;
	152	boolean_t supports_nap;
	153	unsigned long l2cr_value;
	154	time_base_enable_t time_base_enable;
	155	};
	156
	157	typedef struct ml_processor_info ml_processor_info_t;
	158
91447636	159
9bccf70c	160	/* Register a processor */
b0d623f7 A	161	kern_return_t
	162	ml_processor_register(
	163	cpu_id_t cpu_id,
	164	uint32_t lapic_id,
	165	processor_t *processor_out,
	166	boolean_t boot_cpu,
	167	boolean_t start );
0c530ab8	168
43866e37 A	169	/* PCI config cycle probing */
	170	boolean_t ml_probe_read(
	171	vm_offset_t paddr,
	172	unsigned int *val);
55e303ae A	173	boolean_t ml_probe_read_64(
	174	addr64_t paddr,
	175	unsigned int *val);
43866e37 A	176
	177	/* Read physical address byte */
	178	unsigned int ml_phys_read_byte(
	179	vm_offset_t paddr);
55e303ae A	180	unsigned int ml_phys_read_byte_64(
55e303ae A	181	addr64_t paddr);
43866e37 A	182
	183	/* Read physical address half word */
	184	unsigned int ml_phys_read_half(
	185	vm_offset_t paddr);
55e303ae A	186	unsigned int ml_phys_read_half_64(
55e303ae A	187	addr64_t paddr);
43866e37 A	188
	189	/* Read physical address word*/
	190	unsigned int ml_phys_read(
	191	vm_offset_t paddr);
55e303ae A	192	unsigned int ml_phys_read_64(
55e303ae A	193	addr64_t paddr);
43866e37 A	194	unsigned int ml_phys_read_word(
43866e37 A	195	vm_offset_t paddr);
55e303ae A	196	unsigned int ml_phys_read_word_64(
55e303ae A	197	addr64_t paddr);
43866e37 A	198
	199	/* Read physical address double word */
	200	unsigned long long ml_phys_read_double(
	201	vm_offset_t paddr);
55e303ae A	202	unsigned long long ml_phys_read_double_64(
55e303ae A	203	addr64_t paddr);
43866e37 A	204
	205	/* Write physical address byte */
	206	void ml_phys_write_byte(
	207	vm_offset_t paddr, unsigned int data);
55e303ae A	208	void ml_phys_write_byte_64(
55e303ae A	209	addr64_t paddr, unsigned int data);
43866e37 A	210
	211	/* Write physical address half word */
	212	void ml_phys_write_half(
	213	vm_offset_t paddr, unsigned int data);
55e303ae A	214	void ml_phys_write_half_64(
55e303ae A	215	addr64_t paddr, unsigned int data);
43866e37 A	216
	217	/* Write physical address word */
	218	void ml_phys_write(
	219	vm_offset_t paddr, unsigned int data);
55e303ae A	220	void ml_phys_write_64(
55e303ae A	221	addr64_t paddr, unsigned int data);
43866e37 A	222	void ml_phys_write_word(
43866e37 A	223	vm_offset_t paddr, unsigned int data);
55e303ae A	224	void ml_phys_write_word_64(
55e303ae A	225	addr64_t paddr, unsigned int data);
43866e37 A	226
	227	/* Write physical address double word */
	228	void ml_phys_write_double(
	229	vm_offset_t paddr, unsigned long long data);
55e303ae A	230	void ml_phys_write_double_64(
55e303ae A	231	addr64_t paddr, unsigned long long data);
43866e37	232
43866e37 A	233	/* Struct for ml_cpu_get_info */
43866e37 A	234	struct ml_cpu_info {
6d2010ae A	235	uint32_t vector_unit;
	236	uint32_t cache_line_size;
	237	uint32_t l1_icache_size;
	238	uint32_t l1_dcache_size;
	239	uint32_t l2_settings;
	240	uint32_t l2_cache_size;
	241	uint32_t l3_settings;
	242	uint32_t l3_cache_size;
43866e37 A	243	};
	244
	245	typedef struct ml_cpu_info ml_cpu_info_t;
	246
	247	/* Get processor info */
91447636	248	void ml_cpu_get_info(ml_cpu_info_t *ml_cpu_info);
43866e37	249
9bccf70c A	250	void ml_thread_policy(
	251	thread_t thread,
	252	unsigned policy_id,
	253	unsigned policy_info);
1c79356b	254
9bccf70c A	255	#define MACHINE_GROUP 0x00000001
	256	#define MACHINE_NETWORK_GROUP 0x10000000
	257	#define MACHINE_NETWORK_WORKLOOP 0x00000001
	258	#define MACHINE_NETWORK_NETISR 0x00000002
1c79356b	259
43866e37 A	260	/* Return the maximum number of CPUs set by ml_init_max_cpus() */
	261	int ml_get_max_cpus(
	262	void);
	263
2d21ac55 A	264	/*
	265	* The following are in pmCPU.c not machine_routines.c.
	266	*/
0c530ab8 A	267	extern void ml_set_maxsnoop(uint32_t maxdelay);
	268	extern unsigned ml_get_maxsnoop(void);
	269	extern void ml_set_maxbusdelay(uint32_t mdelay);
	270	extern uint32_t ml_get_maxbusdelay(void);
593a1d5f A	271	extern void ml_set_maxintdelay(uint64_t mdelay);
593a1d5f A	272	extern uint64_t ml_get_maxintdelay(void);
6d2010ae	273	extern boolean_t ml_get_interrupt_prewake_applicable(void);
2d21ac55 A	274
2d21ac55 A	275
0c530ab8 A	276	extern uint64_t tmrCvt(uint64_t time, uint64_t conversion);
0c530ab8 A	277
2d21ac55 A	278	extern uint64_t ml_cpu_int_event_time(void);
2d21ac55 A	279
b0d623f7 A	280	#endif /* KERNEL_PRIVATE */
	281
	282	/* Get Interrupts Enabled */
	283	boolean_t ml_get_interrupts_enabled(void);
	284
	285	/* Set Interrupts Enabled */
	286	boolean_t ml_set_interrupts_enabled(boolean_t enable);
	287
	288	/* Check if running at interrupt context */
	289	boolean_t ml_at_interrupt_context(void);
	290
	291	/* Zero bytes starting at a physical address */
	292	void bzero_phys(
	293	addr64_t phys_address,
	294	uint32_t length);
	295
	296	/* Bytes available on current stack */
	297	vm_offset_t ml_stack_remaining(void);
	298
	299	#if CONFIG_COUNTERS
	300	void ml_get_csw_threads(thread_t * /old/, thread_t * /new/);
	301	#endif /* CONFIG_COUNTERS */
1c79356b	302
91447636 A	303	__END_DECLS
91447636 A	304
6d2010ae A	305	#ifdef XNU_KERNEL_PRIVATE
	306	boolean_t ml_fpu_avx_enabled(void);
	307	void interrupt_latency_tracker_setup(void);
	308	void interrupt_reset_latency_stats(void);
	309	void interrupt_populate_latency_stats(char *, unsigned);
060df5ea	310
6d2010ae	311	#endif /* XNU_KERNEL_PRIVATE */
1c79356b	312	#endif /* _I386_MACHINE_ROUTINES_H_ */