[qemu.git] / tests / rtc-test.c

/*
 * QTest testcase for the MC146818 real-time clock
 *
 * Copyright IBM, Corp. 2012
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 *
 */
#include "libqtest.h"
#include "hw/mc146818rtc_regs.h"

#include <glib.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

static uint8_t base = 0x70;

static int bcd2dec(int value)
{
    return (((value >> 4) & 0x0F) * 10) + (value & 0x0F);
}

static int dec2bcd(int value)
{
    return ((value / 10) << 4) | (value % 10);
}

static uint8_t cmos_read(uint8_t reg)
{
    outb(base + 0, reg);
    return inb(base + 1);
}

static void cmos_write(uint8_t reg, uint8_t val)
{
    outb(base + 0, reg);
    outb(base + 1, val);
}

static int tm_cmp(struct tm *lhs, struct tm *rhs)
{
    time_t a, b;
    struct tm d1, d2;

    memcpy(&d1, lhs, sizeof(d1));
    memcpy(&d2, rhs, sizeof(d2));

    a = mktime(&d1);
    b = mktime(&d2);

    if (a < b) {
        return -1;
    } else if (a > b) {
        return 1;
    }

    return 0;
}

#if 0
static void print_tm(struct tm *tm)
{
    printf("%04d-%02d-%02d %02d:%02d:%02d\n",
           tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday,
           tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_gmtoff);
}
#endif

static void cmos_get_date_time(struct tm *date)
{
    int base_year = 2000, hour_offset;
    int sec, min, hour, mday, mon, year;
    time_t ts;
    struct tm dummy;

    sec = cmos_read(RTC_SECONDS);
    min = cmos_read(RTC_MINUTES);
    hour = cmos_read(RTC_HOURS);
    mday = cmos_read(RTC_DAY_OF_MONTH);
    mon = cmos_read(RTC_MONTH);
    year = cmos_read(RTC_YEAR);

    if ((cmos_read(RTC_REG_B) & REG_B_DM) == 0) {
        sec = bcd2dec(sec);
        min = bcd2dec(min);
        hour = bcd2dec(hour);
        mday = bcd2dec(mday);
        mon = bcd2dec(mon);
        year = bcd2dec(year);
        hour_offset = 80;
    } else {
        hour_offset = 0x80;
    }

    if ((cmos_read(0x0B) & REG_B_24H) == 0) {
        if (hour >= hour_offset) {
            hour -= hour_offset;
            hour += 12;
        }
    }

    ts = time(NULL);
    localtime_r(&ts, &dummy);

    date->tm_isdst = dummy.tm_isdst;
    date->tm_sec = sec;
    date->tm_min = min;
    date->tm_hour = hour;
    date->tm_mday = mday;
    date->tm_mon = mon - 1;
    date->tm_year = base_year + year - 1900;
    date->tm_gmtoff = 0;

    ts = mktime(date);
}

static void check_time(int wiggle)
{
    struct tm start, date[4], end;
    struct tm *datep;
    time_t ts;

    /*
     * This check assumes a few things.  First, we cannot guarantee that we get
     * a consistent reading from the wall clock because we may hit an edge of
     * the clock while reading.  To work around this, we read four clock readings
     * such that at least two of them should match.  We need to assume that one
     * reading is corrupt so we need four readings to ensure that we have at
     * least two consecutive identical readings
     *
     * It's also possible that we'll cross an edge reading the host clock so
     * simply check to make sure that the clock reading is within the period of
     * when we expect it to be.
     */

    ts = time(NULL);
    gmtime_r(&ts, &start);

    cmos_get_date_time(&date[0]);
    cmos_get_date_time(&date[1]);
    cmos_get_date_time(&date[2]);
    cmos_get_date_time(&date[3]);

    ts = time(NULL);
    gmtime_r(&ts, &end);

    if (tm_cmp(&date[0], &date[1]) == 0) {
        datep = &date[0];
    } else if (tm_cmp(&date[1], &date[2]) == 0) {
        datep = &date[1];
    } else if (tm_cmp(&date[2], &date[3]) == 0) {
        datep = &date[2];
    } else {
        g_assert_not_reached();
    }

    if (!(tm_cmp(&start, datep) <= 0 && tm_cmp(datep, &end) <= 0)) {
        long t, s;

        start.tm_isdst = datep->tm_isdst;

        t = (long)mktime(datep);
        s = (long)mktime(&start);
        if (t < s) {
            g_test_message("RTC is %ld second(s) behind wall-clock\n", (s - t));
        } else {
            g_test_message("RTC is %ld second(s) ahead of wall-clock\n", (t - s));
        }

        g_assert_cmpint(ABS(t - s), <=, wiggle);
    }
}

static int wiggle = 2;

static void set_year(void)
{
    /* Set BCD mode */
    cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) & ~REG_B_DM);
    cmos_write(RTC_REG_A, 0x76);
    cmos_write(RTC_YEAR, 0x11);
    cmos_write(RTC_MONTH, 0x02);
    cmos_write(RTC_DAY_OF_MONTH, 0x02);
    cmos_write(RTC_HOURS, 0x02);
    cmos_write(RTC_MINUTES, 0x04);
    cmos_write(RTC_SECONDS, 0x58);
    cmos_write(RTC_REG_A, 0x26);

    g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
    g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
    g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x11);

    /* Set a date in 2080 to ensure there is no year-2038 overflow.  */
    cmos_write(RTC_REG_A, 0x76);
    cmos_write(RTC_YEAR, 0x80);
    cmos_write(RTC_REG_A, 0x26);

    g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
    g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
    g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x80);

    cmos_write(RTC_REG_A, 0x76);
    cmos_write(RTC_YEAR, 0x11);
    cmos_write(RTC_REG_A, 0x26);

    g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
    g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
    g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
    g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x11);
}

static void bcd_check_time(void)
{
    /* Set BCD mode */
    cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) & ~REG_B_DM);
    check_time(wiggle);
}

static void dec_check_time(void)
{
    /* Set DEC mode */
    cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) | REG_B_DM);
    check_time(wiggle);
}

static void set_alarm_time(struct tm *tm)
{
    int sec;

    sec = tm->tm_sec;

    if ((cmos_read(RTC_REG_B) & REG_B_DM) == 0) {
        sec = dec2bcd(sec);
    }

    cmos_write(RTC_SECONDS_ALARM, sec);
    cmos_write(RTC_MINUTES_ALARM, RTC_ALARM_DONT_CARE);
    cmos_write(RTC_HOURS_ALARM, RTC_ALARM_DONT_CARE);
}

static void alarm_time(void)
{
    struct tm now;
    time_t ts;
    int i;

    ts = time(NULL);
    gmtime_r(&ts, &now);

    /* set DEC mode */
    cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) | REG_B_DM);

    g_assert(!get_irq(RTC_ISA_IRQ));
    cmos_read(RTC_REG_C);

    now.tm_sec = (now.tm_sec + 2) % 60;
    set_alarm_time(&now);
    cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) | REG_B_AIE);

    for (i = 0; i < 2 + wiggle; i++) {
        if (get_irq(RTC_ISA_IRQ)) {
            break;
        }

        clock_step(1000000000);
    }

    g_assert(get_irq(RTC_ISA_IRQ));
    g_assert((cmos_read(RTC_REG_C) & REG_C_AF) != 0);
    g_assert(cmos_read(RTC_REG_C) == 0);
}

/* success if no crash or abort */
static void fuzz_registers(void)
{
    unsigned int i;

    for (i = 0; i < 1000; i++) {
        uint8_t reg, val;

        reg = (uint8_t)g_test_rand_int_range(0, 16);
        val = (uint8_t)g_test_rand_int_range(0, 256);

        cmos_write(reg, val);
        cmos_read(reg);
    }
}

