Subversion Repositories DashDisplay

/**

  ******************************************************************************

  * @file    stm32l1xx_hal_i2s.c

  * @author  MCD Application Team

  * @brief   I2S HAL module driver.

  *          This file provides firmware functions to manage the following

  *          functionalities of the Integrated Interchip Sound (I2S) peripheral:

  *           + Initialization and de-initialization functions

  *           + IO operation functions

  *           + Peripheral State and Errors functions

  @verbatim

 ===============================================================================

                  ##### How to use this driver #####

 ===============================================================================

 [..]

    The I2S HAL driver can be used as follow:

    (#) Declare a I2S_HandleTypeDef handle structure.

    (#) Initialize the I2S low level resources by implement the HAL_I2S_MspInit() API:

        (##) Enable the SPIx interface clock.

        (##) I2S pins configuration:

            (+++) Enable the clock for the I2S GPIOs.

            (+++) Configure these I2S pins as alternate function pull-up.

        (##) NVIC configuration if you need to use interrupt process (HAL_I2S_Transmit_IT()

             and HAL_I2S_Receive_IT() APIs).

            (+++) Configure the I2Sx interrupt priority.

            (+++) Enable the NVIC I2S IRQ handle.

        (##) DMA Configuration if you need to use DMA process (HAL_I2S_Transmit_DMA()

             and HAL_I2S_Receive_DMA() APIs:

            (+++) Declare a DMA handle structure for the Tx/Rx Stream/Channel.

            (+++) Enable the DMAx interface clock.

            (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.

            (+++) Configure the DMA Tx/Rx Stream/Channel.

            (+++) Associate the initialized DMA handle to the I2S DMA Tx/Rx handle.

            (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the

                  DMA Tx/Rx Stream/Channel.

   (#) Program the Mode, Standard, Data Format, MCLK Output, Audio frequency and Polarity

       using HAL_I2S_Init() function.

   -@- The specific I2S interrupts (Transmission complete interrupt,

       RXNE interrupt and Error Interrupts) will be managed using the macros

       __HAL_I2S_ENABLE_IT() and __HAL_I2S_DISABLE_IT() inside the transmit and receive process.

   -@- Make sure that either:

        (+@) External clock source is configured after setting correctly

             the define constant HSE_VALUE in the stm32l1xx_hal_conf.h file.

    (#) Three mode of operations are available within this driver :

   *** Polling mode IO operation ***

   =================================

   [..]

     (+) Send an amount of data in blocking mode using HAL_I2S_Transmit()

     (+) Receive an amount of data in blocking mode using HAL_I2S_Receive()

   *** Interrupt mode IO operation ***

   ===================================

   [..]

     (+) Send an amount of data in non blocking mode using HAL_I2S_Transmit_IT()

     (+) At transmission end of half transfer HAL_I2S_TxHalfCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_TxHalfCpltCallback

     (+) At transmission end of transfer HAL_I2S_TxCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_TxCpltCallback

     (+) Receive an amount of data in non blocking mode using HAL_I2S_Receive_IT()

     (+) At reception end of half transfer HAL_I2S_RxHalfCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_RxHalfCpltCallback

     (+) At reception end of transfer HAL_I2S_RxCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_RxCpltCallback

     (+) In case of transfer Error, HAL_I2S_ErrorCallback() function is executed and user can

         add his own code by customization of function pointer HAL_I2S_ErrorCallback

   *** DMA mode IO operation ***

   ==============================

   [..]

     (+) Send an amount of data in non blocking mode (DMA) using HAL_I2S_Transmit_DMA()

     (+) At transmission end of half transfer HAL_I2S_TxHalfCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_TxHalfCpltCallback

     (+) At transmission end of transfer HAL_I2S_TxCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_TxCpltCallback

     (+) Receive an amount of data in non blocking mode (DMA) using HAL_I2S_Receive_DMA()

     (+) At reception end of half transfer HAL_I2S_RxHalfCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_RxHalfCpltCallback

     (+) At reception end of transfer HAL_I2S_RxCpltCallback is executed and user can

         add his own code by customization of function pointer HAL_I2S_RxCpltCallback

     (+) In case of transfer Error, HAL_I2S_ErrorCallback() function is executed and user can

         add his own code by customization of function pointer HAL_I2S_ErrorCallback

     (+) Pause the DMA Transfer using HAL_I2S_DMAPause()

     (+) Resume the DMA Transfer using HAL_I2S_DMAResume()

     (+) Stop the DMA Transfer using HAL_I2S_DMAStop()

         In Slave mode, if HAL_I2S_DMAStop is used to stop the communication, an error

         HAL_I2S_ERROR_BUSY_LINE_RX is raised as the master continue to transmit data.

         In this case __HAL_I2S_FLUSH_RX_DR macro must be used to flush the remaining data

         inside DR register and avoid using DeInit/Init process for the next transfer.

   *** I2S HAL driver macros list ***

   ===================================

   [..]

     Below the list of most used macros in I2S HAL driver.

      (+) __HAL_I2S_ENABLE: Enable the specified SPI peripheral (in I2S mode)

      (+) __HAL_I2S_DISABLE: Disable the specified SPI peripheral (in I2S mode)

      (+) __HAL_I2S_ENABLE_IT : Enable the specified I2S interrupts

      (+) __HAL_I2S_DISABLE_IT : Disable the specified I2S interrupts

      (+) __HAL_I2S_GET_FLAG: Check whether the specified I2S flag is set or not

      (+) __HAL_I2S_FLUSH_RX_DR: Read DR Register to Flush RX Data

    [..]

      (@) You can refer to the I2S HAL driver header file for more useful macros

   *** I2S HAL driver macros list ***

   ===================================

   [..]

       Callback registration:

      (#) The compilation flag USE_HAL_I2S_REGISTER_CALLBACKS when set to 1U

          allows the user to configure dynamically the driver callbacks.

          Use Functions HAL_I2S_RegisterCallback() to register an interrupt callback.

          Function HAL_I2S_RegisterCallback() allows to register following callbacks:

            (++) TxCpltCallback        : I2S Tx Completed callback

            (++) RxCpltCallback        : I2S Rx Completed callback

            (++) TxHalfCpltCallback    : I2S Tx Half Completed callback

            (++) RxHalfCpltCallback    : I2S Rx Half Completed callback

            (++) ErrorCallback         : I2S Error callback

            (++) MspInitCallback       : I2S Msp Init callback

            (++) MspDeInitCallback     : I2S Msp DeInit callback

          This function takes as parameters the HAL peripheral handle, the Callback ID

          and a pointer to the user callback function.

      (#) Use function HAL_I2S_UnRegisterCallback to reset a callback to the default

          weak function.

          HAL_I2S_UnRegisterCallback takes as parameters the HAL peripheral handle,

          and the Callback ID.

          This function allows to reset following callbacks:

            (++) TxCpltCallback        : I2S Tx Completed callback

            (++) RxCpltCallback        : I2S Rx Completed callback

            (++) TxHalfCpltCallback    : I2S Tx Half Completed callback

            (++) RxHalfCpltCallback    : I2S Rx Half Completed callback

            (++) ErrorCallback         : I2S Error callback

            (++) MspInitCallback       : I2S Msp Init callback

            (++) MspDeInitCallback     : I2S Msp DeInit callback

       [..]

       By default, after the HAL_I2S_Init() and when the state is HAL_I2S_STATE_RESET

       all callbacks are set to the corresponding weak functions:

       examples HAL_I2S_MasterTxCpltCallback(), HAL_I2S_MasterRxCpltCallback().

       Exception done for MspInit and MspDeInit functions that are

       reset to the legacy weak functions in the HAL_I2S_Init()/ HAL_I2S_DeInit() only when

       these callbacks are null (not registered beforehand).

       If MspInit or MspDeInit are not null, the HAL_I2S_Init()/ HAL_I2S_DeInit()

       keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.

       [..]

       Callbacks can be registered/unregistered in HAL_I2S_STATE_READY state only.

       Exception done MspInit/MspDeInit functions that can be registered/unregistered

       in HAL_I2S_STATE_READY or HAL_I2S_STATE_RESET state,

       thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.

       Then, the user first registers the MspInit/MspDeInit user callbacks

       using HAL_I2S_RegisterCallback() before calling HAL_I2S_DeInit()

       or HAL_I2S_Init() function.

       [..]

       When the compilation define USE_HAL_I2S_REGISTER_CALLBACKS is set to 0 or

       not defined, the callback registering feature is not available

       and weak (surcharged) callbacks are used.

  @endverbatim

  ******************************************************************************

  * @attention

  *

  * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.

  * All rights reserved.</center></h2>

  *

  * This software component is licensed by ST under BSD 3-Clause license,

  * the "License"; You may not use this file except in compliance with the

  * License. You may obtain a copy of the License at:

  *                        opensource.org/licenses/BSD-3-Clause

  *

  ******************************************************************************

  */

