ref: a8d8a94bfac9a6dfcbbfb463f62444f968637d5a
dir: /demos/stm32f429_disco/stm/stm32f429/stm32f429i_discovery_i2c_ee.h/
/**
******************************************************************************
* @file stm32f429i_discovery_i2c_ee.h
* @author MCD Application Team
* @version V1.0.1
* @date 28-October-2013
* @brief This file contains all the functions prototypes for
* the stm32f429i_discovery_i2c_ee.c firmware driver.
******************************************************************************
* @attention
*
* <h2><center>© COPYRIGHT 2013 STMicroelectronics</center></h2>
*
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
* You may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.st.com/software_license_agreement_liberty_v2
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F429I_DISCOVERY_I2C_EE_H
#define __STM32F429I_DISCOVERY_I2C_EE_H
#ifdef __cplusplus
extern "C" {
#endif
/* Includes ------------------------------------------------------------------*/
#include "stm32f429i_discovery.h"
/** @addtogroup Utilities
* @{
*/
/** @addtogroup STM32F4_DISCOVERY
* @{
*/
/** @addtogroup STM32F429I_DISCOVERY
* @{
*/
/** @addtogroup STM32F429I_DISCOVERY_I2C_EE
* @{
*/
/** @defgroup STM32F429I_DISCOVERY_I2C_EE_Exported_Types
* @{
*/
/**
* @}
*/
/** @defgroup STM32F429I_DISCOVERY_I2C_EE_Exported_Constants
* @{
*/
/* Uncomment the following line to use the default sEE_TIMEOUT_UserCallback()
function implemented in stm32f429i_discovery_i2c_ee.c file.
sEE_TIMEOUT_UserCallback() function is called whenever a timeout condition
occure during communication (waiting on an event that doesn't occur, bus
errors, busy devices ...). */
// #define USE_DEFAULT_TIMEOUT_CALLBACK
/* EEPROM hardware address and page size */
#define sEE_HW_ADDRESS 0xA0
#define sEE_PAGESIZE 4
/* Maximum Timeout values for flags and events waiting loops. These timeouts are
not based on accurate values, they just guarantee that the application will
not remain stuck if the I2C communication is corrupted.
You may modify these timeout values depending on CPU frequency and application
conditions (interrupts routines ...). */
#define sEE_FLAG_TIMEOUT ((uint32_t)0x1000)
#define sEE_LONG_TIMEOUT ((uint32_t)(10 * sEE_FLAG_TIMEOUT))
/* Maximum number of trials for sEE_WaitEepromStandbyState() function */
#define sEE_MAX_TRIALS_NUMBER 300
#define sEE_OK 0
#define sEE_FAIL 1
#define USE_DEFAULT_TIMEOUT_CALLBACK
/**
* @}
*/
/** @defgroup STM32F429I_DISCOVERY_I2C_EE_Exported_Macros
* @{
*/
/**
* @}
*/
/** @defgroup STM32F429I_DISCOVERY_I2C_EE_Exported_Functions
* @{
*/
void sEE_DeInit(void);
void sEE_Init(void);
uint32_t sEE_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
uint32_t sEE_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
void sEE_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
uint32_t sEE_WaitEepromStandbyState(void);
void sEE_I2C_DMA_TX_IRQHandler(void);
void sEE_I2C_DMA_RX_IRQHandler(void);
/* USER Callbacks: These are functions for which prototypes only are declared in
EEPROM driver and that should be implemented into user applicaiton. */
/* sEE_TIMEOUT_UserCallback() function is called whenever a timeout condition
occure during communication (waiting on an event that doesn't occur, bus
errors, busy devices ...).
You can use the default timeout callback implementation by uncommenting the
define USE_DEFAULT_TIMEOUT_CALLBACK in stm32f429i_discovery_i2c_ee.h file.
Typically the user implementation of this callback should reset I2C peripheral
and re-initialize communication or in worst case reset all the application. */
uint32_t sEE_TIMEOUT_UserCallback(void);
#ifdef __cplusplus
}
#endif
#endif /* __STM32F429I_DISCOVERY_I2C_EE_H */
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/