/**************************************************************************** * arch/arm/src/stm32l4/stm32l4_rtc.h * * Copyright (C) 2011 Uros Platise. All rights reserved. * Copyright (C) 2011-2013, 2015 Gregory Nutt. All rights reserved. * Author: Uros Platise (Original for the F1) * Gregory Nutt (On-going support and development) * dev@ziggurat29.com (adaptations for STM32L4) * * 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 NuttX 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 OWNER 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. * ****************************************************************************/ /**************************************************************************** * Included Files ****************************************************************************/ #ifndef __ARCH_ARM_SRC_STM32L4_STM32L4_RTC_H #define __ARCH_ARM_SRC_STM32L4_STM32L4_RTC_H #include #include #include "chip.h" #include "chip/stm32l4_rtcc.h" /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ #define STM32L4_RTC_PRESCALER_SECOND 32767 /* Default prescaler to get a second base */ #define STM32L4_RTC_PRESCALER_MIN 1 /* Maximum speed of 16384 Hz */ /**************************************************************************** * Public Types ****************************************************************************/ #ifndef __ASSEMBLY__ #ifdef CONFIG_RTC_ALARM /* The form of an alarm callback */ typedef CODE void (*alm_callback_t)(FAR void *arg, unsigned int alarmid); enum alm_id_e { RTC_ALARMA = 0, /* RTC ALARM A */ RTC_ALARMB, /* RTC ALARM B */ RTC_ALARM_LAST }; /* Structure used to pass parmaters to set an alarm */ struct alm_setalarm_s { int as_id; /* enum alm_id_e */ struct tm as_time; /* Alarm expiration time */ alm_callback_t as_cb; /* Callback (if non-NULL) */ FAR void *as_arg; /* Argument for callback */ }; #endif /* CONFIG_RTC_ALARM */ /**************************************************************************** * Public Data ****************************************************************************/ #undef EXTERN #if defined(__cplusplus) #define EXTERN extern "C" extern "C" { #else #define EXTERN extern #endif /**************************************************************************** * Public Functions ****************************************************************************/ /************************************************************************************ * Name: rtc_is_inits * * Description: * Returns 'true' if the RTC has been initialized (according to the RTC itself). * It will be 'false' if the RTC has never been initialized since first time power * up, and the counters are stopped until it is first initialized. * * Input Parameters: * None * * Returned Value: * bool -- true if the INITS flag is set in the ISR. * ************************************************************************************/ #ifdef CONFIG_RTC_DRIVER bool rtc_is_inits(void); #endif /**************************************************************************** * Name: stm32l4_rtc_getdatetime_with_subseconds * * Description: * Get the current date and time from the date/time RTC. This interface * is only supported by the date/time RTC hardware implementation. * It is used to replace the system timer. It is only used by the RTOS * during initialization to set up the system time when CONFIG_RTC and * CONFIG_RTC_DATETIME are selected (and CONFIG_RTC_HIRES is not). * * NOTE: The sub-second accuracy is returned through 'nsec'. * * Input Parameters: * tp - The location to return the high resolution time value. * nsec - The location to return the subsecond time value. * * Returned Value: * Zero (OK) on success; a negated errno on failure * ****************************************************************************/ #ifdef CONFIG_STM32L4_HAVE_RTC_SUBSECONDS int stm32l4_rtc_getdatetime_with_subseconds(FAR struct tm *tp, FAR long *nsec); #endif /**************************************************************************** * Name: stm32l4_rtc_setdatetime * * Description: * Set the RTC to the provided time. RTC implementations which provide * up_rtc_getdatetime() (CONFIG_RTC_DATETIME is selected) should provide * this function. * * Input Parameters: * tp - the time to use * * Returned Value: * Zero (OK) on success; a negated errno on failure * ****************************************************************************/ #ifdef CONFIG_RTC_DATETIME struct tm; int stm32l4_rtc_setdatetime(FAR const struct tm *tp); #endif /**************************************************************************** * Name: stm32l4_rtc_setdatetime * * Description: * Check if RTC time has been set. * * Returned Value: * Returns true if RTC date-time have been previously set. * ****************************************************************************/ bool stm32l4_rtc_havesettime(void); #ifdef CONFIG_RTC_ALARM /**************************************************************************** * Name: stm32l4_rtc_setalarm * * Description: * Set an alarm to an asbolute time using associated hardware. * * Input Parameters: * alminfo - Information about the alarm configuration. * * Returned Value: * Zero (OK) on success; a negated errno on failure * ****************************************************************************/ int stm32l4_rtc_setalarm(FAR struct alm_setalarm_s *alminfo); /**************************************************************************** * Name: stm32l4_rtc_cancelalarm * * Description: * Cancel an alaram. * * Input Parameters: * alarmid - Identifies the alarm to be cancelled * * Returned Value: * Zero (OK) on success; a negated errno on failure * ****************************************************************************/ int stm32l4_rtc_cancelalarm(enum alm_id_e alarmid); #endif /* CONFIG_RTC_ALARM */ /**************************************************************************** * Name: stm32l4_rtc_lowerhalf * * Description: * Instantiate the RTC lower half driver for the STM32L4. General usage: * * #include * #include "stm32l4_rtc.h> * * struct rtc_lowerhalf_s *lower; * lower = stm32l4_rtc_lowerhalf(); * rtc_initialize(0, lower); * * Input Parameters: * None * * Returned Value: * On success, a non-NULL RTC lower interface is returned. NULL is * returned on any failure. * ****************************************************************************/ #ifdef CONFIG_RTC_DRIVER struct rtc_lowerhalf_s; FAR struct rtc_lowerhalf_s *stm32l4_rtc_lowerhalf(void); #endif #undef EXTERN #if defined(__cplusplus) } #endif #endif /* __ASSEMBLY__ */ #endif /* __ARCH_ARM_SRC_STM32L4_STM32L4_RTC_H */