osfmk/i386/hpet.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  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.
  25  *
  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 {
  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];
  62 } hpetReg;
  63 typedef struct  hpetReg hpetReg_t;
  64
  65 typedef struct hpetTimer {
  66         uint64_t        Config;         /* Timer config and capabilities */
  67         uint64_t        Compare;        /* Timer comparitor */
  68 } hpetTimer_t;
  69
  70 struct hpetInfo
  71 {
  72         uint64_t        hpetCvtt2n;
  73         uint64_t        hpetCvtn2t;
  74         uint64_t        tsc2hpet;
  75         uint64_t        hpet2tsc;
  76         uint64_t        bus2hpet;
  77         uint64_t        hpet2bus;
  78         uint32_t        rcbaArea;
  79         uint32_t        rcbaAreap;
  80 };
  81 typedef struct hpetInfo hpetInfo_t;
  82
  83 struct hpetRequest
  84 {
  85         uint32_t        flags;
  86         uint32_t        hpetOffset;
  87         uint32_t        hpetVector;
  88 };
  89 typedef struct hpetRequest hpetRequest_t;
  90
  91 #define HPET_REQFL_64BIT        0x00000001      /* Timer is 64 bits */
  92
  93 extern uint64_t hpetFemto;
  94 extern uint64_t hpetFreq;
  95 extern uint64_t hpetCvtt2n;
  96 extern uint64_t hpetCvtn2t;
  97 extern uint64_t tsc2hpet;
  98 extern uint64_t hpet2tsc;
  99 extern uint64_t bus2hpet;
 100 extern uint64_t hpet2bus;
 101
 102 extern vm_offset_t rcbaArea;
 103 extern uint32_t rcbaAreap;
 104
 105 extern void map_rcbaAread(void);
 106 extern void hpet_init(void);
 107
 108 extern void hpet_save(void);
 109 extern void hpet_restore(void);
 110
 111 #ifdef XNU_KERNEL_PRIVATE
 112 extern int HPETInterrupt(void);
 113 #endif
 114
 115 extern int hpet_register_callback(int (*hpet_reqst)(uint32_t apicid, void *arg, hpetRequest_t *hpet), void *arg);
 116 extern int hpet_request(uint32_t cpu);
 117
 118 extern uint64_t rdHPET(void);
 119 extern void hpet_get_info(hpetInfo_t *info);
 120
 121 #define hpetAddr        0xFED00000
 122 #define hptcAE          0x80
 123
 124 #endif  /* _I386_HPET_H_ */
 125
 126 #endif  /* KERNEL_PRIVATE */