zephyr/boards/common/actinius/actinius_board_common.c

98 lines
2.4 KiB
C
Raw Normal View History

/*
* Copyright (c) 2021-2022 Actinius
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <zephyr/init.h>
#include <zephyr/devicetree.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/logging/log.h>
#if DT_HAS_COMPAT_STATUS_OKAY(actinius_sim_select) \
|| DT_HAS_COMPAT_STATUS_OKAY(actinius_charger_enable)
LOG_MODULE_REGISTER(actinius_board_control,
CONFIG_ACTINIUS_BOARD_CONTROL_LOG_LEVEL);
#define SIM_SELECT_NODE DT_NODELABEL(sim_select)
#define CHARGER_ENABLE_NODE DT_NODELABEL(charger_enable)
#if DT_HAS_COMPAT_STATUS_OKAY(actinius_sim_select)
static int actinius_board_set_sim_select(void)
{
const struct gpio_dt_spec sim =
GPIO_DT_SPEC_GET(SIM_SELECT_NODE, sim_gpios);
if (!device_is_ready(sim.port)) {
LOG_ERR("The SIM Select Pin port is not ready");
return -ENODEV;
}
if (DT_ENUM_IDX(SIM_SELECT_NODE, sim) == 0) {
(void)gpio_pin_configure_dt(&sim, GPIO_OUTPUT_HIGH);
LOG_INF("eSIM is selected");
} else {
(void)gpio_pin_configure_dt(&sim, GPIO_OUTPUT_LOW);
LOG_INF("External SIM is selected");
}
return 0;
}
#endif /* SIM_SELECT */
#if DT_HAS_COMPAT_STATUS_OKAY(actinius_charger_enable)
static int actinius_board_set_charger_enable(void)
{
const struct gpio_dt_spec charger_en =
GPIO_DT_SPEC_GET(CHARGER_ENABLE_NODE, gpios);
if (!device_is_ready(charger_en.port)) {
LOG_ERR("The Charger Enable Pin port is not ready");
return -ENODEV;
}
if (DT_ENUM_IDX(CHARGER_ENABLE_NODE, charger) == 0) {
(void)gpio_pin_configure_dt(&charger_en, GPIO_OUTPUT_LOW);
LOG_INF("Charger is set to auto");
} else {
(void)gpio_pin_configure_dt(&charger_en, GPIO_OUTPUT_HIGH);
LOG_INF("Charger is disabled");
}
return 0;
}
#endif /* CHARGER_ENABLE */
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>
2022-10-19 15:33:44 +08:00
static int actinius_board_init(void)
{
int result = 0;
#if DT_HAS_COMPAT_STATUS_OKAY(actinius_sim_select)
result = actinius_board_set_sim_select();
if (result < 0) {
LOG_ERR("Failed to set the SIM Select Pin (error: %d)", result);
/* do not return so that the rest of the init process is attempted */
}
#endif
#if DT_HAS_COMPAT_STATUS_OKAY(actinius_charger_enable)
result = actinius_board_set_charger_enable();
if (result < 0) {
LOG_ERR("Failed to set the Charger Enable Pin (error: %d)", result);
/* do not return so that the rest of the init process is attempted */
}
#endif
return result;
}
/* Needs to happen after GPIO driver init */
SYS_INIT(actinius_board_init,
POST_KERNEL,
CONFIG_ACTINIUS_BOARD_CONTROL_INIT_PRIORITY);
#endif /* SIM_SELECT || CHARGER_ENABLE */