chore: provide a way to get the RTC handle

Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

Author: FRASTM

README.md

@@ -153,6 +153,12 @@ It is possible to use it thanks all alarm API with an extra argument:
     rtc.enableAlarm(rtc.MATCH_DHHMMSS, STM32RTC::ALARM_B);
 ```
 
+### Since STM32RTC version higher than 1.3.7
+_Get the RTC handle_
+
+* **`RTC_HandleTypeDef *RTC_GetHandle(void)`**
+
+
 Refer to the Arduino RTC documentation for the other functions
 http://arduino.cc/en/Reference/RTC
 

src/STM32RTC.h

@@ -132,6 +132,12 @@ class STM32RTC {
 
     void end(void);
 
+    // Could be used to mix Arduino API and STM32Cube HAL API (ex: DMA). Use at your own risk.
+    RTC_HandleTypeDef *getHandle(void)
+    {
+      return RTC_GetHandle();
+    }
+
     Source_Clock getClockSource(void);
     void setClockSource(Source_Clock source, uint32_t predivA = (PREDIVA_MAX + 1), uint32_t predivS = (PREDIVS_MAX + 1));
     void getPrediv(uint32_t *predivA, uint32_t *predivS);

src/rtc.c

@@ -98,6 +98,15 @@ static inline int _log2(int x)
 
 /* Exported functions --------------------------------------------------------*/
 
+/**
+  * @brief Get pointer to RTC_HandleTypeDef
+  * @param None
+  * @retval pointer to RTC_HandleTypeDef
+  */
+RTC_HandleTypeDef *RTC_GetHandle(void) {
+  return &RtcHandle;
+}
+
 /**
   * @brief Set RTC clock source
   * @param source: RTC clock source: LSE, LSI or HSE

src/rtc.h

@@ -173,6 +173,7 @@ typedef void(*voidCallbackPtr)(void *);
 
 /* Exported macro ------------------------------------------------------------*/
 /* Exported functions ------------------------------------------------------- */
+RTC_HandleTypeDef *RTC_GetHandle(void);
 void RTC_SetClockSource(sourceClock_t source);
 void RTC_getPrediv(uint32_t *asynch, uint32_t *synch);
 void RTC_setPrediv(uint32_t asynch, uint32_t synch);