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

/*
 * Copyright (c) 2006 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@
 */
#ifdef KERNEL_PRIVATE
#ifndef _I386_HPET_H_
#define _I386_HPET_H_

/*
 * HPET kernel functions to support the HPET KEXT and the
 * power management KEXT.
 */


/*
 *	Memory mapped registers for the HPET
 */
typedef struct hpetReg {
	uint64_t        GCAP_ID;                /* General capabilities */
	uint64_t        rsv1;
	uint64_t        GEN_CONF;               /* General configuration */
	uint64_t        rsv2;
	uint64_t        GINTR_STA;              /* General Interrupt status */
	uint64_t        rsv3[25];
	uint64_t        MAIN_CNT;               /* Main counter */
	uint64_t        rsv4;
	uint64_t        TIM0_CONF;              /* Timer 0 config and cap */
#define                 TIM_CONF 0
#define                 Tn_INT_ENB_CNF 4
	uint64_t        TIM0_COMP;              /* Timer 0 comparator */
#define                 TIM_COMP 8
	uint64_t        rsv5[2];
	uint64_t        TIM1_CONF;              /* Timer 1 config and cap */
	uint64_t        TIM1_COMP;              /* Timer 1 comparator */
	uint64_t        rsv6[2];
	uint64_t        TIM2_CONF;              /* Timer 2 config and cap */
	uint64_t        TIM2_COMP;              /* Timer 2 comparator */
	uint64_t        rsv7[2];
} hpetReg;
typedef struct  hpetReg hpetReg_t;

typedef struct hpetTimer {
	uint64_t        Config;         /* Timer config and capabilities */
	uint64_t        Compare;        /* Timer comparitor */
} hpetTimer_t;

struct hpetInfo {
	uint64_t        hpetCvtt2n;
	uint64_t        hpetCvtn2t;
	uint64_t        tsc2hpet;
	uint64_t        hpet2tsc;
	uint64_t        bus2hpet;
	uint64_t        hpet2bus;
	uint32_t        rcbaArea;
	uint32_t        rcbaAreap;
};
typedef struct hpetInfo hpetInfo_t;

struct hpetRequest {
	uint32_t        flags;
	uint32_t        hpetOffset;
	uint32_t        hpetVector;
};
typedef struct hpetRequest hpetRequest_t;

#define HPET_REQFL_64BIT        0x00000001      /* Timer is 64 bits */

extern uint64_t hpetFemto;
extern uint64_t hpetFreq;
extern uint64_t hpetCvtt2n;
extern uint64_t hpetCvtn2t;
extern uint64_t tsc2hpet;
extern uint64_t hpet2tsc;
extern uint64_t bus2hpet;
extern uint64_t hpet2bus;

extern vm_offset_t rcbaArea;
extern uint32_t rcbaAreap;

extern void map_rcbaAread(void);
extern void hpet_init(void);

extern void hpet_save(void);
extern void hpet_restore(void);

#ifdef XNU_KERNEL_PRIVATE
extern int HPETInterrupt(void);
#endif

extern int hpet_register_callback(int (*hpet_reqst)(uint32_t apicid, void *arg, hpetRequest_t *hpet), void *arg);
extern int hpet_request(uint32_t cpu);

extern uint64_t rdHPET(void);
extern void hpet_get_info(hpetInfo_t *info);

#define hpetAddr        0xFED00000
#define hptcAE          0x80

#endif  /* _I386_HPET_H_ */

