STM324x9I_EVAL BSP User Manual: stm324x9i_eval_eeprom.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm324x9i_eval_eeprom.h
00004   * @author  MCD Application Team
00005   * @version V2.2.2
00006   * @date    13-January-2016
00007   * @brief   This file contains all the functions prototypes for 
00008   *          the stm324x9i_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 __STM32F4x9I_EVAL_EEPROM_H
00041 #define __STM32F4x9I_EVAL_EEPROM_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm324x9i_eval.h"
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */
00053   
00054 /** @addtogroup STM324x9I_EVAL
00055   * @{
00056   */ 
00057   
00058 /** @addtogroup STM324x9I_EVAL_EEPROM
00059   * @brief This file includes the I2C EEPROM driver of STM324x9I-EVAL evaluation board.
00060   * @{
00061   */
00062 
00063 /** @defgroup STM324x9I_EVAL_EEPROM_Exported_Types STM324x9I EVAL EEPROM Exported Types
00064   * @{
00065   */ 
00066 /**
00067   * @}
00068   */
00069   
00070 /** @defgroup STM324x9I_EVAL_EEPROM_Exported_Constants STM324x9I EVAL EEPROM Exported Constants
00071   * @{
00072   */
00073 /* EEPROM hardware address and page size */ 
00074 #define EEPROM_PAGESIZE             4
00075 #define EEPROM_MAX_SIZE             0x2000 /* 64Kbit */
00076                                 
00077 /* Maximum Timeout values for flags and events waiting loops. 
00078 This timeout is based on systick set to 1ms*/   
00079 /* Timeout for read based if read all the EEPROM : EEPROM_MAX_SIZE * BSP_I2C_SPEED (640ms) */
00080 #define EEPROM_READ_TIMEOUT         ((uint32_t)(1000))
00081 /* Timeout for write based on max write which is EEPROM_PAGESIZE bytes: EEPROM_PAGESIZE * BSP_I2C_SPEED (320us) */
00082 #define EEPROM_WRITE_TIMEOUT         ((uint32_t)(10))
00083 
00084 /* Maximum number of trials for EEPROM_WaitEepromStandbyState() function */
00085 #define EEPROM_MAX_TRIALS           3000
00086       
00087 #define EEPROM_OK                   0
00088 #define EEPROM_FAIL                 1
00089 #define EEPROM_TIMEOUT              2
00090 /**
00091   * @}
00092   */ 
00093   
00094 /** @defgroup STM324x9I_EVAL_EEPROM_Exported_Macros STM324x9I EVAL EEPROM Exported Macros
00095   * @{
00096   */    
00097 /**
00098   * @}
00099   */ 
00100 
00101 /** @defgroup STM324x9I_EVAL_EEPROM_Exported_Functions STM324x9I EVAL EEPROM Exported Functions
00102   * @{
00103   */ 
00104 uint32_t BSP_EEPROM_Init(void);
00105 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
00106 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
00107 uint32_t BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
00108 uint32_t BSP_EEPROM_WaitEepromStandbyState(void);
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    occurs during communication (waiting on an event that doesn't occur, bus 
00114    errors, busy devices ...). */
00115 void     BSP_EEPROM_TIMEOUT_UserCallback(void);
00116 
00117 /* Link function for I2C EEPROM peripheral */
00118 void              EEPROM_IO_Init(void);
00119 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00120 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
00121 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
00122 
00123 /**
00124   * @}
00125   */
00126 
00127 /**
00128   * @}
00129   */
00130 
00131 /**
00132   * @}
00133   */
00134 
00135 /**
00136   * @}
00137   */ 
00138 
00139 #ifdef __cplusplus
00140 }
00141 #endif
00142 
00143 #endif /* __STM324x9I_EVAL_EEPROM_H */
00144 
00145 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/