/* Includes ------------------------------------------------------------------*/

#include "stm32l1xx_hal.h"

#ifdef HAL_I2S_MODULE_ENABLED

#if defined(SPI_I2S_SUPPORT)

/** @addtogroup STM32L1xx_HAL_Driver

  * @{

  */

/** @defgroup I2S I2S

  * @brief I2S HAL module driver

  * @{

  */

/* Private typedef -----------------------------------------------------------*/

/* Private define ------------------------------------------------------------*/

#define I2S_TIMEOUT_FLAG          100U         /*!< Timeout 100 ms            */

/* Private macro -------------------------------------------------------------*/

/* Private variables ---------------------------------------------------------*/

/* Private function prototypes -----------------------------------------------*/

/** @defgroup I2S_Private_Functions I2S Private Functions

  * @{

  */

static void               I2S_DMATxCplt(DMA_HandleTypeDef *hdma);

static void               I2S_DMATxHalfCplt(DMA_HandleTypeDef *hdma);

static void               I2S_DMARxCplt(DMA_HandleTypeDef *hdma);

static void               I2S_DMARxHalfCplt(DMA_HandleTypeDef *hdma);

static void               I2S_DMAError(DMA_HandleTypeDef *hdma);

static void               I2S_Transmit_IT(I2S_HandleTypeDef *hi2s);

static void               I2S_Receive_IT(I2S_HandleTypeDef *hi2s);

static HAL_StatusTypeDef  I2S_WaitFlagStateUntilTimeout(I2S_HandleTypeDef *hi2s, uint32_t Flag, FlagStatus State,

                                                        uint32_t Timeout);

/**

  * @}

  */

/* Exported functions ---------------------------------------------------------*/

/** @defgroup I2S_Exported_Functions I2S Exported Functions

  * @{

  */

/** @defgroup  I2S_Exported_Functions_Group1 Initialization and de-initialization functions

  *  @brief    Initialization and Configuration functions

  *

@verbatim

 ===============================================================================

              ##### Initialization and de-initialization functions #####

 ===============================================================================

    [..]  This subsection provides a set of functions allowing to initialize and

          de-initialize the I2Sx peripheral in simplex mode:

      (+) User must Implement HAL_I2S_MspInit() function in which he configures

          all related peripherals resources (CLOCK, GPIO, DMA, IT and NVIC ).

      (+) Call the function HAL_I2S_Init() to configure the selected device with

          the selected configuration:

        (++) Mode

        (++) Standard

        (++) Data Format

        (++) MCLK Output

        (++) Audio frequency

        (++) Polarity

     (+) Call the function HAL_I2S_DeInit() to restore the default configuration

          of the selected I2Sx peripheral.

  @endverbatim

  * @{

  */

