drivers: dma: rpi_pico: Refactor DMA files for Raspberry Pi SoCs

Avoid referring to Pico 2 (the name of a board). In this context,
RPI_PICO is used to refer to the (Zephyr) `SOC_FAMILY` rather than the
Pico 1 board. This clarifies common numerical values between the RP2040
and RP2350 SoC series, and enables existing DTS files to be used with
RP2350-based boards with fewer changes.

Remove the use of Zehpyr's `CONFIG_` macros from the device tree files,
and replace them with `SOC_SERIES`-specific files. Update the driver
implementation to conditionally include the correct file. Update
documentation and samples to match.

Signed-off-by: Andrew Featherstone <[email protected]>

Author: ajf58

drivers/dma/dma_rpi_pico.c

@@ -10,7 +10,11 @@
 #include <zephyr/drivers/reset.h>
 #include <zephyr/logging/log.h>
 #include <zephyr/irq.h>
-#include <zephyr/dt-bindings/dma/rpi_pico_dma.h>
+#if defined(CONFIG_SOC_SERIES_RP2040)
+#include <zephyr/dt-bindings/dma/rpi-pico-dma-rp2040.h>
+#elif defined(CONFIG_SOC_SERIES_RP2350)
+#include <zephyr/dt-bindings/dma/rpi-pico-dma-rp2350.h>
+#endif
 
 #include <hardware/dma.h>
 

dts/bindings/dma/raspberrypi,pico-dma.yaml

@@ -7,7 +7,8 @@ description: |
   channel: Select channel for data transmitting
 
   slot: Select peripheral data request
-    Use the definitions defined in `zephyr/dt-bindings/dma/rpi_pico_dma.h`.
+    Use the definitions defined in `zephyr/dt-bindings/dma/rpi-pico-dma-rp2040.h`,
+    or `zephyr/dt-bindings/dma/rpi-pico-dma-rp2350.h`
 
   channel-config: A 32bit mask specifying the DMA channel configuration
     - bit 3: Enable Quiet IRQ

include/zephyr/dt-bindings/dma/rpi-pico-dma-common.h

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023 TOKITA Hiroshi <[email protected]>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_COMMON_H_
+#define ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_COMMON_H_
+
+/*
+ * Use lower 6-bit of inverted DREQ value for `slot` cell.
+ * Need to be able to work for memory-to-memory transfer
+ * with zero, which is the default value.
+ */
+#define RPI_PICO_DMA_SLOT_TO_DREQ(s) (~(s)&0x3F)
+#define RPI_PICO_DMA_DREQ_TO_SLOT    RPI_PICO_DMA_SLOT_TO_DREQ
+
+#define RPI_PICO_DMA_SLOT_PIO0_TX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x00)
+#define RPI_PICO_DMA_SLOT_PIO0_TX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x01)
+#define RPI_PICO_DMA_SLOT_PIO0_TX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x02)
+#define RPI_PICO_DMA_SLOT_PIO0_TX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x03)
+#define RPI_PICO_DMA_SLOT_PIO0_RX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x04)
+#define RPI_PICO_DMA_SLOT_PIO0_RX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x05)
+#define RPI_PICO_DMA_SLOT_PIO0_RX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x06)
+#define RPI_PICO_DMA_SLOT_PIO0_RX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x07)
+#define RPI_PICO_DMA_SLOT_PIO1_TX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x08)
+#define RPI_PICO_DMA_SLOT_PIO1_TX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x09)
+#define RPI_PICO_DMA_SLOT_PIO1_TX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x0A)
+#define RPI_PICO_DMA_SLOT_PIO1_TX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x0B)
+#define RPI_PICO_DMA_SLOT_PIO1_RX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x0C)
+#define RPI_PICO_DMA_SLOT_PIO1_RX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x0D)
+#define RPI_PICO_DMA_SLOT_PIO1_RX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x0E)
+#define RPI_PICO_DMA_SLOT_PIO1_RX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x0F)
+
+#define RPI_PICO_DMA_SLOT_DMA_TIMER0 RPI_PICO_DMA_DREQ_TO_SLOT(0x3B)
+#define RPI_PICO_DMA_SLOT_DMA_TIMER1 RPI_PICO_DMA_DREQ_TO_SLOT(0x3C)
+#define RPI_PICO_DMA_SLOT_DMA_TIMER2 RPI_PICO_DMA_DREQ_TO_SLOT(0x3D)
+#define RPI_PICO_DMA_SLOT_DMA_TIMER3 RPI_PICO_DMA_DREQ_TO_SLOT(0x3E)
+#define RPI_PICO_DMA_SLOT_FORCE      RPI_PICO_DMA_DREQ_TO_SLOT(0x3F)
+
+#endif /* ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_COMMON_H_ */

