/**
@page I2S_DataExchangeInterrupt I2S Interrupt example
@verbatim
******************************************************************************
* @file I2S/I2S_DataExchangeInterrupt/readme.txt
* @author MCD Application Team
* @brief Description of the I2S Interrupt example.
******************************************************************************
* @attention
*
* Copyright (c) 2016 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim
@par Example Description
This example provides a description of how to set a communication between two
SPIs in I2S mode using interrupts and performing a transfer from Master to Slave.
*------------------------------------------------------------------------------*
| BOARD A BOARD B |
| ____________________ ____________________ |
| | | | | |
| | | | | |
| | __________ | | __________ | |
| | |SPI Master|____|_______SD________|____|SPI Slave | | |
| | | Device |____|_______WS________|____| Device | | |
| | |__________|____|_______CK________|____|__________| | |
| | | | | |
| | | | O LD1 | |
| | Tamper | | O LD2 | |
| | _ | | O LD3 | |
| | |_| | | | |
| | | | | |
| | GND O--|-----------------|--O GND | |
| |____________________| |____________________| |
| |
| |
*------------------------------------------------------------------------------*
At the beginning of the main program the HAL_Init() function is called to reset
all the peripherals, initialize the Flash interface and the systick.
Then the SystemClock_Config() function is used to configure the system
clock (SYSCLK) to run at 216 MHz.
The I2S peripheral configuration is ensured by the HAL_I2S_Init() function.
This later is calling the HAL_I2S_MspInit()function which core is implementing
the configuration of the needed SPI resources according to the used hardware (CLOCK,
GPIO and NVIC). You may update this function to change I2S configuration.
The I2S communication is then initiated.
The HAL_I2S_Transmit_IT() function allows the transmission of a predefined data buffer
and HAL_I2S_Receive_IT() function allows the reception.
The user can choose between Master and Slave through "#define I2S_MASTER_TRANSMITTER"
in the "main.c" file.
If the Master board is used, the "#define I2S_MASTER_TRANSMITTER" must be uncommented.
If the Slave board is used the "#define I2S_MASTER_TRANSMITTER" must be commented.
For this example the I2S_Buffer_Tx is predefined and the I2S_Buffer_Rx size is same as I2S_Buffer_Tx.
In master board, I2S peripheral is configured as Master Transmitter with Interrupt,
whereas in Slave board, I2S peripheral is configured as Slave Receiver with Interrupt.
The both devices are in Philips standard configuration with 16bit and 48KHz audio frequency.
When the user press on the Tamper Button on the Master Board, the master transmitter
start sending data stored in the I2S_Buffer_Tx buffer while the Slave Board receives
data I2S_Buffer_Rx buffer.
Once the transfer is completed a comparison is done and TransferStatus gives the
data transfer status.
STM32 board's LEDs can be used to monitor the transfer status:
- LED1 turned OFF waiting User push-button to be pressed on master board.
- LED1 turns ON if transmission/reception is complete and OK.
- LED3 turns ON if error is generated.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application need to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
Audio, I2S, Data Exchange, Interrupt, Philips Standard, Master, Slave
@Note<74>If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
<20><><A0><A0><A0>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
<0A><><A0><A0><A0><A0>The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).
@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
<0A><><A0><A0><A0> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
<0A><><A0><A0><A0><A0>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
<0A><><A0><A0><A0><A0>Even though the user must manage the cache coherence for read accesses.
<0A><><A0><A0><A0><A0>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
<0A><><A0><A0><A0><A0>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
@par Directory contents
- I2S/I2S_DataExchangeInterrupt/Inc/stm32f7xx_hal_conf.h HAL configuration file
- I2S/I2S_DataExchangeInterrupt/Inc/stm32f7xx_it.h Interrupt handlers header file
- I2S/I2S_DataExchangeInterrupt/Inc/stm32f7xx.h Header for main.c module
- I2S/I2S_DataExchangeInterrupt/Src/stm32f7xx_it.c Interrupt handlers
- I2S/I2S_DataExchangeInterrupt/Src/main.c Main program
- I2S/I2S_DataExchangeInterrupt/Src/system_stm32f7xx.c STM32F7xx system source file
@par Hardware and Software environment
- This example runs on STM32F767ZI devices.
- This example has been tested with STMicroelectronics STM32F767ZI-Nucleo board and can be
easily tailored to any other supported device and development board.
- STM32F767ZI-Nucleo Set-up
- Connect Master board PA5(CN7.Pin10) to Slave Board PA5(CN7.Pin10)
- Connect Master board PA7(CN7.Pin14) to Slave Board PA7(CN7.Pin14)
- Connect Master board PA4(CN7.Pin17) to Slave Board PA4(CN7.Pin17)
- Connect Master board GND to Slave Board GND
- The connection between the pins should use a short wires.
@par How to use it ?
In order to make the program work, you must do the following :
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example
*/
767d083e20