zephyr/drivers/interrupt_controller/intc_irqmp.c
Gerard Marull-Paretas a5fd0d184a init: remove the need for a dummy device pointer in SYS_INIT functions
The init infrastructure, found in `init.h`, is currently used by:

- `SYS_INIT`: to call functions before `main`
- `DEVICE_*`: to initialize devices

They are all sorted according to an initialization level + a priority.
`SYS_INIT` calls are really orthogonal to devices, however, the required
function signature requires a `const struct device *dev` as a first
argument. The only reason for that is because the same init machinery is
used by devices, so we have something like:

```c
struct init_entry {
	int (*init)(const struct device *dev);
	/* only set by DEVICE_*, otherwise NULL */
	const struct device *dev;
}
```

As a result, we end up with such weird/ugly pattern:

```c
static int my_init(const struct device *dev)
{
	/* always NULL! add ARG_UNUSED to avoid compiler warning */
	ARG_UNUSED(dev);
	...
}
```

This is really a result of poor internals isolation. This patch proposes
a to make init entries more flexible so that they can accept sytem
initialization calls like this:

```c
static int my_init(void)
{
	...
}
```

This is achieved using a union:

```c
union init_function {
	/* for SYS_INIT, used when init_entry.dev == NULL */
	int (*sys)(void);
	/* for DEVICE*, used when init_entry.dev != NULL */
	int (*dev)(const struct device *dev);
};

struct init_entry {
	/* stores init function (either for SYS_INIT or DEVICE*)
	union init_function init_fn;
	/* stores device pointer for DEVICE*, NULL for SYS_INIT. Allows
	 * to know which union entry to call.
	 */
	const struct device *dev;
}
```

This solution **does not increase ROM usage**, and allows to offer clean
public APIs for both SYS_INIT and DEVICE*. Note that however, init
machinery keeps a coupling with devices.

**NOTE**: This is a breaking change! All `SYS_INIT` functions will need
to be converted to the new signature. See the script offered in the
following commit.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>

init: convert SYS_INIT functions to the new signature

Conversion scripted using scripts/utils/migrate_sys_init.py.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>

manifest: update projects for SYS_INIT changes

Update modules with updated SYS_INIT calls:

- hal_ti
- lvgl
- sof
- TraceRecorderSource

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>

tests: devicetree: devices: adjust test

Adjust test according to the recently introduced SYS_INIT
infrastructure.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>

tests: kernel: threads: adjust SYS_INIT call

Adjust to the new signature: int (*init_fn)(void);

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-04-12 14:28:07 +00:00

125 lines
3.3 KiB
C

/*
* Copyright (c) 2019-2020 Cobham Gaisler AB
*
* SPDX-License-Identifier: Apache-2.0
*/
/*
* This is a driver for the GRLIB IRQMP interrupt controller common in LEON
* systems.
*
* Interrupt level 1..15 are SPARC interrupts. Interrupt level 16..31, if
* implemented in the interrupt controller, are IRQMP "extended interrupts".
*
* For more information about IRQMP, see the GRLIB IP Core User's Manual.
*/
#define DT_DRV_COMPAT gaisler_irqmp
#include <zephyr/kernel.h>
#include <zephyr/init.h>
/*
* Register description for IRQMP and IRQAMP interrupt controllers
* IRQMP - Multiprocessor Interrupt Controller
* IRQ(A)MP - Multiprocessor Interrupt Controller with extended ASMP support
*/
#define IRQMP_NCPU_MAX 16
struct irqmp_regs {
uint32_t ilevel; /* 0x00 */
uint32_t ipend; /* 0x04 */
uint32_t iforce0; /* 0x08 */
uint32_t iclear; /* 0x0c */
uint32_t mpstat; /* 0x10 */
uint32_t brdlst; /* 0x14 */
uint32_t errstat; /* 0x18 */
uint32_t wdogctrl; /* 0x1c */
uint32_t asmpctrl; /* 0x20 */
uint32_t icselr[2]; /* 0x24 */
uint32_t reserved2c; /* 0x2c */
uint32_t reserved30; /* 0x30 */
uint32_t reserved34; /* 0x34 */
uint32_t reserved38; /* 0x38 */
uint32_t reserved3c; /* 0x3c */
uint32_t pimask[IRQMP_NCPU_MAX]; /* 0x40 */
uint32_t piforce[IRQMP_NCPU_MAX]; /* 0x80 */
uint32_t pextack[IRQMP_NCPU_MAX]; /* 0xc0 */
};
#define IRQMP_PEXTACK_EID (0x1f << 0)
static volatile struct irqmp_regs *get_irqmp_regs(void)
{
return (struct irqmp_regs *) DT_INST_REG_ADDR(0);
}
static int get_irqmp_eirq(void)
{
return DT_INST_PROP(0, eirq);
}
void arch_irq_enable(unsigned int source)
{
volatile struct irqmp_regs *regs = get_irqmp_regs();
volatile uint32_t *pimask = &regs->pimask[0];
const uint32_t setbit = (1U << source);
unsigned int key;
key = arch_irq_lock();
*pimask |= setbit;
arch_irq_unlock(key);
}
void arch_irq_disable(unsigned int source)
{
volatile struct irqmp_regs *regs = get_irqmp_regs();
volatile uint32_t *pimask = &regs->pimask[0];
const uint32_t keepbits = ~(1U << source);
unsigned int key;
key = arch_irq_lock();
*pimask &= keepbits;
arch_irq_unlock(key);
}
int arch_irq_is_enabled(unsigned int source)
{
volatile struct irqmp_regs *regs = get_irqmp_regs();
volatile uint32_t *pimask = &regs->pimask[0];
return !!(*pimask & (1U << source));
}
int z_sparc_int_get_source(int irl)
{
volatile struct irqmp_regs *regs = get_irqmp_regs();
const int eirq = get_irqmp_eirq();
int source;
if ((eirq != 0) && (irl == eirq)) {
source = regs->pextack[0] & IRQMP_PEXTACK_EID;
if (source == 0) {
source = irl;
}
} else {
source = irl;
}
return source;
}
static int irqmp_init(void)
{
volatile struct irqmp_regs *regs = get_irqmp_regs();
regs->ilevel = 0;
regs->ipend = 0;
regs->iforce0 = 0;
regs->pimask[0] = 0;
regs->piforce[0] = 0xfffe0000;
return 0;
}
SYS_INIT(irqmp_init, PRE_KERNEL_1, CONFIG_INTC_INIT_PRIORITY);