2007-06-30 19:32:17 +02:00
|
|
|
/*
|
|
|
|
* ARM AMBA PrimeCell PL031 RTC
|
|
|
|
*
|
|
|
|
* Copyright (c) 2007 CodeSourcery
|
|
|
|
*
|
|
|
|
* This file is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License version 2 as
|
|
|
|
* published by the Free Software Foundation.
|
|
|
|
*
|
2012-01-13 17:44:23 +01:00
|
|
|
* Contributions after 2012-01-13 are licensed under the terms of the
|
|
|
|
* GNU GPL, version 2 or (at your option) any later version.
|
2007-06-30 19:32:17 +02:00
|
|
|
*/
|
|
|
|
|
2013-02-04 15:40:22 +01:00
|
|
|
#include "hw/sysbus.h"
|
2012-12-17 18:20:00 +01:00
|
|
|
#include "qemu/timer.h"
|
2012-12-17 18:20:04 +01:00
|
|
|
#include "sysemu/sysemu.h"
|
2007-06-30 19:32:17 +02:00
|
|
|
|
|
|
|
//#define DEBUG_PL031
|
|
|
|
|
|
|
|
#ifdef DEBUG_PL031
|
2009-05-13 19:53:17 +02:00
|
|
|
#define DPRINTF(fmt, ...) \
|
|
|
|
do { printf("pl031: " fmt , ## __VA_ARGS__); } while (0)
|
2007-06-30 19:32:17 +02:00
|
|
|
#else
|
2009-05-13 19:53:17 +02:00
|
|
|
#define DPRINTF(fmt, ...) do {} while(0)
|
2007-06-30 19:32:17 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#define RTC_DR 0x00 /* Data read register */
|
|
|
|
#define RTC_MR 0x04 /* Match register */
|
|
|
|
#define RTC_LR 0x08 /* Data load register */
|
|
|
|
#define RTC_CR 0x0c /* Control register */
|
|
|
|
#define RTC_IMSC 0x10 /* Interrupt mask and set register */
|
|
|
|
#define RTC_RIS 0x14 /* Raw interrupt status register */
|
|
|
|
#define RTC_MIS 0x18 /* Masked interrupt status register */
|
|
|
|
#define RTC_ICR 0x1c /* Interrupt clear register */
|
|
|
|
|
2013-07-27 15:10:14 +02:00
|
|
|
#define TYPE_PL031 "pl031"
|
|
|
|
#define PL031(obj) OBJECT_CHECK(PL031State, (obj), TYPE_PL031)
|
|
|
|
|
2013-07-27 15:07:44 +02:00
|
|
|
typedef struct PL031State {
|
2013-07-27 15:10:14 +02:00
|
|
|
SysBusDevice parent_obj;
|
|
|
|
|
2011-10-10 17:18:44 +02:00
|
|
|
MemoryRegion iomem;
|
2007-06-30 19:32:17 +02:00
|
|
|
QEMUTimer *timer;
|
|
|
|
qemu_irq irq;
|
|
|
|
|
2012-03-30 12:31:23 +02:00
|
|
|
/* Needed to preserve the tick_count across migration, even if the
|
|
|
|
* absolute value of the rtc_clock is different on the source and
|
|
|
|
* destination.
|
|
|
|
*/
|
|
|
|
uint32_t tick_offset_vmstate;
|
2007-06-30 19:32:17 +02:00
|
|
|
uint32_t tick_offset;
|
|
|
|
|
|
|
|
uint32_t mr;
|
|
|
|
uint32_t lr;
|
|
|
|
uint32_t cr;
|
|
|
|
uint32_t im;
|
|
|
|
uint32_t is;
|
2013-07-27 15:07:44 +02:00
|
|
|
} PL031State;
|
2007-06-30 19:32:17 +02:00
|
|
|
|
|
|
|
static const unsigned char pl031_id[] = {
|
|
|
|
0x31, 0x10, 0x14, 0x00, /* Device ID */
|
|
|
|
0x0d, 0xf0, 0x05, 0xb1 /* Cell ID */
|
|
|
|
};
|
|
|
|
|
2013-07-27 15:07:44 +02:00
|
|
|
static void pl031_update(PL031State *s)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
|
|
|
qemu_set_irq(s->irq, s->is & s->im);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void pl031_interrupt(void * opaque)
|
|
|
|
{
|
2013-07-27 15:07:44 +02:00
|
|
|
PL031State *s = (PL031State *)opaque;
|
2007-06-30 19:32:17 +02:00
|
|
|
|
2012-02-16 10:56:10 +01:00
|
|
|
s->is = 1;
|
2007-06-30 19:32:17 +02:00
|
|
|
DPRINTF("Alarm raised\n");
|
|
|
|
pl031_update(s);
|
|
|
|
}
|
|
|
|
|
2013-07-27 15:07:44 +02:00
|
|
|
static uint32_t pl031_get_count(PL031State *s)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
2013-08-21 17:03:04 +02:00
|
|
|
int64_t now = qemu_clock_get_ns(rtc_clock);
|
2012-03-30 12:31:23 +02:00
|
|
|
return s->tick_offset + now / get_ticks_per_sec();
|
2007-06-30 19:32:17 +02:00
|
|
|
}
|
|
|
|
|
2013-07-27 15:07:44 +02:00
|
|
|
static void pl031_set_alarm(PL031State *s)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
|
|
|
uint32_t ticks;
|
|
|
|
|
|
|
|
/* The timer wraps around. This subtraction also wraps in the same way,
|
|
|
|
and gives correct results when alarm < now_ticks. */
|
2012-03-30 12:31:23 +02:00
|
|
|
ticks = s->mr - pl031_get_count(s);
|
2007-06-30 19:32:17 +02:00
|
|
|
DPRINTF("Alarm set in %ud ticks\n", ticks);
|
|
|
|
if (ticks == 0) {
|
2013-08-21 17:03:08 +02:00
|
|
|
timer_del(s->timer);
|
2007-06-30 19:32:17 +02:00
|
|
|
pl031_interrupt(s);
|
|
|
|
} else {
|
2013-08-21 17:03:04 +02:00
|
|
|
int64_t now = qemu_clock_get_ns(rtc_clock);
|
2013-08-21 17:03:08 +02:00
|
|
|
timer_mod(s->timer, now + (int64_t)ticks * get_ticks_per_sec());
|
2007-06-30 19:32:17 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-23 12:30:10 +02:00
|
|
|
static uint64_t pl031_read(void *opaque, hwaddr offset,
|
2011-10-10 17:18:44 +02:00
|
|
|
unsigned size)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
2013-07-27 15:07:44 +02:00
|
|
|
PL031State *s = (PL031State *)opaque;
|
2007-06-30 19:32:17 +02:00
|
|
|
|
|
|
|
if (offset >= 0xfe0 && offset < 0x1000)
|
|
|
|
return pl031_id[(offset - 0xfe0) >> 2];
|
|
|
|
|
|
|
|
switch (offset) {
|
|
|
|
case RTC_DR:
|
|
|
|
return pl031_get_count(s);
|
|
|
|
case RTC_MR:
|
|
|
|
return s->mr;
|
|
|
|
case RTC_IMSC:
|
|
|
|
return s->im;
|
|
|
|
case RTC_RIS:
|
|
|
|
return s->is;
|
|
|
|
case RTC_LR:
|
|
|
|
return s->lr;
|
|
|
|
case RTC_CR:
|
|
|
|
/* RTC is permanently enabled. */
|
|
|
|
return 1;
|
|
|
|
case RTC_MIS:
|
|
|
|
return s->is & s->im;
|
|
|
|
case RTC_ICR:
|
2012-10-18 15:11:42 +02:00
|
|
|
qemu_log_mask(LOG_GUEST_ERROR,
|
|
|
|
"pl031: read of write-only register at offset 0x%x\n",
|
|
|
|
(int)offset);
|
2007-06-30 19:32:17 +02:00
|
|
|
break;
|
|
|
|
default:
|
2012-10-18 15:11:42 +02:00
|
|
|
qemu_log_mask(LOG_GUEST_ERROR,
|
|
|
|
"pl031_read: Bad offset 0x%x\n", (int)offset);
|
2007-06-30 19:32:17 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2012-10-23 12:30:10 +02:00
|
|
|
static void pl031_write(void * opaque, hwaddr offset,
|
2011-10-10 17:18:44 +02:00
|
|
|
uint64_t value, unsigned size)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
2013-07-27 15:07:44 +02:00
|
|
|
PL031State *s = (PL031State *)opaque;
|
2007-06-30 19:32:17 +02:00
|
|
|
|
|
|
|
|
|
|
|
switch (offset) {
|
|
|
|
case RTC_LR:
|
|
|
|
s->tick_offset += value - pl031_get_count(s);
|
|
|
|
pl031_set_alarm(s);
|
|
|
|
break;
|
|
|
|
case RTC_MR:
|
|
|
|
s->mr = value;
|
|
|
|
pl031_set_alarm(s);
|
|
|
|
break;
|
|
|
|
case RTC_IMSC:
|
|
|
|
s->im = value & 1;
|
|
|
|
DPRINTF("Interrupt mask %d\n", s->im);
|
|
|
|
pl031_update(s);
|
|
|
|
break;
|
|
|
|
case RTC_ICR:
|
2011-04-28 17:20:35 +02:00
|
|
|
/* The PL031 documentation (DDI0224B) states that the interrupt is
|
2007-06-30 19:32:17 +02:00
|
|
|
cleared when bit 0 of the written value is set. However the
|
|
|
|
arm926e documentation (DDI0287B) states that the interrupt is
|
|
|
|
cleared when any value is written. */
|
|
|
|
DPRINTF("Interrupt cleared");
|
|
|
|
s->is = 0;
|
|
|
|
pl031_update(s);
|
|
|
|
break;
|
|
|
|
case RTC_CR:
|
|
|
|
/* Written value is ignored. */
|
|
|
|
break;
|
|
|
|
|
|
|
|
case RTC_DR:
|
|
|
|
case RTC_MIS:
|
|
|
|
case RTC_RIS:
|
2012-10-18 15:11:42 +02:00
|
|
|
qemu_log_mask(LOG_GUEST_ERROR,
|
|
|
|
"pl031: write to read-only register at offset 0x%x\n",
|
|
|
|
(int)offset);
|
2007-06-30 19:32:17 +02:00
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
2012-10-18 15:11:42 +02:00
|
|
|
qemu_log_mask(LOG_GUEST_ERROR,
|
|
|
|
"pl031_write: Bad offset 0x%x\n", (int)offset);
|
2007-06-30 19:32:17 +02:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-10-10 17:18:44 +02:00
|
|
|
static const MemoryRegionOps pl031_ops = {
|
|
|
|
.read = pl031_read,
|
|
|
|
.write = pl031_write,
|
|
|
|
.endianness = DEVICE_NATIVE_ENDIAN,
|
2007-06-30 19:32:17 +02:00
|
|
|
};
|
|
|
|
|
2009-08-14 10:36:05 +02:00
|
|
|
static int pl031_init(SysBusDevice *dev)
|
2007-06-30 19:32:17 +02:00
|
|
|
{
|
2013-07-27 15:10:14 +02:00
|
|
|
PL031State *s = PL031(dev);
|
2008-02-17 12:42:19 +01:00
|
|
|
struct tm tm;
|
2007-06-30 19:32:17 +02:00
|
|
|
|
2013-06-07 03:25:08 +02:00
|
|
|
memory_region_init_io(&s->iomem, OBJECT(s), &pl031_ops, s, "pl031", 0x1000);
|
2011-11-27 10:38:10 +01:00
|
|
|
sysbus_init_mmio(dev, &s->iomem);
|
2007-06-30 19:32:17 +02:00
|
|
|
|
2009-05-14 23:35:07 +02:00
|
|
|
sysbus_init_irq(dev, &s->irq);
|
2008-02-17 12:42:19 +01:00
|
|
|
qemu_get_timedate(&tm, 0);
|
2013-08-21 17:03:04 +02:00
|
|
|
s->tick_offset = mktimegm(&tm) -
|
|
|
|
qemu_clock_get_ns(rtc_clock) / get_ticks_per_sec();
|
2007-06-30 19:32:17 +02:00
|
|
|
|
2013-08-21 17:03:04 +02:00
|
|
|
s->timer = timer_new_ns(rtc_clock, pl031_interrupt, s);
|
2009-08-14 10:36:05 +02:00
|
|
|
return 0;
|
2007-06-30 19:32:17 +02:00
|
|
|
}
|
2009-05-14 23:35:07 +02:00
|
|
|
|
2012-03-30 12:31:23 +02:00
|
|
|
static void pl031_pre_save(void *opaque)
|
|
|
|
{
|
2013-07-27 15:07:44 +02:00
|
|
|
PL031State *s = opaque;
|
2012-03-30 12:31:23 +02:00
|
|
|
|
|
|
|
/* tick_offset is base_time - rtc_clock base time. Instead, we want to
|
2013-08-21 17:03:08 +02:00
|
|
|
* store the base time relative to the QEMU_CLOCK_VIRTUAL for backwards-compatibility. */
|
|
|
|
int64_t delta = qemu_clock_get_ns(rtc_clock) - qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
|
2012-03-30 12:31:23 +02:00
|
|
|
s->tick_offset_vmstate = s->tick_offset + delta / get_ticks_per_sec();
|
|
|
|
}
|
|
|
|
|
2012-03-30 12:31:22 +02:00
|
|
|
static int pl031_post_load(void *opaque, int version_id)
|
|
|
|
{
|
2013-07-27 15:07:44 +02:00
|
|
|
PL031State *s = opaque;
|
2012-03-30 12:31:22 +02:00
|
|
|
|
2013-08-21 17:03:08 +02:00
|
|
|
int64_t delta = qemu_clock_get_ns(rtc_clock) - qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
|
2012-03-30 12:31:23 +02:00
|
|
|
s->tick_offset = s->tick_offset_vmstate - delta / get_ticks_per_sec();
|
2012-03-30 12:31:22 +02:00
|
|
|
pl031_set_alarm(s);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static const VMStateDescription vmstate_pl031 = {
|
|
|
|
.name = "pl031",
|
|
|
|
.version_id = 1,
|
|
|
|
.minimum_version_id = 1,
|
2012-03-30 12:31:23 +02:00
|
|
|
.pre_save = pl031_pre_save,
|
2012-03-30 12:31:22 +02:00
|
|
|
.post_load = pl031_post_load,
|
|
|
|
.fields = (VMStateField[]) {
|
2013-07-27 15:07:44 +02:00
|
|
|
VMSTATE_UINT32(tick_offset_vmstate, PL031State),
|
|
|
|
VMSTATE_UINT32(mr, PL031State),
|
|
|
|
VMSTATE_UINT32(lr, PL031State),
|
|
|
|
VMSTATE_UINT32(cr, PL031State),
|
|
|
|
VMSTATE_UINT32(im, PL031State),
|
|
|
|
VMSTATE_UINT32(is, PL031State),
|
2012-03-30 12:31:22 +02:00
|
|
|
VMSTATE_END_OF_LIST()
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-01-24 20:12:29 +01:00
|
|
|
static void pl031_class_init(ObjectClass *klass, void *data)
|
|
|
|
{
|
2011-12-08 04:34:16 +01:00
|
|
|
DeviceClass *dc = DEVICE_CLASS(klass);
|
2012-01-24 20:12:29 +01:00
|
|
|
SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
|
|
|
|
|
|
|
|
k->init = pl031_init;
|
qdev: Replace no_user by cannot_instantiate_with_device_add_yet
In an ideal world, machines can be built by wiring devices together
with configuration, not code. Unfortunately, that's not the world we
live in right now. We still have quite a few devices that need to be
wired up by code. If you try to device_add such a device, it'll fail
in sometimes mysterious ways. If you're lucky, you get an
unmysterious immediate crash.
To protect users from such badness, DeviceClass member no_user used to
make device models unavailable with -device / device_add, but that
regressed in commit 18b6dad. The device model is still omitted from
help, but is available anyway.
Attempts to fix the regression have been rejected with the argument
that the purpose of no_user isn't clear, and it's prone to misuse.
This commit clarifies no_user's purpose. Anthony suggested to rename
it cannot_instantiate_with_device_add_yet_due_to_internal_bugs, which
I shorten somewhat to keep checkpatch happy. While there, make it
bool.
Every use of cannot_instantiate_with_device_add_yet gets a FIXME
comment asking for rationale. The next few commits will clean them
all up, either by providing a rationale, or by getting rid of the use.
With that done, the regression fix is hopefully acceptable.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marcel Apfelbaum <marcel.a@redhat.com>
Signed-off-by: Andreas Färber <afaerber@suse.de>
2013-11-28 17:26:54 +01:00
|
|
|
dc->cannot_instantiate_with_device_add_yet = true; /* FIXME explain why */
|
2011-12-08 04:34:16 +01:00
|
|
|
dc->vmsd = &vmstate_pl031;
|
2012-01-24 20:12:29 +01:00
|
|
|
}
|
|
|
|
|
2013-01-10 16:19:07 +01:00
|
|
|
static const TypeInfo pl031_info = {
|
2013-07-27 15:10:14 +02:00
|
|
|
.name = TYPE_PL031,
|
2011-12-08 04:34:16 +01:00
|
|
|
.parent = TYPE_SYS_BUS_DEVICE,
|
2013-07-27 15:07:44 +02:00
|
|
|
.instance_size = sizeof(PL031State),
|
2011-12-08 04:34:16 +01:00
|
|
|
.class_init = pl031_class_init,
|
2010-12-23 18:19:55 +01:00
|
|
|
};
|
|
|
|
|
2012-02-09 15:20:55 +01:00
|
|
|
static void pl031_register_types(void)
|
2009-05-14 23:35:07 +02:00
|
|
|
{
|
2011-12-08 04:34:16 +01:00
|
|
|
type_register_static(&pl031_info);
|
2009-05-14 23:35:07 +02:00
|
|
|
}
|
|
|
|
|
2012-02-09 15:20:55 +01:00
|
|
|
type_init(pl031_register_types)
|