STM32L476G_EVAL BSP User Manual: stm32l476g_eval_eeprom.h Source File

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