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"
28 #include "hw/timer/m48t59.h"
29 #include "qemu/timer.h"
30 #include "sysemu/sysemu.h"
31 #include "hw/sysbus.h"
32 #include "exec/address-spaces.h"
34 #include "qemu/module.h"
36 #include "m48t59-internal.h"
38 #define TYPE_M48TXX_SYS_BUS "sysbus-m48txx"
39 #define M48TXX_SYS_BUS_GET_CLASS(obj) \
40 OBJECT_GET_CLASS(M48txxSysBusDeviceClass, (obj), TYPE_M48TXX_SYS_BUS)
41 #define M48TXX_SYS_BUS_CLASS(klass) \
42 OBJECT_CLASS_CHECK(M48txxSysBusDeviceClass, (klass), TYPE_M48TXX_SYS_BUS)
43 #define M48TXX_SYS_BUS(obj) \
44 OBJECT_CHECK(M48txxSysBusState, (obj), TYPE_M48TXX_SYS_BUS)
48 * http://www.st.com/stonline/products/literature/ds/2410/m48t02.pdf
49 * http://www.st.com/stonline/products/literature/ds/2411/m48t08.pdf
50 * http://www.st.com/stonline/products/literature/od/7001/m48t59y.pdf
53 typedef struct M48txxSysBusState
{
54 SysBusDevice parent_obj
;
59 typedef struct M48txxSysBusDeviceClass
{
60 SysBusDeviceClass parent_class
;
62 } M48txxSysBusDeviceClass
;
64 static M48txxInfo m48txx_sysbus_info
[] = {
66 .bus_name
= "sysbus-m48t02",
70 .bus_name
= "sysbus-m48t08",
74 .bus_name
= "sysbus-m48t59",
81 /* Fake timer functions */
83 /* Alarm management */
84 static void alarm_cb (void *opaque
)
88 M48t59State
*NVRAM
= opaque
;
90 qemu_set_irq(NVRAM
->IRQ
, 1);
91 if ((NVRAM
->buffer
[0x1FF5] & 0x80) == 0 &&
92 (NVRAM
->buffer
[0x1FF4] & 0x80) == 0 &&
93 (NVRAM
->buffer
[0x1FF3] & 0x80) == 0 &&
94 (NVRAM
->buffer
[0x1FF2] & 0x80) == 0) {
95 /* Repeat once a month */
96 qemu_get_timedate(&tm
, NVRAM
->time_offset
);
98 if (tm
.tm_mon
== 13) {
102 next_time
= qemu_timedate_diff(&tm
) - NVRAM
->time_offset
;
103 } else if ((NVRAM
->buffer
[0x1FF5] & 0x80) != 0 &&
104 (NVRAM
->buffer
[0x1FF4] & 0x80) == 0 &&
105 (NVRAM
->buffer
[0x1FF3] & 0x80) == 0 &&
106 (NVRAM
->buffer
[0x1FF2] & 0x80) == 0) {
107 /* Repeat once a day */
108 next_time
= 24 * 60 * 60;
109 } else if ((NVRAM
->buffer
[0x1FF5] & 0x80) != 0 &&
110 (NVRAM
->buffer
[0x1FF4] & 0x80) != 0 &&
111 (NVRAM
->buffer
[0x1FF3] & 0x80) == 0 &&
112 (NVRAM
->buffer
[0x1FF2] & 0x80) == 0) {
113 /* Repeat once an hour */
115 } else if ((NVRAM
->buffer
[0x1FF5] & 0x80) != 0 &&
116 (NVRAM
->buffer
[0x1FF4] & 0x80) != 0 &&
117 (NVRAM
->buffer
[0x1FF3] & 0x80) != 0 &&
118 (NVRAM
->buffer
[0x1FF2] & 0x80) == 0) {
119 /* Repeat once a minute */
122 /* Repeat once a second */
125 timer_mod(NVRAM
->alrm_timer
, qemu_clock_get_ns(rtc_clock
) +
127 qemu_set_irq(NVRAM
->IRQ
, 0);
130 static void set_alarm(M48t59State
*NVRAM
)
133 if (NVRAM
->alrm_timer
!= NULL
) {
134 timer_del(NVRAM
->alrm_timer
);
135 diff
= qemu_timedate_diff(&NVRAM
->alarm
) - NVRAM
->time_offset
;
137 timer_mod(NVRAM
->alrm_timer
, diff
* 1000);
141 /* RTC management helpers */
142 static inline void get_time(M48t59State
*NVRAM
, struct tm
*tm
)
144 qemu_get_timedate(tm
, NVRAM
->time_offset
);
147 static void set_time(M48t59State
*NVRAM
, struct tm
*tm
)
149 NVRAM
->time_offset
= qemu_timedate_diff(tm
);
153 /* Watchdog management */
154 static void watchdog_cb (void *opaque
)
156 M48t59State
*NVRAM
= opaque
;
158 NVRAM
->buffer
[0x1FF0] |= 0x80;
159 if (NVRAM
->buffer
[0x1FF7] & 0x80) {
160 NVRAM
->buffer
[0x1FF7] = 0x00;
161 NVRAM
->buffer
[0x1FFC] &= ~0x40;
162 /* May it be a hw CPU Reset instead ? */
163 qemu_system_reset_request(SHUTDOWN_CAUSE_GUEST_RESET
);
165 qemu_set_irq(NVRAM
->IRQ
, 1);
166 qemu_set_irq(NVRAM
->IRQ
, 0);
170 static void set_up_watchdog(M48t59State
*NVRAM
, uint8_t value
)
172 uint64_t interval
; /* in 1/16 seconds */
174 NVRAM
->buffer
[0x1FF0] &= ~0x80;
175 if (NVRAM
->wd_timer
!= NULL
) {
176 timer_del(NVRAM
->wd_timer
);
178 interval
= (1 << (2 * (value
& 0x03))) * ((value
>> 2) & 0x1F);
179 timer_mod(NVRAM
->wd_timer
, ((uint64_t)time(NULL
) * 1000) +
180 ((interval
* 1000) >> 4));
185 /* Direct access to NVRAM */
186 void m48t59_write(M48t59State
*NVRAM
, uint32_t addr
, uint32_t val
)
191 if (addr
> 0x1FF8 && addr
< 0x2000)
192 NVRAM_PRINTF("%s: 0x%08x => 0x%08x\n", __func__
, addr
, val
);
194 /* check for NVRAM access */
195 if ((NVRAM
->model
== 2 && addr
< 0x7f8) ||
196 (NVRAM
->model
== 8 && addr
< 0x1ff8) ||
197 (NVRAM
->model
== 59 && addr
< 0x1ff0)) {
204 /* flags register : read-only */
211 tmp
= from_bcd(val
& 0x7F);
212 if (tmp
>= 0 && tmp
<= 59) {
213 NVRAM
->alarm
.tm_sec
= tmp
;
214 NVRAM
->buffer
[0x1FF2] = val
;
220 tmp
= from_bcd(val
& 0x7F);
221 if (tmp
>= 0 && tmp
<= 59) {
222 NVRAM
->alarm
.tm_min
= tmp
;
223 NVRAM
->buffer
[0x1FF3] = val
;
229 tmp
= from_bcd(val
& 0x3F);
230 if (tmp
>= 0 && tmp
<= 23) {
231 NVRAM
->alarm
.tm_hour
= tmp
;
232 NVRAM
->buffer
[0x1FF4] = val
;
238 tmp
= from_bcd(val
& 0x3F);
240 NVRAM
->alarm
.tm_mday
= tmp
;
241 NVRAM
->buffer
[0x1FF5] = val
;
247 NVRAM
->buffer
[0x1FF6] = val
;
251 NVRAM
->buffer
[0x1FF7] = val
;
252 set_up_watchdog(NVRAM
, val
);
257 NVRAM
->buffer
[addr
] = (val
& ~0xA0) | 0x90;
262 tmp
= from_bcd(val
& 0x7F);
263 if (tmp
>= 0 && tmp
<= 59) {
264 get_time(NVRAM
, &tm
);
266 set_time(NVRAM
, &tm
);
268 if ((val
& 0x80) ^ (NVRAM
->buffer
[addr
] & 0x80)) {
270 NVRAM
->stop_time
= time(NULL
);
272 NVRAM
->time_offset
+= NVRAM
->stop_time
- time(NULL
);
273 NVRAM
->stop_time
= 0;
276 NVRAM
->buffer
[addr
] = val
& 0x80;
281 tmp
= from_bcd(val
& 0x7F);
282 if (tmp
>= 0 && tmp
<= 59) {
283 get_time(NVRAM
, &tm
);
285 set_time(NVRAM
, &tm
);
291 tmp
= from_bcd(val
& 0x3F);
292 if (tmp
>= 0 && tmp
<= 23) {
293 get_time(NVRAM
, &tm
);
295 set_time(NVRAM
, &tm
);
300 /* day of the week / century */
301 tmp
= from_bcd(val
& 0x07);
302 get_time(NVRAM
, &tm
);
304 set_time(NVRAM
, &tm
);
305 NVRAM
->buffer
[addr
] = val
& 0x40;
310 tmp
= from_bcd(val
& 0x3F);
312 get_time(NVRAM
, &tm
);
314 set_time(NVRAM
, &tm
);
320 tmp
= from_bcd(val
& 0x1F);
321 if (tmp
>= 1 && tmp
<= 12) {
322 get_time(NVRAM
, &tm
);
324 set_time(NVRAM
, &tm
);
331 if (tmp
>= 0 && tmp
<= 99) {
332 get_time(NVRAM
, &tm
);
333 tm
.tm_year
= from_bcd(val
) + NVRAM
->base_year
- 1900;
334 set_time(NVRAM
, &tm
);
338 /* Check lock registers state */
339 if (addr
>= 0x20 && addr
<= 0x2F && (NVRAM
->lock
& 1))
341 if (addr
>= 0x30 && addr
<= 0x3F && (NVRAM
->lock
& 2))
344 if (addr
< NVRAM
->size
) {
345 NVRAM
->buffer
[addr
] = val
& 0xFF;
351 uint32_t m48t59_read(M48t59State
*NVRAM
, uint32_t addr
)
354 uint32_t retval
= 0xFF;
356 /* check for NVRAM access */
357 if ((NVRAM
->model
== 2 && addr
< 0x078f) ||
358 (NVRAM
->model
== 8 && addr
< 0x1ff8) ||
359 (NVRAM
->model
== 59 && addr
< 0x1ff0)) {
388 /* A read resets the watchdog */
389 set_up_watchdog(NVRAM
, NVRAM
->buffer
[0x1FF7]);
398 get_time(NVRAM
, &tm
);
399 retval
= (NVRAM
->buffer
[addr
] & 0x80) | to_bcd(tm
.tm_sec
);
404 get_time(NVRAM
, &tm
);
405 retval
= to_bcd(tm
.tm_min
);
410 get_time(NVRAM
, &tm
);
411 retval
= to_bcd(tm
.tm_hour
);
415 /* day of the week / century */
416 get_time(NVRAM
, &tm
);
417 retval
= NVRAM
->buffer
[addr
] | tm
.tm_wday
;
422 get_time(NVRAM
, &tm
);
423 retval
= to_bcd(tm
.tm_mday
);
428 get_time(NVRAM
, &tm
);
429 retval
= to_bcd(tm
.tm_mon
+ 1);
434 get_time(NVRAM
, &tm
);
435 retval
= to_bcd((tm
.tm_year
+ 1900 - NVRAM
->base_year
) % 100);
438 /* Check lock registers state */
439 if (addr
>= 0x20 && addr
<= 0x2F && (NVRAM
->lock
& 1))
441 if (addr
>= 0x30 && addr
<= 0x3F && (NVRAM
->lock
& 2))
444 if (addr
< NVRAM
->size
) {
445 retval
= NVRAM
->buffer
[addr
];
449 if (addr
> 0x1FF9 && addr
< 0x2000)
450 NVRAM_PRINTF("%s: 0x%08x <= 0x%08x\n", __func__
, addr
, retval
);
455 /* IO access to NVRAM */
456 static void NVRAM_writeb(void *opaque
, hwaddr addr
, uint64_t val
,
459 M48t59State
*NVRAM
= opaque
;
461 NVRAM_PRINTF("%s: 0x%"HWADDR_PRIx
" => 0x%"PRIx64
"\n", __func__
, addr
, val
);
464 NVRAM
->addr
&= ~0x00FF;
468 NVRAM
->addr
&= ~0xFF00;
469 NVRAM
->addr
|= val
<< 8;
472 m48t59_write(NVRAM
, NVRAM
->addr
, val
);
473 NVRAM
->addr
= 0x0000;
480 static uint64_t NVRAM_readb(void *opaque
, hwaddr addr
, unsigned size
)
482 M48t59State
*NVRAM
= opaque
;
487 retval
= m48t59_read(NVRAM
, NVRAM
->addr
);
493 NVRAM_PRINTF("%s: 0x%"HWADDR_PRIx
" <= 0x%08x\n", __func__
, addr
, retval
);
498 static uint64_t nvram_read(void *opaque
, hwaddr addr
, unsigned size
)
500 M48t59State
*NVRAM
= opaque
;
502 return m48t59_read(NVRAM
, addr
);
505 static void nvram_write(void *opaque
, hwaddr addr
, uint64_t value
,
508 M48t59State
*NVRAM
= opaque
;
510 return m48t59_write(NVRAM
, addr
, value
);
513 static const MemoryRegionOps nvram_ops
= {
515 .write
= nvram_write
,
516 .impl
.min_access_size
= 1,
517 .impl
.max_access_size
= 1,
518 .valid
.min_access_size
= 1,
519 .valid
.max_access_size
= 4,
520 .endianness
= DEVICE_BIG_ENDIAN
,
523 static const VMStateDescription vmstate_m48t59
= {
526 .minimum_version_id
= 1,
527 .fields
= (VMStateField
[]) {
528 VMSTATE_UINT8(lock
, M48t59State
),
529 VMSTATE_UINT16(addr
, M48t59State
),
530 VMSTATE_VBUFFER_UINT32(buffer
, M48t59State
, 0, NULL
, size
),
531 VMSTATE_END_OF_LIST()
535 void m48t59_reset_common(M48t59State
*NVRAM
)
539 if (NVRAM
->alrm_timer
!= NULL
)
540 timer_del(NVRAM
->alrm_timer
);
542 if (NVRAM
->wd_timer
!= NULL
)
543 timer_del(NVRAM
->wd_timer
);
546 static void m48t59_reset_sysbus(DeviceState
*d
)
548 M48txxSysBusState
*sys
= M48TXX_SYS_BUS(d
);
549 M48t59State
*NVRAM
= &sys
->state
;
551 m48t59_reset_common(NVRAM
);
554 const MemoryRegionOps m48t59_io_ops
= {
556 .write
= NVRAM_writeb
,
558 .min_access_size
= 1,
559 .max_access_size
= 1,
561 .endianness
= DEVICE_LITTLE_ENDIAN
,
564 /* Initialisation routine */
565 Nvram
*m48t59_init(qemu_irq IRQ
, hwaddr mem_base
,
566 uint32_t io_base
, uint16_t size
, int base_year
,
573 for (i
= 0; i
< ARRAY_SIZE(m48txx_sysbus_info
); i
++) {
574 if (m48txx_sysbus_info
[i
].size
!= size
||
575 m48txx_sysbus_info
[i
].model
!= model
) {
579 dev
= qdev_create(NULL
, m48txx_sysbus_info
[i
].bus_name
);
580 qdev_prop_set_int32(dev
, "base-year", base_year
);
581 qdev_init_nofail(dev
);
582 s
= SYS_BUS_DEVICE(dev
);
583 sysbus_connect_irq(s
, 0, IRQ
);
585 memory_region_add_subregion(get_system_io(), io_base
,
586 sysbus_mmio_get_region(s
, 1));
589 sysbus_mmio_map(s
, 0, mem_base
);
599 void m48t59_realize_common(M48t59State
*s
, Error
**errp
)
601 s
->buffer
= g_malloc0(s
->size
);
602 if (s
->model
== 59) {
603 s
->alrm_timer
= timer_new_ns(rtc_clock
, &alarm_cb
, s
);
604 s
->wd_timer
= timer_new_ns(QEMU_CLOCK_VIRTUAL
, &watchdog_cb
, s
);
606 qemu_get_timedate(&s
->alarm
, 0);
609 static void m48t59_init1(Object
*obj
)
611 M48txxSysBusDeviceClass
*u
= M48TXX_SYS_BUS_GET_CLASS(obj
);
612 M48txxSysBusState
*d
= M48TXX_SYS_BUS(obj
);
613 SysBusDevice
*dev
= SYS_BUS_DEVICE(obj
);
614 M48t59State
*s
= &d
->state
;
616 s
->model
= u
->info
.model
;
617 s
->size
= u
->info
.size
;
618 sysbus_init_irq(dev
, &s
->IRQ
);
620 memory_region_init_io(&s
->iomem
, obj
, &nvram_ops
, s
, "m48t59.nvram",
622 memory_region_init_io(&d
->io
, obj
, &m48t59_io_ops
, s
, "m48t59", 4);
625 static void m48t59_realize(DeviceState
*dev
, Error
**errp
)
627 M48txxSysBusState
*d
= M48TXX_SYS_BUS(dev
);
628 M48t59State
*s
= &d
->state
;
629 SysBusDevice
*sbd
= SYS_BUS_DEVICE(dev
);
631 sysbus_init_mmio(sbd
, &s
->iomem
);
632 sysbus_init_mmio(sbd
, &d
->io
);
633 m48t59_realize_common(s
, errp
);
636 static uint32_t m48txx_sysbus_read(Nvram
*obj
, uint32_t addr
)
638 M48txxSysBusState
*d
= M48TXX_SYS_BUS(obj
);
639 return m48t59_read(&d
->state
, addr
);
642 static void m48txx_sysbus_write(Nvram
*obj
, uint32_t addr
, uint32_t val
)
644 M48txxSysBusState
*d
= M48TXX_SYS_BUS(obj
);
645 m48t59_write(&d
->state
, addr
, val
);
648 static void m48txx_sysbus_toggle_lock(Nvram
*obj
, int lock
)
650 M48txxSysBusState
*d
= M48TXX_SYS_BUS(obj
);
651 m48t59_toggle_lock(&d
->state
, lock
);
654 static Property m48t59_sysbus_properties
[] = {
655 DEFINE_PROP_INT32("base-year", M48txxSysBusState
, state
.base_year
, 0),
656 DEFINE_PROP_END_OF_LIST(),
659 static void m48txx_sysbus_class_init(ObjectClass
*klass
, void *data
)
661 DeviceClass
*dc
= DEVICE_CLASS(klass
);
662 NvramClass
*nc
= NVRAM_CLASS(klass
);
664 dc
->realize
= m48t59_realize
;
665 dc
->reset
= m48t59_reset_sysbus
;
666 dc
->props
= m48t59_sysbus_properties
;
667 dc
->vmsd
= &vmstate_m48t59
;
668 nc
->read
= m48txx_sysbus_read
;
669 nc
->write
= m48txx_sysbus_write
;
670 nc
->toggle_lock
= m48txx_sysbus_toggle_lock
;
673 static void m48txx_sysbus_concrete_class_init(ObjectClass
*klass
, void *data
)
675 M48txxSysBusDeviceClass
*u
= M48TXX_SYS_BUS_CLASS(klass
);
676 M48txxInfo
*info
= data
;
681 static const TypeInfo nvram_info
= {
683 .parent
= TYPE_INTERFACE
,
684 .class_size
= sizeof(NvramClass
),
687 static const TypeInfo m48txx_sysbus_type_info
= {
688 .name
= TYPE_M48TXX_SYS_BUS
,
689 .parent
= TYPE_SYS_BUS_DEVICE
,
690 .instance_size
= sizeof(M48txxSysBusState
),
691 .instance_init
= m48t59_init1
,
693 .class_init
= m48txx_sysbus_class_init
,
694 .interfaces
= (InterfaceInfo
[]) {
700 static void m48t59_register_types(void)
702 TypeInfo sysbus_type_info
= {
703 .parent
= TYPE_M48TXX_SYS_BUS
,
704 .class_size
= sizeof(M48txxSysBusDeviceClass
),
705 .class_init
= m48txx_sysbus_concrete_class_init
,
709 type_register_static(&nvram_info
);
710 type_register_static(&m48txx_sysbus_type_info
);
712 for (i
= 0; i
< ARRAY_SIZE(m48txx_sysbus_info
); i
++) {
713 sysbus_type_info
.name
= m48txx_sysbus_info
[i
].bus_name
;
714 sysbus_type_info
.class_data
= &m48txx_sysbus_info
[i
];
715 type_register(&sysbus_type_info
);
719 type_init(m48t59_register_types
)