Add backup register API

Signed-off-by: Frederic.Pillon <[email protected]>

Author: fpistm

cores/arduino/board.h

@@ -9,6 +9,7 @@
 extern "C" {
 #endif // __cplusplus
 #include "analog.h"
+#include "backup.h"
 #include "clock.h"
 #include "core_callback.h"
 #include "digital_io.h"

cores/arduino/stm32/backup.h

@@ -0,0 +1,153 @@
+/**
+  ******************************************************************************
+  * @file    backup.h
+  * @author  fpistm
+  * @brief   Header for backup domain driver
+  ******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; COPYRIGHT(c) 2019 STMicroelectronics</center></h2>
+  *
+  * Redistribution and use in source and binary forms, with or without modification,
+  * are permitted provided that the following conditions are met:
+  *   1. Redistributions of source code must retain the above copyright notice,
+  *      this list of conditions and the following disclaimer.
+  *   2. Redistributions in binary form must reproduce the above copyright notice,
+  *      this list of conditions and the following disclaimer in the documentation
+  *      and/or other materials provided with the distribution.
+  *   3. Neither the name of STMicroelectronics nor the names of its contributors
+  *      may be used to endorse or promote products derived from this software
+  *      without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  *
+  ******************************************************************************
+  */
+
+/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef __BACKUP_H
+#define __BACKUP_H
+
+/* Includes ------------------------------------------------------------------*/
+#include "stm32_def.h"
+#include "stm32yyxx_ll_rtc.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Exported macro ------------------------------------------------------------*/
+#if (!defined(STM32F0xx) && !defined(STM32F3xx) && !defined(STM32L0xx) &&\
+	!defined(STM32L1xx) && !defined(STM32L4xx)) || defined(RTC_BACKUP_SUPPORT)
+#if !defined(STM32L412xx) && !defined(STM32L422xx)
+#define ENABLE_BACKUP_SUPPORT
+#endif
+#endif
+
+#if !defined(RTC_BKP_INDEX) && defined(ENABLE_BACKUP_SUPPORT)
+#define RTC_BKP_INDEX LL_RTC_BKP_DR1
+#else
+#define RTC_BKP_INDEX 0
+#endif
+#ifndef RTC_BKP_VALUE
+#define RTC_BKP_VALUE 0x32F2
+#endif
+
+
+/* Exported functions ------------------------------------------------------- */
+static inline void resetBackupRegister(void)
+{
+#ifdef HAL_PWR_MODULE_ENABLED
+  /*  Enable access to the RTC registers */
+  HAL_PWR_EnableBkUpAccess();
+  /**
+    *  Write twice the value to flush the APB-AHB bridge
+    *  This bit shall be written in the register before writing the next one
+    */
+  HAL_PWR_EnableBkUpAccess();
+#endif
+  __HAL_RCC_BACKUPRESET_FORCE();
+  __HAL_RCC_BACKUPRESET_RELEASE();
+}
+
+static inline void enableBackupRegister(void)
+{
+  /* Enable Power Clock */
+#ifndef STM32H7xx
+  if (__HAL_RCC_PWR_IS_CLK_DISABLED()) {
+    __HAL_RCC_PWR_CLK_ENABLE();
+  }
+#endif
+#ifdef HAL_PWR_MODULE_ENABLED
+  /* Allow access to Backup domain */
+  HAL_PWR_EnableBkUpAccess();
+#endif
+#ifdef STM32F1xx
+  /* Enable BKP CLK enable for backup registers */
+  __HAL_RCC_BKP_CLK_ENABLE();
+#endif
+}
+
+static inline void disableBackupRegister(void)
+{
+#ifdef HAL_PWR_MODULE_ENABLED
+  /* Forbid access to Backup domain */
+  HAL_PWR_DisableBkUpAccess();
+#endif
+#ifdef STM32F1xx
+  /* Disable BKP CLK enable for backup registers */
+  __HAL_RCC_BKP_CLK_DISABLE();
+#endif
+  /* Disable Power Clock */
+#ifndef STM32H7xx
+  if (!__HAL_RCC_PWR_IS_CLK_DISABLED()) {
+    __HAL_RCC_PWR_CLK_DISABLE();
+  }
+#endif
+}
+
+static inline void setBackupRegister(uint32_t index, uint32_t value)
+{
+
+#if defined(STM32F1xx)
+  LL_RTC_BKP_SetRegister(BKP, index, value);
+#else
+#ifdef ENABLE_BACKUP_SUPPORT
+  LL_RTC_BAK_SetRegister(RTC, index, value);
+#else
+  UNUSED(index);
+  UNUSED(value);
+#endif
+#endif
+}
+
+static inline uint32_t getBackupRegister(uint32_t index)
+{
+#if defined(STM32F1xx)
+  return LL_RTC_BKP_GetRegister(BKP, index);
+#else
+#ifdef ENABLE_BACKUP_SUPPORT
+  return LL_RTC_BAK_GetRegister(RTC, index);
+#else
+  UNUSED(index);
+  return 0;
+#endif
+#endif
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __BACKUP_H */
+
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/