183 lines
5.3 KiB
C
183 lines
5.3 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
/*
|
|
Concepts and parts of this file have been contributed by Uladzimir Pylinsky
|
|
aka barthess.
|
|
*/
|
|
|
|
/**
|
|
* @file hal_rtc_lld.h
|
|
* @brief PLATFORM RTC subsystem low level driver header.
|
|
*
|
|
* @addtogroup RTC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_RTC_LLD_H
|
|
#define HAL_RTC_LLD_H
|
|
|
|
#if (HAL_USE_RTC == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Implementation capabilities
|
|
*/
|
|
/**
|
|
* @brief Callback support int the driver.
|
|
*/
|
|
#define RTC_SUPPORTS_CALLBACKS TRUE
|
|
|
|
/**
|
|
* @brief Number of alarms available.
|
|
*/
|
|
#define RTC_ALARMS 2
|
|
|
|
/**
|
|
* @brief Presence of a local persistent storage.
|
|
*/
|
|
#define RTC_HAS_STORAGE FALSE
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name PLATFORM configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief RTCD1 driver enable switch.
|
|
* @details If set to @p TRUE the support for RTC1 is included.
|
|
* @note The default is @p FALSE.
|
|
*/
|
|
#if !defined(PLATFORM_RTC_USE_RTC1) || defined(__DOXYGEN__)
|
|
#define PLATFORM_RTC_USE_RTC1 FALSE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief FileStream specific methods.
|
|
*/
|
|
#define _rtc_driver_methods \
|
|
_file_stream_methods
|
|
|
|
/**
|
|
* @brief Type of an RTC alarm number.
|
|
*/
|
|
typedef uint32_t rtcalarm_t;
|
|
|
|
#if (RTC_SUPPORTS_CALLBACKS == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Type of an RTC event.
|
|
*/
|
|
typedef enum {
|
|
RTC_EVENT_SECOND = 0 /** Triggered every second. */
|
|
} rtcevent_t;
|
|
|
|
/**
|
|
* @brief Type of a generic RTC callback.
|
|
*/
|
|
typedef void (*rtccb_t)(RTCDriver *rtcp, rtcevent_t event);
|
|
#endif
|
|
|
|
/**
|
|
* @brief Type of a structure representing an RTC alarm time stamp.
|
|
*/
|
|
typedef struct {
|
|
/* End of the mandatory fields.*/
|
|
uint32_t dummy;
|
|
} RTCAlarm;
|
|
|
|
#if (RTC_HAS_STORAGE == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @extends FileStream
|
|
*
|
|
* @brief @p RTCDriver virtual methods table.
|
|
*/
|
|
struct RTCDriverVMT {
|
|
_rtc_driver_methods
|
|
};
|
|
#endif
|
|
|
|
/**
|
|
* @brief Structure representing an RTC driver.
|
|
*/
|
|
struct RTCDriver {
|
|
#if (RTC_HAS_STORAGE == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Virtual Methods Table.
|
|
*/
|
|
const struct RTCDriverVMT *vmt;
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
uint32_t dummy;
|
|
};
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if (PLATFORM_RTC_USE_RTC1 == TRUE) && !defined(__DOXYGEN__)
|
|
extern RTCDriver RTCD1;
|
|
#endif
|
|
|
|
#if (RTC_HAS_STORAGE == TRUE) && !defined(__DOXYGEN__)
|
|
extern struct RTCDriverVMT _rtc_lld_vmt;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void rtc_lld_init(void);
|
|
void rtc_lld_set_time(RTCDriver *rtcp, const RTCDateTime *timespec);
|
|
void rtc_lld_get_time(RTCDriver *rtcp, RTCDateTime *timespec);
|
|
#if RTC_ALARMS > 0
|
|
void rtc_lld_set_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm,
|
|
const RTCAlarm *alarmspec);
|
|
void rtc_lld_get_alarm(RTCDriver *rtcp,
|
|
rtcalarm_t alarm,
|
|
RTCAlarm *alarmspec);
|
|
#endif
|
|
#if RTC_SUPPORTS_CALLBACKS == TRUE
|
|
void rtc_lld_set_callback(RTCDriver *rtcp, rtccb_t callback);
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_RTC == TRUE */
|
|
|
|
#endif /* HAL_RTC_LLD_H */
|
|
|
|
/** @} */
|