diff options
Diffstat (limited to 'watch-library/hal/include/hal_calendar.h')
| -rw-r--r-- | watch-library/hal/include/hal_calendar.h | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/watch-library/hal/include/hal_calendar.h b/watch-library/hal/include/hal_calendar.h new file mode 100644 index 00000000..26949a57 --- /dev/null +++ b/watch-library/hal/include/hal_calendar.h @@ -0,0 +1,159 @@ +/** + * \file + * + * \brief Generic CALENDAR functionality declaration. + * + * Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries. + * + * \asf_license_start + * + * \page License + * + * Subject to your compliance with these terms, you may use Microchip + * software and any derivatives exclusively with Microchip products. + * It is your responsibility to comply with third party license terms applicable + * to your use of third party software (including open source software) that + * may accompany Microchip software. + * + * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, + * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, + * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, + * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE + * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL + * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE + * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE + * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT + * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY + * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, + * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. + * + * \asf_license_stop + * + */ + +#ifndef _HAL_CALENDER_H_INCLUDED +#define _HAL_CALENDER_H_INCLUDED + +#include "hpl_calendar.h" +#include <utils_list.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * \addtogroup doc_driver_hal_calendar_async + * + *@{ + */ + +/** \brief Prototype of callback on alarm match + * \param calendar Pointer to the HAL Calendar instance. + */ +typedef void (*calendar_cb_alarm_t)(struct calendar_descriptor *const calendar); + +/** \brief Struct for alarm time + */ +struct calendar_alarm { + struct list_element elem; + struct _calendar_alarm cal_alarm; + calendar_cb_alarm_t callback; +}; + +/** \brief Initialize the Calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \param hw Pointer to the hardware instance. + * \return Operation status of init + * \retval 0 Completed successfully. + */ +int32_t calendar_init(struct calendar_descriptor *const calendar, const void *hw); + +/** \brief Reset the Calendar HAL instance and hardware + * + * Reset Calendar instance to hardware defaults. + * + * \param calendar Pointer to the HAL Calendar instance. + * \return Operation status of reset. + * \retval 0 Completed successfully. + */ +int32_t calendar_deinit(struct calendar_descriptor *const calendar); + +/** \brief Enable the Calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \return Operation status of init + * \retval 0 Completed successfully. + */ +int32_t calendar_enable(struct calendar_descriptor *const calendar); + +/** \brief Disable the Calendar HAL instance and hardware + * + * Disable Calendar instance to hardware defaults. + * + * \param calendar Pointer to the HAL Calendar instance. + * \return Operation status of reset. + * \retval 0 Completed successfully. + */ +int32_t calendar_disable(struct calendar_descriptor *const calendar); + +/** \brief Configure the base year for calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \param p_base_year The desired base year. + * \retval 0 Completed successfully. + */ +int32_t calendar_set_baseyear(struct calendar_descriptor *const calendar, const uint32_t p_base_year); + +/** \brief Configure the time for calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \param p_calendar_time Pointer to the time configuration. + * \retval 0 Completed successfully. + */ +int32_t calendar_set_time(struct calendar_descriptor *const calendar, struct calendar_time *const p_calendar_time); + +/** \brief Configure the date for calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \param p_calendar_date Pointer to the date configuration. + * \return Operation status of time set. + * \retval 0 Completed successfully. + */ +int32_t calendar_set_date(struct calendar_descriptor *const calendar, struct calendar_date *const p_calendar_date); + +/** \brief Get the time for calendar HAL instance and hardware + * + * \param calendar Pointer to the HAL Calendar instance. + * \param date_time Pointer to the value that will be filled with the current time. + * \return Operation status of time retrieve. + * \retval 0 Completed successfully. + */ +int32_t calendar_get_date_time(struct calendar_descriptor *const calendar, struct calendar_date_time *const date_time); + +/** \brief Config the alarm time for calendar HAL instance and hardware + * + * Set the alarm time to calendar instance. If the callback is NULL, remove + * the alarm if the alarm is already added, otherwise, ignore the alarm. + * + * \param calendar Pointer to the HAL Calendar instance. + * \param alarm Pointer to the configuration. + * \param callback Pointer to the callback function. + * \return Operation status of alarm time set. + * \retval 0 Completed successfully. + */ +int32_t calendar_set_alarm(struct calendar_descriptor *const calendar, struct calendar_alarm *const alarm, + calendar_cb_alarm_t callback); + +/** \brief Retrieve the current driver version + * \return Current driver version. + */ +uint32_t calendar_get_version(void); + +/**@}*/ + +#ifdef __cplusplus +} +#endif + +#endif /* _HAL_CALENDER_H_INCLUDED */ |