/******************** (C) COPYRIGHT 2009 STMicroelectronics ********************
* File Name          : readme.txt
* Author             : MCD Application Team
* Version            : V2.0.0
* Date               : 02/28/2009
* Description        : Description of the STM32 I2C Software using Polling, DMA 
*                      and IT.
********************************************************************************
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
* AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
* INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
* CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
* INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*******************************************************************************/

Description
===================
This software allows the STM32 I2C to operate in one of the following modes:

 Master Transmitter using DMA
 Master Receiver using DMA
 Slave Transmitter using DMA
 Slave Receiver using DMA
 Master Transmitter using IT
 Master Receiver using IT
 Slave Receiver using IT
 Slave transmitter using IT
 Master Transmitter using polling
 Master Receiver using polling

If the user wants to perform an I2C communication between two boards based on the STM32, 
he just have to compile the project for slave  and then for master (uncomment the 
corresponding define in driver.h).
The master transmits/receives a buffer of bytes (with prefixed  size by the user, 6 as example) 
into/from the slave.




Directory contents
==================
 + \include    contains the header files.
 + \source     contains the source files.
 + \project    contains pre-configured projects for RVMDK and EWARM5 toolchains.

Hardware environment
====================
This software runs on  STMicroelectronics STM32-EVAL evaluation boards and can be 
easily tailored to any other hardware.

 + Connect I2C1 SCL pin (PB.06) of the Master Board to I2C2 SCL pin (PB.10) of the Slave Board.
 + Connect I2C1 SDA pin (PB.07) of the Master Board to I2C2 SDA pin (PB.11) of the Slave Board.
 - Check that a pull-up resistor is connected on one I2C SDA pin
 - Check that a pull-up resistor is connected on one I2C SCL pin

 

How to use it
=============
In order to make the program work, you must do the following:

1. Load the Master code in the Master Board (see below)
2. Load the Slave code in the Slave Board (see below)
3. Run program in Slave Board
4. Run program in Master Board



In order to load the code, you have do the following:

 + EWARMv5:
    - Open the .eww workspace
    - Rebuild all files: Project->Rebuild all
    - Load the image into the Flash memory
    - Load project image: Project->Debug
    - Run program: Debug->Go(F5)

 + RVMDK
    - Open the .Uv2 project    
    - Load project image: Debug->Start/Stop Debug Session
    - Run program: Debug->Run (F5)   

******************* (C) COPYRIGHT 2009 STMicroelectronics *****END OF FILE****
