STM32L073Z_EVAL BSP User Manual: stm32l073z_eval_eeprom.h Source File

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