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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */

#ifndef	_PPC_MACHINE_ROUTINES_H_
#define	_PPC_MACHINE_ROUTINES_H_

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

#include <sys/appleapiopts.h>

/* 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);

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

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

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

/* enables (or disables) the processor nap mode the function returns the previous value*/
boolean_t ml_enable_nap(
        int target_cpu,
        boolean_t nap_enabled);

/* Put the processor to sleep */
void ml_ppc_sleep(void);
void ml_get_timebase(unsigned long long *timstamp);
void ml_sense__nmi(void);

int ml_enable_cache_level(int cache_level, int enable);

void ml_static_mfree(
	vm_offset_t,
	vm_size_t);
        
/* Init Interrupts */
void ml_install_interrupt_handler(
	void *nub,
	int source,
	void *target,
	IOInterruptHandler handler,
	void *refCon);
               
#ifdef __APPLE_API_UNSTABLE

vm_offset_t
ml_static_ptovirt(
	vm_offset_t);

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

/* 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_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(
	ml_processor_info_t *processor_info,
	processor_t *processor,
	ipi_handler_t *ipi_handler);

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

#endif /* __APPLE_API_UNSTABLE */

#ifdef  __APPLE_API_PRIVATE
#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);

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

#endif /* PEXPERT_KERNEL_PRIVATE || MACH_KERNEL_PRIVATE */

#ifdef	MACH_KERNEL_PRIVATE
void	ml_init_interrupt(void);

boolean_t fake_get_interrupts_enabled(void);

boolean_t fake_set_interrupts_enabled(
	boolean_t enable);

void machine_idle(void);

void machine_signal_idle(
	processor_t processor);

void cacheInit(void);

void cacheDisable(void);

void ml_thrm_init(void);
unsigned int ml_read_temp(void);

void ml_thrm_set(	
	unsigned int low, 
	unsigned int high);

unsigned int ml_throttle(
	unsigned int);

void ml_init_lock_timeout(void);

#endif /* MACH_KERNEL_PRIVATE */

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

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

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

/* Return the current number of CPUs */
int ml_get_current_cpus(
	void);

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

typedef struct ml_cpu_info ml_cpu_info_t;

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

void ml_set_processor_speed(unsigned long speed);
void ml_set_processor_voltage(unsigned long voltage);

#endif /* __APPLE_API_PRIVATE */

#endif /* _PPC_MACHINE_ROUTINES_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*/
	28
	29	#ifndef _PPC_MACHINE_ROUTINES_H_
	30	#define _PPC_MACHINE_ROUTINES_H_
	31
	32	#include <mach/mach_types.h>
	33	#include <mach/boolean.h>
	34	#include <kern/kern_types.h>
55e303ae	35	#include <kern/sched_prim.h>
1c79356b A	36	#include <pexpert/pexpert.h>
1c79356b A	37
9bccf70c	38	#include <sys/appleapiopts.h>
1c79356b	39
9bccf70c A	40	/* Get Interrupts Enabled */
9bccf70c A	41	boolean_t ml_get_interrupts_enabled(void);
1c79356b	42
9bccf70c A	43	/* Set Interrupts Enabled */
9bccf70c A	44	boolean_t ml_set_interrupts_enabled(boolean_t enable);
1c79356b	45
9bccf70c A	46	/* Check if running at interrupt context */
9bccf70c A	47	boolean_t ml_at_interrupt_context(void);
1c79356b	48
9bccf70c A	49	/* Generate a fake interrupt */
	50	void ml_cause_interrupt(void);
	51
	52	/* Type for the IPI Hander */
	53	typedef void (*ipi_handler_t)(void);
	54
	55	/* Type for the Time Base Enable function */
	56	typedef void (*time_base_enable_t)(cpu_id_t cpu_id, boolean_t enable);
	57
	58	/* enables (or disables) the processor nap mode the function returns the previous value*/
	59	boolean_t ml_enable_nap(
	60	int target_cpu,
	61	boolean_t nap_enabled);
	62
	63	/* Put the processor to sleep */
	64	void ml_ppc_sleep(void);
	65	void ml_get_timebase(unsigned long long *timstamp);
	66	void ml_sense__nmi(void);
	67
	68	int ml_enable_cache_level(int cache_level, int enable);