include/zephyr/dt-bindings/dma/rpi-pico-dma-rp2040.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2023 TOKITA Hiroshi <[email protected]>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2040_H_
+#define ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2040_H_
+
+#include "rpi-pico-dma-common.h"
+
+#define RPI_PICO_DMA_SLOT_SPI0_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x10)
+#define RPI_PICO_DMA_SLOT_SPI0_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x11)
+#define RPI_PICO_DMA_SLOT_SPI1_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x12)
+#define RPI_PICO_DMA_SLOT_SPI1_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x13)
+#define RPI_PICO_DMA_SLOT_UART0_TX   RPI_PICO_DMA_DREQ_TO_SLOT(0x14)
+#define RPI_PICO_DMA_SLOT_UART0_RX   RPI_PICO_DMA_DREQ_TO_SLOT(0x15)
+#define RPI_PICO_DMA_SLOT_UART1_TX   RPI_PICO_DMA_DREQ_TO_SLOT(0x16)
+#define RPI_PICO_DMA_SLOT_UART1_RX   RPI_PICO_DMA_DREQ_TO_SLOT(0x17)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP0  RPI_PICO_DMA_DREQ_TO_SLOT(0x18)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP1  RPI_PICO_DMA_DREQ_TO_SLOT(0x19)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP2  RPI_PICO_DMA_DREQ_TO_SLOT(0x1A)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP3  RPI_PICO_DMA_DREQ_TO_SLOT(0x1B)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP4  RPI_PICO_DMA_DREQ_TO_SLOT(0x1C)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP5  RPI_PICO_DMA_DREQ_TO_SLOT(0x1D)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP6  RPI_PICO_DMA_DREQ_TO_SLOT(0x1E)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP7  RPI_PICO_DMA_DREQ_TO_SLOT(0x1F)
+#define RPI_PICO_DMA_SLOT_I2C0_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x30)
+#define RPI_PICO_DMA_SLOT_I2C0_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x31)
+#define RPI_PICO_DMA_SLOT_I2C1_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x32)
+#define RPI_PICO_DMA_SLOT_I2C1_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x33)
+#define RPI_PICO_DMA_SLOT_ADC        RPI_PICO_DMA_DREQ_TO_SLOT(0x34)
+#define RPI_PICO_DMA_SLOT_XIP_STREAM RPI_PICO_DMA_DREQ_TO_SLOT(0x35)
+#define RPI_PICO_DMA_SLOT_XIP_SSITX  RPI_PICO_DMA_DREQ_TO_SLOT(0x36)
+#define RPI_PICO_DMA_SLOT_XIP_SSIRX  RPI_PICO_DMA_DREQ_TO_SLOT(0x37)
+
+#endif /* ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2040_H_ */