int main(int argc, char **argv)
{
    QTestState *s = NULL;
    int ret;

    g_test_init(&argc, &argv, NULL);

    s = qtest_start("-display none -rtc clock=vm");
    qtest_irq_intercept_in(s, "ioapic");

    qtest_add_func("/rtc/bcd/check-time", bcd_check_time);
    qtest_add_func("/rtc/dec/check-time", dec_check_time);
    qtest_add_func("/rtc/alarm-time", alarm_time);
    qtest_add_func("/rtc/set-year", set_year);
    qtest_add_func("/rtc/fuzz-registers", fuzz_registers);
    ret = g_test_run();

    if (s) {
        qtest_quit(s);
    }

    return ret;
}
Commit	Line	Data
d1aaf543 AL	1	/*
	2	* QTest testcase for the MC146818 real-time clock
	3	*
	4	* Copyright IBM, Corp. 2012
	5	*
	6	* Authors:
	7	* Anthony Liguori <aliguori@us.ibm.com>
	8	*
	9	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	10	* See the COPYING file in the top-level directory.
	11	*
	12	*/
	13	#include "libqtest.h"
	14	#include "hw/mc146818rtc_regs.h"
	15
	16	#include <glib.h>
	17	#include <stdio.h>
	18	#include <string.h>
	19	#include <stdlib.h>
	20	#include <unistd.h>
	21
	22	static uint8_t base = 0x70;
	23
	24	static int bcd2dec(int value)
	25	{
	26	return (((value >> 4) & 0x0F) * 10) + (value & 0x0F);
	27	}
	28
	29	static int dec2bcd(int value)
	30	{
	31	return ((value / 10) << 4) \| (value % 10);
	32	}
	33
	34	static uint8_t cmos_read(uint8_t reg)
	35	{
	36	outb(base + 0, reg);
	37	return inb(base + 1);
	38	}
	39
	40	static void cmos_write(uint8_t reg, uint8_t val)
	41	{
	42	outb(base + 0, reg);
	43	outb(base + 1, val);
	44	}
	45
	46	static int tm_cmp(struct tm lhs, struct tm rhs)
	47	{
	48	time_t a, b;
	49	struct tm d1, d2;
	50
	51	memcpy(&d1, lhs, sizeof(d1));
	52	memcpy(&d2, rhs, sizeof(d2));
	53
	54	a = mktime(&d1);
	55	b = mktime(&d2);
	56
	57	if (a < b) {
	58	return -1;
	59	} else if (a > b) {
	60	return 1;
	61	}
	62
	63	return 0;
	64	}
