STM CMSIS
stm32f4xx_hal_i2s_ex.c File Reference

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

#include "stm32f4xx_hal.h"

Detailed Description

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

Author
MCD Application Team
Version
V1.5.0
Date
06-May-2016
  • Extension features Functions
 ==============================================================================
                   ##### 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_I2S_TransmitReceive() 
  
  *** Interrupt mode IO operation ***    
  ===================================
  [..]    
    (+) Send and receive in the same time an amount of data in non blocking mode using HAL_I2S_TransmitReceive_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
    (+) 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 and receive an amount of data in non blocking mode (DMA) using HAL_I2S_TransmitReceive_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
    (+) 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()
Attention

© COPYRIGHT(c) 2016 STMicroelectronics

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.