include/zephyr/dt-bindings/dma/rpi-pico-dma-rp2350.h

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2024 Manuel Aebischer <[email protected]>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2350_H_
+#define ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2350_H_
+
+#include "rpi-pico-dma-common.h"
+
+#define RPI_PICO_DMA_SLOT_PIO2_TX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x10)
+#define RPI_PICO_DMA_SLOT_PIO2_TX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x11)
+#define RPI_PICO_DMA_SLOT_PIO2_TX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x12)
+#define RPI_PICO_DMA_SLOT_PIO2_TX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x13)
+#define RPI_PICO_DMA_SLOT_PIO2_RX0   RPI_PICO_DMA_DREQ_TO_SLOT(0x14)
+#define RPI_PICO_DMA_SLOT_PIO2_RX1   RPI_PICO_DMA_DREQ_TO_SLOT(0x15)
+#define RPI_PICO_DMA_SLOT_PIO2_RX2   RPI_PICO_DMA_DREQ_TO_SLOT(0x16)
+#define RPI_PICO_DMA_SLOT_PIO2_RX3   RPI_PICO_DMA_DREQ_TO_SLOT(0x17)
+#define RPI_PICO_DMA_SLOT_SPI0_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x18)
+#define RPI_PICO_DMA_SLOT_SPI0_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x19)
+#define RPI_PICO_DMA_SLOT_SPI1_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x1A)
+#define RPI_PICO_DMA_SLOT_SPI1_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x1B)
+#define RPI_PICO_DMA_SLOT_UART0_TX   RPI_PICO_DMA_DREQ_TO_SLOT(0x1C)
+#define RPI_PICO_DMA_SLOT_UART0_RX   RPI_PICO_DMA_DREQ_TO_SLOT(0x1D)
+#define RPI_PICO_DMA_SLOT_UART1_TX   RPI_PICO_DMA_DREQ_TO_SLOT(0x1E)
+#define RPI_PICO_DMA_SLOT_UART1_RX   RPI_PICO_DMA_DREQ_TO_SLOT(0x1F)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP0  RPI_PICO_DMA_DREQ_TO_SLOT(0x20)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP1  RPI_PICO_DMA_DREQ_TO_SLOT(0x21)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP2  RPI_PICO_DMA_DREQ_TO_SLOT(0x22)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP3  RPI_PICO_DMA_DREQ_TO_SLOT(0x23)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP4  RPI_PICO_DMA_DREQ_TO_SLOT(0x24)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP5  RPI_PICO_DMA_DREQ_TO_SLOT(0x25)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP6  RPI_PICO_DMA_DREQ_TO_SLOT(0x26)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP7  RPI_PICO_DMA_DREQ_TO_SLOT(0x27)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP8  RPI_PICO_DMA_DREQ_TO_SLOT(0x28)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP9  RPI_PICO_DMA_DREQ_TO_SLOT(0x29)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP10 RPI_PICO_DMA_DREQ_TO_SLOT(0x2A)
+#define RPI_PICO_DMA_SLOT_PWM_WRAP11 RPI_PICO_DMA_DREQ_TO_SLOT(0x2B)
+#define RPI_PICO_DMA_SLOT_I2C0_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x2C)
+#define RPI_PICO_DMA_SLOT_I2C0_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x2D)
+#define RPI_PICO_DMA_SLOT_I2C1_TX    RPI_PICO_DMA_DREQ_TO_SLOT(0x2E)
+#define RPI_PICO_DMA_SLOT_I2C1_RX    RPI_PICO_DMA_DREQ_TO_SLOT(0x2F)
+#define RPI_PICO_DMA_SLOT_ADC        RPI_PICO_DMA_DREQ_TO_SLOT(0x30)
+#define RPI_PICO_DMA_SLOT_XIP_STREAM RPI_PICO_DMA_DREQ_TO_SLOT(0x31)
+#define RPI_PICO_DMA_SLOT_XIP_QMITX  RPI_PICO_DMA_DREQ_TO_SLOT(0x32)
+#define RPI_PICO_DMA_SLOT_XIP_QMIRX  RPI_PICO_DMA_DREQ_TO_SLOT(0x33)
+#define RPI_PICO_DMA_SLOT_HSTX       RPI_PICO_DMA_DREQ_TO_SLOT(0x34)
+#define RPI_PICO_DMA_SLOT_CORESIGHT  RPI_PICO_DMA_DREQ_TO_SLOT(0x35)
+#define RPI_PICO_DMA_SLOT_SHA256     RPI_PICO_DMA_DREQ_TO_SLOT(0x36)
+
+#endif /* ZEPHYR_INCLUDE_DT_BINDINGS_RPI_PICO_DMA_RP2350_H_ */

include/zephyr/dt-bindings/dma/rpi_pico_dma.h

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <zephyr/dt-bindings/dma/rpi_pico_dma.h>
+#include <zephyr/dt-bindings/dma/rpi-pico-dma-rp2040.h>
 
 &dma {
 	status = "okay";