driver: mucx_lpspi: enable runtime mmio configuration

Enable runtime mmio configuration in mcux_lpspi driver. The fsl_lpspi
driver relies on physical address to determine instance number.
So mmap flag 'K_MEM_DIRECT_MAP' is required.

Signed-off-by: Chekhov Ma <[email protected]>

Author: CkovMk

drivers/spi/spi_mcux_lpspi.c

@@ -28,8 +28,13 @@ LOG_MODULE_REGISTER(spi_mcux_lpspi, CONFIG_SPI_LOG_LEVEL);
 #define CHIP_SELECT_COUNT	4
 #define MAX_DATA_WIDTH		4096
 
+/* Required by DEVICE_MMIO_NAMED_* macros */
+#define DEV_CFG(_dev) \
+	((const struct spi_mcux_config *)(_dev)->config)
+#define DEV_DATA(_dev) ((struct spi_mcux_data *)(_dev)->data)
+
 struct spi_mcux_config {
-	LPSPI_Type *base;
+	DEVICE_MMIO_NAMED_ROM(reg_base);
 	const struct device *clock_dev;
 	clock_control_subsys_t clock_subsys;
 	void (*irq_config_func)(const struct device *dev);
@@ -56,6 +61,7 @@ struct stream {
 #endif
 
 struct spi_mcux_data {
+	DEVICE_MMIO_NAMED_RAM(reg_base);
 	const struct device *dev;
 	lpspi_master_handle_t handle;
 	struct spi_context ctx;
@@ -83,9 +89,9 @@ struct spi_mcux_data {
 
 static int spi_mcux_transfer_next_packet(const struct device *dev)
 {
-	const struct spi_mcux_config *config = dev->config;
+	/* const struct spi_mcux_config *config = dev->config; */
 	struct spi_mcux_data *data = dev->data;
-	LPSPI_Type *base = config->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 	struct spi_context *ctx = &data->ctx;
 	lpspi_transfer_t transfer;
 	status_t status;
@@ -98,7 +104,7 @@ static int spi_mcux_transfer_next_packet(const struct device *dev)
 	}
 
 	transfer.configFlags = kLPSPI_MasterPcsContinuous |
-			       (ctx->config->slave << LPSPI_MASTER_PCS_SHIFT);
+				   (ctx->config->slave << LPSPI_MASTER_PCS_SHIFT);
 
 	if (ctx->tx_len == 0) {
 		/* rx only, nothing to tx */
@@ -153,9 +159,9 @@ static int spi_mcux_transfer_next_packet(const struct device *dev)
 
 static void spi_mcux_isr(const struct device *dev)
 {
-	const struct spi_mcux_config *config = dev->config;
+	/* const struct spi_mcux_config *config = dev->config; */
 	struct spi_mcux_data *data = dev->data;
-	LPSPI_Type *base = config->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 
 	LPSPI_MasterTransferHandleIRQ(base, &data->handle);
 }
@@ -182,11 +188,11 @@ static void spi_mcux_master_transfer_callback(LPSPI_Type *base,
 }
 
 static int spi_mcux_configure(const struct device *dev,
-			      const struct spi_config *spi_cfg)
+				  const struct spi_config *spi_cfg)
 {
 	const struct spi_mcux_config *config = dev->config;
 	struct spi_mcux_data *data = dev->data;
-	LPSPI_Type *base = config->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 	lpspi_master_config_t master_config;
 	uint32_t clock_freq;
 	uint32_t word_size;
@@ -205,15 +211,15 @@ static int spi_mcux_configure(const struct device *dev,
 
 	if (spi_cfg->slave > CHIP_SELECT_COUNT) {
 		LOG_ERR("Slave %d is greater than %d",
-			    spi_cfg->slave,
-			    CHIP_SELECT_COUNT);
+				spi_cfg->slave,
+				CHIP_SELECT_COUNT);
 		return -EINVAL;
 	}
 
 	word_size = SPI_WORD_SIZE_GET(spi_cfg->operation);
 	if (word_size > MAX_DATA_WIDTH) {
 		LOG_ERR("Word size %d is greater than %d",
-			    word_size, MAX_DATA_WIDTH);
+				word_size, MAX_DATA_WIDTH);
 		return -EINVAL;
 	}
 
@@ -335,10 +341,10 @@ static void spi_mcux_dma_callback(const struct device *dev, void *arg,
 
 static int spi_mcux_dma_tx_load(const struct device *dev, const uint8_t *buf, size_t len)
 {
-	const struct spi_mcux_config *cfg = dev->config;
+	/* const struct spi_mcux_config *cfg = dev->config; */
 	struct spi_mcux_data *data = dev->data;
 	struct dma_block_config *blk_cfg;
-	LPSPI_Type *base = cfg->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 
 	/* remember active TX DMA channel (used in callback) */
 	struct stream *stream = &data->dma_tx;
@@ -378,10 +384,10 @@ static int spi_mcux_dma_tx_load(const struct device *dev, const uint8_t *buf, si
 static int spi_mcux_dma_rx_load(const struct device *dev, uint8_t *buf,
 				 size_t len)
 {
-	const struct spi_mcux_config *cfg = dev->config;
+	/*const struct spi_mcux_config *cfg = dev->config; */
 	struct spi_mcux_data *data = dev->data;
 	struct dma_block_config *blk_cfg;
-	LPSPI_Type *base = cfg->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 
 	/* retrieve active RX DMA channel (used in callback) */
 	struct stream *stream = &data->dma_rx;
@@ -480,16 +486,16 @@ static inline int spi_mcux_dma_rxtx_load(const struct device *dev,
 }
 
 static int transceive_dma(const struct device *dev,
-		      const struct spi_config *spi_cfg,
-		      const struct spi_buf_set *tx_bufs,
-		      const struct spi_buf_set *rx_bufs,
-		      bool asynchronous,
-		      spi_callback_t cb,
-		      void *userdata)
+			  const struct spi_config *spi_cfg,
+			  const struct spi_buf_set *tx_bufs,
+			  const struct spi_buf_set *rx_bufs,
+			  bool asynchronous,
+			  spi_callback_t cb,
+			  void *userdata)
 {
-	const struct spi_mcux_config *config = dev->config;
+	/* const struct spi_mcux_config *config = dev->config; */
 	struct spi_mcux_data *data = dev->data;
-	LPSPI_Type *base = config->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 	int ret;
 	size_t dma_size;
 
@@ -564,12 +570,12 @@ static int transceive_dma(const struct device *dev,
 #endif
 
 static int transceive(const struct device *dev,
-		      const struct spi_config *spi_cfg,
-		      const struct spi_buf_set *tx_bufs,
-		      const struct spi_buf_set *rx_bufs,
-		      bool asynchronous,
-		      spi_callback_t cb,
-		      void *userdata)
+			  const struct spi_config *spi_cfg,
+			  const struct spi_buf_set *tx_bufs,
+			  const struct spi_buf_set *rx_bufs,
+			  bool asynchronous,
+			  spi_callback_t cb,
+			  void *userdata)
 {
 	struct spi_mcux_data *data = dev->data;
 	int ret;
@@ -599,9 +605,9 @@ static int transceive(const struct device *dev,
 
 
 static int spi_mcux_transceive(const struct device *dev,
-			       const struct spi_config *spi_cfg,
-			       const struct spi_buf_set *tx_bufs,
-			       const struct spi_buf_set *rx_bufs)
+				   const struct spi_config *spi_cfg,
+				   const struct spi_buf_set *tx_bufs,
+				   const struct spi_buf_set *rx_bufs)
 {
 #ifdef CONFIG_SPI_MCUX_LPSPI_DMA
 	const struct spi_mcux_data *data = dev->data;
@@ -616,11 +622,11 @@ static int spi_mcux_transceive(const struct device *dev,
 
 #ifdef CONFIG_SPI_ASYNC
 static int spi_mcux_transceive_async(const struct device *dev,
-				     const struct spi_config *spi_cfg,
-				     const struct spi_buf_set *tx_bufs,
-				     const struct spi_buf_set *rx_bufs,
-				     spi_callback_t cb,
-				     void *userdata)
+					 const struct spi_config *spi_cfg,
+					 const struct spi_buf_set *tx_bufs,
+					 const struct spi_buf_set *rx_bufs,
+					 spi_callback_t cb,
+					 void *userdata)
 {
 #ifdef CONFIG_SPI_MCUX_LPSPI_DMA
 	struct spi_mcux_data *data = dev->data;
@@ -637,7 +643,7 @@ static int spi_mcux_transceive_async(const struct device *dev,
 #endif /* CONFIG_SPI_ASYNC */
 
 static int spi_mcux_release(const struct device *dev,
-			    const struct spi_config *spi_cfg)
+				const struct spi_config *spi_cfg)
 {
 	struct spi_mcux_data *data = dev->data;
 
@@ -652,6 +658,8 @@ static int spi_mcux_init(const struct device *dev)
 	const struct spi_mcux_config *config = dev->config;
 	struct spi_mcux_data *data = dev->data;
 
+	DEVICE_MMIO_NAMED_MAP(dev, reg_base, K_MEM_CACHE_NONE | K_MEM_DIRECT_MAP);
+
 	config->irq_config_func(dev);
 
 	err = spi_context_cs_configure_all(&data->ctx);
@@ -714,19 +722,19 @@ static void spi_mcux_iodev_next(const struct device *dev, bool completion);
 
 static void spi_mcux_iodev_start(const struct device *dev)
 {
-	const struct spi_mcux_config *config = dev->config;
+	/* const struct spi_mcux_config *config = dev->config; */
 	struct spi_mcux_data *data = dev->data;
 	struct rtio_sqe *sqe = &data->txn_curr->sqe;
 	struct spi_dt_spec *spi_dt_spec = sqe->iodev->data;
 	struct spi_config *spi_cfg = &spi_dt_spec->config;
 	struct rtio_iodev_sqe *txn_head = data->txn_head;
 
-	LPSPI_Type *base = config->base;
+	LPSPI_Type *base = (LPSPI_Type *)DEVICE_MMIO_NAMED_GET(dev, reg_base);
 	lpspi_transfer_t transfer;
 	status_t status;
 
 	transfer.configFlags = kLPSPI_MasterPcsContinuous |
-			       (spi_cfg->slave << LPSPI_MASTER_PCS_SHIFT);
+				   (spi_cfg->slave << LPSPI_MASTER_PCS_SHIFT);
 
 	switch (sqe->op) {
 	case RTIO_OP_RX:
@@ -895,7 +903,7 @@ static const struct spi_driver_api spi_mcux_driver_api = {
 	static void spi_mcux_config_func_##n(const struct device *dev);	\
 									\
 	static const struct spi_mcux_config spi_mcux_config_##n = {	\
-		.base = (LPSPI_Type *) DT_INST_REG_ADDR(n),		\
+		DEVICE_MMIO_NAMED_ROM_INIT(reg_base, DT_DRV_INST(n)), \
 		.clock_dev = DEVICE_DT_GET(DT_INST_CLOCKS_CTLR(n)),	\
 		.clock_subsys =						\
 		(clock_control_subsys_t)DT_INST_CLOCKS_CELL(n, name),	\
@@ -924,15 +932,15 @@ static const struct spi_driver_api spi_mcux_driver_api = {
 	};								\
 									\
 	DEVICE_DT_INST_DEFINE(n, &spi_mcux_init, NULL,			\
-			    &spi_mcux_data_##n,				\
-			    &spi_mcux_config_##n, POST_KERNEL,		\
-			    CONFIG_SPI_INIT_PRIORITY,			\
-			    &spi_mcux_driver_api);			\
+				&spi_mcux_data_##n,				\
+				&spi_mcux_config_##n, POST_KERNEL,		\
+				CONFIG_SPI_INIT_PRIORITY,			\
+				&spi_mcux_driver_api);			\
 									\
 	static void spi_mcux_config_func_##n(const struct device *dev)	\
 	{								\
 		IRQ_CONNECT(DT_INST_IRQN(n), DT_INST_IRQ(n, priority),	\
-			    spi_mcux_isr, DEVICE_DT_INST_GET(n), 0);	\
+				spi_mcux_isr, DEVICE_DT_INST_GET(n), 0);	\
 									\
 		irq_enable(DT_INST_IRQN(n));				\
 	}