STM32F439xx HAL User Manual: stm32f4xx_hal_i2s

I2S HAL module driver. This file provides firmware functions to manage the following functionalities of I2S extension peripheral: + Extension features Functions. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

Enumerations
enum	I2S_UseTypeDef { I2S_USE_I2S = 0x00U, I2S_USE_I2SEXT = 0x01U }
Functions
static void	I2SEx_TxRxDMAHalfCplt (DMA_HandleTypeDef *hdma)
	DMA I2S transmit receive process half complete callback.
static void	I2SEx_TxRxDMACplt (DMA_HandleTypeDef *hdma)
	DMA I2S transmit receive process complete callback.
static void	I2SEx_TxRxDMAError (DMA_HandleTypeDef *hdma)
	DMA I2S communication error callback.
static void	I2SEx_FullDuplexTx_IT (I2S_HandleTypeDef *hi2s, I2S_UseTypeDef i2sUsed)
	Full-Duplex IT handler transmit function.
static void	I2SEx_FullDuplexRx_IT (I2S_HandleTypeDef *hi2s, I2S_UseTypeDef i2sUsed)
	Full-Duplex IT handler receive function.
static HAL_StatusTypeDef	I2SEx_FullDuplexWaitFlagStateUntilTimeout (I2S_HandleTypeDef *hi2s, uint32_t Flag, uint32_t State, uint32_t Timeout, I2S_UseTypeDef i2sUsed)
	This function handles I2S Communication Timeout.
HAL_StatusTypeDef	HAL_I2SEx_TransmitReceive (I2S_HandleTypeDef hi2s, uint16_t pTxData, uint16_t *pRxData, uint16_t Size, uint32_t Timeout)
	Full-Duplex Transmit/Receive data in blocking mode.
HAL_StatusTypeDef	HAL_I2SEx_TransmitReceive_IT (I2S_HandleTypeDef hi2s, uint16_t pTxData, uint16_t *pRxData, uint16_t Size)
	Full-Duplex Transmit/Receive data in non-blocking mode using Interrupt.
HAL_StatusTypeDef	HAL_I2SEx_TransmitReceive_DMA (I2S_HandleTypeDef hi2s, uint16_t pTxData, uint16_t *pRxData, uint16_t Size)
	Full-Duplex Transmit/Receive data in non-blocking mode using DMA.
void	HAL_I2SEx_FullDuplex_IRQHandler (I2S_HandleTypeDef *hi2s)
	This function handles I2S/I2Sext interrupt requests in full-duplex mode.
__weak void	HAL_I2SEx_TxRxHalfCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx and Rx Transfer half completed callback.
__weak void	HAL_I2SEx_TxRxCpltCallback (I2S_HandleTypeDef *hi2s)
	Tx and Rx Transfer completed callback.

Detailed Description

I2S HAL module driver. This file provides firmware functions to manage the following functionalities of I2S extension peripheral: + Extension features Functions.

Author:

MCD Application Team

  ==============================================================================
                    ##### I2S Extension features #####
  ==============================================================================
  [..]
     (#) In I2S full duplex mode, each SPI peripheral is able to manage sending and receiving
         data simultaneously using two data lines. Each SPI peripheral has an extended block
         called I2Sxext (i.e I2S2ext for SPI2 and I2S3ext for SPI3).
     (#) The extension block is not a full SPI IP, it is used only as I2S slave to
         implement full duplex mode. The extension block uses the same clock sources
         as its master.

     (#) Both I2Sx and I2Sx_ext can be configured as transmitters or receivers.

     [..]
       (@) Only I2Sx can deliver SCK and WS to I2Sx_ext in full duplex mode, where
         I2Sx can be I2S2 or I2S3.

                  ##### How to use this driver #####
 ===============================================================================
 [..]
   Three operation modes are available within this driver :

   *** Polling mode IO operation ***
   =================================
   [..]
     (+) Send and receive in the same time an amount of data in blocking mode using HAL_I2SEx_TransmitReceive()

   *** Interrupt mode IO operation ***
   ===================================
   [..]
     (+) Send and receive in the same time an amount of data in non blocking mode using HAL_I2SEx_TransmitReceive_IT()
     (+) At transmission/reception end of transfer HAL_I2SEx_TxRxCpltCallback is executed and user can
         add his own code by customization of function pointer HAL_I2SEx_TxRxCpltCallback
     (+) 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 and receive an amount of data in non blocking mode (DMA) using HAL_I2SEx_TransmitReceive_DMA()
     (+) At transmission/reception end of transfer HAL_I2SEx_TxRxCpltCallback is executed and user can
         add his own code by customization of function pointer HAL_I2S_TxRxCpltCallback
     (+) 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

Additional Figure: The Extended block uses the same clock sources as its master.

+-----------------------+ I2Sx_SCK | | ----------+-->| I2Sx |------------------->I2Sx_SD(in/out) +--|-->| | | | +-----------------------+ | | I2S_WS | | ------>| | | | +-----------------------+ | +-->| | | | I2Sx_ext |------------------->I2Sx_extSD(in/out) +----->| | +-----------------------+

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_i2s_ex.c.

Enumerations

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics