Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F103RB/stm32f10x_bkp.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
77:869cf507173a 
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 73:1efda918f0ba 1 /**
bogdanm 73:1efda918f0ba 2 ******************************************************************************
bogdanm 73:1efda918f0ba 3 * @file stm32f10x_bkp.h
bogdanm 73:1efda918f0ba 4 * @author MCD Application Team
emilmont 77:869cf507173a 5 * @version V3.6.1
emilmont 77:869cf507173a 6 * @date 05-March-2012
bogdanm 73:1efda918f0ba 7 * @brief This file contains all the functions prototypes for the BKP firmware
bogdanm 73:1efda918f0ba 8 * library.
bogdanm 76:824293ae5e43 9 *******************************************************************************
bogdanm 76:824293ae5e43 10 * Copyright (c) 2014, STMicroelectronics
bogdanm 76:824293ae5e43 11 * All rights reserved.
bogdanm 76:824293ae5e43 12 *
bogdanm 76:824293ae5e43 13 * Redistribution and use in source and binary forms, with or without
bogdanm 76:824293ae5e43 14 * modification, are permitted provided that the following conditions are met:
bogdanm 76:824293ae5e43 15 *
bogdanm 76:824293ae5e43 16 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 76:824293ae5e43 17 * this list of conditions and the following disclaimer.
bogdanm 76:824293ae5e43 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 76:824293ae5e43 19 * this list of conditions and the following disclaimer in the documentation
bogdanm 76:824293ae5e43 20 * and/or other materials provided with the distribution.
bogdanm 76:824293ae5e43 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 76:824293ae5e43 22 * may be used to endorse or promote products derived from this software
bogdanm 76:824293ae5e43 23 * without specific prior written permission.
bogdanm 76:824293ae5e43 24 *
bogdanm 76:824293ae5e43 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 76:824293ae5e43 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 76:824293ae5e43 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 76:824293ae5e43 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 76:824293ae5e43 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 76:824293ae5e43 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 76:824293ae5e43 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 76:824293ae5e43 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 76:824293ae5e43 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 76:824293ae5e43 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 76:824293ae5e43 35 *******************************************************************************
bogdanm 76:824293ae5e43 36 */
bogdanm 73:1efda918f0ba 37
bogdanm 73:1efda918f0ba 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 73:1efda918f0ba 39 #ifndef __STM32F10x_BKP_H
bogdanm 73:1efda918f0ba 40 #define __STM32F10x_BKP_H
bogdanm 73:1efda918f0ba 41
bogdanm 73:1efda918f0ba 42 #ifdef __cplusplus
bogdanm 73:1efda918f0ba 43 extern "C" {
bogdanm 73:1efda918f0ba 44 #endif
bogdanm 73:1efda918f0ba 45
bogdanm 73:1efda918f0ba 46 /* Includes ------------------------------------------------------------------*/
bogdanm 73:1efda918f0ba 47 #include "stm32f10x.h"
bogdanm 73:1efda918f0ba 48
bogdanm 73:1efda918f0ba 49 /** @addtogroup STM32F10x_StdPeriph_Driver
bogdanm 73:1efda918f0ba 50 * @{
bogdanm 73:1efda918f0ba 51 */
bogdanm 73:1efda918f0ba 52
bogdanm 73:1efda918f0ba 53 /** @addtogroup BKP
bogdanm 73:1efda918f0ba 54 * @{
bogdanm 73:1efda918f0ba 55 */
bogdanm 73:1efda918f0ba 56
bogdanm 73:1efda918f0ba 57 /** @defgroup BKP_Exported_Types
bogdanm 73:1efda918f0ba 58 * @{
bogdanm 73:1efda918f0ba 59 */
bogdanm 73:1efda918f0ba 60
bogdanm 73:1efda918f0ba 61 /**
bogdanm 73:1efda918f0ba 62 * @}
bogdanm 73:1efda918f0ba 63 */
bogdanm 73:1efda918f0ba 64
bogdanm 73:1efda918f0ba 65 /** @defgroup BKP_Exported_Constants
bogdanm 73:1efda918f0ba 66 * @{
bogdanm 73:1efda918f0ba 67 */
bogdanm 73:1efda918f0ba 68
bogdanm 73:1efda918f0ba 69 /** @defgroup Tamper_Pin_active_level
bogdanm 73:1efda918f0ba 70 * @{
bogdanm 73:1efda918f0ba 71 */
bogdanm 73:1efda918f0ba 72
bogdanm 73:1efda918f0ba 73 #define BKP_TamperPinLevel_High ((uint16_t)0x0000)
bogdanm 73:1efda918f0ba 74 #define BKP_TamperPinLevel_Low ((uint16_t)0x0001)
bogdanm 73:1efda918f0ba 75 #define IS_BKP_TAMPER_PIN_LEVEL(LEVEL) (((LEVEL) == BKP_TamperPinLevel_High) || \
bogdanm 73:1efda918f0ba 76 ((LEVEL) == BKP_TamperPinLevel_Low))
bogdanm 73:1efda918f0ba 77 /**
bogdanm 73:1efda918f0ba 78 * @}
bogdanm 73:1efda918f0ba 79 */
bogdanm 73:1efda918f0ba 80
bogdanm 73:1efda918f0ba 81 /** @defgroup RTC_output_source_to_output_on_the_Tamper_pin
bogdanm 73:1efda918f0ba 82 * @{
bogdanm 73:1efda918f0ba 83 */
bogdanm 73:1efda918f0ba 84
bogdanm 73:1efda918f0ba 85 #define BKP_RTCOutputSource_None ((uint16_t)0x0000)
bogdanm 73:1efda918f0ba 86 #define BKP_RTCOutputSource_CalibClock ((uint16_t)0x0080)
bogdanm 73:1efda918f0ba 87 #define BKP_RTCOutputSource_Alarm ((uint16_t)0x0100)
bogdanm 73:1efda918f0ba 88 #define BKP_RTCOutputSource_Second ((uint16_t)0x0300)
bogdanm 73:1efda918f0ba 89 #define IS_BKP_RTC_OUTPUT_SOURCE(SOURCE) (((SOURCE) == BKP_RTCOutputSource_None) || \
bogdanm 73:1efda918f0ba 90 ((SOURCE) == BKP_RTCOutputSource_CalibClock) || \
bogdanm 73:1efda918f0ba 91 ((SOURCE) == BKP_RTCOutputSource_Alarm) || \
bogdanm 73:1efda918f0ba 92 ((SOURCE) == BKP_RTCOutputSource_Second))
bogdanm 73:1efda918f0ba 93 /**
bogdanm 73:1efda918f0ba 94 * @}
bogdanm 73:1efda918f0ba 95 */
bogdanm 73:1efda918f0ba 96
bogdanm 73:1efda918f0ba 97 /** @defgroup Data_Backup_Register
bogdanm 73:1efda918f0ba 98 * @{
bogdanm 73:1efda918f0ba 99 */
bogdanm 73:1efda918f0ba 100
bogdanm 73:1efda918f0ba 101 #define BKP_DR1 ((uint16_t)0x0004)
bogdanm 73:1efda918f0ba 102 #define BKP_DR2 ((uint16_t)0x0008)
bogdanm 73:1efda918f0ba 103 #define BKP_DR3 ((uint16_t)0x000C)
bogdanm 73:1efda918f0ba 104 #define BKP_DR4 ((uint16_t)0x0010)
bogdanm 73:1efda918f0ba 105 #define BKP_DR5 ((uint16_t)0x0014)
bogdanm 73:1efda918f0ba 106 #define BKP_DR6 ((uint16_t)0x0018)
bogdanm 73:1efda918f0ba 107 #define BKP_DR7 ((uint16_t)0x001C)
bogdanm 73:1efda918f0ba 108 #define BKP_DR8 ((uint16_t)0x0020)
bogdanm 73:1efda918f0ba 109 #define BKP_DR9 ((uint16_t)0x0024)
bogdanm 73:1efda918f0ba 110 #define BKP_DR10 ((uint16_t)0x0028)
bogdanm 73:1efda918f0ba 111 #define BKP_DR11 ((uint16_t)0x0040)
bogdanm 73:1efda918f0ba 112 #define BKP_DR12 ((uint16_t)0x0044)
bogdanm 73:1efda918f0ba 113 #define BKP_DR13 ((uint16_t)0x0048)
bogdanm 73:1efda918f0ba 114 #define BKP_DR14 ((uint16_t)0x004C)
bogdanm 73:1efda918f0ba 115 #define BKP_DR15 ((uint16_t)0x0050)
bogdanm 73:1efda918f0ba 116 #define BKP_DR16 ((uint16_t)0x0054)
bogdanm 73:1efda918f0ba 117 #define BKP_DR17 ((uint16_t)0x0058)
bogdanm 73:1efda918f0ba 118 #define BKP_DR18 ((uint16_t)0x005C)
bogdanm 73:1efda918f0ba 119 #define BKP_DR19 ((uint16_t)0x0060)
bogdanm 73:1efda918f0ba 120 #define BKP_DR20 ((uint16_t)0x0064)
bogdanm 73:1efda918f0ba 121 #define BKP_DR21 ((uint16_t)0x0068)
bogdanm 73:1efda918f0ba 122 #define BKP_DR22 ((uint16_t)0x006C)
bogdanm 73:1efda918f0ba 123 #define BKP_DR23 ((uint16_t)0x0070)
bogdanm 73:1efda918f0ba 124 #define BKP_DR24 ((uint16_t)0x0074)
bogdanm 73:1efda918f0ba 125 #define BKP_DR25 ((uint16_t)0x0078)
bogdanm 73:1efda918f0ba 126 #define BKP_DR26 ((uint16_t)0x007C)
bogdanm 73:1efda918f0ba 127 #define BKP_DR27 ((uint16_t)0x0080)
bogdanm 73:1efda918f0ba 128 #define BKP_DR28 ((uint16_t)0x0084)
bogdanm 73:1efda918f0ba 129 #define BKP_DR29 ((uint16_t)0x0088)
bogdanm 73:1efda918f0ba 130 #define BKP_DR30 ((uint16_t)0x008C)
bogdanm 73:1efda918f0ba 131 #define BKP_DR31 ((uint16_t)0x0090)
bogdanm 73:1efda918f0ba 132 #define BKP_DR32 ((uint16_t)0x0094)
bogdanm 73:1efda918f0ba 133 #define BKP_DR33 ((uint16_t)0x0098)
bogdanm 73:1efda918f0ba 134 #define BKP_DR34 ((uint16_t)0x009C)
bogdanm 73:1efda918f0ba 135 #define BKP_DR35 ((uint16_t)0x00A0)
bogdanm 73:1efda918f0ba 136 #define BKP_DR36 ((uint16_t)0x00A4)
bogdanm 73:1efda918f0ba 137 #define BKP_DR37 ((uint16_t)0x00A8)
bogdanm 73:1efda918f0ba 138 #define BKP_DR38 ((uint16_t)0x00AC)
bogdanm 73:1efda918f0ba 139 #define BKP_DR39 ((uint16_t)0x00B0)
bogdanm 73:1efda918f0ba 140 #define BKP_DR40 ((uint16_t)0x00B4)
bogdanm 73:1efda918f0ba 141 #define BKP_DR41 ((uint16_t)0x00B8)
bogdanm 73:1efda918f0ba 142 #define BKP_DR42 ((uint16_t)0x00BC)
bogdanm 73:1efda918f0ba 143
bogdanm 73:1efda918f0ba 144 #define IS_BKP_DR(DR) (((DR) == BKP_DR1) || ((DR) == BKP_DR2) || ((DR) == BKP_DR3) || \
bogdanm 73:1efda918f0ba 145 ((DR) == BKP_DR4) || ((DR) == BKP_DR5) || ((DR) == BKP_DR6) || \
bogdanm 73:1efda918f0ba 146 ((DR) == BKP_DR7) || ((DR) == BKP_DR8) || ((DR) == BKP_DR9) || \
bogdanm 73:1efda918f0ba 147 ((DR) == BKP_DR10) || ((DR) == BKP_DR11) || ((DR) == BKP_DR12) || \
bogdanm 73:1efda918f0ba 148 ((DR) == BKP_DR13) || ((DR) == BKP_DR14) || ((DR) == BKP_DR15) || \
bogdanm 73:1efda918f0ba 149 ((DR) == BKP_DR16) || ((DR) == BKP_DR17) || ((DR) == BKP_DR18) || \
bogdanm 73:1efda918f0ba 150 ((DR) == BKP_DR19) || ((DR) == BKP_DR20) || ((DR) == BKP_DR21) || \
bogdanm 73:1efda918f0ba 151 ((DR) == BKP_DR22) || ((DR) == BKP_DR23) || ((DR) == BKP_DR24) || \
bogdanm 73:1efda918f0ba 152 ((DR) == BKP_DR25) || ((DR) == BKP_DR26) || ((DR) == BKP_DR27) || \
bogdanm 73:1efda918f0ba 153 ((DR) == BKP_DR28) || ((DR) == BKP_DR29) || ((DR) == BKP_DR30) || \
bogdanm 73:1efda918f0ba 154 ((DR) == BKP_DR31) || ((DR) == BKP_DR32) || ((DR) == BKP_DR33) || \
bogdanm 73:1efda918f0ba 155 ((DR) == BKP_DR34) || ((DR) == BKP_DR35) || ((DR) == BKP_DR36) || \
bogdanm 73:1efda918f0ba 156 ((DR) == BKP_DR37) || ((DR) == BKP_DR38) || ((DR) == BKP_DR39) || \
bogdanm 73:1efda918f0ba 157 ((DR) == BKP_DR40) || ((DR) == BKP_DR41) || ((DR) == BKP_DR42))
bogdanm 73:1efda918f0ba 158
bogdanm 73:1efda918f0ba 159 #define IS_BKP_CALIBRATION_VALUE(VALUE) ((VALUE) <= 0x7F)
bogdanm 73:1efda918f0ba 160 /**
bogdanm 73:1efda918f0ba 161 * @}
bogdanm 73:1efda918f0ba 162 */
bogdanm 73:1efda918f0ba 163
bogdanm 73:1efda918f0ba 164 /**
bogdanm 73:1efda918f0ba 165 * @}
bogdanm 73:1efda918f0ba 166 */
bogdanm 73:1efda918f0ba 167
bogdanm 73:1efda918f0ba 168 /** @defgroup BKP_Exported_Macros
bogdanm 73:1efda918f0ba 169 * @{
bogdanm 73:1efda918f0ba 170 */
bogdanm 73:1efda918f0ba 171
bogdanm 73:1efda918f0ba 172 /**
bogdanm 73:1efda918f0ba 173 * @}
bogdanm 73:1efda918f0ba 174 */
bogdanm 73:1efda918f0ba 175
bogdanm 73:1efda918f0ba 176 /** @defgroup BKP_Exported_Functions
bogdanm 73:1efda918f0ba 177 * @{
bogdanm 73:1efda918f0ba 178 */
bogdanm 73:1efda918f0ba 179
bogdanm 73:1efda918f0ba 180 void BKP_DeInit(void);
bogdanm 73:1efda918f0ba 181 void BKP_TamperPinLevelConfig(uint16_t BKP_TamperPinLevel);
bogdanm 73:1efda918f0ba 182 void BKP_TamperPinCmd(FunctionalState NewState);
bogdanm 73:1efda918f0ba 183 void BKP_ITConfig(FunctionalState NewState);
bogdanm 73:1efda918f0ba 184 void BKP_RTCOutputConfig(uint16_t BKP_RTCOutputSource);
bogdanm 73:1efda918f0ba 185 void BKP_SetRTCCalibrationValue(uint8_t CalibrationValue);
bogdanm 73:1efda918f0ba 186 void BKP_WriteBackupRegister(uint16_t BKP_DR, uint16_t Data);
bogdanm 73:1efda918f0ba 187 uint16_t BKP_ReadBackupRegister(uint16_t BKP_DR);
bogdanm 73:1efda918f0ba 188 FlagStatus BKP_GetFlagStatus(void);
bogdanm 73:1efda918f0ba 189 void BKP_ClearFlag(void);
bogdanm 73:1efda918f0ba 190 ITStatus BKP_GetITStatus(void);
bogdanm 73:1efda918f0ba 191 void BKP_ClearITPendingBit(void);
bogdanm 73:1efda918f0ba 192
bogdanm 73:1efda918f0ba 193 #ifdef __cplusplus
bogdanm 73:1efda918f0ba 194 }
bogdanm 73:1efda918f0ba 195 #endif
bogdanm 73:1efda918f0ba 196
bogdanm 73:1efda918f0ba 197 #endif /* __STM32F10x_BKP_H */
bogdanm 73:1efda918f0ba 198 /**
bogdanm 73:1efda918f0ba 199 * @}
bogdanm 73:1efda918f0ba 200 */
bogdanm 73:1efda918f0ba 201
bogdanm 73:1efda918f0ba 202 /**
bogdanm 73:1efda918f0ba 203 * @}
bogdanm 73:1efda918f0ba 204 */
bogdanm 73:1efda918f0ba 205
bogdanm 73:1efda918f0ba 206 /**
bogdanm 73:1efda918f0ba 207 * @}
bogdanm 73:1efda918f0ba 208 */
bogdanm 73:1efda918f0ba 209
emilmont 77:869cf507173a 210 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/