Viktor Zhezher / Mbed 2 deprecated SI570_VFO_F746NG

Library to control Silicon Labs SI570 10 MHZ TO 1.4 GHZ I2C PROGRAMMABLE XO/VCXO.

Dependencies:   mbed

Fork of SI570 by Gerrit Polder

BSP_F746NG/stm32746g_discovery_eeprom.h@1:1556bcaaf759, 2016-03-27 (annotated)

Committer:
DL3LD
Date:
Sun Mar 27 06:55:59 2016 +0000
Revision:
1:1556bcaaf759
STM32F746NG SI570 VFO Test

Who changed what in which revision?

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