65
66	#if 0
67	static void print_tm(struct tm *tm)
68	{
69	printf("%04d-%02d-%02d %02d:%02d:%02d\n",
70	tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday,
71	tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_gmtoff);
72	}
73	#endif
74
75	static void cmos_get_date_time(struct tm *date)
76	{
77	int base_year = 2000, hour_offset;
78	int sec, min, hour, mday, mon, year;
79	time_t ts;
80	struct tm dummy;
81
82	sec = cmos_read(RTC_SECONDS);
83	min = cmos_read(RTC_MINUTES);
84	hour = cmos_read(RTC_HOURS);
85	mday = cmos_read(RTC_DAY_OF_MONTH);
86	mon = cmos_read(RTC_MONTH);
87	year = cmos_read(RTC_YEAR);
88
89	if ((cmos_read(RTC_REG_B) & REG_B_DM) == 0) {
90	sec = bcd2dec(sec);
91	min = bcd2dec(min);
92	hour = bcd2dec(hour);
93	mday = bcd2dec(mday);
94	mon = bcd2dec(mon);
95	year = bcd2dec(year);
96	hour_offset = 80;
97	} else {
98	hour_offset = 0x80;
99	}
100
101	if ((cmos_read(0x0B) & REG_B_24H) == 0) {
102	if (hour >= hour_offset) {
103	hour -= hour_offset;
104	hour += 12;
105	}
106	}
107
108	ts = time(NULL);
109	localtime_r(&ts, &dummy);
110
111	date->tm_isdst = dummy.tm_isdst;
112	date->tm_sec = sec;
113	date->tm_min = min;
114	date->tm_hour = hour;
115	date->tm_mday = mday;
116	date->tm_mon = mon - 1;
117	date->tm_year = base_year + year - 1900;
118	date->tm_gmtoff = 0;
119
120	ts = mktime(date);
121	}
122
123	static void check_time(int wiggle)
124	{
125	struct tm start, date[4], end;
126	struct tm *datep;
127	time_t ts;
128
129	/*
130	* This check assumes a few things. First, we cannot guarantee that we get
131	* a consistent reading from the wall clock because we may hit an edge of
132	* the clock while reading. To work around this, we read four clock readings
133	* such that at least two of them should match. We need to assume that one
134	* reading is corrupt so we need four readings to ensure that we have at
135	* least two consecutive identical readings
136	*
137	* It's also possible that we'll cross an edge reading the host clock so
138	* simply check to make sure that the clock reading is within the period of
139	* when we expect it to be.
140	*/
141
142	ts = time(NULL);
143	gmtime_r(&ts, &start);
144
145	cmos_get_date_time(&date[0]);
146	cmos_get_date_time(&date[1]);
147	cmos_get_date_time(&date[2]);
148	cmos_get_date_time(&date[3]);
149
150	ts = time(NULL);
151	gmtime_r(&ts, &end);
152
153	if (tm_cmp(&date[0], &date[1]) == 0) {
154	datep = &date[0];
155	} else if (tm_cmp(&date[1], &date[2]) == 0) {
156	datep = &date[1];
157	} else if (tm_cmp(&date[2], &date[3]) == 0) {
158	datep = &date[2];
159	} else {
160	g_assert_not_reached();
161	}
162
163	if (!(tm_cmp(&start, datep) <= 0 && tm_cmp(datep, &end) <= 0)) {
02b3efcb	164	long t, s;
d1aaf543 AL	165
	166	start.tm_isdst = datep->tm_isdst;
	167
02b3efcb BS	168	t = (long)mktime(datep);
02b3efcb BS	169	s = (long)mktime(&start);
d1aaf543 AL	170	if (t < s) {
	171	g_test_message("RTC is %ld second(s) behind wall-clock\n", (s - t));
	172	} else {
	173	g_test_message("RTC is %ld second(s) ahead of wall-clock\n", (t - s));
	174	}
	175
	176	g_assert_cmpint(ABS(t - s), <=, wiggle);
	177	}
	178	}
	179
	180	static int wiggle = 2;
	181
b6db4aca PB	182	static void set_year(void)
	183	{
	184	/* Set BCD mode */
	185	cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) & ~REG_B_DM);
	186	cmos_write(RTC_REG_A, 0x76);
	187	cmos_write(RTC_YEAR, 0x11);
	188	cmos_write(RTC_MONTH, 0x02);
	189	cmos_write(RTC_DAY_OF_MONTH, 0x02);
	190	cmos_write(RTC_HOURS, 0x02);
	191	cmos_write(RTC_MINUTES, 0x04);
	192	cmos_write(RTC_SECONDS, 0x58);
	193	cmos_write(RTC_REG_A, 0x26);
	194
	195	g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
	196	g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
	197	g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
	198	g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
	199	g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
	200	g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x11);
	201
	202	/* Set a date in 2080 to ensure there is no year-2038 overflow. */
	203	cmos_write(RTC_REG_A, 0x76);
	204	cmos_write(RTC_YEAR, 0x80);
	205	cmos_write(RTC_REG_A, 0x26);
	206
	207	g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
	208	g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
	209	g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
	210	g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
	211	g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
	212	g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x80);
	213
	214	cmos_write(RTC_REG_A, 0x76);
	215	cmos_write(RTC_YEAR, 0x11);
	216	cmos_write(RTC_REG_A, 0x26);
	217
	218	g_assert_cmpint(cmos_read(RTC_HOURS), ==, 0x02);
	219	g_assert_cmpint(cmos_read(RTC_MINUTES), ==, 0x04);
	220	g_assert_cmpint(cmos_read(RTC_SECONDS), >=, 0x58);
	221	g_assert_cmpint(cmos_read(RTC_DAY_OF_MONTH), ==, 0x02);
	222	g_assert_cmpint(cmos_read(RTC_MONTH), ==, 0x02);
	223	g_assert_cmpint(cmos_read(RTC_YEAR), ==, 0x11);
	224	}
	225
