STM32F072B-Discovery BSP User Manual: stm32f072b_discovery_eeprom.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f072b_discovery_eeprom.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for 
00006   *          the stm32072b_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 __STM32072B_DISCOVERY_EEPROM_H
00039 #define __STM32072B_DISCOVERY_EEPROM_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32f072b_discovery.h"
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051 
00052 /** @addtogroup STM32F072B_DISCOVERY
00053   * @{
00054   */
00055 
00056 /** @defgroup STM32F072B_DISCOVERY_EEPROM STM32F072B_DISCOVERY EEPROM
00057   * @{
00058   */  
00059 
00060 /** @defgroup STM32F072B_DISCOVERY_EEPROM_Exported_Constants Exported Constants
00061   * @{
00062   */
00063   
00064 /* EEPROM hardware address and page size */ 
00065 #define EEPROM_PAGESIZE             4
00066 #define EEPROM_MAX_SIZE             0x2000 /* 64Kbit*/
00067                                 
00068 /* Maximum Timeout values for flags and events waiting loops. 
00069 This timeout is based on systick set to 1ms*/   
00070 #define EEPROM_LONG_TIMEOUT         ((uint32_t)(1000))
00071 
00072 /* Maximum number of trials for EEPROM_WaitEepromStandbyState() function */
00073 #define EEPROM_MAX_TRIALS_NUMBER     300
00074       
00075 #define EEPROM_OK                    0
00076 #define EEPROM_FAIL                  1
00077 #define EEPROM_TIMEOUT               2
00078 
00079 /**
00080   * @}
00081   */ 
00082 
00083 /** @defgroup STM32F072B_DISCOVERY_EEPROM_Exported_Functions Exported Functions
00084   * @{
00085   */ 
00086 uint32_t          BSP_EEPROM_Init(void);
00087 uint32_t          BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
00088 uint32_t          BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
00089 uint32_t          BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
00090 uint32_t          BSP_EEPROM_WaitEepromStandbyState(void);
00091 
00092 /* USER Callbacks: This function is declared as __weak in EEPROM driver and 
00093    should be implemented into user application.  
00094    BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition 
00095    occure during communication (waiting on an event that doesn't occur, bus 
00096    errors, busy devices ...). */
00097 __weak uint32_t   BSP_EEPROM_TIMEOUT_UserCallback(void);
00098 
00099 /* Link function for I2C EEPROM peripheral */
00100 void              EEPROM_IO_Init(void);
00101 uint32_t          EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint32_t pBuffer, uint32_t BufferSize);
00102 uint32_t          EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint32_t pBuffer, uint32_t BufferSize);
00103 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
00104 
00105 /**
00106   * @}
00107   */ 
00108 
00109 /**
00110   * @}
00111   */
00112 
00113 /**
00114   * @}
00115   */
00116 
00117 /**
00118   * @}
00119   */ 
00120 
00121 #ifdef __cplusplus
00122 }
00123 #endif
00124 
00125 #endif /* __STM32072B_DISCOVERY_EEPROM_H */
00126 
00127 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/