timer.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/common/template/vsf_template_hal_driver.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_timer_isr_t
struct	vsf_timer_cfg_t
	timer configuration More...
struct	vsf_timer_channel_cfg_t
struct	vsf_timer_channel_request_t
struct	vsf_timer_status_t
	TIMER status information structure Contains the current status of TIMER operations. More...
struct	vsf_timer_capability_t

Macros
#define	__HAL_DRIVER_   ${SERIES/TIMER_IP}_TIMER_H__
#define	VSF_   ${TIMER_IP}_TIMER_CFG_MULTI_CLASS VSF_TIMER_CFG_MULTI_CLASS
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_REQUEST   ENABLED
#define	VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedefs
typedef enum vsf_timer_channel_mode_t	vsf_timer_channel_mode_t
typedef enum vsf_timer_irq_mask_t	vsf_timer_irq_mask_t
typedef enum vsf_timer_ctrl_t	vsf_timer_ctrl_t
typedef enum vsf_timer_channel_ctrl_t	vsf_timer_channel_ctrl_t
typedef struct vsf_timer_t	vsf_timer_t
typedef void	vsf_timer_isr_handler_t(void *target_ptr, vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)
typedef struct vsf_timer_isr_t	vsf_timer_isr_t
typedef struct vsf_timer_cfg_t	vsf_timer_cfg_t
typedef struct vsf_timer_channel_cfg_t	vsf_timer_channel_cfg_t
typedef struct vsf_timer_channel_request_t	vsf_timer_channel_request_t
typedef struct vsf_timer_status_t	vsf_timer_status_t
typedef struct vsf_timer_capability_t	vsf_timer_capability_t

Enumerations
enum	vsf_timer_channel_mode_t {   VSF_TIMER_CHANNEL_MODE_BASE = (0x00 << 0) ,   VSF_TIMER_BASE_ONESHOT = (0x00 << 1) ,   VSF_TIMER_BASE_CONTINUES = (0x01 << 1) }
enum	vsf_timer_irq_mask_t { VSF_TIMER_IRQ_MASK_OVERFLOW = (0x01 << 0) }
enum	vsf_timer_ctrl_t { __VSF_TIMER_CTRL_DUMMY = 0 }
enum	vsf_timer_channel_ctrl_t { __VSF_TIMER_CHANNEL_CTRL_DUMMY = 0 }

Variables
class vsf_$ *	reg
vsf_timer_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/TIMER_IP}_TIMER_H__

VSF_

#define VSF_   ${TIMER_IP}_TIMER_CFG_MULTI_CLASS VSF_TIMER_CFG_MULTI_CLASS

Note

When vsf_peripheral_status_t is inherited, vsf_template_hal_driver.h needs to be included

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_REQUEST

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_REQUEST   ENABLED

VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_timer_channel_mode_t

typedef enum vsf_timer_channel_mode_t vsf_timer_channel_mode_t

vsf_timer_irq_mask_t

typedef enum vsf_timer_irq_mask_t vsf_timer_irq_mask_t

vsf_timer_ctrl_t

typedef enum vsf_timer_ctrl_t vsf_timer_ctrl_t

vsf_timer_channel_ctrl_t

typedef enum vsf_timer_channel_ctrl_t vsf_timer_channel_ctrl_t

vsf_timer_t

typedef struct vsf_timer_t vsf_timer_t

Note

These types usually don't need to be reimplemented in hardware drivers. They can be reimplemented when existing configuration types don't meet requirements.

vsf_timer_isr_handler_t

typedef void vsf_timer_isr_handler_t(void *target_ptr, vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)

vsf_timer_isr_t

typedef struct vsf_timer_isr_t vsf_timer_isr_t

vsf_timer_cfg_t

typedef struct vsf_timer_cfg_t vsf_timer_cfg_t

vsf_timer_channel_cfg_t

typedef struct vsf_timer_channel_cfg_t vsf_timer_channel_cfg_t

Note

These types usually don't need to be reimplemented in hardware drivers. They can be reimplemented when existing channel configuration types don't meet requirements.

vsf_timer_channel_request_t

typedef struct vsf_timer_channel_request_t vsf_timer_channel_request_t

Note

These types usually don't need to be reimplemented in hardware drivers. They can be reimplemented when existing channel request types don't meet requirements.

vsf_timer_status_t

typedef struct vsf_timer_status_t vsf_timer_status_t

Note

These types usually don't need to be reimplemented in hardware drivers. They can be reimplemented when existing status types don't meet requirements.

vsf_timer_capability_t

typedef struct vsf_timer_capability_t vsf_timer_capability_t

Note

These types usually don't need to be reimplemented in hardware drivers. They can be reimplemented when existing capability types don't meet requirements.

Enumeration Type Documentation

vsf_timer_channel_mode_t

enum vsf_timer_channel_mode_t

Enumerator
VSF_TIMER_CHANNEL_MODE_BASE
VSF_TIMER_BASE_ONESHOT
VSF_TIMER_BASE_CONTINUES

vsf_timer_irq_mask_t

enum vsf_timer_irq_mask_t

Enumerator
VSF_TIMER_IRQ_MASK_OVERFLOW

vsf_timer_ctrl_t

enum vsf_timer_ctrl_t

Enumerator
__VSF_TIMER_CTRL_DUMMY

vsf_timer_channel_ctrl_t

enum vsf_timer_channel_ctrl_t

Enumerator
__VSF_TIMER_CHANNEL_CTRL_DUMMY

Variable Documentation

reg

class vsf_$* reg

isr

vsf_timer_isr_t isr