mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-05-01 22:17:30 +08:00
/**
@page I2C_TwoBoards_AdvComIT I2C Two Boards Advanced Communication IT example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file I2C/I2C_TwoBoards_AdvComIT/readme.txt
* @author MCD Application Team
* @brief Description of the I2C Two Boards Advanced Communication with
* Interrupt example.
******************************************************************************
*
* 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.
*
******************************************************************************
@endverbatim
@par Example Description
How to handle I2C data buffer transmission/reception between two boards,
using an interrupt.
_________________________ _________________________
| ______________| |______________ |
| | I2C3 | | I2C3| |
| | | | | |
| | SCL(PA8)|______________________|(PA8)SCL | |
| | | | | |
| | | | | |
| | | | | |
| | SDA(PC9)|______________________|(PC9)SDA | |
| | | | | |
| |______________| |______________| |
| __ | | __ |
| |__| | | |__| |
| USER | | USER |
| GND|______________________|GND |
|_STM32F4 ________________| |_________________STM32F4_|
This example guides you through the different configuration steps by mean of HAL API
to ensure I2C Data buffer transmission and reception using Interrupt.
The communication is done with 2 Boards through I2C and using the following I2C features:
- 7-bit addressing mode
- Fast speed mode (400KHz)
- Interrupting capability
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 180 MHz.
The I2C peripheral configuration is ensured by the HAL_I2C_Init() function.
This later is calling the HAL_I2C_MspInit()function which implements
the configuration of the needed I2C resources according to the used hardware (CLOCK,
GPIO and NVIC). You may update this function to change I2C configuration.
The I2C communication is then initiated.
The project is splitted in two parts the Master Board and the Slave Board
- Master Board
The HAL_I2C_Master_Receive_IT() and the HAL_I2C_Master_Transmit_IT() functions
allow respectively the reception and the transmission of a predefined data buffer
in Master mode using interrupt.
- Slave Board
The HAL_I2C_Slave_Receive_IT() and the HAL_I2C_Slave_Transmit_IT() functions
allow respectively the reception and the transmission of a predefined data buffer
in Slave mode using interrupt.
The user can choose between Master and Slave through "#define MASTER_BOARD"
in the "main.c" file:
- Uncomment "#define MASTER_BOARD" to select Master board.
- Comment "#define MASTER_BOARD" to select Slave board.
For this example two buffers are used
- aTxBuffer buffer is used to save the data to be transmitted
- aRxBuffer buffer is used to save the received data
Note that the two buffers have the same size
In Master board side:
- Wait user button to be pressed (used for only synchronization at startup)
- Requests write operation by sending specific command "MASTER_REQ_WRITE" to Slave
- Sends the number of data to be written
- Transmits aTxBuffer buffer to slave
- Requests read operation by sending specific command "MASTER_REQ_READ" to Slave
- Sends the number of data to be read
- Receives data from Slave in aRxBuffer
- Checks the correctness of data and Toggle LED3 when data is received correctly occurs
otherwise it turns ON LED5 and communication is stopped (using infinite loop)
In Slave board side:
- Receives request from Master
- Receives the request operation from Master and depending on the operation type (write or read):
- If Master requests write operation:
- Receives number of data to be written by Master
- Receives data from master in aRxBuffer
- Checks the correctness of data and Toggle LED3 when data is received correctly
otherwise it turns ON LED4 and communication is stopped (using infinite loop)
- If Master requests read operation:
- Receives number of data to be written to Master
- Transmits aTxBuffer buffer to master
These operations are repeated periodically and the start of communication is triggered
by pushing the user button of the Master board.
@note In Master side, only Acknowledge failure error is handled. When this error
occurs Master restart the current operation until Slave acknowledges it's
address.
@note I2Cx instance used and associated resources can be updated in "main.h"
file depending hardware configuration used.
@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 needs to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Directory contents
- I2C/I2C_TwoBoards_AdvComIT/Inc/stm32f4xx_hal_conf.h HAL configuration file
- I2C/I2C_TwoBoards_AdvComIT/Inc/stm32f4xx_it.h I2C interrupt handlers header file
- I2C/I2C_TwoBoards_AdvComIT/Inc/main.h Main program header file
- I2C/I2C_TwoBoards_AdvComIT/Src/stm32f4xx_it.c I2C interrupt handlers
- I2C/I2C_TwoBoards_AdvComIT/Src/main.c Main program
- I2C/I2C_TwoBoards_AdvComIT/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
- I2C/I2C_TwoBoards_AdvComIT/Src/stm32f4xx_hal_msp.c HAL MSP module
@par Hardware and Software environment
- This example runs on STM32F429xx devices.
- This example has been tested with STMicroelectronics STM32F429I-Discovery RevC
boards and can be easily tailored to any other supported device
and development board.
- STM32F429I-Discovery RevC Set-up
- Connect Master board PA8 to Slave Board PA8
- Connect Master board PC9 to Slave Board PC9
- Connect Master board GND to Slave Board GND
@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
o Uncomment "#define MASTER_BOARD" and load the project in Master Board
o Comment "#define MASTER_BOARD" and load the project in Slave Board
- Run the example
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
*/