bsp/tms570: Add pin configuration variants

Rearrange pin function bit fields to allow the clearing of all function
bits through TMS570_PIN_AND_FNC().

Move implementation details to source file.

2 files changed, 133 insertions, 46 deletions

diff --git a/bsps/arm/tms570/include/bsp/tms570-pinmux.h b/bsps/arm/tms570/include/bsp/tms570-pinmux.h
index f744b92737..f527073496 100644
--- a/bsps/arm/tms570/include/bsp/tms570-pinmux.h
+++ b/bsps/arm/tms570/include/bsp/tms570-pinmux.h
@@ -23,8 +23,8 @@
 #ifndef LIBBSP_ARM_TMS570_PINMUX_H
 #define LIBBSP_ARM_TMS570_PINMUX_H
 
-#ifndef ASM
-#include <bsp/tms570.h>
+#include <stddef.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -40,10 +40,18 @@ extern "C" {
  * connection is not enabled in parallel to other one.
  * Mask is ored with pin number in such list.
  */
-#define TMS570_PIN_CLEAR_RQ_MASK 0x00000800
+#define TMS570_PIN_CLEAR_RQ_MASK 0x00008000
 
-#define TMS570_PIN_FNC_SHIFT    12
-#define TMS570_PIN_FNC_MASK     0x0000f000
+#define TMS570_PIN_FNC_SHIFT    11
+#define TMS570_PIN_FNC_MASK     0x00007800
+
+/**
+ * @brief This constant indicates that all eight function bits associated with
+ *   the pin shall be cleared.
+ *
+ * Use it as a special value for the pin function in TMS570_PIN_AND_FNC().
+ */
+#define TMS570_PIN_FNC_CLEAR 0x10U
 
 #define TMS570_PIN_NUM_FNC_MASK 0x0000ffff
 
