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

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

#ifndef _PPC_COMMPAGE_H
#define _PPC_COMMPAGE_H

#ifndef	__ASSEMBLER__
#include <stdint.h>
#endif /* __ASSEMBLER__ */


/* Special check bits for the compage_descriptor "special" field. */
 
#define	kCommPageDCBA		0x0001			// this routine uses DCBA, map to NOP if not appropriate
#define	kCommPageSYNC		0x0002			// this routine uses SYNC, LWSYNC, or EIEIO, map to NOP if UP
#define kCommPageISYNC		0x0004			// this routine uses ISYNC, map to NOP if UP
#define	kCommPageMTCRF		0x0008			// set bit 11 in MTCRF if only 1 cr specified

#define kPort32to64			0x1000			// written for 32-bit, must port to 64-bit
#define kCommPage64			0x2000			// this routine is useable in 64-bit mode
#define kCommPage32			0x4000			// this routine is useable in 32-bit mode
#define kCommPageBoth		(kCommPage32+kCommPage64)


#ifdef	__ASSEMBLER__

#define	COMMPAGE_DESCRIPTOR(label,address,must,cant,special)	\
    .globl  EXT(label)  @\
LEXT(label)	@\
    .short	label-.	@\
    .short	.-label-2	@\
    .short	address	@\
    .short	special	@\
    .long	must    @\
    .long	cant
    

#else /* __ASSEMBLER__ */

/* Each potential commpage routine is described by one of these.
 * Note that the COMMPAGE_DESCRIPTOR macro (above), used in
 * assembly language, must agree with this.
 */
 
typedef	struct	commpage_descriptor	{
    short	code_offset;					// offset to code from this descriptor
    short	code_length;					// length in bytes
    short	commpage_address;				// put at this address (_COMM_PAGE_BCOPY etc)
    short	special;						// special handling bits for DCBA and SYNC etc
    long	musthave;						// _cpu_capability bits we must have
    long	canthave;						// _cpu_capability bits we can't have
} commpage_descriptor;


extern	char	*commPagePtr32;				// virt address of 32-bit commpage in kernel map
extern	char	*commPagePtr64;				// virt address of 64-bit commpage in kernel map

extern	void	commpage_set_timestamp(uint64_t tbr, uint64_t secs, uint32_t ticks_per_sec);

#define	commpage_disable_timestamp() commpage_set_timestamp( 0, 0, 0 )

extern	int	commpage_time_dcba( void );

#endif	/* __ASSEMBLER__ */

#endif /* _PPC_COMMPAGE_H */
Commit	Line	Data
43866e37 A	1	/*
	2	* Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
43866e37	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@
43866e37 A	27	*/
	28
	29	#ifndef _PPC_COMMPAGE_H
	30	#define _PPC_COMMPAGE_H
	31
	32	#ifndef __ASSEMBLER__
	33	#include <stdint.h>
	34	#endif /* __ASSEMBLER__ */
	35
	36
	37	/* Special check bits for the compage_descriptor "special" field. */
	38
	39	#define kCommPageDCBA 0x0001 // this routine uses DCBA, map to NOP if not appropriate
91447636 A	40	#define kCommPageSYNC 0x0002 // this routine uses SYNC, LWSYNC, or EIEIO, map to NOP if UP
	41	#define kCommPageISYNC 0x0004 // this routine uses ISYNC, map to NOP if UP
	42	#define kCommPageMTCRF 0x0008 // set bit 11 in MTCRF if only 1 cr specified
	43
	44	#define kPort32to64 0x1000 // written for 32-bit, must port to 64-bit
	45	#define kCommPage64 0x2000 // this routine is useable in 64-bit mode
	46	#define kCommPage32 0x4000 // this routine is useable in 32-bit mode
	47	#define kCommPageBoth (kCommPage32+kCommPage64)
43866e37 A	48
	49
	50	#ifdef __ASSEMBLER__
	51
	52	#define COMMPAGE_DESCRIPTOR(label,address,must,cant,special) \
91447636	53	.globl EXT(label) @\
43866e37 A	54	LEXT(label) @\
	55	.short label-. @\
	56	.short .-label-2 @\
	57	.short address @\
	58	.short special @\
91447636	59	.long must @\
43866e37 A	60	.long cant
	61
	62
	63	#else /* __ASSEMBLER__ */
	64
	65	/* Each potential commpage routine is described by one of these.
	66	* Note that the COMMPAGE_DESCRIPTOR macro (above), used in
	67	* assembly language, must agree with this.
	68	*/
	69
	70	typedef struct commpage_descriptor {
	71	short code_offset; // offset to code from this descriptor
	72	short code_length; // length in bytes
	73	short commpage_address; // put at this address (_COMM_PAGE_BCOPY etc)
	74	short special; // special handling bits for DCBA and SYNC etc
	75	long musthave; // _cpu_capability bits we must have
	76	long canthave; // _cpu_capability bits we can't have
	77	} commpage_descriptor;
	78
	79
91447636 A	80	extern char *commPagePtr32; // virt address of 32-bit commpage in kernel map
91447636 A	81	extern char *commPagePtr64; // virt address of 64-bit commpage in kernel map
43866e37	82
0c530ab8	83	extern void commpage_set_timestamp(uint64_t tbr, uint64_t secs, uint32_t ticks_per_sec);
2d21ac55 A	84
	85	#define commpage_disable_timestamp() commpage_set_timestamp( 0, 0, 0 )
	86
	87	extern int commpage_time_dcba( void );
43866e37 A	88
	89	#endif /* __ASSEMBLER__ */
	90
	91	#endif /* _PPC_COMMPAGE_H */