1 /* 2 * SYS/SYSTIMER.H 3 * 4 * Copyright (c) 2003,2004 The DragonFly Project. All rights reserved. 5 * 6 * This code is derived from software contributed to The DragonFly Project 7 * by Matthew Dillon <dillon@backplane.com> 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 3. Neither the name of The DragonFly Project nor the names of its 20 * contributors may be used to endorse or promote products derived 21 * from this software without specific, prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 27 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 28 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 31 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 33 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * $DragonFly: src/sys/sys/systimer.h,v 1.13 2007/04/30 06:57:36 dillon Exp $ 37 */ 38 39 #ifndef _SYS_SYSTIMER_H_ 40 #define _SYS_SYSTIMER_H_ 41 42 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 43 44 #ifndef _SYS_TYPES_H_ 45 #include <sys/types.h> 46 #endif 47 #ifndef _SYS_QUEUE_H_ 48 #include <sys/queue.h> 49 #endif 50 51 /* XXX fix sys/kinfo.h */ 52 #ifndef __BOOLEAN_T_DEFINED__ 53 #define __BOOLEAN_T_DEFINED__ 54 typedef __boolean_t boolean_t; 55 #endif 56 57 struct intrframe; 58 59 typedef __uint32_t sysclock_t; 60 typedef TAILQ_HEAD(systimerq, systimer) *systimerq_t; 61 typedef void (*systimer_func_t)(struct systimer *); 62 typedef void (*systimer_func2_t)(struct systimer *, struct intrframe *); 63 64 typedef struct systimer { 65 TAILQ_ENTRY(systimer) node; 66 systimerq_t queue; 67 sysclock_t time; /* absolute time next intr */ 68 sysclock_t periodic; /* if non-zero */ 69 systimer_func2_t func; 70 void *data; 71 int flags; 72 int freq; /* frequency if periodic */ 73 struct cputimer *which; /* which timer was used? */ 74 struct globaldata *gd; /* cpu owning structure */ 75 } *systimer_t; 76 77 #define SYSTF_ONQUEUE 0x0001 78 #define SYSTF_IPIRUNNING 0x0002 79 #define SYSTF_NONQUEUED 0x0004 80 81 void systimer_intr_enable(void); 82 void systimer_intr(sysclock_t *, int, struct intrframe *); 83 void systimer_add(systimer_t); 84 void systimer_del(systimer_t); 85 void systimer_init_periodic(systimer_t, void *, void *, int); 86 void systimer_init_periodic_nq(systimer_t, void *, void *, int); 87 void systimer_adjust_periodic(systimer_t, int); 88 void systimer_init_oneshot(systimer_t, void *, void *, int); 89 90 /* 91 * cputimer interface. This provides a free-running (non-interrupt) 92 * timebase for the system. The cputimer 93 * 94 * These variables hold the fixed cputimer frequency, determining the 95 * granularity of cputimer_count(). 96 * 97 * Note that cputimer_count() always returns a full-width wrapping counter. 98 * 99 * The 64 bit versions are used for converting count values into uS or nS 100 * as follows: 101 * 102 * usec = (cputimer_freq64_usec * count) >> 32 103 */ 104 105 struct cputimer { 106 SLIST_ENTRY(cputimer) next; 107 const char *name; 108 int pri; 109 int type; 110 sysclock_t (*count)(void); 111 sysclock_t (*fromhz)(int freq); 112 sysclock_t (*fromus)(int us); 113 void (*construct)(struct cputimer *, sysclock_t); 114 void (*destruct)(struct cputimer *); 115 sysclock_t freq; /* in Hz */ 116 int64_t freq64_usec; /* in (1e6 << 32) / timer_freq */ 117 int64_t freq64_nsec; /* in (1e9 << 32) / timer_freq */ 118 sysclock_t base; /* (implementation dependant) */ 119 }; 120 121 extern struct cputimer *sys_cputimer; 122 123 #define CPUTIMER_DUMMY 0 124 #define CPUTIMER_8254_SEL1 1 125 #define CPUTIMER_8254_SEL2 2 126 #define CPUTIMER_ACPI 3 127 #define CPUTIMER_VKERNEL 4 128 #define CPUTIMER_HPET 5 129 130 #define CPUTIMER_PRI_DUMMY -10 131 #define CPUTIMER_PRI_8254 0 132 #define CPUTIMER_PRI_ACPI 10 133 #define CPUTIMER_PRI_HPET 15 134 #define CPUTIMER_PRI_VKERNEL 20 135 136 void cputimer_select(struct cputimer *, int); 137 void cputimer_register(struct cputimer *); 138 void cputimer_deregister(struct cputimer *); 139 void cputimer_set_frequency(struct cputimer *, int); 140 sysclock_t cputimer_default_fromhz(int); 141 sysclock_t cputimer_default_fromus(int); 142 void cputimer_default_construct(struct cputimer *, sysclock_t); 143 void cputimer_default_destruct(struct cputimer *); 144 145 /* 146 * Interrupt cputimer interface. 147 * 148 * Interrupt cputimers are normally one shot timers which will 149 * generate interrupt upon expiration. 150 * 151 * initclock -- Called at SI_BOOT2_CLOCKREG, SI_ORDER_SECOND. The 152 * interrupt timer could deregister itself here, if it 153 * is not the selected system interrupt cputimer. Before 154 * this function is called, 'enable' and 'reload' will 155 * not be called. 156 * enable -- Enable interrupt. It is called by each CPU. It is 157 * only called once during boot. Before this function 158 * is called, 'reload' will not be called. 159 * reload -- Called by each CPU when it wants to to reprogram the 160 * one shot timer expiration time. The reload value is 161 * measured in sys_cputimer->freq. 162 * config -- Setup the interrupt cputimer according to the passed 163 * in non-interrupt cputimer. It will be called when 164 * sys_cputimer's frequency is changed or when sys_cputimer 165 * itself is changed. It is also called when this interrupt 166 * cputimer gets registered. 167 * restart -- Start the possibly stalled interrupt cputimer immediately. 168 * Do fixup if necessary. 169 * pmfixup -- Called after ACPI power management is enabled. 170 */ 171 struct cputimer_intr { 172 sysclock_t freq; 173 void (*reload) 174 (struct cputimer_intr *, sysclock_t); 175 void (*enable) 176 (struct cputimer_intr *); 177 void (*config) 178 (struct cputimer_intr *, const struct cputimer *); 179 void (*restart) 180 (struct cputimer_intr *); 181 void (*pmfixup) 182 (struct cputimer_intr *); 183 void (*initclock) 184 (struct cputimer_intr *, boolean_t); 185 SLIST_ENTRY(cputimer_intr) next; 186 const char *name; 187 int type; /* CPUTIMER_INTR_ */ 188 int prio; /* CPUTIMER_INTR_PRIO_ */ 189 uint32_t caps; /* CPUTIMER_INTR_CAP_ */ 190 }; 191 192 #define CPUTIMER_INTR_8254 0 193 #define CPUTIMER_INTR_LAPIC 1 194 #define CPUTIMER_INTR_VKERNEL 2 195 196 /* NOTE: Keep the new values less than CPUTIMER_INTR_PRIO_MAX */ 197 #define CPUTIMER_INTR_PRIO_8254 0 198 #define CPUTIMER_INTR_PRIO_LAPIC 10 199 #define CPUTIMER_INTR_PRIO_VKERNEL 20 200 #define CPUTIMER_INTR_PRIO_MAX 1000 201 202 #define CPUTIMER_INTR_CAP_NONE 0 203 #define CPUTIMER_INTR_CAP_PS 0x1 /* works during powersaving */ 204 205 /* 206 * Interrupt cputimer implementation interfaces 207 * 208 * NOTE: 209 * cputimer_intr_deregister() is _not_ allowed to be called 210 * with the currently selected interrupt cputimer. 211 */ 212 void cputimer_intr_register(struct cputimer_intr *); 213 void cputimer_intr_deregister(struct cputimer_intr *); 214 int cputimer_intr_select(struct cputimer_intr *, int); 215 216 /* 217 * Interrupt cputimer implementation helper functions 218 * 219 * default_enable -- NOP 220 * default_restart -- reload(0) 221 * default_config -- NOP 222 * default_pmfixup -- NOP 223 * default_initclock -- NOP 224 */ 225 void cputimer_intr_default_enable(struct cputimer_intr *); 226 void cputimer_intr_default_restart(struct cputimer_intr *); 227 void cputimer_intr_default_config(struct cputimer_intr *, 228 const struct cputimer *); 229 void cputimer_intr_default_pmfixup(struct cputimer_intr *); 230 void cputimer_intr_default_initclock(struct cputimer_intr *, boolean_t); 231 232 /* 233 * Interrupt cputimer external interfaces 234 */ 235 void cputimer_intr_enable(void); 236 void cputimer_intr_pmfixup(void); 237 void cputimer_intr_config(const struct cputimer *); 238 void cputimer_intr_reload(sysclock_t); 239 void cputimer_intr_restart(void); 240 int cputimer_intr_select_caps(uint32_t); 241 242 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 243 244 #endif /* !_SYS_SYSTIMER_H_ */ 245