STM32L4R9I_EVAL BSP User Manual
|
stm32l4r9i_eval_eeprom.h
Go to the documentation of this file.
00001 /** 00002 ****************************************************************************** 00003 * @file stm32l4r9i_eval_eeprom.h 00004 * @author MCD Application Team 00005 * @brief This file contains all the functions prototypes for 00006 * the stm32l4r9i_eval_eeprom.c firmware driver. 00007 ****************************************************************************** 00008 * @attention 00009 * 00010 * <h2><center>© COPYRIGHT(c) 2017 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 __STM32L4R9I_EVAL_EEPROM_H 00039 #define __STM32L4R9I_EVAL_EEPROM_H 00040 00041 #ifdef __cplusplus 00042 extern "C" { 00043 #endif 00044 00045 /* Includes ------------------------------------------------------------------*/ 00046 #include "stm32l4r9i_eval.h" 00047 00048 /** @addtogroup BSP 00049 * @{ 00050 */ 00051 00052 /** @addtogroup STM32L4R9I_EVAL 00053 * @{ 00054 */ 00055 00056 /** @addtogroup STM32L4R9I_EVAL_EEPROM 00057 * @brief This file includes the I2C EEPROM driver of STM32L4R9I_EVAL evaluation board. 00058 * @{ 00059 */ 00060 00061 /** @defgroup STM32L4R9I_EVAL_EEPROM_Exported_Constants Exported Constants 00062 * @{ 00063 */ 00064 /* EEPROM hardware address and page size */ 00065 #define EEPROM_PAGESIZE ((uint8_t)4) 00066 #define EEPROM_MAX_SIZE ((uint16_t)0x2000) /* 64Kbit */ 00067 00068 00069 /* Maximum number of trials for BSP_EEPROM_WaitEepromStandbyState() function */ 00070 #define EEPROM_MAX_TRIALS ((uint32_t)3000) 00071 00072 #define EEPROM_OK ((uint32_t)0) 00073 #define EEPROM_FAIL ((uint32_t)1) 00074 #define EEPROM_TIMEOUT ((uint32_t)2) 00075 /** 00076 * @} 00077 */ 00078 00079 /** @defgroup STM32L4R9I_EVAL_EEPROM_Exported_Functions Exported Functions 00080 * @{ 00081 */ 00082 uint32_t BSP_EEPROM_Init(void); 00083 uint8_t BSP_EEPROM_DeInit(void); 00084 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead); 00085 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite); 00086 uint32_t BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite); 00087 uint32_t BSP_EEPROM_WaitEepromStandbyState(void); 00088 00089 /* USER Callbacks: This function is declared as __weak in EEPROM driver and 00090 should be implemented into user application. 00091 BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition 00092 occurs during communication (waiting on an event that doesn't occur, bus 00093 errors, busy devices ...). */ 00094 void BSP_EEPROM_TIMEOUT_UserCallback(void); 00095 00096 /* Link function for I2C EEPROM peripheral */ 00097 void EEPROM_IO_Init(void); 00098 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize); 00099 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize); 00100 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials); 00101 00102 /** 00103 * @} 00104 */ 00105 00106 /** 00107 * @} 00108 */ 00109 00110 /** 00111 * @} 00112 */ 00113 00114 /** 00115 * @} 00116 */ 00117 00118 #ifdef __cplusplus 00119 } 00120 #endif 00121 00122 #endif /* __STM32L4R9I_EVAL_EEPROM_H */ 00123 00124 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Thu Oct 12 2017 10:53:59 for STM32L4R9I_EVAL BSP User Manual by
![doxygen](doxygen.png)