/**

  * @brief  Initializes the I2S according to the specified parameters

  *         in the I2S_InitTypeDef and create the associated handle.

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s)

{

  uint32_t i2sdiv;

  uint32_t i2sodd;

  uint32_t packetlength;

  uint32_t tmp;

  uint32_t i2sclk;

  /* Check the I2S handle allocation */

  if (hi2s == NULL)

  {

    return HAL_ERROR;

  }

  /* Check the I2S parameters */

  assert_param(IS_I2S_ALL_INSTANCE(hi2s->Instance));

  assert_param(IS_I2S_MODE(hi2s->Init.Mode));

  assert_param(IS_I2S_STANDARD(hi2s->Init.Standard));

  assert_param(IS_I2S_DATA_FORMAT(hi2s->Init.DataFormat));

  assert_param(IS_I2S_MCLK_OUTPUT(hi2s->Init.MCLKOutput));

  assert_param(IS_I2S_AUDIO_FREQ(hi2s->Init.AudioFreq));

  assert_param(IS_I2S_CPOL(hi2s->Init.CPOL));

  if (hi2s->State == HAL_I2S_STATE_RESET)

  {

    /* Allocate lock resource and initialize it */

    hi2s->Lock = HAL_UNLOCKED;

#if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)

    /* Init the I2S Callback settings */

    hi2s->TxCpltCallback       = HAL_I2S_TxCpltCallback;          /* Legacy weak TxCpltCallback       */

    hi2s->RxCpltCallback       = HAL_I2S_RxCpltCallback;          /* Legacy weak RxCpltCallback       */

    hi2s->TxHalfCpltCallback   = HAL_I2S_TxHalfCpltCallback;      /* Legacy weak TxHalfCpltCallback   */

    hi2s->RxHalfCpltCallback   = HAL_I2S_RxHalfCpltCallback;      /* Legacy weak RxHalfCpltCallback   */

    hi2s->ErrorCallback        = HAL_I2S_ErrorCallback;           /* Legacy weak ErrorCallback        */

    if (hi2s->MspInitCallback == NULL)

    {

      hi2s->MspInitCallback = HAL_I2S_MspInit; /* Legacy weak MspInit  */

    }

    /* Init the low level hardware : GPIO, CLOCK, NVIC... */

    hi2s->MspInitCallback(hi2s);

#else

    /* Init the low level hardware : GPIO, CLOCK, CORTEX...etc */

    HAL_I2S_MspInit(hi2s);

#endif /* USE_HAL_I2S_REGISTER_CALLBACKS */

  }

  hi2s->State = HAL_I2S_STATE_BUSY;

  /*----------------------- SPIx I2SCFGR & I2SPR Configuration ----------------*/

  /* Clear I2SMOD, I2SE, I2SCFG, PCMSYNC, I2SSTD, CKPOL, DATLEN and CHLEN bits */

  CLEAR_BIT(hi2s->Instance->I2SCFGR, (SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN | SPI_I2SCFGR_CKPOL | \

                                      SPI_I2SCFGR_I2SSTD | SPI_I2SCFGR_PCMSYNC | SPI_I2SCFGR_I2SCFG | \

                                      SPI_I2SCFGR_I2SE | SPI_I2SCFGR_I2SMOD));

  hi2s->Instance->I2SPR = 0x0002U;

  /*----------------------- I2SPR: I2SDIV and ODD Calculation -----------------*/

  /* If the requested audio frequency is not the default, compute the prescaler */

  if (hi2s->Init.AudioFreq != I2S_AUDIOFREQ_DEFAULT)

  {

    /* Check the frame length (For the Prescaler computing) ********************/

    if (hi2s->Init.DataFormat == I2S_DATAFORMAT_16B)

    {

      /* Packet length is 16 bits */

      packetlength = 16U;

    }

    else

    {

      /* Packet length is 32 bits */

      packetlength = 32U;

    }

    /* I2S standard */

    if (hi2s->Init.Standard <= I2S_STANDARD_LSB)

    {

      /* In I2S standard packet length is multiplied by 2 */

      packetlength = packetlength * 2U;

    }

    /* Get the source clock value: based on System Clock value */

    i2sclk = HAL_RCC_GetSysClockFreq();

    /* Compute the Real divider depending on the MCLK output state, with a floating point */

    if (hi2s->Init.MCLKOutput == I2S_MCLKOUTPUT_ENABLE)

    {

      /* MCLK output is enabled */

      if (hi2s->Init.DataFormat != I2S_DATAFORMAT_16B)

      {

        tmp = (uint32_t)(((((i2sclk / (packetlength * 4U)) * 10U) / hi2s->Init.AudioFreq)) + 5U);

      }

      else

      {

        tmp = (uint32_t)(((((i2sclk / (packetlength * 8U)) * 10U) / hi2s->Init.AudioFreq)) + 5U);

      }

    }

    else

    {

      /* MCLK output is disabled */

      tmp = (uint32_t)(((((i2sclk / packetlength) * 10U) / hi2s->Init.AudioFreq)) + 5U);

    }

    /* Remove the flatting point */

    tmp = tmp / 10U;

    /* Check the parity of the divider */

    i2sodd = (uint32_t)(tmp & (uint32_t)1U);

    /* Compute the i2sdiv prescaler */

    i2sdiv = (uint32_t)((tmp - i2sodd) / 2U);

    /* Get the Mask for the Odd bit (SPI_I2SPR[8]) register */

    i2sodd = (uint32_t)(i2sodd << 8U);

  }

  else

  {

    /* Set the default values */

    i2sdiv = 2U;

    i2sodd = 0U;

  }

  /* Test if the divider is 1 or 0 or greater than 0xFF */

  if ((i2sdiv < 2U) || (i2sdiv > 0xFFU))

  {

    /* Set the error code and execute error callback*/

    SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_PRESCALER);

    return  HAL_ERROR;

  }

  /*----------------------- SPIx I2SCFGR & I2SPR Configuration ----------------*/

  /* Write to SPIx I2SPR register the computed value */

  hi2s->Instance->I2SPR = (uint32_t)((uint32_t)i2sdiv | (uint32_t)(i2sodd | (uint32_t)hi2s->Init.MCLKOutput));

  /* Clear I2SMOD, I2SE, I2SCFG, PCMSYNC, I2SSTD, CKPOL, DATLEN and CHLEN bits */

  /* And configure the I2S with the I2S_InitStruct values                      */

  MODIFY_REG(hi2s->Instance->I2SCFGR, (SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN | \

                                       SPI_I2SCFGR_CKPOL | SPI_I2SCFGR_I2SSTD | \

                                       SPI_I2SCFGR_PCMSYNC | SPI_I2SCFGR_I2SCFG | \

                                       SPI_I2SCFGR_I2SE  | SPI_I2SCFGR_I2SMOD), \

             (SPI_I2SCFGR_I2SMOD | hi2s->Init.Mode | \

              hi2s->Init.Standard | hi2s->Init.DataFormat | \

              hi2s->Init.CPOL));

