drivers: mcux: flexio: Added generic MCUX FlexIO driver

Added FlexIO driver with SPI support only. Other interfaces may be added later. Signed-off-by: Mikhail Siomin <victorovich.01@mail.ru>
zephyrproject-rtos · Jan 12, 2023 · 202572f · 202572f
1 parent 6cbb3f5
commit 202572f
Show file tree

Hide file tree

Showing 28 changed files with 1,258 additions and 2 deletions.
diff --git a/drivers/clock_control/clock_control_mcux_ccm.c b/drivers/clock_control/clock_control_mcux_ccm.c
@@ -226,6 +226,53 @@ static int mcux_ccm_get_subsys_rate(const struct device *dev,
 				/ (CLOCK_GetDiv(kCLOCK_Sai3Div) + 1);
 		break;
 #endif
+
+#if CONFIG_MCUX_FLEXIO
+	case IMX_CCM_FLEXIO1_CLK:
+	{
+		uint32_t flexio_mux = CLOCK_GetMux(kCLOCK_Flexio1Mux);
+		uint32_t source_clk_freq = 0;
+
+		if (flexio_mux == 0) {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllAudio);
+		} else if (flexio_mux == 1) {
+			source_clk_freq = CLOCK_GetUsb1PfdFreq(kCLOCK_Pfd2);
+	#ifdef PLL_VIDEO_OFFSET /* fsl_clock.h */
+		} else if (flexio_mux == 2) {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllVideo);
+	#endif
+		} else {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllUsb1);
+		}
+
+		*rate = source_clk_freq / (CLOCK_GetDiv(kCLOCK_Flexio1PreDiv) + 1)
+					/ (CLOCK_GetDiv(kCLOCK_Flexio1Div) + 1);
+	} break;
+#endif
+
+#if (DT_NODE_HAS_STATUS(DT_NODELABEL(flexio2), okay) \
+		 || DT_NODE_HAS_STATUS(DT_NODELABEL(flexio3), okay)) && CONFIG_MCUX_FLEXIO
+	case IMX_CCM_FLEXIO2_3_CLK:
+	{
+		uint32_t flexio_mux = CLOCK_GetMux(kCLOCK_Flexio2Mux);
+		uint32_t source_clk_freq = 0;
+
+		if (flexio_mux == 0) {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllAudio);
+		} else if (flexio_mux == 1) {
+			source_clk_freq = CLOCK_GetUsb1PfdFreq(kCLOCK_Pfd2);
+	#ifdef PLL_VIDEO_OFFSET /* fsl_clock.h */
+		} else if (flexio_mux == 2) {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllVideo);
+	#endif
+		} else {
+			source_clk_freq = CLOCK_GetPllFreq(kCLOCK_PllUsb1);
+		}
+
+		*rate = source_clk_freq / (CLOCK_GetDiv(kCLOCK_Flexio2PreDiv) + 1)
+					/ (CLOCK_GetDiv(kCLOCK_Flexio2Div) + 1);
+	} break;
+#endif
 	}
 
 	return 0;

diff --git a/drivers/misc/CMakeLists.txt b/drivers/misc/CMakeLists.txt
@@ -3,3 +3,4 @@
 add_subdirectory_ifdef(CONFIG_ARM_ETHOS_U ethos_u)
 add_subdirectory_ifdef(CONFIG_FT800 ft8xx)
 add_subdirectory_ifdef(CONFIG_GROVE_LCD_RGB grove_lcd_rgb)
+add_subdirectory_ifdef(CONFIG_MCUX_FLEXIO mcux_flexio)
diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig
@@ -7,5 +7,6 @@ menu "Miscellaneous Drivers"
 
 source "drivers/misc/ft8xx/Kconfig"
 source "drivers/misc/grove_lcd_rgb/Kconfig"
+source "drivers/misc/mcux_flexio/Kconfig"
 
 endmenu
