ST / BSP_DISCO_F469NI

STM32F469NI Discovery board drivers

Dependents:   DISCO-F469NI_LCDTS_GUI_demo Configurable_Robots DISCO-F469NI_LCD_demo DISCO-F469NI_SD_demo ... more

Drivers/BSP/STM32469I-Discovery/stm32469i_discovery_eeprom.h@2:123b894b49dd, 2017-05-16 (annotated)

Committer:
Jerome Coutant
Date:
Tue May 16 10:50:26 2017 +0200
Revision:
2:123b894b49dd
Child:
3:3cdfcc4f7c9d
STM32Cube_FW_BSP_DISCO_F469NI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jerome Coutant 2:123b894b49dd 1 /**
Jerome Coutant 2:123b894b49dd 2 ******************************************************************************
Jerome Coutant 2:123b894b49dd 3 * @file stm32469i_discovery_eeprom.h
Jerome Coutant 2:123b894b49dd 4 * @author MCD Application Team
Jerome Coutant 2:123b894b49dd 5 * @version V2.0.0
Jerome Coutant 2:123b894b49dd 6 * @date 27-January-2017
Jerome Coutant 2:123b894b49dd 7 * @brief This file contains all the functions prototypes for
Jerome Coutant 2:123b894b49dd 8 * the stm32469i_discovery_eeprom.c firmware driver.
Jerome Coutant 2:123b894b49dd 9 ******************************************************************************
Jerome Coutant 2:123b894b49dd 10 * @attention
Jerome Coutant 2:123b894b49dd 11 *
Jerome Coutant 2:123b894b49dd 12 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
Jerome Coutant 2:123b894b49dd 13 *
Jerome Coutant 2:123b894b49dd 14 * Redistribution and use in source and binary forms, with or without modification,
Jerome Coutant 2:123b894b49dd 15 * are permitted provided that the following conditions are met:
Jerome Coutant 2:123b894b49dd 16 * 1. Redistributions of source code must retain the above copyright notice,
Jerome Coutant 2:123b894b49dd 17 * this list of conditions and the following disclaimer.
Jerome Coutant 2:123b894b49dd 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jerome Coutant 2:123b894b49dd 19 * this list of conditions and the following disclaimer in the documentation
Jerome Coutant 2:123b894b49dd 20 * and/or other materials provided with the distribution.
Jerome Coutant 2:123b894b49dd 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Jerome Coutant 2:123b894b49dd 22 * may be used to endorse or promote products derived from this software
Jerome Coutant 2:123b894b49dd 23 * without specific prior written permission.
Jerome Coutant 2:123b894b49dd 24 *
Jerome Coutant 2:123b894b49dd 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jerome Coutant 2:123b894b49dd 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jerome Coutant 2:123b894b49dd 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jerome Coutant 2:123b894b49dd 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jerome Coutant 2:123b894b49dd 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jerome Coutant 2:123b894b49dd 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jerome Coutant 2:123b894b49dd 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jerome Coutant 2:123b894b49dd 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jerome Coutant 2:123b894b49dd 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jerome Coutant 2:123b894b49dd 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jerome Coutant 2:123b894b49dd 35 *
Jerome Coutant 2:123b894b49dd 36 ******************************************************************************
Jerome Coutant 2:123b894b49dd 37 */
Jerome Coutant 2:123b894b49dd 38
Jerome Coutant 2:123b894b49dd 39 /* Define to prevent recursive inclusion -------------------------------------*/
Jerome Coutant 2:123b894b49dd 40 #ifndef __STM32F469I_DISCOVERY_EEPROM_H
Jerome Coutant 2:123b894b49dd 41 #define __STM32F469I_DISCOVERY_EEPROM_H
Jerome Coutant 2:123b894b49dd 42
Jerome Coutant 2:123b894b49dd 43 #ifdef __cplusplus
Jerome Coutant 2:123b894b49dd 44 extern "C" {
Jerome Coutant 2:123b894b49dd 45 #endif
Jerome Coutant 2:123b894b49dd 46
Jerome Coutant 2:123b894b49dd 47 /* Includes ------------------------------------------------------------------*/
Jerome Coutant 2:123b894b49dd 48 #include "stm32469i_discovery.h"
Jerome Coutant 2:123b894b49dd 49
Jerome Coutant 2:123b894b49dd 50 /** @addtogroup BSP
Jerome Coutant 2:123b894b49dd 51 * @{
Jerome Coutant 2:123b894b49dd 52 */
Jerome Coutant 2:123b894b49dd 53
Jerome Coutant 2:123b894b49dd 54 /** @addtogroup STM32469I_Discovery
Jerome Coutant 2:123b894b49dd 55 * @{
Jerome Coutant 2:123b894b49dd 56 */
Jerome Coutant 2:123b894b49dd 57
Jerome Coutant 2:123b894b49dd 58 /** @addtogroup STM32469I-Discovery_EEPROM
Jerome Coutant 2:123b894b49dd 59 * @brief This file includes the I2C EEPROM driver of STM32469I-Discovery board.
Jerome Coutant 2:123b894b49dd 60 * @{
Jerome Coutant 2:123b894b49dd 61 */
Jerome Coutant 2:123b894b49dd 62
Jerome Coutant 2:123b894b49dd 63 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Types STM32469I Discovery EEPROM Exported Types
Jerome Coutant 2:123b894b49dd 64 * @{
Jerome Coutant 2:123b894b49dd 65 */
Jerome Coutant 2:123b894b49dd 66 /**
Jerome Coutant 2:123b894b49dd 67 * @}
Jerome Coutant 2:123b894b49dd 68 */
Jerome Coutant 2:123b894b49dd 69
Jerome Coutant 2:123b894b49dd 70 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Constants STM32469I Discovery EEPROM Exported Constants
Jerome Coutant 2:123b894b49dd 71 * @{
Jerome Coutant 2:123b894b49dd 72 */
Jerome Coutant 2:123b894b49dd 73 /* EEPROM hardware address and page size */
Jerome Coutant 2:123b894b49dd 74 #define EEPROM_PAGESIZE ((uint8_t)4)
Jerome Coutant 2:123b894b49dd 75 #define EEPROM_MAX_SIZE ((uint16_t)0x2000) /* 64Kbit */
Jerome Coutant 2:123b894b49dd 76
Jerome Coutant 2:123b894b49dd 77 /* Maximum Timeout values for flags and events waiting loops.
Jerome Coutant 2:123b894b49dd 78 This timeout is based on systick set to 1ms*/
Jerome Coutant 2:123b894b49dd 79 /* Timeout for read based if read all the EEPROM : EEPROM_MAX_SIZE * I2C_SPEED (640ms) */
Jerome Coutant 2:123b894b49dd 80 #define EEPROM_READ_TIMEOUT ((uint32_t)(1000))
Jerome Coutant 2:123b894b49dd 81 /* Timeout for write based on max write which is EEPROM_PAGESIZE bytes: EEPROM_PAGESIZE * I2C_SPEED (320us) */
Jerome Coutant 2:123b894b49dd 82 #define EEPROM_WRITE_TIMEOUT ((uint32_t)(10))
Jerome Coutant 2:123b894b49dd 83
Jerome Coutant 2:123b894b49dd 84 /* Maximum number of trials for EEPROM_WaitEepromStandbyState() function */
Jerome Coutant 2:123b894b49dd 85 #define EEPROM_MAX_TRIALS 3000
Jerome Coutant 2:123b894b49dd 86
Jerome Coutant 2:123b894b49dd 87 #define EEPROM_OK 0
Jerome Coutant 2:123b894b49dd 88 #define EEPROM_FAIL 1
Jerome Coutant 2:123b894b49dd 89 #define EEPROM_TIMEOUT 2
Jerome Coutant 2:123b894b49dd 90 /**
Jerome Coutant 2:123b894b49dd 91 * @}
Jerome Coutant 2:123b894b49dd 92 */
Jerome Coutant 2:123b894b49dd 93
Jerome Coutant 2:123b894b49dd 94 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Macros STM32469I Discovery EEPROM Exported Macros
Jerome Coutant 2:123b894b49dd 95 * @{
Jerome Coutant 2:123b894b49dd 96 */
Jerome Coutant 2:123b894b49dd 97 /**
Jerome Coutant 2:123b894b49dd 98 * @}
Jerome Coutant 2:123b894b49dd 99 */
Jerome Coutant 2:123b894b49dd 100
Jerome Coutant 2:123b894b49dd 101 /** @defgroup STM32469I-Discovery_EEPROM_Exported_Functions STM32469I Discovery EEPROM Exported Functions
Jerome Coutant 2:123b894b49dd 102 * @{
Jerome Coutant 2:123b894b49dd 103 */
Jerome Coutant 2:123b894b49dd 104 uint32_t BSP_EEPROM_Init(void);
Jerome Coutant 2:123b894b49dd 105 uint8_t BSP_EEPROM_DeInit(void);
Jerome Coutant 2:123b894b49dd 106 uint32_t BSP_EEPROM_ReadBuffer(uint8_t* pBuffer, uint16_t ReadAddr, uint16_t* NumByteToRead);
Jerome Coutant 2:123b894b49dd 107 uint32_t BSP_EEPROM_WritePage(uint8_t* pBuffer, uint16_t WriteAddr, uint8_t* NumByteToWrite);
Jerome Coutant 2:123b894b49dd 108 uint32_t BSP_EEPROM_WriteBuffer(uint8_t* pBuffer, uint16_t WriteAddr, uint16_t NumByteToWrite);
Jerome Coutant 2:123b894b49dd 109 uint32_t BSP_EEPROM_WaitEepromStandbyState(void);
Jerome Coutant 2:123b894b49dd 110
Jerome Coutant 2:123b894b49dd 111 /* USER Callbacks: This function is declared as __weak in EEPROM driver and
Jerome Coutant 2:123b894b49dd 112 should be implemented into user application.
Jerome Coutant 2:123b894b49dd 113 BSP_EEPROM_TIMEOUT_UserCallback() function is called whenever a timeout condition
Jerome Coutant 2:123b894b49dd 114 occure during communication (waiting on an event that doesn't occur, bus
Jerome Coutant 2:123b894b49dd 115 errors, busy devices ...). */
Jerome Coutant 2:123b894b49dd 116 void BSP_EEPROM_TIMEOUT_UserCallback(void);
Jerome Coutant 2:123b894b49dd 117
Jerome Coutant 2:123b894b49dd 118 /* Link function for I2C EEPROM peripheral */
Jerome Coutant 2:123b894b49dd 119 void EEPROM_IO_Init(void);
Jerome Coutant 2:123b894b49dd 120 HAL_StatusTypeDef EEPROM_IO_WriteData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
Jerome Coutant 2:123b894b49dd 121 HAL_StatusTypeDef EEPROM_IO_ReadData(uint16_t DevAddress, uint16_t MemAddress, uint8_t *pBuffer, uint32_t BufferSize);
Jerome Coutant 2:123b894b49dd 122 HAL_StatusTypeDef EEPROM_IO_IsDeviceReady(uint16_t DevAddress, uint32_t Trials);
Jerome Coutant 2:123b894b49dd 123
Jerome Coutant 2:123b894b49dd 124 /**
Jerome Coutant 2:123b894b49dd 125 * @}
Jerome Coutant 2:123b894b49dd 126 */
Jerome Coutant 2:123b894b49dd 127
Jerome Coutant 2:123b894b49dd 128 /**
Jerome Coutant 2:123b894b49dd 129 * @}
Jerome Coutant 2:123b894b49dd 130 */
Jerome Coutant 2:123b894b49dd 131
Jerome Coutant 2:123b894b49dd 132 /**
Jerome Coutant 2:123b894b49dd 133 * @}
Jerome Coutant 2:123b894b49dd 134 */
Jerome Coutant 2:123b894b49dd 135
Jerome Coutant 2:123b894b49dd 136 /**
Jerome Coutant 2:123b894b49dd 137 * @}
Jerome Coutant 2:123b894b49dd 138 */
Jerome Coutant 2:123b894b49dd 139
Jerome Coutant 2:123b894b49dd 140 #ifdef __cplusplus
Jerome Coutant 2:123b894b49dd 141 }
Jerome Coutant 2:123b894b49dd 142 #endif
Jerome Coutant 2:123b894b49dd 143
Jerome Coutant 2:123b894b49dd 144 #endif /* __STM32F469I_DISCOVERY_EEPROM_H */
Jerome Coutant 2:123b894b49dd 145
Jerome Coutant 2:123b894b49dd 146 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/