rtc.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  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.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __HAL_DRIVER_${SERIES/RTC_IP}_RTC_H__
#define __HAL_DRIVER_${SERIES/RTC_IP}_RTC_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if VSF_HAL_USE_RTC == ENABLED
 
/*\note Refer to template/README.md for usage cases.
 *      For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
 *      For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
 *      For emulated drivers, **** No reimplementation ****.
 */
 
/*\note Includes CAN ONLY be put here. */
/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
 
// IPCore
#if     defined(__VSF_HAL_${RTC_IP}_RTC_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_HAL_${RTC_IP}_RTC_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
// IPCore end
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
/*\note VSF_${RTC_IP}_RTC_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
 *          while VSF_HW_RTC_CFG_MULTI_CLASS should be in rtc.c.
 */
 
// IPCore
#ifndef VSF_${RTC_IP}_RTC_CFG_MULTI_CLASS
#   define VSF_${RTC_IP}_RTC_CFG_MULTI_CLASS    VSF_RTC_CFG_MULTI_CLASS
#endif
// IPCore end
 
// HW
#define VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK     ENABLED
#define VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG          ENABLED
#define VSF_RTC_CFG_REIMPLEMENT_TYPE_CTRL         ENABLED
#define VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED
 
#define VSF_RTC_CFG_TIME_TYPE                     uint64_t
// HW end
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
// IPCore
vsf_class(vsf_${rtc_ip}_rtc_t) {
#if VSF_${RTC_IP}_CFG_MULTI_CLASS == ENABLED
    public_member(
        vsf_rtc_t               vsf_rtc;
    )
#endif
 
/*\note You can add more member in vsf_${rtc_ip}_rtc_t instance.
 *      For members accessible from child, put in protected_member.
 *      Else, put in private_member.
 */
 
    protected_member(
        vsf_${rtc_ip}_rtc_reg_t *reg;
        vsf_rtc_isr_t           isr;
    )
};
// IPCore end
 
// HW/IPCore, not for emulated drivers
#if VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
typedef enum vsf_rtc_irq_mask_t {
    VSF_RTC_IRQ_MASK_ALARM = (0x1ul << 0),
 
    // more vendor-specific irq mask
} vsf_rtc_irq_mask_t;
#endif
 
#if VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
typedef struct vsf_rtc_t vsf_rtc_t;
typedef void vsf_rtc_isr_handler_t(void *target_ptr, vsf_rtc_t *rtc_ptr, vsf_rtc_irq_mask_t irq_mask);
typedef struct vsf_rtc_isr_t {
    vsf_rtc_isr_handler_t *handler_fn;
    void *target_ptr;
    vsf_arch_prio_t prio;
} vsf_rtc_isr_t;
typedef struct vsf_rtc_cfg_t {
    vsf_rtc_isr_t isr;
} vsf_rtc_cfg_t;
#endif
 
#if VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
typedef struct vsf_rtc_capability_t {
#if VSF_RTC_CFG_INHERIT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
    vsf_rtc_irq_mask_t irq_mask;
} vsf_rtc_capability_t;
#endif
 
#if VSF_RTC_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
typedef enum vsf_rtc_ctrl_t {
    __VSF_RTC_CTRL_DUMMY = 0,
} vsf_rtc_ctrl_t;
#endif
 
// HW/IPCore end
 
/*============================ INCLUDES ======================================*/
 
// IPCore
/*\note Extern APIs for ip core diriver.
 *      There is no requirement about how APIs of IPCore drivers should be implemented.
 *      Just consider the simplicity for actual peripheral drivers.
 */
// IPCore end
 
#ifdef __cplusplus
}
#endif
 
// IPCore
#undef __VSF_HAL_${RTC_IP}_RTC_CLASS_IMPLEMENT
#undef __VSF_HAL_${RTC_IP}_RTC_CLASS_INHERIT__
// IPCore end
 
#endif      // VSF_HAL_USE_RTC
#endif      // __HAL_DRIVER_${SERIES/RTC_IP}_RTC_H__
/* EOF */