cpu/sam0_common: implement SERCOM time-sharing

This adds a `periph_sercom` feature and implementation which `periph_i2c`, `periph_uart`, and `periph_spi` are implemented on top. This allows for sharing a single SERCOM instance to provide multiple serial interfaces (in round-robin time-sharing fashion). Note: In practice, a SERCOM can often not be shared if it needs to provide an UART. Background: While code using the I2C/SPI APIs is already optimized to share the peripheral with `i2c_acquire()`/`spi_acquire()` and `i2c_release()`/`spi_release()`, UARTs are typically not shared and most users will not call `uart_poweron()` and `uart_poweroff()` to only have the SERCOM in UART mode when actually needed. Worse: For many use cases (such as stdin), the UART will need to be constantly running, as receiving data happens asynchronously at unpredictable points in time.
RIOT-OS · Nov 26, 2024 · c672afd · c672afd
1 parent 1f624ad
commit c672afd
Show file tree

Hide file tree

Showing 45 changed files with 1,016 additions and 813 deletions.
diff --git a/boards/adafruit-grand-central-m4-express/include/periph_conf.h b/boards/adafruit-grand-central-m4-express/include/periph_conf.h
@@ -324,14 +324,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0_2
-#define UART_0_ISR_TX       isr_sercom0_0
-#define UART_1_ISR          isr_sercom4_2
-#define UART_1_ISR_TX       isr_sercom4_0
-#define UART_2_ISR          isr_sercom1_2
-#define UART_2_ISR_TX       isr_sercom1_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/adafruit-itsybitsy-m4/include/periph_conf.h b/boards/adafruit-itsybitsy-m4/include/periph_conf.h
@@ -105,10 +105,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3_2
-#define UART_0_ISR_TX       isr_sercom3_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/adafruit-metro-m4-express/include/periph_conf.h b/boards/adafruit-metro-m4-express/include/periph_conf.h
@@ -253,10 +253,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3_2
-#define UART_0_ISR_TX       isr_sercom3_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/adafruit-pybadge/include/periph_conf.h b/boards/adafruit-pybadge/include/periph_conf.h
@@ -105,10 +105,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5_2
-#define UART_0_ISR_TX       isr_sercom5_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/arduino-mkrwan1300/include/periph_conf.h b/boards/arduino-mkrwan1300/include/periph_conf.h
@@ -66,10 +66,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom4
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/arduino-nano-33-iot/include/periph_conf.h b/boards/arduino-nano-33-iot/include/periph_conf.h
@@ -133,9 +133,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/common/arduino-mkr/include/periph_conf.h b/boards/common/arduino-mkr/include/periph_conf.h
@@ -52,9 +52,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/common/arduino-zero/include/periph_conf.h b/boards/common/arduino-zero/include/periph_conf.h
@@ -155,10 +155,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/common/saml1x/include/periph_conf.h b/boards/common/saml1x/include/periph_conf.h
@@ -111,12 +111,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom2_2
-#define UART_0_ISR_TX       isr_sercom2_0
-#define UART_1_ISR          isr_sercom1_2
-#define UART_1_ISR_TX       isr_sercom1_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/feather-m0/include/periph_conf.h b/boards/feather-m0/include/periph_conf.h
@@ -135,9 +135,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samd10-xmini/include/periph_conf.h b/boards/samd10-xmini/include/periph_conf.h
@@ -139,9 +139,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samd20-xpro/include/periph_conf.h b/boards/samd20-xpro/include/periph_conf.h
@@ -180,11 +180,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3
-#define UART_1_ISR          isr_sercom4
-#define UART_2_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samd21-xpro/include/periph_conf.h b/boards/samd21-xpro/include/periph_conf.h
@@ -182,11 +182,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3
-#define UART_1_ISR          isr_sercom4
-#define UART_2_ISR          isr_sercom5
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/same54-xpro/include/periph_conf.h b/boards/same54-xpro/include/periph_conf.h
@@ -182,19 +182,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom2_2
-#define UART_0_ISR_TX       isr_sercom2_0
-
-#define UART_1_ISR          isr_sercom0_2
-#define UART_1_ISR_TX       isr_sercom0_0
-
-#define UART_2_ISR          isr_sercom5_2
-#define UART_2_ISR_TX       isr_sercom5_0
-
-#define UART_3_ISR          isr_sercom1_2
-#define UART_3_ISR_TX       isr_sercom1_0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/saml21-xpro/include/periph_conf.h b/boards/saml21-xpro/include/periph_conf.h
@@ -111,11 +111,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3
-#define UART_1_ISR          isr_sercom4
-#define UART_2_ISR          isr_sercom1
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samr21-xpro/include/periph_conf.h b/boards/samr21-xpro/include/periph_conf.h
@@ -176,10 +176,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-#define UART_1_ISR          isr_sercom5
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samr30-xpro/include/periph_conf.h b/boards/samr30-xpro/include/periph_conf.h
@@ -73,9 +73,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/samr34-xpro/include/periph_conf.h b/boards/samr34-xpro/include/periph_conf.h
@@ -106,10 +106,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-#define UART_1_ISR          isr_sercom3
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/seeeduino_xiao/include/periph_conf.h b/boards/seeeduino_xiao/include/periph_conf.h
@@ -133,9 +133,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom4
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sensebox_samd21/include/periph_conf.h b/boards/sensebox_samd21/include/periph_conf.h
@@ -150,10 +150,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3
-#define UART_1_ISR          isr_sercom4
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/serpente/include/periph_conf.h b/boards/serpente/include/periph_conf.h
@@ -141,10 +141,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom2
-#define UART_1_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sodaq-autonomo/include/periph_conf.h b/boards/sodaq-autonomo/include/periph_conf.h
@@ -98,12 +98,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom0
-#define UART_1_ISR          isr_sercom5
-#define UART_2_ISR          isr_sercom4
-#define UART_3_ISR          isr_sercom1
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sodaq-explorer/include/periph_conf.h b/boards/sodaq-explorer/include/periph_conf.h
@@ -80,11 +80,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom4
-#define UART_2_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sodaq-one/include/periph_conf.h b/boards/sodaq-one/include/periph_conf.h
@@ -69,10 +69,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom2
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sodaq-sara-aff/include/periph_conf.h b/boards/sodaq-sara-aff/include/periph_conf.h
@@ -72,10 +72,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom0
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/sodaq-sara-sff/include/periph_conf.h b/boards/sodaq-sara-sff/include/periph_conf.h
@@ -69,10 +69,6 @@ static const uart_conf_t uart_config[] = {
     },
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom5
-#define UART_1_ISR          isr_sercom2
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/boards/yarm/include/periph_conf.h b/boards/yarm/include/periph_conf.h
@@ -80,9 +80,6 @@ static const uart_conf_t uart_config[] = {
     }
 };
 
