sdk_ng: Roll back the SAI driver version to 2.4.3

The 2.4.4 SAI driver from the 24.12.00 release
will cause FRDM-MCXN947 i2s speed exmaple run fail,
currently roll back it to 2.4.3 version.

Signed-off-by: Zhaoxiang Jin <[email protected]>

Author: ZhaoxiangJin

mcux/mcux-sdk-ng/drivers/sai/fsl_sai.c

@@ -277,7 +277,16 @@ static uint32_t SAI_GetInstance(I2S_Type *base)
         }
     }
 
-    assert(instance < ARRAY_SIZE(s_saiBases));
+    if (instance == ARRAY_SIZE(s_saiBases)) {
+        assert(false);
+	/* asserts may not always be enabled. As such, return NULL here to
+	 * avoid compilation warnings complaining about a possible out-of-bounds
+	 * access. If the user decides to disable the asserts, it is up to them
+	 * to debug in case of out-of-bounds access as SAI_GetInstance() will
+	 * return a valid instance.
+	 */
+	return 0;
+    }
 
     return instance;
 }
@@ -940,8 +949,8 @@ void SAI_TxSetFifoConfig(I2S_Type *base, sai_fifo_t *config)
 {
     assert(config != NULL);
 #if defined(FSL_FEATURE_SAI_HAS_FIFO) && (FSL_FEATURE_SAI_HAS_FIFO)
-    if ((config->fifoWatermark == 0U) ||
-        (config->fifoWatermark > (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base))))
+    if (config->fifoWatermark > (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base)) ||
+	(!MCUX_SDK_SAI_ALLOW_NULL_FIFO_WATERMARK && config->fifoWatermark == 0U))
     {
         config->fifoWatermark = (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base) / 2U);
     }
@@ -986,8 +995,8 @@ void SAI_RxSetFifoConfig(I2S_Type *base, sai_fifo_t *config)
 {
     assert(config != NULL);
 #if defined(FSL_FEATURE_SAI_HAS_FIFO) && (FSL_FEATURE_SAI_HAS_FIFO)
-    if ((config->fifoWatermark == 0U) ||
-        (config->fifoWatermark > (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base))))
+    if (config->fifoWatermark > (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base)) ||
+	(!MCUX_SDK_SAI_ALLOW_NULL_FIFO_WATERMARK && config->fifoWatermark == 0U))
     {
         config->fifoWatermark = (uint8_t)((uint32_t)FSL_FEATURE_SAI_FIFO_COUNTn(base) / 2U);
     }
@@ -1131,24 +1140,15 @@ void SAI_RxSetSerialDataConfig(I2S_Type *base, sai_serial_data_t *config)
     base->RCR4 = rcr4;
 }
 
-/*!
- * brief SAI transmitter configurations.
- *
- * param base SAI base pointer.
- * param config transmitter configurations.
- */
-void SAI_TxSetConfig(I2S_Type *base, sai_transceiver_t *config)
+#if !MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG
+static void SAI_ComputeChannelConfig(I2S_Type *base, sai_transceiver_t *config)
 {
     assert(config != NULL);
     assert(FSL_FEATURE_SAI_CHANNEL_COUNTn(base) != -1);
 
     uint8_t i           = 0U;
-    uint32_t val        = 0U;
     uint8_t channelNums = 0U;
 
-    /* reset transmitter */
-    SAI_TxReset(base);
-
     /* if channel mask is not set, then format->channel must be set,
      use it to get channel mask value */
     if (config->channelMask == 0U)
@@ -1175,6 +1175,35 @@ void SAI_TxSetConfig(I2S_Type *base, sai_transceiver_t *config)
     }
 
     config->channelNums = channelNums;
