zephyr/drivers/timer/mips_cp0_timer.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

134 lines
3 KiB
C

/*
* Copyright (c) 2020, 2021 Antony Pavlov <antonynpavlov@gmail.com>
* Copyright (c) 2021 Remy Luisant <remy@luisant.ca>
*
* Based on riscv_machine_timer.c and xtensa_sys_timer.c
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <limits.h>
#include <zephyr/device.h>
#include <zephyr/drivers/timer/system_timer.h>
#include <zephyr/irq.h>
#include <zephyr/sys_clock.h>
#include <zephyr/spinlock.h>
#include <soc.h>
#include <mips/mipsregs.h>
#define CYC_PER_TICK ((uint32_t)((uint64_t)sys_clock_hw_cycles_per_sec() \
/ (uint64_t)CONFIG_SYS_CLOCK_TICKS_PER_SEC))
#define MAX_CYC INT_MAX
#define MAX_TICKS ((MAX_CYC - CYC_PER_TICK) / CYC_PER_TICK)
#define MIN_DELAY 1000
#define TICKLESS IS_ENABLED(CONFIG_TICKLESS_KERNEL)
static struct k_spinlock lock;
static uint32_t last_count;
static ALWAYS_INLINE void set_cp0_compare(uint32_t time)
{
_mips_write_32bit_c0_register(CP0_COMPARE, time);
}
static ALWAYS_INLINE uint32_t get_cp0_count(void)
{
return _mips_read_32bit_c0_register(CP0_COUNT);
}
static void timer_isr(const void *arg)
{
ARG_UNUSED(arg);
k_spinlock_key_t key = k_spin_lock(&lock);
uint32_t now = get_cp0_count();
uint32_t dticks = ((now - last_count) / CYC_PER_TICK);
last_count = now;
if (!TICKLESS) {
uint32_t next = last_count + CYC_PER_TICK;
if (next - now < MIN_DELAY) {
next += CYC_PER_TICK;
}
set_cp0_compare(next);
}
k_spin_unlock(&lock, key);
sys_clock_announce(TICKLESS ? dticks : 1);
}
void sys_clock_set_timeout(int32_t ticks, bool idle)
{
ARG_UNUSED(idle);
if (!TICKLESS) {
return;
}
ticks = ticks == K_TICKS_FOREVER ? MAX_TICKS : ticks;
ticks = CLAMP(ticks - 1, 0, (int32_t)MAX_TICKS);
k_spinlock_key_t key = k_spin_lock(&lock);
uint32_t current_count = get_cp0_count();
uint32_t delay_wanted = ticks * CYC_PER_TICK;
/* Round up to next tick boundary. */
uint32_t adj = (current_count - last_count) + (CYC_PER_TICK - 1);
if (delay_wanted <= MAX_CYC - adj) {
delay_wanted += adj;
} else {
delay_wanted = MAX_CYC;
}
delay_wanted = (delay_wanted / CYC_PER_TICK) * CYC_PER_TICK;
if ((int32_t)(delay_wanted + last_count - current_count) < MIN_DELAY) {
delay_wanted += CYC_PER_TICK;
}
set_cp0_compare(delay_wanted + last_count);
k_spin_unlock(&lock, key);
}
uint32_t sys_clock_elapsed(void)
{
if (!TICKLESS) {
return 0;
}
k_spinlock_key_t key = k_spin_lock(&lock);
uint32_t ticks_elapsed = (get_cp0_count() - last_count) / CYC_PER_TICK;
k_spin_unlock(&lock, key);
return ticks_elapsed;
}
uint32_t sys_clock_cycle_get_32(void)
{
return get_cp0_count();
}
static int sys_clock_driver_init(void)
{
IRQ_CONNECT(MIPS_MACHINE_TIMER_IRQ, 0, timer_isr, NULL, 0);
last_count = get_cp0_count();
/*
* In a tickless system the first tick might possibly be pushed
* much further into the future than is being done here.
*/
set_cp0_compare(last_count + CYC_PER_TICK);
irq_enable(MIPS_MACHINE_TIMER_IRQ);
return 0;
}
SYS_INIT(sys_clock_driver_init, PRE_KERNEL_2,
CONFIG_SYSTEM_CLOCK_INIT_PRIORITY);