stm32f769i_discovery_eeprom.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f769i_discovery_eeprom.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for 
00006   *          the stm32f769i_discovery_eeprom.c firmware driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F769I_DISCOVERY_EEPROM_H
00039 #define __STM32F769I_DISCOVERY_EEPROM_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32f769i_discovery.h"
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051   
00052 /** @addtogroup STM32F769I_DISCOVERY
00053   * @{
00054   */ 
00055   
00056 /** @addtogroup STM32F769I_DISCOVERY_EEPROM
00057   * @brief This file includes the I2C EEPROM driver of STM32F769I-DISCOVERY board.
00058   * @{
00059   */
00060 
00061 /** @defgroup STM32F769I_DISCOVERY_EEPROM_Exported_Types  EEPROM Exported Types
00062   * @{
00063   */ 
00064 /**
00065   * @}
00066   */
00067   
00068 /** @defgroup STM32F769I_DISCOVERY_EEPROM_Exported_Constants 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 
00076 /* Maximum number of trials for EEPROM_WaitEepromStandbyState() function */
00077 #define EEPROM_MAX_TRIALS           ((uint32_t)3000)
00078       
00079 #define EEPROM_OK                   ((uint32_t)0)
00080 #define EEPROM_FAIL                 ((uint32_t)1)
00081 #define EEPROM_TIMEOUT              ((uint32_t)2)
00082 /**
00083   * @}
00084   */ 
00085   
00086 /** @defgroup STM32F769I_DISCOVERY_EEPROM_Exported_Macros EEPROM Exported Macros
00087   * @{
00088   */    
00089 /**
00090   * @}
00091   */ 
00092 
00093 /** @defgroup STM32F769I_DISCOVERY_EEPROM_Exported_Functions EEPROM Exported Functions
00094   * @{
00095   */ 
00096 uint32_t BSP_EEPROM_Init(void);
00097 uint8_t  BSP_EEPROM_DeInit(void);
00098 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
00099 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
00100 uint32_t BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
00101 uint32_t BSP_EEPROM_WaitEepromStandbyState(void);
00102 
00103 /* USER Callbacks: This function is declared as __weak in EEPROM driver and 
00104    should be implemented into user application.  
00105    BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition 
00106    occurs during communication (waiting on an event that doesn't occur, bus
00107    errors, busy devices ...). */
00108 void     BSP_EEPROM_TIMEOUT_UserCallback(void);
00109 
00110 /* Link function for I2C EEPROM peripheral */
00111 void              EEPROM_IO_Init(void);
00112 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00113 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00114 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
00115 
00116 /**
00117   * @}
00118   */
00119 
00120 /**
00121   * @}
00122   */
00123 
00124 /**
00125   * @}
00126   */
00127 
00128 /**
00129   * @}
00130   */ 
00131 
00132 #ifdef __cplusplus
00133 }
00134 #endif
00135 
00136 #endif /* __STM32F769I_DISCOVERY_EEPROM_H */
00137 
00138 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/