+}
+#endif /* MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG */
+
+/*!
+ * brief SAI transmitter configurations.
+ *
+ * param base SAI base pointer.
+ * param config transmitter configurations.
+ */
+void SAI_TxSetConfig(I2S_Type *base, sai_transceiver_t *config)
+{
+    uint32_t val = 0U;
+
+    /* reset transmitter */
+    SAI_TxReset(base);
+
+#if !MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG
+    /* sometimes, the user of the SAI driver may want to
+     * set the channel configuration (i.e: the startChannel,
+     * channelMask, endChannel, and channelNums fields of
+     * sai_transceiver_t) before calling SAI_TxSetConfig().
+     * As such, if the user wants to do this, they can define
+     * FSL_FEATURE_SAI_DISABLE_IMPLICIT_CHAN_CONFIG which will
+     * stop SAI_TxSetConfig() from implicitly computing those
+     * values.
+     */
+    SAI_ComputeChannelConfig(base, config);
+#endif /* MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG */
+
 #if defined(FSL_FEATURE_SAI_HAS_FIFO_COMBINE_MODE) && (FSL_FEATURE_SAI_HAS_FIFO_COMBINE_MODE)
     /* make sure combine mode disabled while multipe channel is used */
     if (config->channelNums > 1U)
@@ -1273,42 +1302,24 @@ void SAI_TransferTxSetConfig(I2S_Type *base, sai_handle_t *handle, sai_transceiv
  */
 void SAI_RxSetConfig(I2S_Type *base, sai_transceiver_t *config)
 {
-    assert(config != NULL);
-    assert(FSL_FEATURE_SAI_CHANNEL_COUNTn(base) != -1);
-
-    uint8_t i           = 0U;
-    uint32_t val        = 0U;
-    uint8_t channelNums = 0U;
+    uint32_t val = 0U;
 
     /* reset receiver */
     SAI_RxReset(base);
 
-    /* if channel mask is not set, then format->channel must be set,
-     use it to get channel mask value */
-    if (config->channelMask == 0U)
-    {
-        config->channelMask = 1U << config->startChannel;
-    }
-
-    for (i = 0U; i < (uint32_t)FSL_FEATURE_SAI_CHANNEL_COUNTn(base); i++)
-    {
-        if (IS_SAI_FLAG_SET((1UL << i), config->channelMask))
-        {
-            channelNums++;
-            config->endChannel = i;
-        }
-    }
-
-    for (i = 0U; i < (uint32_t)FSL_FEATURE_SAI_CHANNEL_COUNTn(base); i++)
-    {
-        if (IS_SAI_FLAG_SET((1UL << i), config->channelMask))
-        {
-            config->startChannel = i;
-            break;
-        }
-    }
+#if !MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG
+    /* sometimes, the user of the SAI driver may want to
+     * set the channel configuration (i.e: the startChannel,
+     * channelMask, endChannel, and channelNums fields of
+     * sai_transceiver_t) before calling SAI_RxSetConfig().
+     * As such, if the user wants to do this, they can define
+     * FSL_FEATURE_SAI_DISABLE_IMPLICIT_CHAN_CONFIG which will
+     * stop SAI_RxSetConfig() from implicitly computing those
+     * values.
+     */
+    SAI_ComputeChannelConfig(base, config);
+#endif /* MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG */
 
-    config->channelNums = channelNums;
 #if defined(FSL_FEATURE_SAI_HAS_FIFO_COMBINE_MODE) && (FSL_FEATURE_SAI_HAS_FIFO_COMBINE_MODE)
     /* make sure combine mode disabled while multipe channel is used */
     if (config->channelNums > 1U)

mcux/mcux-sdk-ng/drivers/sai/fsl_sai.h

@@ -20,9 +20,33 @@
  * Definitions
  ******************************************************************************/
 
+/*! @brief Used to control whether SAI_RxSetFifoConfig()/SAI_TxSetFifoConfig()
+ * allows a NULL FIFO watermark.
+ *
+ * If this macro is set to 0 then SAI_RxSetFifoConfig()/SAI_TxSetFifoConfig()
+ * will set the watermark to half of the FIFO's depth if passed a NULL
+ * watermark.
+ */
+#ifndef MCUX_SDK_SAI_ALLOW_NULL_FIFO_WATERMARK
+#define MCUX_SDK_SAI_ALLOW_NULL_FIFO_WATERMARK 0
+#endif /* MCUX_SDK_SAI_ALLOW_NULL_FIFO_WATERMARK */
+
+/*! @brief Disable implicit channel data configuration within SAI_TxSetConfig()/SAI_RxSetConfig().
+ *
+ * Use this macro to control whether SAI_RxSetConfig()/SAI_TxSetConfig() will
+ * attempt to implicitly configure the channel data. By channel data we mean
+ * the startChannel, channelMask, endChannel, and channelNums fields from the
+ * sai_transciever_t structure. By default, SAI_TxSetConfig()/SAI_RxSetConfig()
+ * will attempt to compute these fields, which may not be desired in cases where
+ * the user wants to set them before the call to said functions.
+ */
+#ifndef MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG
+#define MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG 0
+#endif /* MCUX_SDK_SAI_DISABLE_IMPLICIT_CHAN_CONFIG */
+
 /*! @name Driver version */
 /*! @{ */
-#define FSL_SAI_DRIVER_VERSION (MAKE_VERSION(2, 4, 4)) /*!< Version 2.4.4 */
+#define FSL_SAI_DRIVER_VERSION (MAKE_VERSION(2, 4, 3)) /*!< Version 2.4.3 */
 /*! @} */
 
 /*! @brief _sai_status_t, SAI return status.*/
@@ -245,12 +269,10 @@ typedef enum _sai_data_pin_state
 /*! @brief sai fifo combine mode definition */
 typedef enum _sai_fifo_combine
 {
-    kSAI_FifoCombineDisabled               = 0U, /*!< sai TX/RX fifo combine mode disabled */
-    kSAI_FifoCombineModeEnabledOnRead      = 1U, /*!< sai TX fifo combine mode enabled on FIFO reads */
-    kSAI_FifoCombineModeEnabledOnWrite     = 2U, /*!< sai TX fifo combine mode enabled on FIFO write */
-    kSAI_RxFifoCombineModeEnabledOnWrite   = 1U, /*!< sai RX fifo combine mode enabled on FIFO write */
-    kSAI_RXFifoCombineModeEnabledOnRead    = 2U, /*!< sai RX fifo combine mode enabled on FIFO reads */
-    kSAI_FifoCombineModeEnabledOnReadWrite = 3U, /*!< sai TX/RX fifo combined mode enabled on FIFO read/writes */
+    kSAI_FifoCombineDisabled = 0U,          /*!< sai fifo combine mode disabled */
+    kSAI_FifoCombineModeEnabledOnWrite,     /*!< sai fifo combine mode enabled on FIFO write */
+    kSAI_FifoCombineModeEnabledOnRead,      /*!< sai fifo combine mode enabled on FIFO reads */
+    kSAI_FifoCombineModeEnabledOnReadWrite, /*!< sai fifo combined mode enabled on FIFO read/writes */
 } sai_fifo_combine_t;
 #endif