stm32469i_discovery_eeprom.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32469i_discovery_eeprom.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for
00006   *          the stm32469i_discovery_eeprom.c firmware driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32F469I_DISCOVERY_EEPROM_H
00039 #define __STM32F469I_DISCOVERY_EEPROM_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32469i_discovery.h"
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051 
00052 /** @addtogroup STM32469I_Discovery
00053   * @{
00054   */
00055 
00056 /** @addtogroup STM32469I-Discovery_EEPROM
00057   * @brief This file includes the I2C EEPROM driver of STM32469I-Discovery board.
00058   * @{
00059   */
00060 
00061 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Types STM32469I Discovery EEPROM Exported Types
00062   * @{
00063   */
00064 /**
00065   * @}
00066   */
00067 
00068 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Constants STM32469I Discovery EEPROM Exported Constants
00069   * @{
00070   */
00071 /* EEPROM hardware address and page size */
00072 #define EEPROM_PAGESIZE             ((uint8_t)4)
00073 #define EEPROM_MAX_SIZE             ((uint16_t)0x2000) /* 64Kbit */
00074 
00075 /* Maximum Timeout values for flags and events waiting loops.
00076 This timeout is based on systick set to 1ms*/
00077 /* Timeout for read based if read all the EEPROM : EEPROM_MAX_SIZE * I2C_SPEED (640ms) */
00078 #define EEPROM_READ_TIMEOUT         ((uint32_t)(1000))
00079 /* Timeout for write based on max write which is EEPROM_PAGESIZE bytes: EEPROM_PAGESIZE * I2C_SPEED (320us) */
00080 #define EEPROM_WRITE_TIMEOUT         ((uint32_t)(10))
00081 
00082 /* Maximum number of trials for EEPROM_WaitEepromStandbyState() function */
00083 #define EEPROM_MAX_TRIALS           3000
00084 
00085 #define EEPROM_OK                   0
00086 #define EEPROM_FAIL                 1
00087 #define EEPROM_TIMEOUT              2
00088 /**
00089   * @}
00090   */
00091 
00092 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Macros STM32469I Discovery EEPROM Exported Macros
00093   * @{
00094   */
00095 /**
00096   * @}
00097   */
00098 
00099 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Functions STM32469I Discovery EEPROM Exported Functions
00100   * @{
00101   */
00102 uint32_t BSP_EEPROM_Init(void);
00103 uint8_t  BSP_EEPROM_DeInit(void);
00104 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
00105 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
00106 uint32_t BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
00107 uint32_t BSP_EEPROM_WaitEepromStandbyState(void);
00108 
00109 /* USER Callbacks: This function is declared as __weak in EEPROM driver and
00110    should be implemented into user application.
00111    BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition
00112    occure during communication (waiting on an event that doesn't occur, bus
00113    errors, busy devices ...). */
00114 void     BSP_EEPROM_TIMEOUT_UserCallback(void);
00115 
00116 /* Link function for I2C EEPROM peripheral */
00117 void              EEPROM_IO_Init(void);
00118 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00119 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00120 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
00121 
00122 /**
00123   * @}
00124   */
00125 
00126 /**
00127   * @}
00128   */
00129 
00130 /**
00131   * @}
00132   */
00133 
00134 /**
00135   * @}
00136   */
00137 
00138 #ifdef __cplusplus
00139 }
00140 #endif
00141 
00142 #endif /* __STM32F469I_DISCOVERY_EEPROM_H */
00143 
00144 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/