Re: [Qemu-devel] [PATCH v10 06/13] hw/intc: RX62N interrupt controller (ICUa)

[Yoshinori Sato <ysato@users.sourceforge.jp>]

On Thu, 09 May 2019 01:27:40 +0900,
Philippe Mathieu-Daudé wrote:
> 
> On 5/8/19 4:56 PM, Yoshinori Sato wrote:
> > This implementation supported only ICUa.
> > Hardware manual.
> > https://www.renesas.com/us/en/doc/products/mpumcu/doc/rx_family/r01uh0033ej0140_rx62n.pdf
> > 
> > Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
> > ---
> >  include/hw/intc/rx_icu.h |  49 +++++++
> >  hw/intc/rx_icu.c         | 375 +++++++++++++++++++++++++++++++++++++++++++++++
> >  hw/intc/Makefile.objs    |   1 +
> >  3 files changed, 425 insertions(+)
> >  create mode 100644 include/hw/intc/rx_icu.h
> >  create mode 100644 hw/intc/rx_icu.c
> > 
> > diff --git a/include/hw/intc/rx_icu.h b/include/hw/intc/rx_icu.h
> > new file mode 100644
> > index 0000000000..bc46b3079b
> > --- /dev/null
> > +++ b/include/hw/intc/rx_icu.h
> > @@ -0,0 +1,49 @@
> > +#ifndef RX_ICU_H
> > +#define RX_ICU_H
> > +
> > +#include "qemu-common.h"
> > +#include "hw/irq.h"
> > +
> > +struct IRQSource {
> > +    int sense;
> 
> Hmm can you use the enum?
> 
> > +    int level;
> > +};
> > +
> > +struct RXICUState {
> > +    SysBusDevice parent_obj;
> > +
> > +    MemoryRegion memory;
> > +    struct IRQSource src[256];
> > +    char *icutype;
> > +    uint32_t nr_irqs;
> > +    uint32_t *map;
> > +    uint32_t nr_sense;
> > +    uint32_t *init_sense;
> > +
> > +    uint8_t ir[256];
> > +    uint8_t dtcer[256];
> > +    uint8_t ier[32];
> > +    uint8_t ipr[142];
> > +    uint8_t dmasr[4];
> > +    uint16_t fir;
> > +    uint8_t nmisr;
> > +    uint8_t nmier;
> > +    uint8_t nmiclr;
> > +    uint8_t nmicr;
> > +    int req_irq;
> > +    qemu_irq _irq;
> > +    qemu_irq _fir;
> > +    qemu_irq _swi;
> > +};
> > +typedef struct RXICUState RXICUState;
> > +
> > +#define TYPE_RXICU "rxicu"
> > +#define RXICU(obj) OBJECT_CHECK(RXICUState, (obj), TYPE_RXICU)
> > +
> > +#define SWI 27
> 
> enum {
> 
> > +#define TRG_LEVEL 0
> > +#define TRG_NEDGE 1
> > +#define TRG_PEDGE 2
> > +#define TRG_BEDGE 3
> 
> };
> 
> > +
> > +#endif /* RX_ICU_H */
> > diff --git a/hw/intc/rx_icu.c b/hw/intc/rx_icu.c
> > new file mode 100644
> > index 0000000000..345e047a45
> > --- /dev/null
> > +++ b/hw/intc/rx_icu.c
> > @@ -0,0 +1,375 @@
> > +/*
> > + * RX Interrupt control unit
> 
> "Interrupt Control Unit"
> 
> "Warning: Only ICUa is supported."
> 
> > + *
> > + * Datasheet: RX62N Group, RX621 Group User's Manual: Hardware
> > + * (Rev.1.40 R01UH0033EJ0140)
> > + *
> > + * Copyright (c) 2019 Yoshinori Sato
> > + *
> > + * This program is free software; you can redistribute it and/or modify it
> > + * under the terms and conditions of the GNU General Public License,
> > + * version 2 or later, as published by the Free Software Foundation.
> > + *
> > + * This program is distributed in the hope 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-common.h"
> > +#include "qemu/log.h"
> > +#include "qapi/error.h"
> > +#include "cpu.h"
> > +#include "hw/hw.h"
> > +#include "hw/sysbus.h"
> > +#include "hw/registerfields.h"
> > +#include "hw/intc/rx_icu.h"
> > +#include "qemu/error-report.h"
> > +
> > +REG8(IR, 0)
> > +  FIELD(IR, IR,  0, 1)
> > +REG8(DTCER, 0x100)
> > +  FIELD(DTCER, DTCE,  0, 1)
> > +REG8(IER, 0x200)
> > +REG8(SWINTR, 0x2e0)
> > +  FIELD(SWINTR, SWINT, 0, 1)
> > +REG16(FIR, 0x2f0)
> > +  FIELD(FIR, FVCT, 0, 8)
> > +  FIELD(FIR, FIEN, 15, 1)
> > +REG8(IPR, 0x300)
> > +  FIELD(IPR, IPR, 0, 4)
> > +REG8(DMRSR, 0x400)
> > +REG8(IRQCR, 0x500)
> > +  FIELD(IRQCR, IRQMD, 2, 2)
> > +REG8(NMISR, 0x580)
> > +  FIELD(NMISR, NMIST, 0, 1)
> > +  FIELD(NMISR, LVDST, 1, 1)
> > +  FIELD(NMISR, OSTST, 2, 1)
> > +REG8(NMIER, 0x581)
> > +  FIELD(NMIER, NMIEN, 0, 1)
> > +  FIELD(NMIER, LVDEN, 1, 1)
> > +  FIELD(NMIER, OSTEN, 2, 1)
> > +REG8(NMICLR, 0x582)
> > +  FIELD(NMICLR, NMICLR, 0, 1)
> > +  FIELD(NMICLR, OSTCLR, 2, 1)
> > +REG8(NMICR, 0x583)
> > +  FIELD(NMICR, NMIMD, 3, 1)
> > +
> > +#define request(icu, n) (icu->ipr[icu->map[n]] << 8 | n)
> > +
> > +static qemu_irq *rxicu_pin(RXICUState *icu, int n_IRQ)
> > +{
> > +    if ((icu->fir & R_FIR_FIEN_MASK) &&
> > +        (icu->fir & R_FIR_FVCT_MASK) == n_IRQ) {
> > +        return &icu->_fir;
> > +    } else {
> > +        return &icu->_irq;
> > +    }
> > +}
> > +
> > +static void rxicu_request(RXICUState *icu, int n_IRQ)
> > +{
> > +    int enable;
> > +
> > +    enable = icu->ier[n_IRQ / 8] & (1 << (n_IRQ & 7));
> > +    if (n_IRQ > 0 && enable != 0 && atomic_read(&icu->req_irq) < 0) {
> > +        atomic_set(&icu->req_irq, n_IRQ);
> > +        qemu_set_irq(*rxicu_pin(icu, n_IRQ), request(icu, n_IRQ));
> > +    }
> > +}
> > +
> > +static void rxicu_set_irq(void *opaque, int n_IRQ, int level)
> > +{
> > +    RXICUState *icu = opaque;
> > +    struct IRQSource *src;
> > +    int issue;
> > +
> > +    if (n_IRQ >= 256) {
> 
> OK this should be RX_IRQ_COUNT (noted in later patch).
> 
> > +        error_report("%s: IRQ %d out of range", __func__, n_IRQ);
> > +        return;
> > +    }
> > +
> > +    src = &icu->src[n_IRQ];
> > +
> > +    level = (level != 0);
> > +    switch (src->sense) {
> > +    case TRG_LEVEL:
> > +        /* level-sensitive irq */
> > +        issue = level;
> > +        src->level = level;
> > +        break;
> > +    case TRG_NEDGE:
> > +        issue = (level == 0 && src->level == 1);
> > +        src->level = level;
> > +        break;
> > +    case TRG_PEDGE:
> > +        issue = (level == 1 && src->level == 0);
> > +        src->level = level;
> > +        break;
> > +    case TRG_BEDGE:
> > +        issue = ((level ^ src->level) & 1);
> > +        src->level = level;
> > +        break;
> > +    default:
> > +        g_assert_not_reached();
> > +    }
> > +    if (issue == 0 && src->sense == TRG_LEVEL) {
> > +        icu->ir[n_IRQ] = 0;
> > +        if (atomic_read(&icu->req_irq) == n_IRQ) {
> > +            /* clear request */
> > +            qemu_set_irq(*rxicu_pin(icu, n_IRQ), 0);
> > +            atomic_set(&icu->req_irq, -1);
> > +        }
> > +        return;
> > +    }
> > +    if (issue) {
> > +        icu->ir[n_IRQ] = 1;
> > +        rxicu_request(icu, n_IRQ);
> > +    }
> > +}
> > +
> > +static void rxicu_ack_irq(void *opaque, int no, int level)
> > +{
> > +    RXICUState *icu = opaque;
> > +    int i;
> > +    int n_IRQ;
> > +    int max_pri;
> > +
> > +    n_IRQ = atomic_read(&icu->req_irq);
> > +    if (n_IRQ < 0) {
> > +        return;
> > +    }
> > +    atomic_set(&icu->req_irq, -1);
> > +    if (icu->src[n_IRQ].sense != TRG_LEVEL) {
> > +        icu->ir[n_IRQ] = 0;
> > +    }
> > +
> > +    max_pri = 0;
> > +    n_IRQ = -1;
> > +    for (i = 0; i < 256; i++) {
> > +        if (icu->ir[i]) {
> > +            if (max_pri < icu->ipr[icu->map[i]]) {
> > +                n_IRQ = i;
> > +                max_pri = icu->ipr[icu->map[i]];
> > +            }
> > +        }
> > +    }
> > +
> > +    if (n_IRQ >= 0) {
> > +        rxicu_request(icu, n_IRQ);
> > +    }
> > +}
> > +
> > +static uint64_t icu_read(void *opaque, hwaddr addr, unsigned size)
> > +{
> > +    hwaddr offset = addr & 0xfff;
> 
> The region is 0x600 wide, why AND? (if required that would be & 0x5ff).
> 
> > +    RXICUState *icu = opaque;
> > +    int reg = addr & 0xff;
> > +
> > +    if ((offset != A_FIR && size != 1) ||
> > +        (offset == A_FIR && size != 2)) {
> > +        qemu_log_mask(LOG_GUEST_ERROR,
> > +                      "rx_icu: Invalid read size %08lx.\n", offset);
> > +        return 0xffffffffffffffffULL;
> 
> UINT64_MAX?
> 
> Here I get on 32bit host:
> 
> In file included from qemu/hw/intc/rx_icu.c:24:0:
> qemu/hw/intc/rx_icu.c: In function 'icu_read':
> qemu/hw/intc/rx_icu.c:176:23: error: format '%lx' expects argument of
> type 'long unsigned int', but argument 2 has type 'hwaddr {aka long long
> unsigned int}' [-Werror=format=]
>                        "rx_icu: Invalid read size %08lx.\n", offset);
>                        ^
> qemu/include/qemu/log.h:85:22: note: in definition of macro 'qemu_log_mask'
>              qemu_log(FMT, ## __VA_ARGS__);              \
>                       ^
> qemu/hw/intc/rx_icu.c:208:23: error: format '%lx' expects argument of
> type 'long unsigned int', but argument 2 has type 'hwaddr {aka long long
> unsigned int}' [-Werror=format=]
>                        "rx_icu: Register %08lx not implemented\n", offset);
>                        ^
> qemu/include/qemu/log.h:85:22: note: in definition of macro 'qemu_log_mask'
>              qemu_log(FMT, ## __VA_ARGS__);              \
>                       ^
> qemu/hw/intc/rx_icu.c: In function 'icu_write':
> qemu/hw/intc/rx_icu.c:223:23: error: format '%lx' expects argument of
> type 'long unsigned int', but argument 2 has type 'hwaddr {aka long long
> unsigned int}' [-Werror=format=]
>                        "rx_icu: Invalid write size at %08lx.\n", offset);
>                        ^
> qemu/include/qemu/log.h:85:22: note: in definition of macro 'qemu_log_mask'
>              qemu_log(FMT, ## __VA_ARGS__);              \
>                       ^
> qemu/hw/intc/rx_icu.c:276:23: error: format '%lx' expects argument of
> type 'long unsigned int', but argument 2 has type 'hwaddr {aka long long
> unsigned int}' [-Werror=format=]
>                        "rx_icu: Register %08lx not implemented\n", offset);
>                        ^
> qemu/include/qemu/log.h:85:22: note: in definition of macro 'qemu_log_mask'
>              qemu_log(FMT, ## __VA_ARGS__);              \
>                       ^
> cc1: all warnings being treated as errors
> 
> Please fix using HWADDR_PRIX.
> 
> > +    }
> > +    switch (offset) {
> > +    case A_IR ... A_IR + 0xff:
> > +        return icu->ir[reg] & R_IR_IR_MASK;
> > +    case A_DTCER ... A_DTCER + 0xff:
> > +        return icu->dtcer[reg] & R_DTCER_DTCE_MASK;
> > +    case A_IER ... A_IER + 0x1f:
> > +        return icu->ier[reg];
> > +    case A_SWINTR:
> > +        return 0;
> > +    case A_FIR:
> > +        return icu->fir & (R_FIR_FIEN_MASK | R_FIR_FVCT_MASK);
> > +    case A_IPR ... A_IPR + 0x8f:
> > +        return icu->ipr[reg] & R_IPR_IPR_MASK;
> > +    case A_DMRSR:
> > +    case A_DMRSR + 4:
> > +    case A_DMRSR + 8:
> > +    case A_DMRSR + 12:
> > +        return icu->dmasr[reg >> 2];
> > +    case A_IRQCR ... A_IRQCR + 0x1f:
> > +        return icu->src[64 + reg].sense << R_IRQCR_IRQMD_SHIFT;
> > +    case A_NMISR:
> > +    case A_NMICLR:
> > +        return 0;
> > +    case A_NMIER:
> > +        return icu->nmier;
> > +    case A_NMICR:
> > +        return icu->nmicr;
> > +    default:
> > +        qemu_log_mask(LOG_UNIMP,
> > +                      "rx_icu: Register %08lx not implemented\n", offset);
> > +        break;
> > +    }
> > +    return 0xffffffffffffffffULL;
> 
> UINT64_MAX
> 
> > +}
> > +
> > +static void icu_write(void *opaque, hwaddr addr, uint64_t val, unsigned size)
> > +{
> > +    hwaddr offset = addr & 0xfff;
> 
> AND not needed IMO.
> 
> > +    RXICUState *icu = opaque;
> > +    int reg = addr & 0xff;
> > +
> > +    if ((offset != A_FIR && size != 1) ||
> > +        (offset == A_FIR && size != 2)) {
> > +        qemu_log_mask(LOG_GUEST_ERROR,
> > +                      "rx_icu: Invalid write size at %08lx.\n", offset);
> 
> Oh, I think we don't end logging with trailing dot...
> 
> > +        return;
> > +    }
> > +    switch (offset) {
> > +    case A_IR ... A_IR + 0xff:
> > +        if (icu->src[reg].sense != TRG_LEVEL && val == 0) {
> > +            icu->ir[reg] = 0;
> > +        }
> > +        break;
> > +    case A_DTCER ... A_DTCER + 0xff:
> > +        icu->dtcer[reg] = val & R_DTCER_DTCE_MASK;
> > +        qemu_log_mask(LOG_UNIMP,
> > +                      "rx_icu: DTC not implemented\n");
> > +        break;
> > +    case A_IER ... A_IER + 0x1f:
> > +        icu->ier[reg] = val;
> > +        break;
> > +    case A_SWINTR:
> > +        if (val & R_SWINTR_SWINT_MASK) {
> > +            qemu_irq_pulse(icu->_swi);
> > +        }
> > +        break;
> > +    case A_FIR:
> > +        icu->fir = val & (R_FIR_FIEN_MASK | R_FIR_FVCT_MASK);
> > +        break;
> > +    case A_IPR ... A_IPR + 0x8f:
> > +        icu->ipr[reg] = val & R_IPR_IPR_MASK;
> > +        break;
> > +    case A_DMRSR:
> > +    case A_DMRSR + 4:
> > +    case A_DMRSR + 8:
> > +    case A_DMRSR + 12:
> > +        icu->dmasr[reg >> 2] = val;
> > +        qemu_log_mask(LOG_UNIMP,
> > +                      "rx_icu: DMAC not implemented\n");
> > +        break;
> > +    case A_IRQCR ... A_IRQCR + 0x1f:
> > +        icu->src[64 + reg].sense = val >> R_IRQCR_IRQMD_SHIFT;
> > +        break;
> > +    case A_NMICLR:
> > +        break;
> > +    case A_NMIER:
> > +        icu->nmier |= val & (R_NMIER_NMIEN_MASK |
> > +                             R_NMIER_LVDEN_MASK |
> > +                             R_NMIER_OSTEN_MASK);
> > +            break;
> > +    case A_NMICR:
> > +        if ((icu->nmier & R_NMIER_NMIEN_MASK) == 0) {
> > +            icu->nmicr = val & R_NMICR_NMIMD_MASK;
> > +        }
> > +        break;
> > +    default:
> > +        qemu_log_mask(LOG_UNIMP,
> > +                      "rx_icu: Register %08lx not implemented\n", offset);
> > +        break;
> > +    }
> > +}
> > +
> > +static const MemoryRegionOps icu_ops = {
> > +    .write = icu_write,
> > +    .read  = icu_read,
> > +    .endianness = DEVICE_LITTLE_ENDIAN,
> > +    .impl = {
> > +        .max_access_size = 2,
> > +    },
> > +};
> > +
> > +static void rxicu_realize(DeviceState *dev, Error **errp)
> > +{
> > +    RXICUState *icu = RXICU(dev);
> > +    int i, j;
> > +
> > +    if (icu->init_sense == NULL) {
> > +        qemu_log_mask(LOG_GUEST_ERROR,
> > +                      "rx_icu: trigger-level property must be set.");
> > +        return;
> > +    }
> > +    for (i = j = 0; i < 256; i++) {
> 
> RX_IRQ_COUNT
> 
> > +        if (icu->init_sense[j] == i) {
> > +            icu->src[i].sense = TRG_LEVEL;
> > +            if (j < icu->nr_sense) {
> > +                j++;
> > +            }
> > +        } else
> > +            icu->src[i].sense = TRG_PEDGE;
> > +    }
> > +    icu->req_irq = -1;
> > +}
> > +
> > +static void rxicu_init(Object *obj)
> > +{
> > +    SysBusDevice *d = SYS_BUS_DEVICE(obj);
> > +    RXICUState *icu = RXICU(obj);
> > +
> > +    memory_region_init_io(&icu->memory, OBJECT(icu), &icu_ops,
> > +                          icu, "rx-icu", 0x600);
> > +    sysbus_init_mmio(d, &icu->memory);
> > +
> > +    qdev_init_gpio_in(DEVICE(d), rxicu_set_irq, 256);
> 
> RX_IRQ_COUNT
> 
> > +    qdev_init_gpio_in_named(DEVICE(d), rxicu_ack_irq, "ack", 1);
> > +    sysbus_init_irq(d, &icu->_irq);
> > +    sysbus_init_irq(d, &icu->_fir);
> > +    sysbus_init_irq(d, &icu->_swi);
> > +}
> > +
> > +static void rxicu_fini(Object *obj)
> > +{
> > +    RXICUState *icu = RXICU(obj);
> > +    g_free(icu->map);
> > +    g_free(icu->init_sense);
> > +}
> > +
> > +static const VMStateDescription vmstate_rxicu = {
> > +    .name = "rx-icu",
> > +    .version_id = 1,
> > +    .minimum_version_id = 1,
> > +    .fields = (VMStateField[]) {
> > +        VMSTATE_END_OF_LIST()
> > +    }
> > +};
> > +
> > +static Property rxicu_properties[] = {
> > +    DEFINE_PROP_ARRAY("ipr-map", RXICUState, nr_irqs, map,
> > +                      qdev_prop_uint32, uint32_t),
> > +    DEFINE_PROP_ARRAY("trigger-level", RXICUState, nr_sense, init_sense,
> > +                      qdev_prop_uint32, uint32_t),
> > +    DEFINE_PROP_END_OF_LIST(),
> > +};
> > +
> > +static void rxicu_class_init(ObjectClass *klass, void *data)
> > +{
> > +    DeviceClass *dc = DEVICE_CLASS(klass);
> > +
> > +    dc->realize = rxicu_realize;
> > +    dc->props = rxicu_properties;
> > +    dc->vmsd = &vmstate_rxicu;
> > +}
> > +
> > +static const TypeInfo rxicu_info = {
> > +    .name       = TYPE_RXICU,
> > +    .parent     = TYPE_SYS_BUS_DEVICE,
> > +    .instance_size = sizeof(RXICUState),
> > +    .instance_init = rxicu_init,
> > +    .instance_finalize = rxicu_fini,
> > +    .class_init = rxicu_class_init,
> > +};
> > +
> > +static void rxicu_register_types(void)
> > +{
> > +    type_register_static(&rxicu_info);
> > +}
> > +
> > +type_init(rxicu_register_types)
> > diff --git a/hw/intc/Makefile.objs b/hw/intc/Makefile.objs
> > index df712c3e6c..b54b09b12e 100644
> > --- a/hw/intc/Makefile.objs
> > +++ b/hw/intc/Makefile.objs
> > @@ -48,3 +48,4 @@ obj-$(CONFIG_ARM_GIC) += arm_gicv3_cpuif.o
> >  obj-$(CONFIG_MIPS_CPS) += mips_gic.o
> >  obj-$(CONFIG_NIOS2) += nios2_iic.o
> >  obj-$(CONFIG_OMPIC) += ompic.o
> > +obj-$(CONFIG_RX) += rx_icu.o
> 
> Why not declare a RENESAS_ICU in Kconfig and use it?

ICU only using RX.
Timer and SCI using other Renesas MCUs.
So ICU have RX specific name.

> obj-$(CONFIG_RENESAS_ICU) += rx_icu.o
> 
> Good work!
> 
> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> 

-- 
Yosinori Sato