1 // 16bit code to handle system clocks.
3 // Copyright (C) 2008-2010 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU LGPLv3 license.
8 #include "biosvar.h" // SET_BDA
9 #include "util.h" // debug_enter
10 #include "disk.h" // floppy_tick
11 #include "cmos.h" // inb_cmos
12 #include "pic.h" // eoi_pic1
13 #include "bregs.h" // struct bregs
14 #include "biosvar.h" // GET_GLOBAL
15 #include "usb-hid.h" // usb_check_event
18 #define RTC_A_UIP 0x80
20 #define RTC_B_SET 0x80
21 #define RTC_B_PIE 0x40
22 #define RTC_B_AIE 0x20
23 #define RTC_B_UIE 0x10
24 #define RTC_B_BIN 0x04
25 #define RTC_B_24HR 0x02
26 #define RTC_B_DSE 0x01
29 // Bits for PORT_PS2_CTRLB
30 #define PPCB_T2GATE (1<<0)
31 #define PPCB_SPKR (1<<1)
32 #define PPCB_T2OUT (1<<5)
34 // Bits for PORT_PIT_MODE
35 #define PM_SEL_TIMER0 (0<<6)
36 #define PM_SEL_TIMER1 (1<<6)
37 #define PM_SEL_TIMER2 (2<<6)
38 #define PM_SEL_READBACK (3<<6)
39 #define PM_ACCESS_LATCH (0<<4)
40 #define PM_ACCESS_LOBYTE (1<<4)
41 #define PM_ACCESS_HIBYTE (2<<4)
42 #define PM_ACCESS_WORD (3<<4)
43 #define PM_MODE0 (0<<1)
44 #define PM_MODE1 (1<<1)
45 #define PM_MODE2 (2<<1)
46 #define PM_MODE3 (3<<1)
47 #define PM_MODE4 (4<<1)
48 #define PM_MODE5 (5<<1)
49 #define PM_CNT_BINARY (0<<0)
50 #define PM_CNT_BCD (1<<0)
53 /****************************************************************
55 ****************************************************************/
57 #define CALIBRATE_COUNT 0x800 // Approx 1.7ms
59 u32 cpu_khz VAR16VISIBLE;
65 u8 orig = inb(PORT_PS2_CTRLB);
66 outb((orig & ~PPCB_SPKR) | PPCB_T2GATE, PORT_PS2_CTRLB);
67 /* binary, mode 0, LSB/MSB, Ch 2 */
68 outb(PM_SEL_TIMER2|PM_ACCESS_WORD|PM_MODE0|PM_CNT_BINARY, PORT_PIT_MODE);
70 outb(CALIBRATE_COUNT & 0xFF, PORT_PIT_COUNTER2);
72 outb(CALIBRATE_COUNT >> 8, PORT_PIT_COUNTER2);
74 u64 start = rdtscll();
75 while ((inb(PORT_PS2_CTRLB) & PPCB_T2OUT) == 0)
79 // Restore PORT_PS2_CTRLB
80 outb(orig, PORT_PS2_CTRLB);
82 // Store calibrated cpu khz.
83 u64 diff = end - start;
84 dprintf(6, "tsc calibrate start=%u end=%u diff=%u\n"
85 , (u32)start, (u32)end, (u32)diff);
86 u32 hz = diff * PIT_TICK_RATE / CALIBRATE_COUNT;
87 SET_GLOBAL(cpu_khz, hz / 1000);
89 dprintf(1, "CPU Mhz=%u\n", hz / 1000000);
95 u64 start = rdtscll();
96 u64 end = start + diff;
97 while (!check_tsc(end))
104 u64 start = rdtscll();
105 u64 end = start + diff;
106 while (!check_tsc(end))
110 void ndelay(u32 count) {
111 tscdelay(count * GET_GLOBAL(cpu_khz) / 1000000);
113 void udelay(u32 count) {
114 tscdelay(count * GET_GLOBAL(cpu_khz) / 1000);
116 void mdelay(u32 count) {
117 tscdelay(count * GET_GLOBAL(cpu_khz));
120 void nsleep(u32 count) {
121 tscsleep(count * GET_GLOBAL(cpu_khz) / 1000000);
123 void usleep(u32 count) {
124 tscsleep(count * GET_GLOBAL(cpu_khz) / 1000);
126 void msleep(u32 count) {
127 tscsleep(count * GET_GLOBAL(cpu_khz));
130 // Return the TSC value that is 'msecs' time in the future.
132 calc_future_tsc(u32 msecs)
134 u32 khz = GET_GLOBAL(cpu_khz);
135 return rdtscll() + ((u64)khz * msecs);
138 calc_future_tsc_usec(u32 usecs)
140 u32 khz = GET_GLOBAL(cpu_khz);
141 return rdtscll() + ((u64)(khz/1000) * usecs);
145 /****************************************************************
147 ****************************************************************/
152 // This function checks to see if the update-in-progress bit
153 // is set in CMOS Status Register A. If not, it returns 0.
154 // If it is set, it tries to wait until there is a transition
155 // to 0, and will return 0 if such a transition occurs. A -1
156 // is returned only after timing out. The maximum period
157 // that this bit should be set is constrained to (1984+244)
158 // useconds, but we wait for longer just to be sure.
160 if ((inb_cmos(CMOS_STATUS_A) & RTC_A_UIP) == 0)
162 u64 end = calc_future_tsc(15);
164 if ((inb_cmos(CMOS_STATUS_A) & RTC_A_UIP) == 0)
167 // update-in-progress never transitioned to 0
176 // timer0: binary count, 16bit count, mode 2
177 outb(PM_SEL_TIMER0|PM_ACCESS_WORD|PM_MODE2|PM_CNT_BINARY, PORT_PIT_MODE);
178 // maximum count of 0000H = 18.2Hz
179 outb(0x0, PORT_PIT_COUNTER0);
180 outb(0x0, PORT_PIT_COUNTER0);
186 outb_cmos(0x26, CMOS_STATUS_A); // 32,768Khz src, 976.5625us updates
187 u8 regB = inb_cmos(CMOS_STATUS_B);
188 outb_cmos((regB & RTC_B_DSE) | RTC_B_24HR, CMOS_STATUS_B);
189 inb_cmos(CMOS_STATUS_C);
190 inb_cmos(CMOS_STATUS_D);
196 return (val & 0xf) + ((val >> 4) * 10);
202 dprintf(3, "init timer\n");
208 u32 seconds = bcd2bin(inb_cmos(CMOS_RTC_SECONDS));
209 u32 minutes = bcd2bin(inb_cmos(CMOS_RTC_MINUTES));
210 u32 hours = bcd2bin(inb_cmos(CMOS_RTC_HOURS));
211 u32 ticks = (hours * 60 + minutes) * 60 + seconds;
212 ticks = ((u64)ticks * PIT_TICK_RATE) / PIT_TICK_INTERVAL;
213 SET_BDA(timer_counter, ticks);
214 SET_BDA(timer_rollover, 0);
216 enable_hwirq(0, FUNC16(entry_08));
217 enable_hwirq(8, FUNC16(entry_70));
221 /****************************************************************
222 * Standard clock functions
223 ****************************************************************/
225 #define TICKS_PER_DAY (u32)((u64)60*60*24*PIT_TICK_RATE / PIT_TICK_INTERVAL)
227 // Calculate the timer value at 'count' number of full timer ticks in
230 calc_future_timer_ticks(u32 count)
232 return (GET_BDA(timer_counter) + count + 1) % TICKS_PER_DAY;
235 // Return the timer value that is 'msecs' time in the future.
237 calc_future_timer(u32 msecs)
240 return GET_BDA(timer_counter);
241 u32 kticks = DIV_ROUND_UP((u64)msecs * PIT_TICK_RATE, PIT_TICK_INTERVAL);
242 u32 ticks = DIV_ROUND_UP(kticks, 1000);
243 return calc_future_timer_ticks(ticks);
246 // Check if the given timer value has passed.
250 return (((GET_BDA(timer_counter) + TICKS_PER_DAY - end) % TICKS_PER_DAY)
251 < (TICKS_PER_DAY/2));
254 // get current clock count
256 handle_1a00(struct bregs *regs)
259 u32 ticks = GET_BDA(timer_counter);
260 regs->cx = ticks >> 16;
262 regs->al = GET_BDA(timer_rollover);
263 SET_BDA(timer_rollover, 0); // reset flag
267 // Set Current Clock Count
269 handle_1a01(struct bregs *regs)
271 u32 ticks = (regs->cx << 16) | regs->dx;
272 SET_BDA(timer_counter, ticks);
273 SET_BDA(timer_rollover, 0); // reset flag
274 // XXX - should use set_code_success()?
281 handle_1a02(struct bregs *regs)
283 if (rtc_updating()) {
288 regs->dh = inb_cmos(CMOS_RTC_SECONDS);
289 regs->cl = inb_cmos(CMOS_RTC_MINUTES);
290 regs->ch = inb_cmos(CMOS_RTC_HOURS);
291 regs->dl = inb_cmos(CMOS_STATUS_B) & RTC_B_DSE;
299 handle_1a03(struct bregs *regs)
301 // Using a debugger, I notice the following masking/setting
302 // of bits in Status Register B, by setting Reg B to
303 // a few values and getting its value after INT 1A was called.
306 // before 1111 1101 0111 1101 0000 0000
307 // after 0110 0010 0110 0010 0000 0010
309 // Bit4 in try#1 flipped in hardware (forced low) due to bit7=1
310 // My assumption: RegB = ((RegB & 01100000b) | 00000010b)
311 if (rtc_updating()) {
313 // fall through as if an update were not in progress
315 outb_cmos(regs->dh, CMOS_RTC_SECONDS);
316 outb_cmos(regs->cl, CMOS_RTC_MINUTES);
317 outb_cmos(regs->ch, CMOS_RTC_HOURS);
318 // Set Daylight Savings time enabled bit to requested value
319 u8 val8 = ((inb_cmos(CMOS_STATUS_B) & (RTC_B_PIE|RTC_B_AIE))
320 | RTC_B_24HR | (regs->dl & RTC_B_DSE));
321 outb_cmos(val8, CMOS_STATUS_B);
323 regs->al = val8; // val last written to Reg B
329 handle_1a04(struct bregs *regs)
332 if (rtc_updating()) {
336 regs->cl = inb_cmos(CMOS_RTC_YEAR);
337 regs->dh = inb_cmos(CMOS_RTC_MONTH);
338 regs->dl = inb_cmos(CMOS_RTC_DAY_MONTH);
339 if (CONFIG_COREBOOT) {
345 regs->ch = inb_cmos(CMOS_CENTURY);
353 handle_1a05(struct bregs *regs)
355 // Using a debugger, I notice the following masking/setting
356 // of bits in Status Register B, by setting Reg B to
357 // a few values and getting its value after INT 1A was called.
359 // try#1 try#2 try#3 try#4
360 // before 1111 1101 0111 1101 0000 0010 0000 0000
361 // after 0110 1101 0111 1101 0000 0010 0000 0000
363 // Bit4 in try#1 flipped in hardware (forced low) due to bit7=1
364 // My assumption: RegB = (RegB & 01111111b)
365 if (rtc_updating()) {
370 outb_cmos(regs->cl, CMOS_RTC_YEAR);
371 outb_cmos(regs->dh, CMOS_RTC_MONTH);
372 outb_cmos(regs->dl, CMOS_RTC_DAY_MONTH);
373 if (!CONFIG_COREBOOT)
374 outb_cmos(regs->ch, CMOS_CENTURY);
375 // clear halt-clock bit
376 u8 val8 = inb_cmos(CMOS_STATUS_B) & ~RTC_B_SET;
377 outb_cmos(val8, CMOS_STATUS_B);
379 regs->al = val8; // AL = val last written to Reg B
383 // Set Alarm Time in CMOS
385 handle_1a06(struct bregs *regs)
387 // Using a debugger, I notice the following masking/setting
388 // of bits in Status Register B, by setting Reg B to
389 // a few values and getting its value after INT 1A was called.
392 // before 1101 1111 0101 1111 0000 0000
393 // after 0110 1111 0111 1111 0010 0000
395 // Bit4 in try#1 flipped in hardware (forced low) due to bit7=1
396 // My assumption: RegB = ((RegB & 01111111b) | 00100000b)
397 u8 val8 = inb_cmos(CMOS_STATUS_B); // Get Status Reg B
399 if (val8 & RTC_B_AIE) {
400 // Alarm interrupt enabled already
404 if (rtc_updating()) {
406 // fall through as if an update were not in progress
408 outb_cmos(regs->dh, CMOS_RTC_SECONDS_ALARM);
409 outb_cmos(regs->cl, CMOS_RTC_MINUTES_ALARM);
410 outb_cmos(regs->ch, CMOS_RTC_HOURS_ALARM);
411 // enable Status Reg B alarm bit, clear halt clock bit
412 outb_cmos((val8 & ~RTC_B_SET) | RTC_B_AIE, CMOS_STATUS_B);
418 handle_1a07(struct bregs *regs)
420 // Using a debugger, I notice the following masking/setting
421 // of bits in Status Register B, by setting Reg B to
422 // a few values and getting its value after INT 1A was called.
424 // try#1 try#2 try#3 try#4
425 // before 1111 1101 0111 1101 0010 0000 0010 0010
426 // after 0100 0101 0101 0101 0000 0000 0000 0010
428 // Bit4 in try#1 flipped in hardware (forced low) due to bit7=1
429 // My assumption: RegB = (RegB & 01010111b)
430 u8 val8 = inb_cmos(CMOS_STATUS_B); // Get Status Reg B
431 // clear clock-halt bit, disable alarm bit
432 outb_cmos(val8 & ~(RTC_B_SET|RTC_B_AIE), CMOS_STATUS_B);
434 regs->al = val8; // val last written to Reg B
440 handle_1aXX(struct bregs *regs)
442 set_unimplemented(regs);
445 // INT 1Ah Time-of-day Service Entry Point
447 handle_1a(struct bregs *regs)
449 debug_enter(regs, DEBUG_HDL_1a);
451 case 0x00: handle_1a00(regs); break;
452 case 0x01: handle_1a01(regs); break;
453 case 0x02: handle_1a02(regs); break;
454 case 0x03: handle_1a03(regs); break;
455 case 0x04: handle_1a04(regs); break;
456 case 0x05: handle_1a05(regs); break;
457 case 0x06: handle_1a06(regs); break;
458 case 0x07: handle_1a07(regs); break;
459 case 0xb1: handle_1ab1(regs); break;
460 default: handle_1aXX(regs); break;
464 // INT 08h System Timer ISR Entry Point
468 debug_isr(DEBUG_ISR_08);
472 u32 counter = GET_BDA(timer_counter);
474 // compare to one days worth of timer ticks at 18.2 hz
475 if (counter >= TICKS_PER_DAY) {
476 // there has been a midnight rollover at this point
478 SET_BDA(timer_rollover, GET_BDA(timer_rollover) + 1);
481 SET_BDA(timer_counter, counter);
485 // chain to user timer tick INT #0x1c
487 call16_simpint(0x1c, &eax, &flags);
493 /****************************************************************
495 ****************************************************************/
500 u16 ebda_seg = get_ebda_seg();
501 int count = GET_EBDA2(ebda_seg, RTCusers);
502 SET_EBDA2(ebda_seg, RTCusers, count+1);
505 // Turn on the Periodic Interrupt timer
506 u8 bRegister = inb_cmos(CMOS_STATUS_B);
507 outb_cmos(bRegister | RTC_B_PIE, CMOS_STATUS_B);
513 u16 ebda_seg = get_ebda_seg();
514 int count = GET_EBDA2(ebda_seg, RTCusers);
515 SET_EBDA2(ebda_seg, RTCusers, count-1);
518 // Clear the Periodic Interrupt.
519 u8 bRegister = inb_cmos(CMOS_STATUS_B);
520 outb_cmos(bRegister & ~RTC_B_PIE, CMOS_STATUS_B);
524 set_usertimer(u32 usecs, u16 seg, u16 offset)
526 if (GET_BDA(rtc_wait_flag) & RWS_WAIT_PENDING)
529 // Interval not already set.
530 SET_BDA(rtc_wait_flag, RWS_WAIT_PENDING); // Set status byte.
531 SET_BDA(user_wait_complete_flag, SEGOFF(seg, offset));
532 SET_BDA(user_wait_timeout, usecs);
538 clear_usertimer(void)
540 if (!(GET_BDA(rtc_wait_flag) & RWS_WAIT_PENDING))
542 // Turn off status byte.
543 SET_BDA(rtc_wait_flag, 0);
547 #define RET_ECLOCKINUSE 0x83
549 // Wait for CX:DX microseconds
551 handle_1586(struct bregs *regs)
553 // Use the rtc to wait for the specified time.
555 u32 count = (regs->cx << 16) | regs->dx;
556 int ret = set_usertimer(count, GET_SEG(SS), (u32)&statusflag);
558 set_code_invalid(regs, RET_ECLOCKINUSE);
566 // Set Interval requested.
568 handle_158300(struct bregs *regs)
570 int ret = set_usertimer((regs->cx << 16) | regs->dx, regs->es, regs->bx);
572 // Interval already set.
573 set_code_invalid(regs, RET_EUNSUPPORTED);
578 // Clear interval requested
580 handle_158301(struct bregs *regs)
587 handle_1583XX(struct bregs *regs)
589 set_code_unimplemented(regs, RET_EUNSUPPORTED);
594 handle_1583(struct bregs *regs)
597 case 0x00: handle_158300(regs); break;
598 case 0x01: handle_158301(regs); break;
599 default: handle_1583XX(regs); break;
603 #define USEC_PER_RTC DIV_ROUND_CLOSEST(1000000, 1024)
605 // int70h: IRQ8 - CMOS RTC
609 debug_isr(DEBUG_ISR_70);
611 // Check which modes are enabled and have occurred.
612 u8 registerB = inb_cmos(CMOS_STATUS_B);
613 u8 registerC = inb_cmos(CMOS_STATUS_C);
615 if (!(registerB & (RTC_B_PIE|RTC_B_AIE)))
617 if (registerC & RTC_B_AIE) {
618 // Handle Alarm Interrupt.
620 call16_simpint(0x4a, &eax, &flags);
622 if (!(registerC & RTC_B_PIE))
625 // Handle Periodic Interrupt.
629 if (!GET_BDA(rtc_wait_flag))
632 // Wait Interval (Int 15, AH=83) active.
633 u32 time = GET_BDA(user_wait_timeout); // Time left in microseconds.
634 if (time < USEC_PER_RTC) {
635 // Done waiting - write to specified flag byte.
636 struct segoff_s segoff = GET_BDA(user_wait_complete_flag);
637 u16 ptr_seg = segoff.seg;
638 u8 *ptr_far = (u8*)(segoff.offset+0);
639 u8 oldval = GET_FARVAR(ptr_seg, *ptr_far);
640 SET_FARVAR(ptr_seg, *ptr_far, oldval | 0x80);
645 time -= USEC_PER_RTC;
646 SET_BDA(user_wait_timeout, time);