arch/i386/kernel/time_hpet.c

   1 /*
   2  *  linux/arch/i386/kernel/time_hpet.c
   3  *  This code largely copied from arch/x86_64/kernel/time.c
   4  *  See that file for credits.
   5  *
   6  *  2003-06-30    Venkatesh Pallipadi - Additional changes for HPET support
   7  */
   8
   9 #include <linux/errno.h>
  10 #include <linux/kernel.h>
  11 #include <linux/param.h>
  12 #include <linux/string.h>
  13 #include <linux/init.h>
  14 #include <linux/smp.h>
  15
  16 #include <asm/timer.h>
  17 #include <asm/fixmap.h>
  18 #include <asm/apic.h>
  19
  20 #include <linux/timex.h>
  21 #include <linux/config.h>
  22
  23 #include <asm/hpet.h>
  24 #include <linux/hpet.h>
  25
  26 unsigned long hpet_period;      /* fsecs / HPET clock */
  27 unsigned long hpet_tick;        /* hpet clks count per tick */
  28 unsigned long hpet_address;     /* hpet memory map physical address */
  29
  30 static int use_hpet;            /* can be used for runtime check of hpet */
  31 static int boot_hpet_disable;   /* boottime override for HPET timer */
  32 static unsigned long hpet_virt_address; /* hpet kernel virtual address */
  33
  34 #define FSEC_TO_USEC (1000000000UL)
  35
  36 int hpet_readl(unsigned long a)
  37 {
  38         return readl(hpet_virt_address + a);
  39 }
  40
  41 void hpet_writel(unsigned long d, unsigned long a)
  42 {
  43         writel(d, hpet_virt_address + a);
  44 }
  45
  46 #ifdef CONFIG_X86_LOCAL_APIC
  47 /*
  48  * HPET counters dont wrap around on every tick. They just change the
  49  * comparator value and continue. Next tick can be caught by checking
  50  * for a change in the comparator value. Used in apic.c.
  51  */
  52 void __init wait_hpet_tick(void)
  53 {
  54         unsigned int start_cmp_val, end_cmp_val;
  55
  56         start_cmp_val = hpet_readl(HPET_T0_CMP);
  57         do {
  58                 end_cmp_val = hpet_readl(HPET_T0_CMP);
  59         } while (start_cmp_val == end_cmp_val);
  60 }
  61 #endif
  62
  63 /*
  64  * Check whether HPET was found by ACPI boot parse. If yes setup HPET
  65  * counter 0 for kernel base timer.
  66  */
  67 int __init hpet_enable(void)
  68 {
  69         unsigned int cfg, id;
  70         unsigned long tick_fsec_low, tick_fsec_high; /* tick in femto sec */
  71         unsigned long hpet_tick_rem;
  72
  73         if (boot_hpet_disable)
  74                 return -1;
  75
  76         if (!hpet_address) {
  77                 return -1;
  78         }
  79         hpet_virt_address = (unsigned long) ioremap_nocache(hpet_address,
  80                                                             HPET_MMAP_SIZE);
  81         /*
  82          * Read the period, compute tick and quotient.
  83          */
  84         id = hpet_readl(HPET_ID);
  85
  86         /*
  87          * We are checking for value '1' or more in number field.
  88          * So, we are OK with HPET_EMULATE_RTC part too, where we need
  89          * to have atleast 2 timers.
  90          */
  91         if (!(id & HPET_ID_NUMBER) ||
  92             !(id & HPET_ID_LEGSUP))
  93                 return -1;
  94
  95         hpet_period = hpet_readl(HPET_PERIOD);
  96         if ((hpet_period < HPET_MIN_PERIOD) || (hpet_period > HPET_MAX_PERIOD))
  97                 return -1;
  98
  99         /*
 100          * 64 bit math
 101          * First changing tick into fsec
 102          * Then 64 bit div to find number of hpet clk per tick
 103          */
 104         ASM_MUL64_REG(tick_fsec_low, tick_fsec_high,
 105                         KERNEL_TICK_USEC, FSEC_TO_USEC);
 106         ASM_DIV64_REG(hpet_tick, hpet_tick_rem,
 107                         hpet_period, tick_fsec_low, tick_fsec_high);
 108
 109         if (hpet_tick_rem > (hpet_period >> 1))
 110                 hpet_tick++; /* rounding the result */
 111
 112         /*
 113          * Stop the timers and reset the main counter.
 114          */
 115         cfg = hpet_readl(HPET_CFG);
 116         cfg &= ~HPET_CFG_ENABLE;
 117         hpet_writel(cfg, HPET_CFG);
 118         hpet_writel(0, HPET_COUNTER);
 119         hpet_writel(0, HPET_COUNTER + 4);
 120
 121         /*
 122          * Set up timer 0, as periodic with first interrupt to happen at
 123          * hpet_tick, and period also hpet_tick.
 124          */
 125         cfg = hpet_readl(HPET_T0_CFG);
 126         cfg |= HPET_TN_ENABLE | HPET_TN_PERIODIC |
 127                HPET_TN_SETVAL | HPET_TN_32BIT;
 128         hpet_writel(cfg, HPET_T0_CFG);
 129         hpet_writel(hpet_tick, HPET_T0_CMP);
 130
 131         /*
 132          * Go!
 133          */
 134         cfg = hpet_readl(HPET_CFG);
 135         cfg |= HPET_CFG_ENABLE | HPET_CFG_LEGACY;
 136         hpet_writel(cfg, HPET_CFG);
 137
 138         use_hpet = 1;
 139
 140 #ifdef  CONFIG_HPET
 141         {
 142                 struct hpet_data        hd;
 143                 unsigned int            ntimer;
 144
 145                 memset(&hd, 0, sizeof (hd));
 146
 147                 ntimer = hpet_readl(HPET_ID);
 148                 ntimer = (ntimer & HPET_ID_NUMBER) >> HPET_ID_NUMBER_SHIFT;
 149                 ntimer++;
 150
 151                 /*
 152                  * Register with driver.
 153                  * Timer0 and Timer1 is used by platform.
 154                  */
 155                 hd.hd_address = hpet_virt_address;
 156                 hd.hd_nirqs = ntimer;
 157                 hd.hd_flags = HPET_DATA_PLATFORM;
 158 #ifndef CONFIG_HPET_EMULATE_RTC
 159                 hd.hd_state = 0x1;
 160 #else
 161                 hd.hd_state = 0x3;
 162 #endif
 163                 hd.hd_irq[0] = HPET_LEGACY_8254;
 164                 hd.hd_irq[1] = HPET_LEGACY_RTC;
 165                 if (ntimer > 2) {
 166                         struct hpet             *hpet;
 167                         struct hpet_timer       *timer;
 168                         int                     i;
 169
 170                         hpet = (struct hpet *) hpet_virt_address;
 171
 172                         for (i = 2, timer = &hpet->hpet_timers[2]; i < ntimer;
 173                                 timer++, i++)
 174                                 hd.hd_irq[i] = (timer->hpet_config &
 175                                         Tn_INT_ROUTE_CNF_MASK) >>
 176                                         Tn_INT_ROUTE_CNF_SHIFT;
 177
 178                 }
 179
 180                 hpet_alloc(&hd);
 181         }
 182 #endif
 183
 184 #ifdef CONFIG_X86_LOCAL_APIC
 185         wait_timer_tick = wait_hpet_tick;
 186 #endif
 187         return 0;
 188 }
 189
 190 int is_hpet_enabled(void)
 191 {
 192         return use_hpet;
 193 }
 194
 195 int is_hpet_capable(void)
 196 {
 197         if (!boot_hpet_disable && hpet_address)
 198                 return 1;
 199         return 0;
 200 }
 201
 202 static int __init hpet_setup(char* str)
 203 {
 204         if (str) {
 205                 if (!strncmp("disable", str, 7))
 206                         boot_hpet_disable = 1;
 207         }
 208         return 1;
 209 }
 210
 211 __setup("hpet=", hpet_setup);
 212
 213 #ifdef CONFIG_HPET_EMULATE_RTC
 214 /* HPET in LegacyReplacement Mode eats up RTC interrupt line. When, HPET
 215  * is enabled, we support RTC interrupt functionality in software.
 216  * RTC has 3 kinds of interrupts:
 217  * 1) Update Interrupt - generate an interrupt, every sec, when RTC clock
 218  *    is updated
 219  * 2) Alarm Interrupt - generate an interrupt at a specific time of day
 220  * 3) Periodic Interrupt - generate periodic interrupt, with frequencies
 221  *    2Hz-8192Hz (2Hz-64Hz for non-root user) (all freqs in powers of 2)
 222  * (1) and (2) above are implemented using polling at a frequency of
 223  * 64 Hz. The exact frequency is a tradeoff between accuracy and interrupt
 224  * overhead. (DEFAULT_RTC_INT_FREQ)
 225  * For (3), we use interrupts at 64Hz or user specified periodic
 226  * frequency, whichever is higher.
 227  */
 228 #include <linux/mc146818rtc.h>
 229 #include <linux/rtc.h>
 230
 231 extern irqreturn_t rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs);
 232
 233 #define DEFAULT_RTC_INT_FREQ    64
 234 #define RTC_NUM_INTS            1
 235
 236 static unsigned long UIE_on;
 237 static unsigned long prev_update_sec;
 238
 239 static unsigned long AIE_on;
 240 static struct rtc_time alarm_time;
 241
 242 static unsigned long PIE_on;
 243 static unsigned long PIE_freq = DEFAULT_RTC_INT_FREQ;
 244 static unsigned long PIE_count;
 245
 246 static unsigned long hpet_rtc_int_freq; /* RTC interrupt frequency */
 247
 248 /*
 249  * Timer 1 for RTC, we do not use periodic interrupt feature,
 250  * even if HPET supports periodic interrupts on Timer 1.
 251  * The reason being, to set up a periodic interrupt in HPET, we need to
 252  * stop the main counter. And if we do that everytime someone diables/enables
 253  * RTC, we will have adverse effect on main kernel timer running on Timer 0.
 254  * So, for the time being, simulate the periodic interrupt in software.
 255  *
 256  * hpet_rtc_timer_init() is called for the first time and during subsequent
 257  * interuppts reinit happens through hpet_rtc_timer_reinit().
 258  */
 259 int hpet_rtc_timer_init(void)
 260 {
 261         unsigned int cfg, cnt;
 262         unsigned long flags;
 263
 264         if (!is_hpet_enabled())
 265                 return 0;
 266         /*
 267          * Set the counter 1 and enable the interrupts.
 268          */
 269         if (PIE_on && (PIE_freq > DEFAULT_RTC_INT_FREQ))
 270                 hpet_rtc_int_freq = PIE_freq;
 271         else
 272                 hpet_rtc_int_freq = DEFAULT_RTC_INT_FREQ;
 273
 274         local_irq_save(flags);
 275         cnt = hpet_readl(HPET_COUNTER);
 276         cnt += ((hpet_tick*HZ)/hpet_rtc_int_freq);
 277         hpet_writel(cnt, HPET_T1_CMP);
 278         local_irq_restore(flags);
 279
 280         cfg = hpet_readl(HPET_T1_CFG);
 281         cfg |= HPET_TN_ENABLE | HPET_TN_SETVAL | HPET_TN_32BIT;
 282         hpet_writel(cfg, HPET_T1_CFG);
 283
 284         return 1;
 285 }
 286
 287 static void hpet_rtc_timer_reinit(void)
 288 {
 289         unsigned int cfg, cnt;
 290
 291         if (!(PIE_on | AIE_on | UIE_on))
 292                 return;
 293
 294         if (PIE_on && (PIE_freq > DEFAULT_RTC_INT_FREQ))
 295                 hpet_rtc_int_freq = PIE_freq;
 296         else
 297                 hpet_rtc_int_freq = DEFAULT_RTC_INT_FREQ;
 298
 299         /* It is more accurate to use the comparator value than current count.*/
 300         cnt = hpet_readl(HPET_T1_CMP);
 301         cnt += hpet_tick*HZ/hpet_rtc_int_freq;
 302         hpet_writel(cnt, HPET_T1_CMP);
 303
 304         cfg = hpet_readl(HPET_T1_CFG);
 305         cfg |= HPET_TN_ENABLE | HPET_TN_SETVAL | HPET_TN_32BIT;
 306         hpet_writel(cfg, HPET_T1_CFG);
 307
 308         return;
 309 }
 310
 311 /*
 312  * The functions below are called from rtc driver.
 313  * Return 0 if HPET is not being used.
 314  * Otherwise do the necessary changes and return 1.
 315  */
 316 int hpet_mask_rtc_irq_bit(unsigned long bit_mask)
 317 {
 318         if (!is_hpet_enabled())
 319                 return 0;
 320
 321         if (bit_mask & RTC_UIE)
 322                 UIE_on = 0;
 323         if (bit_mask & RTC_PIE)
 324                 PIE_on = 0;
 325         if (bit_mask & RTC_AIE)
 326                 AIE_on = 0;
 327
 328         return 1;
 329 }
 330
 331 int hpet_set_rtc_irq_bit(unsigned long bit_mask)
 332 {
 333         int timer_init_reqd = 0;
 334
 335         if (!is_hpet_enabled())
 336                 return 0;
 337
 338         if (!(PIE_on | AIE_on | UIE_on))
 339                 timer_init_reqd = 1;
 340
 341         if (bit_mask & RTC_UIE) {
 342                 UIE_on = 1;
 343         }
 344         if (bit_mask & RTC_PIE) {
 345                 PIE_on = 1;
 346                 PIE_count = 0;
 347         }
 348         if (bit_mask & RTC_AIE) {
 349                 AIE_on = 1;
 350         }
 351
 352         if (timer_init_reqd)
 353                 hpet_rtc_timer_init();
 354
 355         return 1;
 356 }
 357
 358 int hpet_set_alarm_time(unsigned char hrs, unsigned char min, unsigned char sec)
 359 {
 360         if (!is_hpet_enabled())
 361                 return 0;
 362
 363         alarm_time.tm_hour = hrs;
 364         alarm_time.tm_min = min;
 365         alarm_time.tm_sec = sec;
 366
 367         return 1;
 368 }
 369
 370 int hpet_set_periodic_freq(unsigned long freq)
 371 {
 372         if (!is_hpet_enabled())
 373                 return 0;
 374
 375         PIE_freq = freq;
 376         PIE_count = 0;
 377
 378         return 1;
 379 }
 380
 381 int hpet_rtc_dropped_irq(void)
 382 {
 383         if (!is_hpet_enabled())
 384                 return 0;
 385
 386         return 1;
 387 }
 388
 389 irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 390 {
 391         struct rtc_time curr_time;
 392         unsigned long rtc_int_flag = 0;
 393         int call_rtc_interrupt = 0;
 394
 395         hpet_rtc_timer_reinit();
 396
 397         if (UIE_on | AIE_on) {
 398                 rtc_get_rtc_time(&curr_time);
 399         }
 400         if (UIE_on) {
 401                 if (curr_time.tm_sec != prev_update_sec) {
 402                         /* Set update int info, call real rtc int routine */
 403                         call_rtc_interrupt = 1;
 404                         rtc_int_flag = RTC_UF;
 405                         prev_update_sec = curr_time.tm_sec;
 406                 }
 407         }
 408         if (PIE_on) {
 409                 PIE_count++;
 410                 if (PIE_count >= hpet_rtc_int_freq/PIE_freq) {
 411                         /* Set periodic int info, call real rtc int routine */
 412                         call_rtc_interrupt = 1;
 413                         rtc_int_flag |= RTC_PF;
 414                         PIE_count = 0;
 415                 }
 416         }
 417         if (AIE_on) {
 418                 if ((curr_time.tm_sec == alarm_time.tm_sec) &&
 419                     (curr_time.tm_min == alarm_time.tm_min) &&
 420                     (curr_time.tm_hour == alarm_time.tm_hour)) {
 421                         /* Set alarm int info, call real rtc int routine */
 422                         call_rtc_interrupt = 1;
 423                         rtc_int_flag |= RTC_AF;
 424                 }
 425         }
 426         if (call_rtc_interrupt) {
 427                 rtc_int_flag |= (RTC_IRQF | (RTC_NUM_INTS << 8));
 428                 rtc_interrupt(rtc_int_flag, dev_id, regs);
 429         }
 430         return IRQ_HANDLED;
 431 }
 432 #endif
 433