-/* interrupt function name mapping */
-#define UART_0_ISR          isr_sercom3
-
 #define UART_NUMOF          ARRAY_SIZE(uart_config)
 /** @} */
 

diff --git a/bootloaders/riotboot_serial/Makefile.ci b/bootloaders/riotboot_serial/Makefile.ci
@@ -2,5 +2,6 @@ BOARD_INSUFFICIENT_MEMORY := \
     frdm-kw41z \
     pba-d-01-kw2x \
     phynode-kw41z \
+    samr21-xpro \
     usb-kw41z \
     #
diff --git a/cpu/cortexm_common/include/cpu.h b/cpu/cortexm_common/include/cpu.h
@@ -30,12 +30,10 @@
 #ifndef CPU_H
 #define CPU_H
 
-#include <stdio.h>
-
 #include "irq.h"
 #include "sched.h"
 #include "thread.h"
-#include "cpu_conf.h"
+#include "cpu_conf.h" /* IWYU pragma: export */
 
 #ifdef __cplusplus
 extern "C" {

diff --git a/cpu/sam0_common/Makefile.dep b/cpu/sam0_common/Makefile.dep
@@ -10,6 +10,11 @@ ifneq (,$(filter periph_spi,$(USEMODULE)))
   USEMODULE += periph_spi_gpio_mode
 endif
 
+ifneq (,$(filter periph_spi periph_uart periph_i2c,$(USEMODULE)))
+  FEATURES_REQUIRED += periph_sercom
+  USEMODULE += bitfield
+endif
+
 ifneq (,$(filter periph_sdmmc,$(USEMODULE)))
   USEMODULE += sdmmc_sdhc
 endif

diff --git a/cpu/sam0_common/Makefile.features b/cpu/sam0_common/Makefile.features
@@ -30,6 +30,7 @@ FEATURES_PROVIDED += periph_sdmmc_auto_cmd12
 FEATURES_PROVIDED += periph_sdmmc_hs
 FEATURES_PROVIDED += periph_sdmmc_mmc
 FEATURES_PROVIDED += periph_sdmmc_sdhc
+FEATURES_PROVIDED += periph_sercom
 FEATURES_PROVIDED += periph_spi_reconfigure
 FEATURES_PROVIDED += periph_spi_gpio_mode
 FEATURES_PROVIDED += periph_spi_reconfigure