2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Peter Dinda <pdinda@northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Peter Dinda <pdinda@northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
21 #include <palacios/vmm_dev_mgr.h>
22 #include <palacios/vmm.h>
23 #include <palacios/vmm_types.h>
25 #include <palacios/vmm_lock.h>
27 #include <devices/ide.h>
28 #include <palacios/vmm_intr.h>
29 #include <palacios/vmm_host_events.h>
30 #include <palacios/vm_guest.h>
33 #ifndef V3_CONFIG_DEBUG_NVRAM
35 #define PrintDebug(fmt, args...)
39 #define NVRAM_REG_PORT 0x70
40 #define NVRAM_DATA_PORT 0x71
42 #define NVRAM_RTC_IRQ 0x8
45 typedef enum {NVRAM_READY, NVRAM_REG_POSTED} nvram_state_t;
48 #define NVRAM_REG_MAX 256
51 // These are borrowed from Bochs, which borrowed from
52 // Ralf Brown's interupt list, and extended
53 #define NVRAM_REG_SEC 0x00
54 #define NVRAM_REG_SEC_ALARM 0x01
55 #define NVRAM_REG_MIN 0x02
56 #define NVRAM_REG_MIN_ALARM 0x03
57 #define NVRAM_REG_HOUR 0x04
58 #define NVRAM_REG_HOUR_ALARM 0x05
59 #define NVRAM_REG_WEEK_DAY 0x06
60 #define NVRAM_REG_MONTH_DAY 0x07
61 #define NVRAM_REG_MONTH 0x08
62 #define NVRAM_REG_YEAR 0x09
63 #define NVRAM_REG_STAT_A 0x0a
64 #define NVRAM_REG_STAT_B 0x0b
65 #define NVRAM_REG_STAT_C 0x0c
66 #define NVRAM_REG_STAT_D 0x0d
67 #define NVRAM_REG_DIAGNOSTIC_STATUS 0x0e
68 #define NVRAM_REG_SHUTDOWN_STATUS 0x0f
70 #define NVRAM_IBM_HD_DATA 0x12
71 #define NVRAM_IDE_TRANSLATION 0x39
73 #define NVRAM_REG_FLOPPY_TYPE 0x10
74 #define NVRAM_REG_EQUIPMENT_BYTE 0x14
76 #define NVRAM_REG_BASE_MEMORY_HIGH 0x16
77 #define NVRAM_REG_BASE_MEMORY_LOW 0x15
79 #define NVRAM_REG_EXT_MEMORY_HIGH 0x18
80 #define NVRAM_REG_EXT_MEMORY_LOW 0x17
82 #define NVRAM_REG_EXT_MEMORY_2ND_HIGH 0x31
83 #define NVRAM_REG_EXT_MEMORY_2ND_LOW 0x30
85 #define NVRAM_REG_BOOTSEQ_OLD 0x2d
87 #define NVRAM_REG_AMI_BIG_MEMORY_HIGH 0x35
88 #define NVRAM_REG_AMI_BIG_MEMORY_LOW 0x34
90 #define NVRAM_REG_CSUM_HIGH 0x2e
91 #define NVRAM_REG_CSUM_LOW 0x2f
92 #define NVRAM_REG_IBM_CENTURY_BYTE 0x32
93 #define NVRAM_REG_IBM_PS2_CENTURY_BYTE 0x37
95 #define NVRAM_REG_BOOTSEQ_NEW_FIRST 0x3D
96 #define NVRAM_REG_BOOTSEQ_NEW_SECOND 0x38
98 #define CHECKSUM_REGION_FIRST_BYTE 0x10
99 #define CHECKSUM_REGION_LAST_BYTE 0x2d
102 struct nvram_internal {
103 nvram_state_t dev_state;
105 uint8_t mem_state[NVRAM_REG_MAX];
106 uint8_t reg_map[NVRAM_REG_MAX / 8];
108 struct vm_device * ide;
110 struct v3_vm_info * vm;
112 struct v3_timer *timer;
114 v3_lock_t nvram_lock;
116 uint64_t us; //microseconds - for clock update - zeroed every second
117 uint64_t pus; //microseconds - for periodic interrupt - cleared every period
122 uint8_t rate : 4; // clock rate = 65536Hz / 2 rate (0110=1024 Hz)
123 uint8_t basis : 3; // time base, 010 = 32,768 Hz
124 uint8_t uip : 1; // 1=update in progress
125 } __attribute__((__packed__)) __attribute__((__aligned__ (1))) ;
128 uint8_t sum : 1; // 1=summer (daylight savings)
129 uint8_t h24 : 1; // 1=24h clock
130 uint8_t dm : 1; // 0=date/time is in bcd, 1=binary
131 uint8_t rec : 1; // 1=rectangular signal
132 uint8_t ui : 1; // 1=update interrupt
133 uint8_t ai : 1; // 1=alarm interrupt
134 uint8_t pi : 1; // 1=periodic interrupt
135 uint8_t set : 1; // 1=blocked update
136 } __attribute__((__packed__)) __attribute__((__aligned__ (1))) ;
139 uint8_t res : 4; // reserved
140 uint8_t uf : 1; // 1=source of interrupt is update
141 uint8_t af : 1; // 1=source of interrupt is alarm interrupt
142 uint8_t pf : 1; // 1=source of interrupt is periodic interrupt
143 uint8_t irq : 1; // 1=interrupt requested
144 } __attribute__((__packed__)) __attribute__((__aligned__ (1))) ;
147 uint8_t res : 7; // reserved
148 uint8_t val : 1; // 1=cmos ram data is OK
149 } __attribute__((__packed__)) __attribute__((__aligned__ (1))) ;
157 } __attribute__((packed));;
161 static void set_reg_num(struct nvram_internal * nvram, uint8_t reg_num) {
162 int major = (reg_num / 8);
163 int minor = reg_num % 8;
165 nvram->reg_map[major] |= (0x1 << minor);
168 static int is_reg_set(struct nvram_internal * nvram, uint8_t reg_num) {
169 int major = (reg_num / 8);
170 int minor = reg_num % 8;
172 return (nvram->reg_map[major] & (0x1 << minor)) ? 1 : 0;
176 static void set_memory(struct nvram_internal * nvram, uint8_t reg, uint8_t val) {
177 set_reg_num(nvram, reg);
178 nvram->mem_state[reg] = val;
181 static int get_memory(struct nvram_internal * nvram, uint8_t reg, uint8_t * val) {
183 if (!is_reg_set(nvram, reg)) {
188 *val = nvram->mem_state[reg];
193 static uint8_t add_to(uint8_t * left, uint8_t * right, uint8_t bcd) {
197 struct bcd_num * bl = (struct bcd_num *)left;
198 struct bcd_num * br = (struct bcd_num *)right;
202 carry = bl->bot / 0xa;
205 bl->top += carry + br->top;
206 carry = bl->top / 0xa;
223 static uint8_t days_in_month(uint8_t month, uint8_t bcd) {
224 // This completely ignores Julian / Gregorian stuff right now
281 static void update_time(struct nvram_internal * data, uint64_t period_us) {
282 struct rtc_stata * stata = (struct rtc_stata *)&((data->mem_state[NVRAM_REG_STAT_A]));
283 struct rtc_statb * statb = (struct rtc_statb *)&((data->mem_state[NVRAM_REG_STAT_B]));
284 struct rtc_statc * statc = (struct rtc_statc *)&((data->mem_state[NVRAM_REG_STAT_C]));
285 //struct rtc_statd *statd = (struct rtc_statd *) &((data->mem_state[NVRAM_REG_STAT_D]));
286 uint8_t * sec = (uint8_t *)&(data->mem_state[NVRAM_REG_SEC]);
287 uint8_t * min = (uint8_t *)&(data->mem_state[NVRAM_REG_MIN]);
288 uint8_t * hour = (uint8_t *)&(data->mem_state[NVRAM_REG_HOUR]);
289 uint8_t * weekday = (uint8_t *)&(data->mem_state[NVRAM_REG_WEEK_DAY]);
290 uint8_t * monthday = (uint8_t *)&(data->mem_state[NVRAM_REG_MONTH_DAY]);
291 uint8_t * month = (uint8_t *)&(data->mem_state[NVRAM_REG_MONTH]);
292 uint8_t * year = (uint8_t *)&(data->mem_state[NVRAM_REG_YEAR]);
293 uint8_t * cent = (uint8_t *)&(data->mem_state[NVRAM_REG_IBM_CENTURY_BYTE]);
294 uint8_t * cent_ps2 = (uint8_t *)&(data->mem_state[NVRAM_REG_IBM_PS2_CENTURY_BYTE]);
295 uint8_t * seca = (uint8_t *)&(data->mem_state[NVRAM_REG_SEC_ALARM]);
296 uint8_t * mina = (uint8_t *)&(data->mem_state[NVRAM_REG_MIN_ALARM]);
297 uint8_t * houra = (uint8_t *)&(data->mem_state[NVRAM_REG_HOUR_ALARM]);
300 uint8_t bcd = (statb->dm == 0);
303 uint32_t periodic_period;
305 PrintDebug("nvram: update_time by %llu microseocnds\n",period_us);
307 // We will set these flags on exit
313 // We will reset us after one second
314 data->us += period_us;
315 // We will reset pus after one periodic_period
316 data->pus += period_us;
318 if (data->us > 1000000) {
320 carry = add_to(sec, &carry, bcd);
323 PrintError("nvram: somehow managed to get a carry in second update\n");
326 if ( (bcd && (*sec == 0x60)) ||
327 ((!bcd) && (*sec == 60))) {
332 carry = add_to(min, &carry, bcd);
334 PrintError("nvram: somehow managed to get a carry in minute update\n");
337 if ( (bcd && (*min == 0x60)) ||
338 ((!bcd) && (*min == 60))) {
347 uint8_t temp = ((bcd) ? 0x12 : 12);
348 add_to(&hour24, &temp, bcd);
353 carry = add_to(&hour24, &carry, bcd);
355 PrintError("nvram: somehow managed to get a carry in hour update\n");
358 if ( (bcd && (hour24 == 0x24)) ||
359 ((!bcd) && (hour24 == 24))) {
371 if ( (bcd && (hour24 < 0x12)) ||
372 ((!bcd) && (hour24 < 12))) {
378 *hour = (hour24 - 12) | 0x80;
381 struct bcd_num * n = (struct bcd_num *)hour;
394 // now see if we need to carry into the days and further
397 add_to(weekday, &carry, bcd);
399 *weekday %= 0x7; // same regardless of bcd
401 if ((*monthday) != days_in_month(*month, bcd)) {
402 add_to(monthday, &carry, bcd);
407 add_to(month, &carry, bcd);
409 if ( (bcd && (*month == 0x13)) ||
410 ((!bcd) && (*month == 13))) {
411 *month = 1; // same for both
414 carry = add_to(year, &carry, bcd);
416 if ( (bcd && carry) ||
417 ((!bcd) && (*year == 100))) {
420 add_to(cent, &carry, bcd);
431 // OK, now check for the alarm, if it is set to interrupt
433 if ((*sec == *seca) && (*min == *mina) && (*hour == *houra)) {
435 PrintDebug("nvram: interrupt on alarm\n");
441 periodic_period = 1000000 / (65536 / (0x1 << stata->rate));
442 if (data->pus >= periodic_period) {
444 data->pus -= periodic_period;
445 PrintDebug("nvram: interrupt on periodic\n");
451 PrintDebug("nvram: interrupt on update\n");
454 statc->irq = (statc->pf || statc->af || statc->uf);
456 PrintDebug("nvram: time is now: YMDHMS: 0x%x:0x%x:0x%x:0x%x:0x%x,0x%x bcd=%d\n", *year, *month, *monthday, *hour, *min, *sec,bcd);
458 // Interrupt associated VM, if needed
460 PrintDebug("nvram: injecting interrupt\n");
461 v3_raise_irq(data->vm, NVRAM_RTC_IRQ);
466 static void nvram_update_timer(struct guest_info *vm,
471 struct nvram_internal *nvram_state = (struct nvram_internal *)priv_data;
476 period_us = (1000*cpu_cycles/cpu_freq);
478 update_time(nvram_state,period_us);
483 static void set_memory_size(struct nvram_internal * nvram, addr_t bytes) {
484 // 1. Conventional Mem: 0-640k in K
485 // 2. Extended Mem: 0-16MB in K
486 // 3. Big Mem: 0-4G in 64K
490 // at most 640K of conventional memory
491 if (bytes > 640 * 1024) {
497 set_memory(nvram, NVRAM_REG_BASE_MEMORY_HIGH, (memk >> 8) & 0x00ff);
498 set_memory(nvram, NVRAM_REG_BASE_MEMORY_LOW, memk & 0x00ff);
500 // set extended memory - first 1 MB is lost to 640K chunk
501 // extended memory is min(0MB, bytes-1MB)
502 if (bytes < 1024*1024) {
503 // no extended memory
506 memk = (bytes - 1024 * 1024 ) / 1024;
509 set_memory(nvram, NVRAM_REG_EXT_MEMORY_HIGH, (memk >> 8) & 0x00ff);
510 set_memory(nvram, NVRAM_REG_EXT_MEMORY_LOW, memk & 0x00ff);
511 set_memory(nvram, NVRAM_REG_EXT_MEMORY_2ND_HIGH, (memk >> 8) & 0x00ff);
512 set_memory(nvram, NVRAM_REG_EXT_MEMORY_2ND_LOW, memk & 0x00ff);
514 // Set the extended memory beyond 16 MB in 64k chunks
515 // this is min(0, bytes-16MB)
516 if (bytes<(1024*1024*16)) {
519 mem_chunks = (bytes - (1024 * 1024 * 16)) / (1024 * 64);
522 set_memory(nvram, NVRAM_REG_AMI_BIG_MEMORY_HIGH, (mem_chunks >> 8) & 0x00ff);
523 set_memory(nvram, NVRAM_REG_AMI_BIG_MEMORY_LOW, mem_chunks & 0x00ff);
530 static void init_harddrives(struct nvram_internal * nvram) {
536 int info_base_reg = 0x1b;
539 // 0x19 == first drive type
540 // 0x1a == second drive type
542 // 0x1b == first drive geometry base
543 // 0x24 == second drive geometry base
545 // It looks like the BIOS only tracks the disks on the first channel at 0x12?
546 for (i = 0; i < 2; i++) {
547 if (v3_ide_get_geometry(nvram->ide->private_data, 0, i, &cyls, &heads, §s) == 0) {
549 int info_reg = info_base_reg + (i * 9);
551 set_memory(nvram, type_reg + i, 0x2f);
553 set_memory(nvram, info_reg, cyls & 0xff);
554 set_memory(nvram, info_reg + 1, (cyls >> 8) & 0xff);
555 set_memory(nvram, info_reg + 2, heads & 0xff);
557 // Write precomp cylinder (1 and 2)
558 set_memory(nvram, info_reg + 3, 0xff);
559 set_memory(nvram, info_reg + 4, 0xff);
561 // harddrive control byte
562 set_memory(nvram, info_reg + 5, 0xc0 | ((heads > 8) << 3));
564 set_memory(nvram, info_reg + 6, cyls & 0xff);
565 set_memory(nvram, info_reg + 7, (cyls >> 8) & 0xff);
567 set_memory(nvram, info_reg + 8, sects & 0xff);
569 hd_data |= (0xf0 >> (i * 4));
573 set_memory(nvram, NVRAM_IBM_HD_DATA, hd_data);
576 #define TRANSLATE_NONE 0x0
577 #define TRANSLATE_LBA 0x1
578 #define TRANSLATE_LARGE 0x2
579 #define TRANSLATE_RECHS 0x3
580 // We're going to do LBA translation for everything...
583 for (i = 0; i < 4; i++) {
584 int chan_num = i / 2;
585 int drive_num = i % 2;
588 if (v3_ide_get_geometry(nvram->ide->private_data, chan_num, drive_num, &tmp[0], &tmp[1], &tmp[2]) == 0) {
589 trans |= TRANSLATE_LBA << (i * 2);
593 set_memory(nvram, NVRAM_IDE_TRANSLATION, trans);
597 static uint16_t compute_checksum(struct nvram_internal * nvram) {
598 uint16_t checksum = 0;
602 /* add all fields between the RTC and the checksum fields */
603 for (reg = CHECKSUM_REGION_FIRST_BYTE; reg < CHECKSUM_REGION_LAST_BYTE; reg++) {
604 /* unset fields are considered zero so get_memory can be ignored */
605 get_memory(nvram, reg, &val);
612 static int init_nvram_state(struct v3_vm_info * vm, struct nvram_internal * nvram) {
613 uint16_t checksum = 0;
615 memset(nvram->mem_state, 0, NVRAM_REG_MAX);
616 memset(nvram->reg_map, 0, NVRAM_REG_MAX / 8);
618 v3_lock_init(&(nvram->nvram_lock));
621 // 2 1.44 MB floppy drives
624 set_memory(nvram, NVRAM_REG_FLOPPY_TYPE, 0x44);
626 set_memory(nvram, NVRAM_REG_FLOPPY_TYPE, 0x00);
630 // For old boot sequence style, do floppy first
632 set_memory(nvram, NVRAM_REG_BOOTSEQ_OLD, 0x10);
635 // For new boot sequence style, do floppy, cd, then hd
636 set_memory(nvram, NVRAM_REG_BOOTSEQ_NEW_FIRST, 0x31);
637 set_memory(nvram, NVRAM_REG_BOOTSEQ_NEW_SECOND, 0x20);
640 // For new boot sequence style, do cd, hd, floppy
641 set_memory(nvram, NVRAM_REG_BOOTSEQ_NEW_FIRST, 0x23);
642 set_memory(nvram, NVRAM_REG_BOOTSEQ_NEW_SECOND, 0x10);
645 // Set equipment byte to note 2 floppies, vga display, keyboard,math,floppy
646 set_memory(nvram, NVRAM_REG_EQUIPMENT_BYTE, 0x4f);
647 // set_memory(nvram, NVRAM_REG_EQUIPMENT_BYTE, 0xf);
650 // Set the shutdown status gently
652 set_memory(nvram, NVRAM_REG_SHUTDOWN_STATUS, 0x0);
656 // 00100110 = no update in progress, base=32768 Hz, rate = 1024 Hz
657 set_memory(nvram, NVRAM_REG_STAT_A, 0x26);
660 // 00000010 = not setting, no interrupts, blocked rect signal, bcd mode (bit 3 = 0), 24 hour, normal time
661 set_memory(nvram, NVRAM_REG_STAT_B, 0x02);
665 // No IRQ requested, result not do to any source
666 set_memory(nvram, NVRAM_REG_STAT_C, 0x00);
670 set_memory(nvram, NVRAM_REG_STAT_D, 0x80);
673 // january 1, 2008, 00:00:00
674 set_memory(nvram, NVRAM_REG_SEC, 0x00);
675 set_memory(nvram, NVRAM_REG_SEC_ALARM, 0x00);
676 set_memory(nvram, NVRAM_REG_MIN, 0x00);
677 set_memory(nvram, NVRAM_REG_MIN_ALARM, 0x00);
678 set_memory(nvram, NVRAM_REG_HOUR, 0x00);
679 set_memory(nvram, NVRAM_REG_HOUR_ALARM, 0x00);
681 set_memory(nvram, NVRAM_REG_MONTH, 0x01);
682 set_memory(nvram, NVRAM_REG_MONTH_DAY, 0x1);
683 set_memory(nvram, NVRAM_REG_WEEK_DAY, 0x1);
684 set_memory(nvram, NVRAM_REG_YEAR, 0x08);
685 set_memory(nvram, NVRAM_REG_IBM_CENTURY_BYTE, 0x20);
686 set_memory(nvram, NVRAM_REG_IBM_PS2_CENTURY_BYTE, 0x20);
688 set_memory(nvram, NVRAM_REG_DIAGNOSTIC_STATUS, 0x00);
693 set_memory_size(nvram, vm->mem_size);
694 init_harddrives(nvram);
696 /* compute checksum (must follow all assignments here) */
697 checksum = compute_checksum(nvram);
698 set_memory(nvram, NVRAM_REG_CSUM_HIGH, (checksum >> 8) & 0xff);
699 set_memory(nvram, NVRAM_REG_CSUM_LOW, checksum & 0xff);
703 nvram->dev_state = NVRAM_READY;
714 static int nvram_write_reg_port(struct guest_info * core, uint16_t port,
715 void * src, uint_t length, void * priv_data) {
717 struct nvram_internal * data = priv_data;
719 memcpy(&(data->thereg), src, 1);
720 PrintDebug("nvram: Writing To NVRAM reg: 0x%x\n", data->thereg);
725 static int nvram_read_data_port(struct guest_info * core, uint16_t port,
726 void * dst, uint_t length, void * priv_data) {
728 struct nvram_internal * data = priv_data;
730 addr_t irq_state = v3_lock_irqsave(data->nvram_lock);
732 if (get_memory(data, data->thereg, (uint8_t *)dst) == -1) {
733 PrintError("nvram: Register %d (0x%x) Not set - POSSIBLE BUG IN MACHINE INIT - CONTINUING\n", data->thereg, data->thereg);
737 PrintDebug("nvram: nvram_read_data_port(0x%x) = 0x%x\n", data->thereg, *(uint8_t *)dst);
740 if (data->thereg == NVRAM_REG_STAT_A) {
741 data->mem_state[data->thereg] ^= 0x80; // toggle Update in progess
744 v3_unlock_irqrestore(data->nvram_lock, irq_state);
750 static int nvram_write_data_port(struct guest_info * core, uint16_t port,
751 void * src, uint_t length, void * priv_data) {
753 struct nvram_internal * data = priv_data;
755 addr_t irq_state = v3_lock_irqsave(data->nvram_lock);
757 set_memory(data, data->thereg, *(uint8_t *)src);
759 v3_unlock_irqrestore(data->nvram_lock, irq_state);
761 PrintDebug("nvram: nvram_write_data_port(0x%x) = 0x%x\n",
762 data->thereg, data->mem_state[data->thereg]);
770 static int nvram_free(struct nvram_internal * nvram_state) {
772 // unregister host events
773 struct guest_info *info = &(nvram_state->vm->cores[0]);
775 if (nvram_state->timer) {
776 v3_remove_timer(info,nvram_state->timer);
779 V3_Free(nvram_state);
785 static struct v3_timer_ops timer_ops = {
786 .update_timer = nvram_update_timer,
790 static struct v3_device_ops dev_ops = {
791 .free = (int (*)(void *))nvram_free,
798 static int nvram_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
799 struct nvram_internal * nvram_state = NULL;
800 struct vm_device * ide = v3_find_dev(vm, v3_cfg_val(cfg, "storage"));
801 char * dev_id = v3_cfg_val(cfg, "ID");
805 PrintError("nvram: Could not find IDE device\n");
809 PrintDebug("nvram: init_device\n");
810 nvram_state = (struct nvram_internal *)V3_Malloc(sizeof(struct nvram_internal) + 1000);
812 PrintDebug("nvram: internal at %p\n", (void *)nvram_state);
814 nvram_state->ide = ide;
815 nvram_state->vm = vm;
817 struct vm_device * dev = v3_add_device(vm, dev_id, &dev_ops, nvram_state);
820 PrintError("nvram: Could not attach device %s\n", dev_id);
821 V3_Free(nvram_state);
825 init_nvram_state(vm, nvram_state);
828 ret |= v3_dev_hook_io(dev, NVRAM_REG_PORT, NULL, &nvram_write_reg_port);
829 ret |= v3_dev_hook_io(dev, NVRAM_DATA_PORT, &nvram_read_data_port, &nvram_write_data_port);
832 PrintError("nvram: Error hooking NVRAM IO ports\n");
833 v3_remove_device(dev);
837 nvram_state->timer = v3_add_timer(&(vm->cores[0]),&timer_ops,nvram_state);
839 if (nvram_state->timer == NULL ) {
840 v3_remove_device(dev);
847 device_register("NVRAM", nvram_init)