1c79356b A	69
	70	void ml_static_mfree(
	71	vm_offset_t,
	72	vm_size_t);
	73
1c79356b A	74	/* Init Interrupts */
	75	void ml_install_interrupt_handler(
	76	void *nub,
	77	int source,
	78	void *target,
	79	IOInterruptHandler handler,
	80	void *refCon);
	81
9bccf70c	82	#ifdef __APPLE_API_UNSTABLE
1c79356b	83
9bccf70c A	84	vm_offset_t
	85	ml_static_ptovirt(
	86	vm_offset_t);
1c79356b	87
9bccf70c A	88	/* virtual to physical on wired pages */
	89	vm_offset_t ml_vtophys(
	90	vm_offset_t vaddr);
1c79356b A	91
	92	/* PCI config cycle probing */
	93	boolean_t ml_probe_read(
	94	vm_offset_t paddr,
	95	unsigned int *val);
55e303ae A	96	boolean_t ml_probe_read_64(
	97	addr64_t paddr,
	98	unsigned int *val);
1c79356b A	99
	100	/* Read physical address byte */
	101	unsigned int ml_phys_read_byte(
	102	vm_offset_t paddr);
55e303ae A	103	unsigned int ml_phys_read_byte_64(
	104	addr64_t paddr);
	105
	106	/* Read physical address half word */
	107	unsigned int ml_phys_read_half(
	108	vm_offset_t paddr);
	109	unsigned int ml_phys_read_half_64(
	110	addr64_t paddr);
1c79356b	111
55e303ae	112	/* Read physical address word*/
1c79356b A	113	unsigned int ml_phys_read(
1c79356b A	114	vm_offset_t paddr);
55e303ae A	115	unsigned int ml_phys_read_64(
	116	addr64_t paddr);
	117	unsigned int ml_phys_read_word(
	118	vm_offset_t paddr);
	119	unsigned int ml_phys_read_word_64(
	120	addr64_t paddr);
	121
	122	/* Read physical address double word */
	123	unsigned long long ml_phys_read_double(
	124	vm_offset_t paddr);
	125	unsigned long long ml_phys_read_double_64(
	126	addr64_t paddr);
1c79356b A	127
	128	/* Write physical address byte */
	129	void ml_phys_write_byte(
	130	vm_offset_t paddr, unsigned int data);
55e303ae A	131	void ml_phys_write_byte_64(
55e303ae A	132	addr64_t paddr, unsigned int data);
1c79356b	133
55e303ae A	134	/* Write physical address half word */
	135	void ml_phys_write_half(
	136	vm_offset_t paddr, unsigned int data);
	137	void ml_phys_write_half_64(
	138	addr64_t paddr, unsigned int data);
	139
	140	/* Write physical address word */
1c79356b A	141	void ml_phys_write(
1c79356b A	142	vm_offset_t paddr, unsigned int data);
55e303ae A	143	void ml_phys_write_64(
	144	addr64_t paddr, unsigned int data);
	145	void ml_phys_write_word(
	146	vm_offset_t paddr, unsigned int data);
	147	void ml_phys_write_word_64(
	148	addr64_t paddr, unsigned int data);
	149
	150	/* Write physical address double word */
	151	void ml_phys_write_double(
	152	vm_offset_t paddr, unsigned long long data);
	153	void ml_phys_write_double_64(
	154	addr64_t paddr, unsigned long long data);
1c79356b	155
1c79356b	156	/* Struct for ml_processor_register */
55e303ae	157	struct ml_processor_info {
1c79356b A	158	cpu_id_t cpu_id;
	159	boolean_t boot_cpu;
	160	vm_offset_t start_paddr;
	161	boolean_t supports_nap;
	162	unsigned long l2cr_value;
	163	time_base_enable_t time_base_enable;
	164	};
	165