d1aaf543 AL	226	static void bcd_check_time(void)
	227	{
	228	/* Set BCD mode */
	229	cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) & ~REG_B_DM);
	230	check_time(wiggle);
	231	}
	232
	233	static void dec_check_time(void)
	234	{
	235	/* Set DEC mode */
	236	cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) \| REG_B_DM);
	237	check_time(wiggle);
	238	}
	239
	240	static void set_alarm_time(struct tm *tm)
	241	{
	242	int sec;
	243
	244	sec = tm->tm_sec;
	245
	246	if ((cmos_read(RTC_REG_B) & REG_B_DM) == 0) {
	247	sec = dec2bcd(sec);
	248	}
	249
	250	cmos_write(RTC_SECONDS_ALARM, sec);
	251	cmos_write(RTC_MINUTES_ALARM, RTC_ALARM_DONT_CARE);
	252	cmos_write(RTC_HOURS_ALARM, RTC_ALARM_DONT_CARE);
	253	}
	254
	255	static void alarm_time(void)
	256	{
	257	struct tm now;
	258	time_t ts;
	259	int i;
	260
	261	ts = time(NULL);
	262	gmtime_r(&ts, &now);
	263
	264	/* set DEC mode */
	265	cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) \| REG_B_DM);
	266
	267	g_assert(!get_irq(RTC_ISA_IRQ));
	268	cmos_read(RTC_REG_C);
	269
	270	now.tm_sec = (now.tm_sec + 2) % 60;
	271	set_alarm_time(&now);
	272	cmos_write(RTC_REG_B, cmos_read(RTC_REG_B) \| REG_B_AIE);
	273
	274	for (i = 0; i < 2 + wiggle; i++) {
	275	if (get_irq(RTC_ISA_IRQ)) {
	276	break;
	277	}
	278
	279	clock_step(1000000000);
	280	}
	281
	282	g_assert(get_irq(RTC_ISA_IRQ));
	283	g_assert((cmos_read(RTC_REG_C) & REG_C_AF) != 0);
	284	g_assert(cmos_read(RTC_REG_C) == 0);
	285	}
	286
85215d41 BS	287	/* success if no crash or abort */
	288	static void fuzz_registers(void)
	289	{
	290	unsigned int i;
	291
	292	for (i = 0; i < 1000; i++) {
	293	uint8_t reg, val;
	294
	295	reg = (uint8_t)g_test_rand_int_range(0, 16);
	296	val = (uint8_t)g_test_rand_int_range(0, 256);
	297
	298	cmos_write(reg, val);
	299	cmos_read(reg);
	300	}
	301	}
	302
d1aaf543 AL	303	int main(int argc, char **argv)
	304	{
	305	QTestState *s = NULL;
	306	int ret;
	307
	308	g_test_init(&argc, &argv, NULL);
	309
	310	s = qtest_start("-display none -rtc clock=vm");
	311	qtest_irq_intercept_in(s, "ioapic");
	312
	313	qtest_add_func("/rtc/bcd/check-time", bcd_check_time);
	314	qtest_add_func("/rtc/dec/check-time", dec_check_time);
	315	qtest_add_func("/rtc/alarm-time", alarm_time);
b6db4aca	316	qtest_add_func("/rtc/set-year", set_year);
85215d41	317	qtest_add_func("/rtc/fuzz-registers", fuzz_registers);
d1aaf543 AL	318	ret = g_test_run();
	319
	320	if (s) {
	321	qtest_quit(s);
	322	}
	323
	324	return ret;
	325	}