#if defined(SPI_I2SCFGR_ASTRTEN)

  if ((hi2s->Init.Standard == I2S_STANDARD_PCM_SHORT) || ((hi2s->Init.Standard == I2S_STANDARD_PCM_LONG)))

  {

    /* Write to SPIx I2SCFGR */

    SET_BIT(hi2s->Instance->I2SCFGR, SPI_I2SCFGR_ASTRTEN);

  }

#endif /* SPI_I2SCFGR_ASTRTEN */

  hi2s->ErrorCode = HAL_I2S_ERROR_NONE;

  hi2s->State     = HAL_I2S_STATE_READY;

  return HAL_OK;

}

/**

  * @brief DeInitializes the I2S peripheral

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_DeInit(I2S_HandleTypeDef *hi2s)

{

  /* Check the I2S handle allocation */

  if (hi2s == NULL)

  {

    return HAL_ERROR;

  }

  /* Check the parameters */

  assert_param(IS_I2S_ALL_INSTANCE(hi2s->Instance));

  hi2s->State = HAL_I2S_STATE_BUSY;

  /* Disable the I2S Peripheral Clock */

  __HAL_I2S_DISABLE(hi2s);

#if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)

  if (hi2s->MspDeInitCallback == NULL)

  {

    hi2s->MspDeInitCallback = HAL_I2S_MspDeInit; /* Legacy weak MspDeInit  */

  }

  /* DeInit the low level hardware: GPIO, CLOCK, NVIC... */

  hi2s->MspDeInitCallback(hi2s);

#else

  /* DeInit the low level hardware: GPIO, CLOCK, NVIC... */

  HAL_I2S_MspDeInit(hi2s);

#endif /* USE_HAL_I2S_REGISTER_CALLBACKS */

  hi2s->ErrorCode = HAL_I2S_ERROR_NONE;

  hi2s->State     = HAL_I2S_STATE_RESET;

  /* Release Lock */

  __HAL_UNLOCK(hi2s);

  return HAL_OK;

}

/**

  * @brief I2S MSP Init

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @retval None

  */

__weak void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s)

{

  /* Prevent unused argument(s) compilation warning */

  UNUSED(hi2s);

  /* NOTE : This function Should not be modified, when the callback is needed,

            the HAL_I2S_MspInit could be implemented in the user file

   */

}

/**

  * @brief I2S MSP DeInit

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @retval None

  */

__weak void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s)

{

  /* Prevent unused argument(s) compilation warning */

  UNUSED(hi2s);

  /* NOTE : This function Should not be modified, when the callback is needed,

            the HAL_I2S_MspDeInit could be implemented in the user file

   */

}

#if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)