diff --git a/drivers/misc/mcux_flexio/CMakeLists.txt b/drivers/misc/mcux_flexio/CMakeLists.txt
@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+
+zephyr_library()
+
+zephyr_include_directories(${ZEPHYR_BASE}/drivers)
+
+zephyr_library_sources(mcux_flexio.c)
diff --git a/drivers/misc/mcux_flexio/Kconfig b/drivers/misc/mcux_flexio/Kconfig
@@ -0,0 +1,25 @@
+# Copyright (c) 2023, STRIM, ALC
+# SPDX-License-Identifier: Apache-2.0
+
+config MCUX_FLEXIO
+	bool
+	depends on HAS_MCUX_FLEXIO
+	depends on CLOCK_CONTROL
+	help
+	  Enable the FlexIO.
+	  FlexIO is not used separately.
+
+config MCUX_FLEXIO_INIT_PRIORITY
+	int "Init priority"
+	depends on MCUX_FLEXIO
+	default 50
+	help
+	  MCUX FlexIO device driver initialization priority.
+
+config MCUX_FLEXIO_CHILD_INIT_PRIORITY
+	int "Init priority"
+	depends on MCUX_FLEXIO
+	default 51
+	help
+	  MCUX FlexIO Child device driver initialization priority.
+	  Must be greater than MCUX_FLEXIO_INIT_PRIORITY.
diff --git a/drivers/misc/mcux_flexio/mcux_flexio.c b/drivers/misc/mcux_flexio/mcux_flexio.c
@@ -0,0 +1,264 @@
+/*
+ * Copyright (c) 2023, STRIM, ALC
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#define DT_DRV_COMPAT nxp_imx_flexio
+
+#include <zephyr/kernel.h>
+#include <zephyr/device.h>
+#include <zephyr/logging/log.h>
+
+#include <fsl_flexio.h>
+
+#include "mcux_flexio.h"
+#include <spi/spi_mcux_flexio.h>
+/* add new interface */
+
+LOG_MODULE_REGISTER(mcux_flexio, CONFIG_LOG_DEFAULT_LEVEL);
+
+struct mcux_flexio_config {
+	FLEXIO_Type *base;
+	const struct device *clock_dev;
+	clock_control_subsys_t clock_subsys;
+	struct mcux_flexio_child *children;
+	size_t num_children;
+	void (*irq_config_func)(const struct device *dev);
+	void (*irq_enable_func)(void);
+	void (*irq_disable_func)(void);
+};
+
+struct mcux_flexio_data {
+	struct k_mutex lock;
+};
+
+typedef int (*child_isr_t)(const struct device *dev);
+typedef void (*child_res_t)(const struct device *dev, struct mcux_flexio_child_res *child_res);
+
+struct mcux_flexio_child_config {
+	child_isr_t isr;
+	child_res_t res;
+};
+
+enum mcux_flexio_type {
+	NXP_IMX_FLEXIO_SPI = 0,
+	/* add new interface */
+	NXP_IMX_FLEXIO_LAST_INDEX,
+};
+
+static const struct mcux_flexio_child_config children_config[NXP_IMX_FLEXIO_LAST_INDEX] = {
+	[NXP_IMX_FLEXIO_SPI] = { spi_mcux_isr, spi_mcux_res },
+	/* add new interface */
+};
+
+struct mcux_flexio_child {
+	const struct device *dev;
+	const enum mcux_flexio_type compatible;
+};
+
+static void mcux_flexio_isr(const struct device *dev)
+{
+	const struct mcux_flexio_config *config = dev->config;
+	struct mcux_flexio_child *child;
+	const struct device *isr_dev;
+	child_isr_t isr_func;
+
+	for (size_t i = 0; i < config->num_children; i++) {
+		child = &config->children[i];
+		isr_func = children_config[child->compatible].isr;
+		isr_dev = child->dev;
+
+		if (isr_func != NULL && isr_dev != NULL) {
+			int ret = isr_func(isr_dev);
+
+			if (ret != 0) {
+				LOG_ERR("isr return: %d", ret);
+			}
+		} else {
+			LOG_ERR("isr_func() or isr_dev() equal NULL");
+		}
+	}
+	SDK_ISR_EXIT_BARRIER;
+}
+
+static uint32_t count_ones(uint32_t number)
+{
+	uint32_t res = 0;
+
+	while (number) {
+		res++;
+		number &= number - 1;
+	}
+	return res;
+}
+
+static int mcux_flexio_check_res_overlap(const struct device *dev)
+{
+	const struct mcux_flexio_config *config = dev->config;
+	struct mcux_flexio_child *child;
+	child_res_t res_func;
+
+	struct mcux_flexio_child_res res = {0};
+
+	for (size_t i = 0; i < config->num_children; i++) {
+		child = &config->children[i];
+		res_func = children_config[child->compatible].res;
+
+		if (res_func != NULL) {
+			struct mcux_flexio_child_res child_res;
+
+			res_func(child->dev, &child_res);
+
+			res.pin ^= child_res.pin;
+			res.num_pin += child_res.num_pin;
+			res.shifter ^= child_res.shifter;
+			res.num_shifter += child_res.num_shifter;
+			res.timer ^= child_res.timer;
+			res.num_timer += child_res.num_timer;
+		} else {
+			LOG_ERR("%s: res_func not found", __func__);
+			return -1;
+		}
+	}
+
+	if (count_ones(res.pin) != res.num_pin) {
+		LOG_ERR("Pins overlapping in %s", dev->name);
+		return -2;
+	}
+
+	if (count_ones(res.shifter) != res.num_shifter) {
+		LOG_ERR("Shifters overlapping in %s", dev->name);
+		return -3;
+	}
+
+	if (count_ones(res.timer) != res.num_timer) {
+		LOG_ERR("Timers overlapping in %s", dev->name);
+		return -4;
+	}
+
+	return 0;
+}
+
+static int mcux_flexio_init(const struct device *dev)
+{
+	const struct mcux_flexio_config *config = dev->config;
+	struct mcux_flexio_data *data = dev->data;
+	flexio_config_t flexio_config;
+
+	int err = mcux_flexio_check_res_overlap(dev);
+
+	if (err < 0) {
+		return err;
+	}
+
+	k_mutex_init(&data->lock);
+
+	FLEXIO_GetDefaultConfig(&flexio_config);
+	FLEXIO_Init(config->base, &flexio_config);
+	config->irq_config_func(dev);
+
+	return 0;
+}
+
+static void mcux_flexio_irq_enable(const struct device *flexio_dev)
+{
+	const struct mcux_flexio_config *config = flexio_dev->config;
+
+	config->irq_enable_func();
+}
+
+static void mcux_flexio_irq_disable(const struct device *flexio_dev)
+{
+	const struct mcux_flexio_config *config = flexio_dev->config;
+
+	config->irq_disable_func();
+}
+
+static void mcux_flexio_lock(const struct device *flexio_dev)
+{
+	struct mcux_flexio_data *data = flexio_dev->data;
+
+	k_mutex_lock(&data->lock, K_FOREVER);
+}
+
+static void mcux_flexio_unlock(const struct device *flexio_dev)
+{
+	struct mcux_flexio_data *data = flexio_dev->data;
+
+	k_mutex_unlock(&data->lock);
+}
+
+static int mcux_flexio_get_rate(const struct device *flexio_dev, uint32_t *rate)
+{
+	const struct mcux_flexio_config *config = flexio_dev->config;
+
+	return clock_control_get_rate(config->clock_dev, config->clock_subsys, rate);
+}
+
+static const struct mcux_flexio_api mcux_flexio_driver_api = {
+	.interrupt_enable = mcux_flexio_irq_enable,
+	.interrupt_disable = mcux_flexio_irq_disable,
+	.lock = mcux_flexio_lock,
+	.unlock = mcux_flexio_unlock,
+	.get_rate = mcux_flexio_get_rate,
+};
+
+BUILD_ASSERT(CONFIG_MCUX_FLEXIO_CHILD_INIT_PRIORITY > CONFIG_MCUX_FLEXIO_INIT_PRIORITY,
+		"MCUX_FLEXIO_CHILD_INIT_PRIORITY must be greater than MCUX_FLEXIO_INIT_PRIORITY");
+
+#define MCUX_FLEXIO_CHILD_INIT(child_node_id)				\
+	{								\
+		.dev = DEVICE_DT_GET(child_node_id),			\
+		.compatible = DT_STRING_UPPER_TOKEN_BY_IDX(child_node_id, compatible, 0), \
+	},
+
+#define MCUX_FLEXIO_INIT(n)						\
+	static void mcux_flexio_irq_config_func_##n(const struct device *dev); \
+	static void mcux_flexio_irq_enable_func_##n(void);		\
+	static void mcux_flexio_irq_disable_func_##n(void);		\
+									\
+	static struct mcux_flexio_child mcux_flexio_children_##n[] = {	\
+		DT_INST_FOREACH_CHILD_STATUS_OKAY(n, MCUX_FLEXIO_CHILD_INIT) \
+	};								\
+									\
+	static struct mcux_flexio_data mcux_flexio_data_##n;		\
+									\
+	static const struct mcux_flexio_config mcux_flexio_config_##n = { \
+		.base = (FLEXIO_Type *)DT_INST_REG_ADDR(n),		\
+		.clock_dev = DEVICE_DT_GET(DT_INST_CLOCKS_CTLR(n)),	\
+		.clock_subsys =						\
+		(clock_control_subsys_t)DT_INST_CLOCKS_CELL(n, name),	\
+		.children = mcux_flexio_children_##n,			\
+		.num_children = ARRAY_SIZE(mcux_flexio_children_##n),	\
+		.irq_config_func = mcux_flexio_irq_config_func_##n,	\
+		.irq_enable_func = mcux_flexio_irq_enable_func_##n,	\
+		.irq_disable_func = mcux_flexio_irq_disable_func_##n,	\
+	};								\
+									\
+	DEVICE_DT_INST_DEFINE(n, &mcux_flexio_init,			\
+			      NULL,					\
+				  &mcux_flexio_data_##n,		\
+			      &mcux_flexio_config_##n,			\
+			      POST_KERNEL,				\
+			      CONFIG_MCUX_FLEXIO_INIT_PRIORITY,		\
+			      &mcux_flexio_driver_api);			\
+									\
+	static void mcux_flexio_irq_config_func_##n(const struct device *dev) \
+	{								\
+		IRQ_CONNECT(DT_INST_IRQN(n), DT_INST_IRQ(n, priority),	\
+			    mcux_flexio_isr, DEVICE_DT_INST_GET(n), 0);	\
+		irq_enable(DT_INST_IRQN(n));				\
+	}								\
+									\
+	static void mcux_flexio_irq_enable_func_##n(void)		\
+	{								\
+		irq_enable(DT_INST_IRQN(n));				\
+	}								\
+									\
+	static void mcux_flexio_irq_disable_func_##n(void)		\
+	{								\
+		irq_disable(DT_INST_IRQN(n));				\
+	}
+
+DT_INST_FOREACH_STATUS_OKAY(MCUX_FLEXIO_INIT)
diff --git a/drivers/misc/mcux_flexio/mcux_flexio.h b/drivers/misc/mcux_flexio/mcux_flexio.h
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023, STRIM, ALC
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#ifndef ZEPHYR_DRIVERS_SPI_MCUX_FLEXIO_H_
+#define ZEPHYR_DRIVERS_SPI_MCUX_FLEXIO_H_
+
+#include <zephyr/drivers/spi.h>
+
+
+struct mcux_flexio_api {
+	void (*interrupt_enable)(const struct device *flexio_dev);
+	void (*interrupt_disable)(const struct device *flexio_dev);
+	void (*lock)(const struct device *flexio_dev);
+	void (*unlock)(const struct device *flexio_dev);
+	int (*get_rate)(const struct device *flexio_dev, uint32_t *rate);
+};
+
+struct mcux_flexio_child_res {
+	uint8_t shifter;
+	uint8_t num_shifter;
+	uint8_t timer;
+	uint8_t num_timer;
+	uint32_t pin;
+	uint32_t num_pin;
+};
+
+
+#endif /* ZEPHYR_DRIVERS_SPI_MCUX_FLEXIO_H_ */