2 * QEMU M48T59 and M48T08 NVRAM emulation for PPC PREP and Sparc platforms
4 * Copyright (c) 2003-2005, 2007, 2017 Jocelyn Mayer
5 * Copyright (c) 2013 Hervé Poussineau
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
29 #include "hw/qdev-properties.h"
30 #include "hw/rtc/m48t59.h"
31 #include "qemu/timer.h"
32 #include "sysemu/runstate.h"
33 #include "sysemu/sysemu.h"
34 #include "hw/sysbus.h"
35 #include "exec/address-spaces.h"
37 #include "qemu/module.h"
40 #include "m48t59-internal.h"
41 #include "migration/vmstate.h"
43 #define TYPE_M48TXX_SYS_BUS "sysbus-m48txx"
44 #define M48TXX_SYS_BUS_GET_CLASS(obj) \
45 OBJECT_GET_CLASS(M48txxSysBusDeviceClass, (obj), TYPE_M48TXX_SYS_BUS)
46 #define M48TXX_SYS_BUS_CLASS(klass) \
47 OBJECT_CLASS_CHECK(M48txxSysBusDeviceClass, (klass), TYPE_M48TXX_SYS_BUS)
48 #define M48TXX_SYS_BUS(obj) \
49 OBJECT_CHECK(M48txxSysBusState, (obj), TYPE_M48TXX_SYS_BUS)
53 * http://www.st.com/stonline/products/literature/ds/2410/m48t02.pdf
54 * http://www.st.com/stonline/products/literature/ds/2411/m48t08.pdf
55 * http://www.st.com/stonline/products/literature/od/7001/m48t59y.pdf
58 typedef struct M48txxSysBusState {
59 SysBusDevice parent_obj;
64 typedef struct M48txxSysBusDeviceClass {
65 SysBusDeviceClass parent_class;
67 } M48txxSysBusDeviceClass;
69 static M48txxInfo m48txx_sysbus_info[] = {
71 .bus_name = "sysbus-m48t02",
75 .bus_name = "sysbus-m48t08",
79 .bus_name = "sysbus-m48t59",
86 /* Fake timer functions */
88 /* Alarm management */
89 static void alarm_cb (void *opaque)
93 M48t59State *NVRAM = opaque;
95 qemu_set_irq(NVRAM->IRQ, 1);
96 if ((NVRAM->buffer[0x1FF5] & 0x80) == 0 &&
97 (NVRAM->buffer[0x1FF4] & 0x80) == 0 &&
98 (NVRAM->buffer[0x1FF3] & 0x80) == 0 &&
99 (NVRAM->buffer[0x1FF2] & 0x80) == 0) {
100 /* Repeat once a month */
101 qemu_get_timedate(&tm, NVRAM->time_offset);
103 if (tm.tm_mon == 13) {
107 next_time = qemu_timedate_diff(&tm) - NVRAM->time_offset;
108 } else if ((NVRAM->buffer[0x1FF5] & 0x80) != 0 &&
109 (NVRAM->buffer[0x1FF4] & 0x80) == 0 &&
110 (NVRAM->buffer[0x1FF3] & 0x80) == 0 &&
111 (NVRAM->buffer[0x1FF2] & 0x80) == 0) {
112 /* Repeat once a day */
113 next_time = 24 * 60 * 60;
114 } else if ((NVRAM->buffer[0x1FF5] & 0x80) != 0 &&
115 (NVRAM->buffer[0x1FF4] & 0x80) != 0 &&
116 (NVRAM->buffer[0x1FF3] & 0x80) == 0 &&
117 (NVRAM->buffer[0x1FF2] & 0x80) == 0) {
118 /* Repeat once an hour */
120 } else if ((NVRAM->buffer[0x1FF5] & 0x80) != 0 &&
121 (NVRAM->buffer[0x1FF4] & 0x80) != 0 &&
122 (NVRAM->buffer[0x1FF3] & 0x80) != 0 &&
123 (NVRAM->buffer[0x1FF2] & 0x80) == 0) {
124 /* Repeat once a minute */
127 /* Repeat once a second */
130 timer_mod(NVRAM->alrm_timer, qemu_clock_get_ns(rtc_clock) +
132 qemu_set_irq(NVRAM->IRQ, 0);
135 static void set_alarm(M48t59State *NVRAM)
138 if (NVRAM->alrm_timer != NULL) {
139 timer_del(NVRAM->alrm_timer);
140 diff = qemu_timedate_diff(&NVRAM->alarm) - NVRAM->time_offset;
142 timer_mod(NVRAM->alrm_timer, diff * 1000);
146 /* RTC management helpers */
147 static inline void get_time(M48t59State *NVRAM, struct tm *tm)
149 qemu_get_timedate(tm, NVRAM->time_offset);
152 static void set_time(M48t59State *NVRAM, struct tm *tm)
154 NVRAM->time_offset = qemu_timedate_diff(tm);
158 /* Watchdog management */
159 static void watchdog_cb (void *opaque)
161 M48t59State *NVRAM = opaque;
163 NVRAM->buffer[0x1FF0] |= 0x80;
164 if (NVRAM->buffer[0x1FF7] & 0x80) {
165 NVRAM->buffer[0x1FF7] = 0x00;
166 NVRAM->buffer[0x1FFC] &= ~0x40;
167 /* May it be a hw CPU Reset instead ? */
168 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET);
170 qemu_set_irq(NVRAM->IRQ, 1);
171 qemu_set_irq(NVRAM->IRQ, 0);
175 static void set_up_watchdog(M48t59State *NVRAM, uint8_t value)
177 uint64_t interval; /* in 1/16 seconds */
179 NVRAM->buffer[0x1FF0] &= ~0x80;
180 if (NVRAM->wd_timer != NULL) {
181 timer_del(NVRAM->wd_timer);
183 interval = (1 << (2 * (value & 0x03))) * ((value >> 2) & 0x1F);
184 timer_mod(NVRAM->wd_timer, ((uint64_t)time(NULL) * 1000) +
185 ((interval * 1000) >> 4));
190 /* Direct access to NVRAM */
191 void m48t59_write(M48t59State *NVRAM, uint32_t addr, uint32_t val)
196 trace_m48txx_nvram_mem_write(addr, val);
198 /* check for NVRAM access */
199 if ((NVRAM->model == 2 && addr < 0x7f8) ||
200 (NVRAM->model == 8 && addr < 0x1ff8) ||
201 (NVRAM->model == 59 && addr < 0x1ff0)) {
208 /* flags register : read-only */
215 tmp = from_bcd(val & 0x7F);
216 if (tmp >= 0 && tmp <= 59) {
217 NVRAM->alarm.tm_sec = tmp;
218 NVRAM->buffer[0x1FF2] = val;
224 tmp = from_bcd(val & 0x7F);
225 if (tmp >= 0 && tmp <= 59) {
226 NVRAM->alarm.tm_min = tmp;
227 NVRAM->buffer[0x1FF3] = val;
233 tmp = from_bcd(val & 0x3F);
234 if (tmp >= 0 && tmp <= 23) {
235 NVRAM->alarm.tm_hour = tmp;
236 NVRAM->buffer[0x1FF4] = val;
242 tmp = from_bcd(val & 0x3F);
244 NVRAM->alarm.tm_mday = tmp;
245 NVRAM->buffer[0x1FF5] = val;
251 NVRAM->buffer[0x1FF6] = val;
255 NVRAM->buffer[0x1FF7] = val;
256 set_up_watchdog(NVRAM, val);
261 NVRAM->buffer[addr] = (val & ~0xA0) | 0x90;
266 tmp = from_bcd(val & 0x7F);
267 if (tmp >= 0 && tmp <= 59) {
268 get_time(NVRAM, &tm);
270 set_time(NVRAM, &tm);
272 if ((val & 0x80) ^ (NVRAM->buffer[addr] & 0x80)) {
274 NVRAM->stop_time = time(NULL);
276 NVRAM->time_offset += NVRAM->stop_time - time(NULL);
277 NVRAM->stop_time = 0;
280 NVRAM->buffer[addr] = val & 0x80;
285 tmp = from_bcd(val & 0x7F);
286 if (tmp >= 0 && tmp <= 59) {
287 get_time(NVRAM, &tm);
289 set_time(NVRAM, &tm);
295 tmp = from_bcd(val & 0x3F);
296 if (tmp >= 0 && tmp <= 23) {
297 get_time(NVRAM, &tm);
299 set_time(NVRAM, &tm);
304 /* day of the week / century */
305 tmp = from_bcd(val & 0x07);
306 get_time(NVRAM, &tm);
308 set_time(NVRAM, &tm);
309 NVRAM->buffer[addr] = val & 0x40;
314 tmp = from_bcd(val & 0x3F);
316 get_time(NVRAM, &tm);
318 set_time(NVRAM, &tm);
324 tmp = from_bcd(val & 0x1F);
325 if (tmp >= 1 && tmp <= 12) {
326 get_time(NVRAM, &tm);
328 set_time(NVRAM, &tm);
335 if (tmp >= 0 && tmp <= 99) {
336 get_time(NVRAM, &tm);
337 tm.tm_year = from_bcd(val) + NVRAM->base_year - 1900;
338 set_time(NVRAM, &tm);
342 /* Check lock registers state */
343 if (addr >= 0x20 && addr <= 0x2F && (NVRAM->lock & 1))
345 if (addr >= 0x30 && addr <= 0x3F && (NVRAM->lock & 2))
348 if (addr < NVRAM->size) {
349 NVRAM->buffer[addr] = val & 0xFF;
355 uint32_t m48t59_read(M48t59State *NVRAM, uint32_t addr)
358 uint32_t retval = 0xFF;
360 /* check for NVRAM access */
361 if ((NVRAM->model == 2 && addr < 0x078f) ||
362 (NVRAM->model == 8 && addr < 0x1ff8) ||
363 (NVRAM->model == 59 && addr < 0x1ff0)) {
392 /* A read resets the watchdog */
393 set_up_watchdog(NVRAM, NVRAM->buffer[0x1FF7]);
402 get_time(NVRAM, &tm);
403 retval = (NVRAM->buffer[addr] & 0x80) | to_bcd(tm.tm_sec);
408 get_time(NVRAM, &tm);
409 retval = to_bcd(tm.tm_min);
414 get_time(NVRAM, &tm);
415 retval = to_bcd(tm.tm_hour);
419 /* day of the week / century */
420 get_time(NVRAM, &tm);
421 retval = NVRAM->buffer[addr] | tm.tm_wday;
426 get_time(NVRAM, &tm);
427 retval = to_bcd(tm.tm_mday);
432 get_time(NVRAM, &tm);
433 retval = to_bcd(tm.tm_mon + 1);
438 get_time(NVRAM, &tm);
439 retval = to_bcd((tm.tm_year + 1900 - NVRAM->base_year) % 100);
442 /* Check lock registers state */
443 if (addr >= 0x20 && addr <= 0x2F && (NVRAM->lock & 1))
445 if (addr >= 0x30 && addr <= 0x3F && (NVRAM->lock & 2))
448 if (addr < NVRAM->size) {
449 retval = NVRAM->buffer[addr];
453 trace_m48txx_nvram_mem_read(addr, retval);
458 /* IO access to NVRAM */
459 static void NVRAM_writeb(void *opaque, hwaddr addr, uint64_t val,
462 M48t59State *NVRAM = opaque;
464 trace_m48txx_nvram_io_write(addr, val);
467 NVRAM->addr &= ~0x00FF;
471 NVRAM->addr &= ~0xFF00;
472 NVRAM->addr |= val << 8;
475 m48t59_write(NVRAM, NVRAM->addr, val);
476 NVRAM->addr = 0x0000;
483 static uint64_t NVRAM_readb(void *opaque, hwaddr addr, unsigned size)
485 M48t59State *NVRAM = opaque;
490 retval = m48t59_read(NVRAM, NVRAM->addr);
496 trace_m48txx_nvram_io_read(addr, retval);
501 static uint64_t nvram_read(void *opaque, hwaddr addr, unsigned size)
503 M48t59State *NVRAM = opaque;
505 return m48t59_read(NVRAM, addr);
508 static void nvram_write(void *opaque, hwaddr addr, uint64_t value,
511 M48t59State *NVRAM = opaque;
513 return m48t59_write(NVRAM, addr, value);
516 static const MemoryRegionOps nvram_ops = {
518 .write = nvram_write,
519 .impl.min_access_size = 1,
520 .impl.max_access_size = 1,
521 .valid.min_access_size = 1,
522 .valid.max_access_size = 4,
523 .endianness = DEVICE_BIG_ENDIAN,
526 static const VMStateDescription vmstate_m48t59 = {
529 .minimum_version_id = 1,
530 .fields = (VMStateField[]) {
531 VMSTATE_UINT8(lock, M48t59State),
532 VMSTATE_UINT16(addr, M48t59State),
533 VMSTATE_VBUFFER_UINT32(buffer, M48t59State, 0, NULL, size),
534 VMSTATE_END_OF_LIST()
538 void m48t59_reset_common(M48t59State *NVRAM)
542 if (NVRAM->alrm_timer != NULL)
543 timer_del(NVRAM->alrm_timer);
545 if (NVRAM->wd_timer != NULL)
546 timer_del(NVRAM->wd_timer);
549 static void m48t59_reset_sysbus(DeviceState *d)
551 M48txxSysBusState *sys = M48TXX_SYS_BUS(d);
552 M48t59State *NVRAM = &sys->state;
554 m48t59_reset_common(NVRAM);
557 const MemoryRegionOps m48t59_io_ops = {
559 .write = NVRAM_writeb,
561 .min_access_size = 1,
562 .max_access_size = 1,
564 .endianness = DEVICE_LITTLE_ENDIAN,
567 /* Initialisation routine */
568 Nvram *m48t59_init(qemu_irq IRQ, hwaddr mem_base,
569 uint32_t io_base, uint16_t size, int base_year,
576 for (i = 0; i < ARRAY_SIZE(m48txx_sysbus_info); i++) {
577 if (m48txx_sysbus_info[i].size != size ||
578 m48txx_sysbus_info[i].model != model) {
582 dev = qdev_create(NULL, m48txx_sysbus_info[i].bus_name);
583 qdev_prop_set_int32(dev, "base-year", base_year);
584 qdev_init_nofail(dev);
585 s = SYS_BUS_DEVICE(dev);
586 sysbus_connect_irq(s, 0, IRQ);
588 memory_region_add_subregion(get_system_io(), io_base,
589 sysbus_mmio_get_region(s, 1));
592 sysbus_mmio_map(s, 0, mem_base);
602 void m48t59_realize_common(M48t59State *s, Error **errp)
604 s->buffer = g_malloc0(s->size);
605 if (s->model == 59) {
606 s->alrm_timer = timer_new_ns(rtc_clock, &alarm_cb, s);
607 s->wd_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, &watchdog_cb, s);
609 qemu_get_timedate(&s->alarm, 0);
612 static void m48t59_init1(Object *obj)
614 M48txxSysBusDeviceClass *u = M48TXX_SYS_BUS_GET_CLASS(obj);
615 M48txxSysBusState *d = M48TXX_SYS_BUS(obj);
616 SysBusDevice *dev = SYS_BUS_DEVICE(obj);
617 M48t59State *s = &d->state;
619 s->model = u->info.model;
620 s->size = u->info.size;
621 sysbus_init_irq(dev, &s->IRQ);
623 memory_region_init_io(&s->iomem, obj, &nvram_ops, s, "m48t59.nvram",
625 memory_region_init_io(&d->io, obj, &m48t59_io_ops, s, "m48t59", 4);
628 static void m48t59_realize(DeviceState *dev, Error **errp)
630 M48txxSysBusState *d = M48TXX_SYS_BUS(dev);
631 M48t59State *s = &d->state;
632 SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
634 sysbus_init_mmio(sbd, &s->iomem);
635 sysbus_init_mmio(sbd, &d->io);
636 m48t59_realize_common(s, errp);
639 static uint32_t m48txx_sysbus_read(Nvram *obj, uint32_t addr)
641 M48txxSysBusState *d = M48TXX_SYS_BUS(obj);
642 return m48t59_read(&d->state, addr);
645 static void m48txx_sysbus_write(Nvram *obj, uint32_t addr, uint32_t val)
647 M48txxSysBusState *d = M48TXX_SYS_BUS(obj);
648 m48t59_write(&d->state, addr, val);
651 static void m48txx_sysbus_toggle_lock(Nvram *obj, int lock)
653 M48txxSysBusState *d = M48TXX_SYS_BUS(obj);
654 m48t59_toggle_lock(&d->state, lock);
657 static Property m48t59_sysbus_properties[] = {
658 DEFINE_PROP_INT32("base-year", M48txxSysBusState, state.base_year, 0),
659 DEFINE_PROP_END_OF_LIST(),
662 static void m48txx_sysbus_class_init(ObjectClass *klass, void *data)
664 DeviceClass *dc = DEVICE_CLASS(klass);
665 NvramClass *nc = NVRAM_CLASS(klass);
667 dc->realize = m48t59_realize;
668 dc->reset = m48t59_reset_sysbus;
669 device_class_set_props(dc, m48t59_sysbus_properties);
670 dc->vmsd = &vmstate_m48t59;
671 nc->read = m48txx_sysbus_read;
672 nc->write = m48txx_sysbus_write;
673 nc->toggle_lock = m48txx_sysbus_toggle_lock;
676 static void m48txx_sysbus_concrete_class_init(ObjectClass *klass, void *data)
678 M48txxSysBusDeviceClass *u = M48TXX_SYS_BUS_CLASS(klass);
679 M48txxInfo *info = data;
684 static const TypeInfo nvram_info = {
686 .parent = TYPE_INTERFACE,
687 .class_size = sizeof(NvramClass),
690 static const TypeInfo m48txx_sysbus_type_info = {
691 .name = TYPE_M48TXX_SYS_BUS,
692 .parent = TYPE_SYS_BUS_DEVICE,
693 .instance_size = sizeof(M48txxSysBusState),
694 .instance_init = m48t59_init1,
696 .class_init = m48txx_sysbus_class_init,
697 .interfaces = (InterfaceInfo[]) {
703 static void m48t59_register_types(void)
705 TypeInfo sysbus_type_info = {
706 .parent = TYPE_M48TXX_SYS_BUS,
707 .class_size = sizeof(M48txxSysBusDeviceClass),
708 .class_init = m48txx_sysbus_concrete_class_init,
712 type_register_static(&nvram_info);
713 type_register_static(&m48txx_sysbus_type_info);
715 for (i = 0; i < ARRAY_SIZE(m48txx_sysbus_info); i++) {
716 sysbus_type_info.name = m48txx_sysbus_info[i].bus_name;
717 sysbus_type_info.class_data = &m48txx_sysbus_info[i];
718 type_register(&sysbus_type_info);
722 type_init(m48t59_register_types)