/**

  * @brief  Register a User I2S Callback

  *         To be used instead of the weak predefined callback

  * @param  hi2s Pointer to a I2S_HandleTypeDef structure that contains

  *                the configuration information for the specified I2S.

  * @param  CallbackID ID of the callback to be registered

  * @param  pCallback pointer to the Callback function

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_RegisterCallback(I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID,

                                           pI2S_CallbackTypeDef pCallback)

{

  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)

  {

    /* Update the error code */

    hi2s->ErrorCode |= HAL_I2S_ERROR_INVALID_CALLBACK;

    return HAL_ERROR;

  }

  /* Process locked */

  __HAL_LOCK(hi2s);

  if (HAL_I2S_STATE_READY == hi2s->State)

  {

    switch (CallbackID)

    {

      case HAL_I2S_TX_COMPLETE_CB_ID :

        hi2s->TxCpltCallback = pCallback;

        break;

      case HAL_I2S_RX_COMPLETE_CB_ID :

        hi2s->RxCpltCallback = pCallback;

        break;

      case HAL_I2S_TX_HALF_COMPLETE_CB_ID :

        hi2s->TxHalfCpltCallback = pCallback;

        break;

      case HAL_I2S_RX_HALF_COMPLETE_CB_ID :

        hi2s->RxHalfCpltCallback = pCallback;

        break;

      case HAL_I2S_ERROR_CB_ID :

        hi2s->ErrorCallback = pCallback;

        break;

      case HAL_I2S_MSPINIT_CB_ID :

        hi2s->MspInitCallback = pCallback;

        break;

      case HAL_I2S_MSPDEINIT_CB_ID :

        hi2s->MspDeInitCallback = pCallback;

        break;

      default :

        /* Update the error code */

        SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else if (HAL_I2S_STATE_RESET == hi2s->State)

  {

    switch (CallbackID)

    {

      case HAL_I2S_MSPINIT_CB_ID :

        hi2s->MspInitCallback = pCallback;

        break;

      case HAL_I2S_MSPDEINIT_CB_ID :

        hi2s->MspDeInitCallback = pCallback;

        break;

      default :

        /* Update the error code */

        SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else

  {

    /* Update the error code */

    SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

    /* Return error status */

    status =  HAL_ERROR;

  }

  /* Release Lock */

  __HAL_UNLOCK(hi2s);

  return status;

}

/**

  * @brief  Unregister an I2S Callback

  *         I2S callback is redirected to the weak predefined callback

  * @param  hi2s Pointer to a I2S_HandleTypeDef structure that contains

  *                the configuration information for the specified I2S.

  * @param  CallbackID ID of the callback to be unregistered

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_UnRegisterCallback(I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID)

{

  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */

  __HAL_LOCK(hi2s);

  if (HAL_I2S_STATE_READY == hi2s->State)

  {

    switch (CallbackID)

    {

      case HAL_I2S_TX_COMPLETE_CB_ID :

        hi2s->TxCpltCallback = HAL_I2S_TxCpltCallback;                /* Legacy weak TxCpltCallback       */

        break;

      case HAL_I2S_RX_COMPLETE_CB_ID :

        hi2s->RxCpltCallback = HAL_I2S_RxCpltCallback;                /* Legacy weak RxCpltCallback       */

        break;

      case HAL_I2S_TX_HALF_COMPLETE_CB_ID :

        hi2s->TxHalfCpltCallback = HAL_I2S_TxHalfCpltCallback;        /* Legacy weak TxHalfCpltCallback   */

        break;

      case HAL_I2S_RX_HALF_COMPLETE_CB_ID :

        hi2s->RxHalfCpltCallback = HAL_I2S_RxHalfCpltCallback;        /* Legacy weak RxHalfCpltCallback   */

        break;

      case HAL_I2S_ERROR_CB_ID :

        hi2s->ErrorCallback = HAL_I2S_ErrorCallback;                  /* Legacy weak ErrorCallback        */

        break;

      case HAL_I2S_MSPINIT_CB_ID :

        hi2s->MspInitCallback = HAL_I2S_MspInit;                      /* Legacy weak MspInit              */

        break;

      case HAL_I2S_MSPDEINIT_CB_ID :

        hi2s->MspDeInitCallback = HAL_I2S_MspDeInit;                  /* Legacy weak MspDeInit            */

        break;

      default :

        /* Update the error code */

        SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else if (HAL_I2S_STATE_RESET == hi2s->State)

  {

    switch (CallbackID)

    {

      case HAL_I2S_MSPINIT_CB_ID :

        hi2s->MspInitCallback = HAL_I2S_MspInit;                      /* Legacy weak MspInit              */

        break;

      case HAL_I2S_MSPDEINIT_CB_ID :

        hi2s->MspDeInitCallback = HAL_I2S_MspDeInit;                  /* Legacy weak MspDeInit            */

        break;

      default :

        /* Update the error code */

        SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else

  {

    /* Update the error code */

    SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_INVALID_CALLBACK);

    /* Return error status */

    status =  HAL_ERROR;

  }

  /* Release Lock */

  __HAL_UNLOCK(hi2s);

  return status;

}

#endif /* USE_HAL_I2S_REGISTER_CALLBACKS */

/**

  * @}

  */

/** @defgroup I2S_Exported_Functions_Group2 IO operation functions

  *  @brief Data transfers functions

  *

@verbatim

 ===============================================================================

                      ##### IO operation functions #####

 ===============================================================================

    [..]

    This subsection provides a set of functions allowing to manage the I2S data

    transfers.

    (#) There are two modes of transfer:

       (++) Blocking mode : The communication is performed in the polling mode.

            The status of all data processing is returned by the same function

            after finishing transfer.

       (++) No-Blocking mode : The communication is performed using Interrupts

            or DMA. These functions return the status of the transfer startup.

            The end of the data processing will be indicated through the

            dedicated I2S IRQ when using Interrupt mode or the DMA IRQ when

            using DMA mode.

    (#) Blocking mode functions are :

        (++) HAL_I2S_Transmit()

        (++) HAL_I2S_Receive()

    (#) No-Blocking mode functions with Interrupt are :

        (++) HAL_I2S_Transmit_IT()

        (++) HAL_I2S_Receive_IT()

    (#) No-Blocking mode functions with DMA are :

        (++) HAL_I2S_Transmit_DMA()

        (++) HAL_I2S_Receive_DMA()

    (#) A set of Transfer Complete Callbacks are provided in non Blocking mode:

        (++) HAL_I2S_TxCpltCallback()

        (++) HAL_I2S_RxCpltCallback()

        (++) HAL_I2S_ErrorCallback()

@endverbatim

  * @{

  */

/**

  * @brief  Transmit an amount of data in blocking mode

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @param  pData a 16-bit pointer to data buffer.

  * @param  Size number of data sample to be sent:

  * @note   When a 16-bit data frame or a 16-bit data frame extended is selected during the I2S

  *         configuration phase, the Size parameter means the number of 16-bit data length

  *         in the transaction and when a 24-bit data frame or a 32-bit data frame is selected

  *         the Size parameter means the number of 24-bit or 32-bit data length.

  * @param  Timeout Timeout duration

  * @note   The I2S is kept enabled at the end of transaction to avoid the clock de-synchronization

  *         between Master and Slave(example: audio streaming).

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)

{

  uint32_t tmpreg_cfgr;

  if ((pData == NULL) || (Size == 0U))

  {

    return  HAL_ERROR;

  }

  /* Process Locked */

  __HAL_LOCK(hi2s);

  if (hi2s->State != HAL_I2S_STATE_READY)

  {

    __HAL_UNLOCK(hi2s);

    return HAL_BUSY;

  }

  /* Set state and reset error code */

  hi2s->State = HAL_I2S_STATE_BUSY_TX;

  hi2s->ErrorCode = HAL_I2S_ERROR_NONE;

  hi2s->pTxBuffPtr = pData;

  tmpreg_cfgr = hi2s->Instance->I2SCFGR & (SPI_I2SCFGR_DATLEN | SPI_I2SCFGR_CHLEN);

  if ((tmpreg_cfgr == I2S_DATAFORMAT_24B) || (tmpreg_cfgr == I2S_DATAFORMAT_32B))

  {

    hi2s->TxXferSize = (Size << 1U);

    hi2s->TxXferCount = (Size << 1U);

  }

  else

  {

    hi2s->TxXferSize = Size;

    hi2s->TxXferCount = Size;

  }

  tmpreg_cfgr = hi2s->Instance->I2SCFGR;

  /* Check if the I2S is already enabled */

  if ((hi2s->Instance->I2SCFGR & SPI_I2SCFGR_I2SE) != SPI_I2SCFGR_I2SE)

  {

    /* Enable I2S peripheral */

    __HAL_I2S_ENABLE(hi2s);

  }

  /* Wait until TXE flag is set */

  if (I2S_WaitFlagStateUntilTimeout(hi2s, I2S_FLAG_TXE, SET, Timeout) != HAL_OK)

  {

    /* Set the error code */

    SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_TIMEOUT);

    hi2s->State = HAL_I2S_STATE_READY;

    __HAL_UNLOCK(hi2s);

    return HAL_ERROR;

  }

  while (hi2s->TxXferCount > 0U)

  {

    hi2s->Instance->DR = (*hi2s->pTxBuffPtr);

    hi2s->pTxBuffPtr++;

    hi2s->TxXferCount--;

    /* Wait until TXE flag is set */

    if (I2S_WaitFlagStateUntilTimeout(hi2s, I2S_FLAG_TXE, SET, Timeout) != HAL_OK)

    {

      /* Set the error code */

      SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_TIMEOUT);

      hi2s->State = HAL_I2S_STATE_READY;

      __HAL_UNLOCK(hi2s);

      return HAL_ERROR;

    }

    /* Check if an underrun occurs */

    if (__HAL_I2S_GET_FLAG(hi2s, I2S_FLAG_UDR) == SET)

    {

      /* Clear underrun flag */

      __HAL_I2S_CLEAR_UDRFLAG(hi2s);

      /* Set the error code */

      SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_UDR);

    }

  }

  /* Check if Slave mode is selected */

  if (((tmpreg_cfgr & SPI_I2SCFGR_I2SCFG) == I2S_MODE_SLAVE_TX)

      || ((tmpreg_cfgr & SPI_I2SCFGR_I2SCFG) == I2S_MODE_SLAVE_RX))

  {

    /* Wait until Busy flag is reset */

    if (I2S_WaitFlagStateUntilTimeout(hi2s, I2S_FLAG_BSY, RESET, Timeout) != HAL_OK)

    {

      /* Set the error code */

      SET_BIT(hi2s->ErrorCode, HAL_I2S_ERROR_TIMEOUT);

      hi2s->State = HAL_I2S_STATE_READY;

      __HAL_UNLOCK(hi2s);

      return HAL_ERROR;

    }

  }

  hi2s->State = HAL_I2S_STATE_READY;

  __HAL_UNLOCK(hi2s);

  return HAL_OK;

}

/**

  * @brief  Receive an amount of data in blocking mode

  * @param  hi2s pointer to a I2S_HandleTypeDef structure that contains

  *         the configuration information for I2S module

  * @param  pData a 16-bit pointer to data buffer.

  * @param  Size number of data sample to be sent:

  * @note   When a 16-bit data frame or a 16-bit data frame extended is selected during the I2S

  *         configuration phase, the Size parameter means the number of 16-bit data length

  *         in the transaction and when a 24-bit data frame or a 32-bit data frame is selected

  *         the Size parameter means the number of 24-bit or 32-bit data length.

  * @param  Timeout Timeout duration

  * @note   The I2S is kept enabled at the end of transaction to avoid the clock de-synchronization

  *         between Master and Slave(example: audio streaming).

  * @note   In I2S Master Receiver mode, just after enabling the peripheral the clock will be generate

  *         in continuous way and as the I2S is not disabled at the end of the I2S transaction.

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)

{

  uint32_t tmpreg_cfgr;

  if ((pData == NULL) || (Size == 0U))

  {

    return  HAL_ERROR;

  }

  /* Process Locked */

  __HAL_LOCK(hi2s);

  if (hi2s->State != HAL_I2S_STATE_READY)

  {

    __HAL_UNLOCK(hi2s);

    return HAL_BUSY;

  }

  /* Set state and reset error code */

  hi2s->State = HAL_I2S_STATE_BUSY_RX;

  hi2s->ErrorCode = HAL_I2S_ERROR_NONE;

  hi2s->pRxBuffPtr = pData;

  tmpreg_cfgr = hi2s->Instance->I2SCFGR & (SPI_I2SCFGR_DATLEN | SPI_I2SCFGR_CHLEN);

  if ((tmpreg_cfgr == I2S_DATAFORMAT_24B) || (tmpreg_cfgr == I2S_DATAFORMAT_32B))

  {

    hi2s->RxXferSize = (Size << 1U);

    hi2s->RxXferCount = (Size << 1U);

  }

  else

  {

    hi2s->RxXferSize = Size;