55e303ae	166	typedef struct ml_processor_info ml_processor_info_t;
1c79356b A	167
	168	/* Register a processor */
	169	kern_return_t ml_processor_register(
	170	ml_processor_info_t *processor_info,
	171	processor_t *processor,
	172	ipi_handler_t *ipi_handler);
	173
55e303ae A	174	/* Zero bytes starting at a physical address */
	175	void bzero_phys(
	176	addr64_t phys_address,
	177	uint32_t length);
	178
9bccf70c	179	#endif /* __APPLE_API_UNSTABLE */
1c79356b	180
9bccf70c A	181	#ifdef __APPLE_API_PRIVATE
	182	#if defined(PEXPERT_KERNEL_PRIVATE) \|\| defined(MACH_KERNEL_PRIVATE)
	183	/* IO memory map services */
1c79356b	184
9bccf70c A	185	/* Map memory map IO space */
	186	vm_offset_t ml_io_map(
	187	vm_offset_t phys_addr,
	188	vm_size_t size);
1c79356b	189
9bccf70c A	190	/* boot memory allocation */
	191	vm_offset_t ml_static_malloc(
	192	vm_size_t size);
1c79356b	193
9bccf70c	194	#endif /* PEXPERT_KERNEL_PRIVATE \|\| MACH_KERNEL_PRIVATE */
1c79356b A	195
1c79356b A	196	#ifdef MACH_KERNEL_PRIVATE
9bccf70c A	197	void ml_init_interrupt(void);
	198
	199	boolean_t fake_get_interrupts_enabled(void);
	200
	201	boolean_t fake_set_interrupts_enabled(
	202	boolean_t enable);
	203
9bccf70c A	204	void machine_idle(void);
	205
	206	void machine_signal_idle(
	207	processor_t processor);
	208
1c79356b A	209	void cacheInit(void);
	210
	211	void cacheDisable(void);
	212
	213	void ml_thrm_init(void);
	214	unsigned int ml_read_temp(void);
	215
	216	void ml_thrm_set(
	217	unsigned int low,
	218	unsigned int high);
	219
	220	unsigned int ml_throttle(
	221	unsigned int);
1c79356b	222
ab86ba33 A	223	void ml_init_lock_timeout(void);
ab86ba33 A	224
9bccf70c A	225	#endif /* MACH_KERNEL_PRIVATE */
	226
	227	void ml_thread_policy(
	228	thread_t thread,
	229	unsigned policy_id,
	230	unsigned policy_info);
	231
	232	#define MACHINE_GROUP 0x00000001
	233	#define MACHINE_NETWORK_GROUP 0x10000000
	234	#define MACHINE_NETWORK_WORKLOOP 0x00000001
	235	#define MACHINE_NETWORK_NETISR 0x00000002
	236
43866e37 A	237	/* Initialize the maximum number of CPUs */
	238	void ml_init_max_cpus(
	239	unsigned long max_cpus);
	240
	241	/* Return the maximum number of CPUs set by ml_init_max_cpus() */
	242	int ml_get_max_cpus(
	243	void);
	244
	245	/* Return the current number of CPUs */
	246	int ml_get_current_cpus(
	247	void);
	248
	249	/* Struct for ml_cpu_get_info */
	250	struct ml_cpu_info {
9bccf70c A	251	unsigned long vector_unit;
	252	unsigned long cache_line_size;
	253	unsigned long l1_icache_size;
	254	unsigned long l1_dcache_size;
	255	unsigned long l2_settings;
	256	unsigned long l2_cache_size;
	257	unsigned long l3_settings;
	258	unsigned long l3_cache_size;
	259	};
	260
43866e37	261	typedef struct ml_cpu_info ml_cpu_info_t;
9bccf70c A	262
9bccf70c A	263	/* Get processor info */
43866e37	264	void ml_cpu_get_info(ml_cpu_info_t *cpu_info);
1c79356b	265
d52fe63f	266	void ml_set_processor_speed(unsigned long speed);
d12e1678	267	void ml_set_processor_voltage(unsigned long voltage);
d52fe63f	268
9bccf70c A	269	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	270
1c79356b	271	#endif /* _PPC_MACHINE_ROUTINES_H_ */