hw/arm/bcm2835_peripherals: add bcm283x arm timer
Subsystems (2)
PATCH v4 1/1 hw/arm/bcm2835_peripherals: add bcm283x arm timer
--- hw/arm/bcm2835_peripherals.c | 17 ++ hw/timer/Makefile.objs | 2 + hw/timer/bcm283x_timer.c | 271 +++++++++++++++++++++++++++ include/hw/arm/bcm2835_peripherals.h | 2 + include/hw/timer/bcm283x_timer.h | 50 +++++ 5 files changed, 342 insertions(+) create mode 100644 hw/timer/bcm283x_timer.c create mode 100644 include/hw/timer/bcm283x_timer.h
hw/arm/bcm2835_peripherals.c +17 -0
@@ -117,6 +117,10 @@ static void bcm2835_peripherals_init(Object *obj) OBJECT(&s->sdhci.sdbus), &error_abort);object_property_add_const_link (OBJECT (&s->gpio),"sdbus-sdhost" ,OBJECT (&s->sdhost.sdbus), &error_abort); + +/* SP804-alike ARM Timer */ +sysbus_init_child_obj (obj,"bcm283x_timer" ,OBJECT (&s->bcm283x_timer), +sizeof (s->bcm283x_timer), TYPE_BCM283xTimer); }static void bcm2835_peripherals_realize (DeviceState *dev,Error **errp)
@@ -334,6 +338,19 @@ static void bcm2835_peripherals_realize(DeviceState *dev, Error **errp)error_propagate (errp, err);return ; } + +/* SP804-alike ARM Timer */ +object_property_set_bool (OBJECT (&s->bcm283x_timer), true,"realized" , &err); +if (err) { +error_propagate (errp, err); +return ; + } + +memory_region_add_subregion (&s->peri_mr,ARMCTRL_TIMER0_1_OFFSET , +sysbus_mmio_get_region (SYS_BUS_DEVICE (&s->bcm283x_timer),0 )); +sysbus_connect_irq (SYS_BUS_DEVICE (&s->bcm283x_timer),0 , +qdev_get_gpio_in_named (DEVICE (&s->ic),BCM2835_IC_ARM_IRQ , +INTERRUPT_ARM_TIMER )); }static void bcm2835_peripherals_class_init (ObjectClass *oc,void *data)
hw/timer/Makefile.objs +2 -0
@@ -47,3 +47,5 @@ common-obj-$(CONFIG_SUN4V_RTC) += sun4v-rtc.o common-obj-$(CONFIG_CMSDK_APB_TIMER) += cmsdk-apb-timer.o common-obj-$(CONFIG_CMSDK_APB_DUALTIMER) += cmsdk-apb-dualtimer.o common-obj-$(CONFIG_MSF2) += mss-timer.o + +common-obj-$(CONFIG_RASPI) += bcm283x_timer.o
hw/timer/bcm283x_timer.c new file +271 -0
271 lines not on this page · raw message
include/hw/arm/bcm2835_peripherals.h +2 -0
@@ -23,6 +23,7 @@#include "hw/sd/sdhci.h" #include "hw/sd/bcm2835_sdhost.h" #include "hw/gpio/bcm2835_gpio.h" +#include "hw/timer/bcm283x_timer.h" #define TYPE_BCM2835_PERIPHERALS "bcm2835-peripherals"#define BCM2835_PERIPHERALS (obj) \
@@ -48,6 +49,7 @@ typedef struct BCM2835PeripheralState {SDHCIState sdhci;BCM2835SDHostState sdhost;BCM2835GpioState gpio; + BCM283xTimerState bcm283x_timer; } BCM2835PeripheralState;#endif /* BCM2835_PERIPHERALS_H */
include/hw/timer/bcm283x_timer.h new file +50 -0
50 lines not on this page · raw message
--
2.20.1
Quoted 3 lines · Mark
Signed-off-by Mark <[email protected]>---
Hi Mark; thanks for this patch.
hw/timer/bcm283x_timer.c line 3
Quoted 6 lines
hw/timer/bcm283x_timer.c new file +3
-0@@ -0,0 +1,271 @@ +/* +* Broadcom BCM283x ARM timer variant based on ARM SP804 +* Copyright (c) 2019, Mark <[email protected]>
Could we have your full name in the Copyright and
Signed-off-by: lines, please? (Unless you do only have a single name; I know some people don't have two names...)
Quoted 19 lines
hw/timer/bcm283x_timer.c new file +19
-0+* +* This program is free software; you can redistribute it and/or +* modify it under the terms of the GNU General Public License +* as published by the Free Software Foundation; either version +* 2 of the License, or (at your option) any later version. +* +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License along +* with this program; if not, see <http://www.gnu.org/licenses/>. +*/ +#include "qemu/osdep.h" +#include "qemu/timer.h" +#include "qemu-common.h" +#include "hw/qdev.h" +#include "hw/timer/bcm283x_timer.h"
hw/timer/bcm283x_timer.c line 32
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+#include "qemu/main-loop.h" +#include "qemu/log.h" + +#define TIMER_CTRL_32BIT (1 << 1) +#define TIMER_CTRL_DIV1 (0 << 2) +#define TIMER_CTRL_DIV16 (1 << 2) +#define TIMER_CTRL_DIV256 (2 << 2) +#define TIMER_CTRL_IE (1 << 5) +#define TIMER_CTRL_ENABLE (1 << 7) +#define TIMER_CTRL_ENABLE_FREECNTR (1 << 9)
You might like to look at the include/hw/registerfields.h macros, which would let you define these register fields like this:
FIELD(CTRL, 32BIT, 1, 1)FIELD(CTRL, DIV, 2, 2)FIELD(CTRL, IE, 5, 1)
...
and defines macros R_CTRL_32BIT_MASK, R_CTRL_32BIT_SHIFT, and R_CTRL_32BIT_LENGTH, etc for you. You can also then say
FIELD_EX32(s->control, CTRL, DIV)
to get the value of the DIV field in the register, or
s->control = FIELD_DP32(s->control, CTRL, DIV, 2);
to write 2 into the DIV field.
I think this ends up easier to read than doing raw bit shifting and masking, but it's up to you.
You can also use the REG32() macro to define symbolic names for register offsets:REG32(FOO, 0x04)
defines A_FOO to be 0x04 (the address offset of the register) and R_FOO to be 0x1 (the integer offset, useful if you're keeping register values in a uint32_t array, though you aren't here and I wouldn't recommend that for this case).
Quoted 69 lines
hw/timer/bcm283x_timer.c new file +69
-0+ +/* BCM283x's implementation of SP804 ARM timer */ + +static void bcm283x_timer_set_irq (void *opaque,int irq,int level) +{ +BCM283xTimerState *s =BCM283xTimer (opaque); + + s->int_level = level; +qemu_set_irq (s->irq, s->int_level); +} + +static void bcm283x_timer_update (BCM283xTimerState *s) +{ +if (s->int_level && (s->control &TIMER_CTRL_IE )) { +qemu_irq_raise (s->irq); + }else { +qemu_irq_lower (s->irq); + } +} + +static void bcm283x_timer_tick (void *opaque) +{ +BCM283xTimerState *s =BCM283xTimer (opaque); + s->int_level =1 ; +bcm283x_timer_update (s); +} + +static void bcm283x_free_timer_tick (void *opaque) +{ +/* Do nothing */ +} + +static uint64_t bcm283x_timer_read (void *opaque,hwaddr offset,unsigned size) +{ +BCM283xTimerState *s =BCM283xTimer (opaque); + +switch (offset >>2 ) { +case 0 :/* Load register */ +case 6 :/* Reload register */ +return s->limit; +case 1 :/* Value register */ +return ptimer_get_count (s->timer); +case 2 :/* Control register */ +return s->control; +case 3 :/* IRQ clear/ACK register */ +/* +* The register is write-only, +* but returns reverse "ARMT" string bytes +*/ +return 0x544D5241 ; +case 4 :/* RAW IRQ register */ +return s->int_level; +case 5 :/* Masked IRQ register */ +if ((s->control &TIMER_CTRL_IE ) ==0 ) { +return 0 ; + } +return s->int_level; +case 8 :/* Free-running counter */ +return ptimer_get_count (s->free_timer); +default : +qemu_log_mask (LOG_GUEST_ERROR , +"%s: Bad offset %x\n" , __func__, (int ) offset); +return 0 ; + } +} + +static void bcm283x_timer_write (void *opaque,hwaddr offset,uint64_t value, +unsigned size) +{
hw/timer/bcm283x_timer.c line 111
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+BCM283xTimerState *s =BCM283xTimer (opaque); +uint32_t freq, freecntr_freq; + +switch (offset >>2 ) { +case 0 :/* Load register */ + s->limit = value; +ptimer_set_limit (s->timer, s->limit,1 ); +break ; +case 1 :/* Value register */ +/* Read only */
You could log this as a LOG_GUEST_ERROR if you like.
Quoted 28 lines
hw/timer/bcm283x_timer.c new file +28
-0+break ; +case 2 :/* Control register */ +if (s->control &TIMER_CTRL_ENABLE ) { +ptimer_stop (s->timer); + } + + s->control = value; + +/* Configure SP804 */ + freq = BCM283x_SYSTEM_CLOCK_FREQ / (s->prediv +1 ); +/* Set pre-scaler */ +switch ((value >>2 ) &3 ) { +case 1 :/* 16 */ + freq >>=4 ; +break ; +case 2 :/* 256 */ + freq >>=8 ; +break ; + } +ptimer_set_limit (s->timer, s->limit, s->control &TIMER_CTRL_ENABLE ); +ptimer_set_freq (s->timer, freq); + +/* Configure free-running counter */ + freecntr_freq = BCM283x_SYSTEM_CLOCK_FREQ / + (1 + ((value >>16 ) &0xFF )); +if (s->control &TIMER_CTRL_32BIT ) { +ptimer_set_limit (s->free_timer,0xFFFFFFFF , + s->control &TIMER_CTRL_ENABLE_FREECNTR );
hw/timer/bcm283x_timer.c line 149
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+ }else { +ptimer_set_limit (s->free_timer,0xFFFF , + s->control &TIMER_CTRL_ENABLE_FREECNTR ); + } +ptimer_set_freq (s->free_timer, freecntr_freq); + +if (s->control &TIMER_CTRL_ENABLE ) { +ptimer_run (s->timer,0 ); + }else { +ptimer_stop (s->free_timer);
I don't understand this logic. In the SP804 implementation the control register is handled by:
if CTRL_ENABLE bit is already set {
stop the timer
}
update the timer parameters;
if CTRL_ENABLE bit is set in new register value {
start the timer
}
which is done to avoid complications with changing timer parameters while the underlying ptimer is running.
The if/else here is weird because it stops the free timer in the else clause, but the condition being checked seems to be the control bit for the other timer.
I would have expected the logic here to be a bit like:
if CTRL_ENABLE bit set in old register value {
stop main timer
}
if FREECNTR enable bit set in old register value {
stop free timer
}
update parameters for both timers
if CTRL_ENABLE bit set in new register value {
start main timer
}
if FREECNTR enable bit set in new register value {
start free timer
}
(Optionally: don't do the stop-and-restart of timer X unless the config for it is actually being changed, so we don't mess with the accuracy of timer X unnecessarily while we're reconfiguring timer Y.)
Quoted 31 lines
hw/timer/bcm283x_timer.c new file +31
-0+ } + +if (s->control &TIMER_CTRL_ENABLE_FREECNTR ) { +ptimer_run (s->free_timer,0 ); + }else { +ptimer_stop (s->free_timer); + } +break ; +case 3 :/* IRQ clear/ACK register */ + s->int_level =0 ; +break ; +case 6 :/* Reload register */ + s->limit = value; +ptimer_set_limit (s->timer, s->limit,0 ); +break ; +case 7 :/* Pre-divider register */ + s->prediv = value; +break ; +default : +qemu_log_mask (LOG_GUEST_ERROR , +"%s: Bad offset %x\n" , __func__, (int ) offset); +break ; + } + +bcm283x_timer_update (s); +} + +static const MemoryRegionOps bcm283x_timer_ops = { + .read = bcm283x_timer_read, + .write = bcm283x_timer_write, + .endianness =DEVICE_NATIVE_ENDIAN
hw/timer/bcm283x_timer.c line 190
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+}; + +static const VMStateDescription vmstate_bcm283x_timer = { + .name ="bcm283x_timer" , + .version_id =1 , + .minimum_version_id =1 , + .fields = (VMStateField []) { +VMSTATE_UINT32 (control, BCM283xTimerState), +VMSTATE_UINT32 (limit, BCM283xTimerState), +VMSTATE_UINT32 (int_level, BCM283xTimerState),
You've forgotten prediv, I think.
Quoted 15 lines
hw/timer/bcm283x_timer.c new file +15
-0+VMSTATE_PTIMER (timer, BCM283xTimerState), +VMSTATE_PTIMER (free_timer, BCM283xTimerState), + VMSTATE_END_OF_LIST() + } +}; + +static void bcm283x_timer_init (Object *obj) +{ +BCM283xTimerState *s =BCM283xTimer (obj); +SysBusDevice *sbd =SYS_BUS_DEVICE (obj); + +memory_region_init_io (&s->iomem, obj, &bcm283x_timer_ops, s, + TYPE_BCM283xTimer,0x100 ); + +sysbus_init_mmio (sbd, &s->iomem);
hw/timer/bcm283x_timer.c line 215
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+sysbus_init_irq (sbd, &s->irq); +} + +static void bcm283x_timer_reset (DeviceState *dev) +{ +BCM283xTimerState *s =BCM283xTimer (dev); + + s->limit =0 ; + s->int_level =0 ; + s->control =TIMER_CTRL_IE | (0x0E <<16 );
The spec says the reset value of the free-running counter prescaler is 0x3E -- is it wrong ? (I know that doc does have a pile of errors.)
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+ s->prediv =0x7D ; + +/* +* Stop the timers. +* No need to update freqs/limits as this will automatically be done once +* the system writes control register. +*/ +ptimer_stop (s->timer); +ptimer_stop (s->free_timer); +}
hw/timer/bcm283x_timer.c line 235
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+ +static void bcm283x_timer_realize (DeviceState *dev,Error **errp) +{ +BCM283xTimerState *s =BCM283xTimer (dev); +QEMUBH *bh; + + s->limit =0 ; + s->int_level =0 ; + s->control =TIMER_CTRL_IE | (0x0E <<16 ); + s->prediv =0x7D ;
You can delete these four lines, as they are handled by the reset function.
hw/timer/bcm283x_timer.c line 239
Quoted 4 lines
hw/timer/bcm283x_timer.c new file +4
-0+ +/* Create a regular SP804 timer */ + bh =qemu_bh_new (bcm283x_timer_tick, s); + s->timer =ptimer_init (bh,PTIMER_POLICY_DEFAULT );
PTIMER_POLICY_DEFAULT is very rarely what you actually want -- see the comments in include/hw/ptimer.h, which discuss what you should set to get the same behaviour as the hardware in various edge cases.
hw/timer/bcm283x_timer.c line 240
Quoted 1 line
hw/timer/bcm283x_timer.c new file +1
-0+ s->irq =qemu_allocate_irq (bcm283x_timer_set_irq, s,0 );
I know this code has come from the sp804 code, but it's actually wrong (and I should fix the sp804). qemu_allocate_irq() is for interrupt lines that come into a device, not for ones that go out from it, like this one. The call happens to have no visible bad effects because what it does will be overrriden later when the board code wires up the interrupt to the interrupt controller. (There will be a tiny memory leak.)
You can just delete the qemu_allocate_irq() call here, and the bcm283x_timer_set_irq() function.
hw/timer/bcm283x_timer.c line 246
Quoted 6 lines
hw/timer/bcm283x_timer.c new file +6
-0+ +/* Create a free-running timer */ + bh =qemu_bh_new (bcm283x_free_timer_tick, s); + s->free_timer =ptimer_init (bh,PTIMER_POLICY_DEFAULT ); + +vmstate_register (NULL ,-1 , &vmstate_bcm283x_timer, s);
You don't need this call to vmstate_register(), because the setting of k->vmsd below handles registering the vmstate for you.
Quoted 7 lines
hw/timer/bcm283x_timer.c new file +7
-0+} + +static void bcm283x_timer_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *k =DEVICE_CLASS (klass); + + k->realize = bcm283x_timer_realize;
hw/timer/bcm283x_timer.c line 263
Quoted 10 lines
hw/timer/bcm283x_timer.c new file +10
-0+ k->vmsd = &vmstate_bcm283x_timer; + k->reset = bcm283x_timer_reset; +} + +static const TypeInfo bcm283x_timer_info = { + .name = TYPE_BCM283xTimer, + .parent =TYPE_SYS_BUS_DEVICE , + .instance_size =sizeof (BCM283xTimerState), + .instance_init = bcm283x_timer_init, + .class_init = bcm283x_timer_class_init
It's generally best to put a trailing ',' even after the last line in a struct initializer like this -- it means that if we add another line below it later we don't need to edit the preceding line just to add the comma.
hw/timer/bcm283x_timer.c line 264
Quoted 1 line
hw/timer/bcm283x_timer.c new file +1
-0+};
thanks
-- PMM
Quoted 11 lines · Peter Maydell
Quoted 1 line · Mark
+
s->irq=qemu_allocate_irq(bcm283x_timer_set_irq, s, 0);I know this code has come from the sp804 code, but it's actually wrong (and I should fix the sp804).
qemu_allocate_irq()is for interrupt lines that come into a device, not for ones that go out from it, like this one. The call happens to have no visible bad effects because what it does will be overrriden later when the board code wires up the interrupt to the interrupt controller. (There will be a tiny memory leak.)
Looking more closely at this, my analysis here is wrong -- sorry. For the sp804, this call is necessary, because the sp804 has a dual layer structure between the arm_timer_state layer and the SP804State layer. It creates outbound IRQs from the arm_timer_state with qemu_allocate_irq(), and effectively connects them to the SP804State via the sp804_set_irq() function (which raises the outbound IRQ from the SP804State if either of the arm_timer_state lines is high).
In your case there is no dual-layer structure, so you don't need to call qemu_allocate_irq() at all. (You're effectively trying to use BCM283xTimerState as both the inner layer IRQ and the outer layer IRQ, and it happens to work because the setup of the outer layer happens last so the bogus inner layer initialization is ignored.)
Quoted 2 lines
You can just delete the
qemu_allocate_irq()call here, and thebcm283x_timer_set_irq()function.
So my recommendation here was correct, but my reasoning was not right.
thanks
-- PMM