@@ -52,6 +60,15 @@ extern "C" {
 
 #define TMS570_PIN_FNC_AUTO  (-1)
 
+/**
+ * @brief Defines the function of the pin.
+ *
+ * @param pin is the pin identifier.  Use TMS570_BALL_WITH_MMR() to define the
+ *   pin identifier.
+ *
+ * param fnc is the pin function.  The pin function shall be the function bit
+ *   index or TMS570_PIN_FNC_CLEAR.
+ */
 #define TMS570_PIN_AND_FNC(pin, fnc) \
   ((pin) | ((fnc) << TMS570_PIN_FNC_SHIFT))
 
@@ -61,6 +78,43 @@ extern "C" {
 #define TMS570_BALL_WITH_MMR(mmrx, pos) \
   ((pos) | ((mmrx) << 2))
 
+/**
+ * @brief Prepares a pin configuration sequence.
+ *
+ * Use tms570_pin_config_apply() to apply pin configurations.  Use
+ * tms570_pin_config_complete() to complete the pin configuration sequence.
+ */
+void tms570_pin_config_prepare(void);
+
+/**
+ * @brief Applies a pin configuration.
+ *
+ * This function can only be used if the pin configuration was prepared by
+ * tms570_pin_config_prepare().
+ *
+ * @param config is the pin configuration defined by TMS570_PIN_AND_FNC() or
+ *   TMS570_PIN_WITH_IN_ALT().
+ */
+void tms570_pin_config_apply(uint32_t config);
+
+/**
+ * @brief Applies a pin configuration array.
+ *
+ * This function can only be used if the pin configuration was prepared by
+ * tms570_pin_config_prepare().
+ *
+ * @param config is the pin configuration array.  Calls
+ *   tms570_pin_config_apply() for each pin configuration in the array.
+ *
+ * @param count is the element count of the pin configuration array.
+ */
+void tms570_pin_config_array_apply(const uint32_t *config, size_t count);
+
+/**
+ * @brief Completes a pin configuration sequence.
+ */
+void tms570_pin_config_complete(void);
+
 /* Generic functions select pin to peripheral connection */
 
 void tms570_bsp_pin_set_function(int pin_num, int pin_fnc);
@@ -71,15 +125,6 @@ void tms570_bsp_pin_config_one(uint32_t pin_num_and_fnc);
 
 void tms570_bsp_pinmmr_config(const uint32_t *pinmmr_values, int reg_start, int reg_count);
 
-static inline void
-tms570_bsp_pin_to_pinmmrx(volatile uint32_t **pinmmrx, unsigned int *pin_shift,
-                          int pin_num)
-{
-  pin_num = (pin_num & TMS570_PIN_NUM_MASK) >> TMS570_PIN_NUM_SHIFT;
-  *pinmmrx = &TMS570_IOMM.PINMUX.PINMMR0 + (pin_num >> 2);
-  *pin_shift = (pin_num & 0x3)*8;
-}
-
 #define TMS570_PINMMR_REG_SINGLE_VAL_ACTION(reg, pin) \
   (((((pin) & TMS570_PIN_NUM_MASK) >> 2 != (reg)) || ((pin) & TMS570_PIN_CLEAR_RQ_MASK))? 0: \
    1 << ((((pin) & TMS570_PIN_FNC_MASK) >> TMS570_PIN_FNC_SHIFT) + \
@@ -125,9 +170,6 @@ tms570_bsp_pin_to_pinmmrx(volatile uint32_t **pinmmrx, unsigned int *pin_shift,
 #define TMS570_PINMMR_COMA_LIST(pin_list) \
   pin_list(TMS570_PINMMR_COMA_LIST_ACTION, 0)
 
-
-#endif
-
 /** @} */
 
 #ifdef __cplusplus
diff --git a/bsps/arm/tms570/start/pinmux.c b/bsps/arm/tms570/start/pinmux.c
index 6aec5f7c32..a045891774 100644
--- a/bsps/arm/tms570/start/pinmux.c
+++ b/bsps/arm/tms570/start/pinmux.c
@@ -24,8 +24,19 @@
 #include <bsp/tms570-pinmux.h>
 #include <bsp/irq.h>
 
-uint32_t tms570_bsp_pinmmr_kick_key0 = 0x83E70B13U;
-uint32_t tms570_bsp_pinmmr_kick_key1 = 0x95A4F1E0U;
+RTEMS_STATIC_ASSERT(
+  TMS570_PIN_CLEAR_RQ_MASK == TMS570_PIN_FNC_CLEAR << TMS570_PIN_FNC_SHIFT,
+  TMS570_PIN_CONFIG
+);
+
+static inline void
+tms570_bsp_pin_to_pinmmrx(volatile uint32_t **pinmmrx, uint32_t *pin_shift,
+                          uint32_t config)
+{
+  uint32_t pin_num = (config & TMS570_PIN_NUM_MASK) >> TMS570_PIN_NUM_SHIFT;
+  *pinmmrx = &TMS570_IOMM.PINMUX.PINMMR0 + (pin_num >> 2);
+  *pin_shift = (pin_num & 0x3)*8;
+}
 
 /**
  * @brief select desired function of pin/ball
@@ -110,33 +121,11 @@ void
 tms570_bsp_pin_config_one(uint32_t pin_num_and_fnc)
 {
   rtems_interrupt_level intlev;
-  uint32_t pin_in_alt;
 
   rtems_interrupt_disable(intlev);
-
-  TMS570_IOMM.KICK_REG0 = tms570_bsp_pinmmr_kick_key0;
-  TMS570_IOMM.KICK_REG1 = tms570_bsp_pinmmr_kick_key1;
-
-  pin_in_alt = pin_num_and_fnc & TMS570_PIN_IN_ALT_MASK;
-  if ( pin_in_alt ) {
-    pin_in_alt >>= TMS570_PIN_IN_ALT_SHIFT;
-    if ( pin_in_alt & TMS570_PIN_CLEAR_RQ_MASK ) {
-      tms570_bsp_pin_clear_function(pin_in_alt, TMS570_PIN_FNC_AUTO);
-    } else {
-      tms570_bsp_pin_set_function(pin_in_alt, TMS570_PIN_FNC_AUTO);
-    }
-  }
-
-  pin_num_and_fnc &= TMS570_PIN_NUM_FNC_MASK;
-  if ( pin_num_and_fnc & TMS570_PIN_CLEAR_RQ_MASK ) {
-    tms570_bsp_pin_clear_function(pin_num_and_fnc, TMS570_PIN_FNC_AUTO);
-  } else {
-    tms570_bsp_pin_set_function(pin_num_and_fnc, TMS570_PIN_FNC_AUTO);
-  }
-
-  TMS570_IOMM.KICK_REG0 = 0;
-  TMS570_IOMM.KICK_REG1 = 0;
-
+  tms570_pin_config_prepare();
+  tms570_pin_config_apply(pin_num_and_fnc);
+  tms570_pin_config_complete();
   rtems_interrupt_enable(intlev);
 }
 
@@ -167,8 +156,7 @@ tms570_bsp_pinmmr_config(const uint32_t *pinmmr_values, int reg_start, int reg_c
   if ( reg_count <= 0)
     return;
 
-  TMS570_IOMM.KICK_REG0 = tms570_bsp_pinmmr_kick_key0;
-  TMS570_IOMM.KICK_REG1 = tms570_bsp_pinmmr_kick_key1;
+  tms570_pin_config_prepare();
 
   pinmmrx = (&TMS570_IOMM.PINMUX.PINMMR0) + reg_start;
   pval = pinmmr_values;
@@ -190,6 +178,63 @@ tms570_bsp_pinmmr_config(const uint32_t *pinmmr_values, int reg_start, int reg_c
     pval++;
   } while( --cnt );
 
+  tms570_pin_config_complete();
+}
+
+void tms570_pin_config_prepare(void)
+{
+  TMS570_IOMM.KICK_REG0 = 0x83E70B13U;
+  TMS570_IOMM.KICK_REG1 = 0x95A4F1E0U;
+}
+
+static void
+tms570_pin_set_function(uint32_t config)
+{
+  volatile uint32_t *pinmmrx;
+  uint32_t pin_shift;
+  uint32_t pin_fnc;
+  uint32_t bit;
+  uint32_t val;
+
+  tms570_bsp_pin_to_pinmmrx(&pinmmrx, &pin_shift, config);
+  pin_fnc = (config & TMS570_PIN_FNC_MASK) >> TMS570_PIN_FNC_SHIFT;
+  bit = 1U << (pin_fnc + pin_shift);
+  val = *pinmmrx;
+  val &= ~(0xffU << pin_shift);
+
+  if ((config & TMS570_PIN_CLEAR_RQ_MASK) == 0) {
+    val |= bit;
+  }
+
+  *pinmmrx = val;
+}
+
+void tms570_pin_config_apply(uint32_t config)
+{
+  uint32_t pin_in_alt;
+  uint32_t pin_num_and_fnc;
+
+  pin_in_alt = config & TMS570_PIN_IN_ALT_MASK;
+  if (pin_in_alt != 0) {
+    pin_in_alt >>= TMS570_PIN_IN_ALT_SHIFT;
+    tms570_pin_set_function(pin_in_alt);
+  }
+
+  pin_num_and_fnc = config & TMS570_PIN_NUM_FNC_MASK;
+  tms570_pin_set_function(pin_num_and_fnc);
+}
+
+void tms570_pin_config_array_apply(const uint32_t *config, size_t count)
+{
+  size_t i;
+
+  for (i = 0; i < count; ++i) {
+    tms570_pin_config_apply(config[i]);
+  }
+}
+
+void tms570_pin_config_complete(void)
+{
   TMS570_IOMM.KICK_REG0 = 0;
   TMS570_IOMM.KICK_REG1 = 0;
 }