#endif  /* KERNEL_PRIVATE */
Commit	Line	Data
b0d623f7 A	1	/*
	2	* Copyright (c) 2006 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
b0d623f7 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.
0a7de745	14	*
b0d623f7 A	15	* Please obtain a copy of the License at
b0d623f7 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
b0d623f7 A	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.
0a7de745	25	*
b0d623f7 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28	#ifdef KERNEL_PRIVATE
	29	#ifndef _I386_HPET_H_
	30	#define _I386_HPET_H_
	31
	32	/*
	33	* HPET kernel functions to support the HPET KEXT and the
	34	* power management KEXT.
	35	*/
	36
	37
	38	/*
	39	* Memory mapped registers for the HPET
	40	*/
	41	typedef struct hpetReg {
0a7de745 A	42	uint64_t GCAP_ID; /* General capabilities */
	43	uint64_t rsv1;
	44	uint64_t GEN_CONF; /* General configuration */
	45	uint64_t rsv2;
	46	uint64_t GINTR_STA; /* General Interrupt status */
	47	uint64_t rsv3[25];
	48	uint64_t MAIN_CNT; /* Main counter */
	49	uint64_t rsv4;
	50	uint64_t TIM0_CONF; /* Timer 0 config and cap */
	51	#define TIM_CONF 0
	52	#define Tn_INT_ENB_CNF 4
	53	uint64_t TIM0_COMP; /* Timer 0 comparator */
	54	#define TIM_COMP 8
	55	uint64_t rsv5[2];
	56	uint64_t TIM1_CONF; /* Timer 1 config and cap */
	57	uint64_t TIM1_COMP; /* Timer 1 comparator */
	58	uint64_t rsv6[2];
	59	uint64_t TIM2_CONF; /* Timer 2 config and cap */
	60	uint64_t TIM2_COMP; /* Timer 2 comparator */
	61	uint64_t rsv7[2];
b0d623f7	62	} hpetReg;
0a7de745	63	typedef struct hpetReg hpetReg_t;
b0d623f7 A	64
b0d623f7 A	65	typedef struct hpetTimer {
0a7de745 A	66	uint64_t Config; /* Timer config and capabilities */
0a7de745 A	67	uint64_t Compare; /* Timer comparitor */
b0d623f7 A	68	} hpetTimer_t;
b0d623f7 A	69
0a7de745 A	70	struct hpetInfo {
	71	uint64_t hpetCvtt2n;
	72	uint64_t hpetCvtn2t;
	73	uint64_t tsc2hpet;
	74	uint64_t hpet2tsc;
	75	uint64_t bus2hpet;
	76	uint64_t hpet2bus;
	77	uint32_t rcbaArea;
	78	uint32_t rcbaAreap;
b0d623f7 A	79	};
	80	typedef struct hpetInfo hpetInfo_t;
	81
0a7de745 A	82	struct hpetRequest {
	83	uint32_t flags;
	84	uint32_t hpetOffset;
	85	uint32_t hpetVector;
b0d623f7 A	86	};
	87	typedef struct hpetRequest hpetRequest_t;
	88
0a7de745	89	#define HPET_REQFL_64BIT 0x00000001 /* Timer is 64 bits */
b0d623f7 A	90
	91	extern uint64_t hpetFemto;
	92	extern uint64_t hpetFreq;
	93	extern uint64_t hpetCvtt2n;
	94	extern uint64_t hpetCvtn2t;
	95	extern uint64_t tsc2hpet;
	96	extern uint64_t hpet2tsc;
	97	extern uint64_t bus2hpet;
	98	extern uint64_t hpet2bus;
	99
0a7de745	100	extern vm_offset_t rcbaArea;
b0d623f7 A	101	extern uint32_t rcbaAreap;
	102
	103	extern void map_rcbaAread(void);
	104	extern void hpet_init(void);
	105
	106	extern void hpet_save(void);
	107	extern void hpet_restore(void);
	108
	109	#ifdef XNU_KERNEL_PRIVATE
	110	extern int HPETInterrupt(void);
	111	#endif
	112
	113	extern int hpet_register_callback(int (hpet_reqst)(uint32_t apicid, void arg, hpetRequest_t hpet), void arg);
	114	extern int hpet_request(uint32_t cpu);
	115
	116	extern uint64_t rdHPET(void);
	117	extern void hpet_get_info(hpetInfo_t *info);
	118
0a7de745 A	119	#define hpetAddr 0xFED00000
0a7de745 A	120	#define hptcAE 0x80
b0d623f7	121
0a7de745	122	#endif /* _I386_HPET_H_ */
b0d623f7	123
0a7de745	124	#endif /* KERNEL_PRIVATE */