rtc.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "../../__device.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_rtc_isr_t
	RTC interrupt service routine configuration structure. More...
struct	vsf_rtc_cfg_t
	RTC configuration structure. More...
struct	vsf_rtc_capability_t
	RTC capability structure. Describes the features and capabilities supported by the RTC hardware. More...

Macros
#define	__HAL_DRIVER_   ${SERIES/RTC_IP}_RTC_H__
#define	VSF_   ${RTC_IP}_RTC_CFG_MULTI_CLASS VSF_RTC_CFG_MULTI_CLASS
#define	VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED
#define	VSF_RTC_CFG_TIME_TYPE   uint64_t

Typedefs
typedef enum vsf_rtc_irq_mask_t	vsf_rtc_irq_mask_t
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_t
typedef struct vsf_rtc_cfg_t	vsf_rtc_cfg_t
typedef struct vsf_rtc_capability_t	vsf_rtc_capability_t

Enumerations
enum	vsf_rtc_irq_mask_t { VSF_RTC_IRQ_MASK_ALARM = (0x1ul << 0) }

Variables
class vsf_$ *	reg
vsf_rtc_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/RTC_IP}_RTC_H__

VSF_

#define VSF_   ${RTC_IP}_RTC_CFG_MULTI_CLASS VSF_RTC_CFG_MULTI_CLASS

VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

Note

hw RTC driver can reimplement following types: To enable reimplementation, please enable macro below: VSF_RTC_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_rtc_irq_mask_t VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG for vsf_rtc_cfg_t VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_rtc_capability_t Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers. *** DO NOT reimplement these in emulated drivers. ***

VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_RTC_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_RTC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

VSF_RTC_CFG_TIME_TYPE

#define VSF_RTC_CFG_TIME_TYPE   uint64_t

Note

VSF_RTC_CFG_TIME_TYPE can be implemented for hw drivers.

Typedef Documentation

vsf_rtc_irq_mask_t

typedef enum vsf_rtc_irq_mask_t vsf_rtc_irq_mask_t

vsf_rtc_t

typedef struct vsf_rtc_t vsf_rtc_t

vsf_rtc_isr_handler_t

typedef void vsf_rtc_isr_handler_t(void *target_ptr, vsf_rtc_t *rtc_ptr, vsf_rtc_irq_mask_t irq_mask)

vsf_rtc_isr_t

typedef struct vsf_rtc_isr_t vsf_rtc_isr_t

vsf_rtc_cfg_t

typedef struct vsf_rtc_cfg_t vsf_rtc_cfg_t

vsf_rtc_capability_t

typedef struct vsf_rtc_capability_t vsf_rtc_capability_t

Enumeration Type Documentation

vsf_rtc_irq_mask_t

enum vsf_rtc_irq_mask_t

Enumerator
VSF_RTC_IRQ_MASK_ALARM

Variable Documentation

reg

class vsf_$* reg

isr

vsf_rtc_isr_t isr