STM32091C_EVAL BSP User Manual: stm32091c_eval_eeprom.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32091c_eval_eeprom.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for 
00006   *          the stm32091c_eval_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 __STM32091C_EVAL_EEPROM_H
00039 #define __STM32091C_EVAL_EEPROM_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32091c_eval.h"
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051 
00052 /** @addtogroup STM32091C_EVAL
00053   * @{
00054   */
00055 
00056 /** @defgroup STM32091C_EVAL_EEPROM STM32091C-EVAL EEPROM
00057   * @{
00058   */
00059 
00060 /** @defgroup STM32091C_EVAL_EEPROM_Private_Variables Private Variables
00061   * @{
00062   */ 
00063 /**
00064   * @}
00065   */ 
00066   
00067 /** @defgroup STM32091C_EVAL_EEPROM_Exported_Types Exported Types
00068   * @{
00069   */ 
00070 typedef struct
00071 {
00072   uint32_t  (*Init)(void);
00073   uint32_t  (*ReadBuffer)(uint8_t* , uint16_t , uint32_t* );
00074   uint32_t  (*WritePage)(uint8_t* , uint16_t , uint32_t* );
00075 }EEPROM_DrvTypeDef;
00076 /**
00077   * @}
00078   */
00079 
00080 /** @defgroup STM32091C_EVAL_EEPROM_Exported_Constants Exported Constants
00081   * @{
00082   */
00083 /* EEPROMs hardware address and page size */ 
00084 #define EEPROM_ADDRESS_M24LR64_A01      0xA0    /* RF EEPROM ANT7-M24LR-A01 used */
00085 #define EEPROM_ADDRESS_M24LR64_A02      0xA6    /* RF EEPROM ANT7-M24LR-A02 used */
00086 
00087 #define EEPROM_PAGESIZE_M24LR64         4       /* RF EEPROM ANT7-M24LR-A used */
00088       
00089 /* EEPROM BSP return values */
00090 #define EEPROM_OK                       0
00091 #define EEPROM_FAIL                     1   
00092 #define EEPROM_TIMEOUT                  2   
00093  
00094 /* EEPROM BSP devices definition list supported */
00095 #define BSP_EEPROM_M24LR64              1       /* RF I2C EEPROM M24LR64 */
00096 
00097 /* Maximum number of trials for EEPROM_I2C_WaitEepromStandbyState() function */
00098 #define EEPROM_MAX_TRIALS               300
00099 /**
00100   * @}
00101   */
00102 
00103 /** @defgroup STM32091C_EVAL_EEPROM_Exported_Functions Exported Functions
00104   * @{
00105   */
00106 uint32_t          BSP_EEPROM_Init(void);
00107 uint32_t          BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint32_t* NumByteToRead);
00108 uint32_t          BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint32_t NumByteToWrite);
00109 
00110 /* USER Callbacks: This function is declared as __weak in EEPROM driver and 
00111    should be implemented into user application.  
00112    BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition 
00113    occure during communication (waiting on an event that doesn't occur, bus 
00114    errors, busy devices ...). */
00115 void              BSP_EEPROM_TIMEOUT_UserCallback(void);
00116 
00117 
00118 /* Link functions for I2C EEPROM peripheral */
00119 void              EEPROM_IO_Init(void);
00120 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t* pBuffer, uint32_t BufferSize);
00121 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t* pBuffer, uint32_t BufferSize);
00122 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
00123 
00124 /**
00125   * @}
00126   */
00127 
00128 /** @defgroup STM32091C_EVAL_EEPROM_Private_Functions Private Functions
00129   * @{
00130   */
00131 /**
00132   * @}
00133   */  
00134 
00135 /**
00136   * @}
00137   */
00138 
00139 /**
00140   * @}
00141   */
00142 
00143 /**
00144   * @}
00145   */
00146 
00147 #ifdef __cplusplus
00148 }
00149 #endif
00150 
00151 #endif /* __STM32091C_EVAL_EEPROM_H */
00152 
00153 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/