a5fd0d184a
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>
91 lines
1.8 KiB
C
91 lines
1.8 KiB
C
/*
|
|
* Copyright (c) 2020 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#include <zephyr/kernel.h>
|
|
#include <zephyr/device.h>
|
|
#include <zephyr/init.h>
|
|
#include <zephyr/drivers/ipm.h>
|
|
|
|
#include <zephyr/logging/log.h>
|
|
LOG_MODULE_REGISTER(ipm_console, CONFIG_IPM_LOG_LEVEL);
|
|
|
|
const struct device *ipm_dev;
|
|
|
|
static int console_out(int c)
|
|
{
|
|
static char buf[CONFIG_IPM_CONSOLE_LINE_BUF_LEN];
|
|
static size_t len;
|
|
int ret;
|
|
|
|
if (c != '\n' && len < sizeof(buf)) {
|
|
buf[len++] = c;
|
|
return c;
|
|
}
|
|
|
|
ret = ipm_send(ipm_dev, 1, len, buf, len);
|
|
if (ret) {
|
|
LOG_ERR("Error sending character %c over IPM, ret %d", c, ret);
|
|
}
|
|
|
|
memset(buf, 0, sizeof(buf));
|
|
len = 0;
|
|
|
|
/* After buffer is full start a new one */
|
|
if (c != '\n') {
|
|
buf[len++] = c;
|
|
}
|
|
|
|
return c;
|
|
}
|
|
|
|
#if defined(CONFIG_STDOUT_CONSOLE)
|
|
extern void __stdout_hook_install(int (*hook)(int));
|
|
#else
|
|
#define __stdout_hook_install(x) \
|
|
do { /* nothing */ \
|
|
} while ((0))
|
|
#endif
|
|
|
|
#if defined(CONFIG_PRINTK)
|
|
extern void __printk_hook_install(int (*fn)(int));
|
|
#else
|
|
#define __printk_hook_install(x) \
|
|
do { /* nothing */ \
|
|
} while ((0))
|
|
#endif
|
|
|
|
/* Install printk/stdout hooks */
|
|
static void ipm_console_hook_install(void)
|
|
{
|
|
__stdout_hook_install(console_out);
|
|
__printk_hook_install(console_out);
|
|
}
|
|
|
|
static int ipm_console_init(void)
|
|
{
|
|
|
|
LOG_DBG("IPM console initialization");
|
|
|
|
ipm_dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
|
|
if (!device_is_ready(ipm_dev)) {
|
|
LOG_ERR("%s is not ready", ipm_dev->name);
|
|
return -ENODEV;
|
|
}
|
|
|
|
if (ipm_max_id_val_get(ipm_dev) < CONFIG_IPM_CONSOLE_LINE_BUF_LEN) {
|
|
LOG_ERR("IPM driver does not support buffer length %d",
|
|
CONFIG_IPM_CONSOLE_LINE_BUF_LEN);
|
|
return -ENOTSUP;
|
|
}
|
|
|
|
ipm_console_hook_install();
|
|
|
|
return 0;
|
|
}
|
|
|
|
/* Need to be initialized after IPM */
|
|
SYS_INIT(ipm_console_init, POST_KERNEL, CONFIG_CONSOLE_INIT_PRIORITY);
|