18#ifndef __VSF_TEMPLATE_TIMER_H__
19#define __VSF_TEMPLATE_TIMER_H__
38#ifndef VSF_TIMER_CFG_MULTI_CLASS
39# define VSF_TIMER_CFG_MULTI_CLASS ENABLED
50#if defined(VSF_HW_TIMER_COUNT) && !defined(VSF_HW_TIMER_MASK)
51# define VSF_HW_TIMER_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_TIMER_COUNT)
54#if defined(VSF_HW_TIMER_MASK) && !defined(VSF_HW_TIMER_COUNT)
55# define VSF_HW_TIMER_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_TIMER_MASK)
64#ifndef VSF_TIMER_CFG_PREFIX
65# if VSF_TIMER_CFG_MULTI_CLASS == ENABLED
66# define VSF_TIMER_CFG_PREFIX vsf
67# elif defined(VSF_HW_TIMER_COUNT) && (VSF_HW_TIMER_COUNT != 0)
68# define VSF_TIMER_CFG_PREFIX vsf_hw
70# define VSF_TIMER_CFG_PREFIX vsf
80#ifndef VSF_TIMER_CFG_FUNCTION_RENAME
81# define VSF_TIMER_CFG_FUNCTION_RENAME ENABLED
92#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK
93# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
106#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG
107# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG DISABLED
118#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE
119# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE DISABLED
131#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG
132# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG DISABLED
144#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_REQUEST
145# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_REQUEST DISABLED
156#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS
157# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
168#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL
169# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL DISABLED
180#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL
181# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL DISABLED
193#ifndef VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY
194# define VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
204#ifndef VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY
205# define VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY ENABLED
216#define VSF_TIMER_APIS(__prefix_name) \
217 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, init, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, vsf_timer_cfg_t *cfg_ptr) \
218 __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, fini, VSF_MCONNECT(__prefix_name, _t) *timer_ptr) \
219 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, get_configuration, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, vsf_timer_cfg_t *cfg_ptr) \
220 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, enable, VSF_MCONNECT(__prefix_name, _t) *timer_ptr) \
221 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, timer, disable, VSF_MCONNECT(__prefix_name, _t) *timer_ptr) \
222 __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_enable, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \
223 __VSF_HAL_TEMPLATE_API(__prefix_name, void, timer, irq_disable, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, vsf_timer_irq_mask_t irq_mask) \
224 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_timer_status_t, timer, status, VSF_MCONNECT(__prefix_name, _t) *timer_ptr) \
225 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_timer_capability_t, timer, capability, VSF_MCONNECT(__prefix_name, _t) *timer_ptr) \
226 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, set_period, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint32_t period) \
227 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, ctrl, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, vsf_timer_ctrl_t ctrl, void* param) \
228 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_config, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel, vsf_timer_channel_cfg_t *channel_cfg_ptr) \
229 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_start, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel) \
230 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_stop, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel) \
231 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_request_start, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel, vsf_timer_channel_request_t *request_ptr) \
232 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_request_stop, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel) \
233 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, timer, channel_ctrl, VSF_MCONNECT(__prefix_name, _t) *timer_ptr, uint8_t channel, vsf_timer_channel_ctrl_t ctrl, void* param)
237#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE == DISABLED
414#ifndef VSF_TIMER_CHANNEL_MODE_MASK
416#ifdef VSF_TIMER_CHANNEL_MODE_PWM
417 | VSF_TIMER_CHANNEL_MODE_PWM
419#ifdef VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE
420 | VSF_TIMER_CHANNEL_MODE_OUTPUT_COMPARE
422#ifdef VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE
423 | VSF_TIMER_CHANNEL_MODE_INPUT_CAPTURE
425#ifdef VSF_TIMER_CHANNEL_MODE_ENCODER
426 | VSF_TIMER_CHANNEL_MODE_ENCODER
428#ifdef VSF_TIMER_CHANNEL_MODE_ONE_PULSE
429 | VSF_TIMER_CHANNEL_MODE_ONE_PULSE
431#ifdef VSF_TIMER_CHANNEL_MODE_HALL_SENSOR
432 | VSF_TIMER_CHANNEL_MODE_HALL_SENSOR
437#ifndef VSF_TIMER_BASE_COUNTER_MASK
442#ifndef VSF_TIMER_CHANNEL_MODE_ALL_MASK
448#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
478#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
509#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == DISABLED
517#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
539#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CTRL == DISABLED
561#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == DISABLED
588#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
598#if VSF_TIMER_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
600#if VSF_TIMER_CFG_INHERIT_HAL_CAPABILITY == ENABLED
622#undef __VSF_HAL_TEMPLATE_API
623#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
629#if VSF_TIMER_CFG_MULTI_CLASS == ENABLED
941#if VSF_TIMER_CFG_FUNCTION_RENAME == ENABLED
942# define __vsf_timer_t VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_t)
943# define vsf_timer_init(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_init) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
944# define vsf_timer_fini(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_fini) ((__vsf_timer_t *)(__TIME))
945# define vsf_timer_enable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_enable) ((__vsf_timer_t *)(__TIME))
946# define vsf_timer_disable(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_disable) ((__vsf_timer_t *)(__TIME))
947# define vsf_timer_status(__TIMER) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_status) ((__vsf_timer_t *)(__TIMER))
948# define vsf_timer_capability(__TIME) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_capability) ((__vsf_timer_t *)(__TIME))
949# define vsf_timer_get_configuration(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_get_configuration) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
950# define vsf_timer_irq_enable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_enable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
951# define vsf_timer_irq_disable(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_irq_disable) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
952# define vsf_timer_set_period(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_set_period) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
953# define vsf_timer_ctrl(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_ctrl) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
954# define vsf_timer_channel_config(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_config) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
955# define vsf_timer_channel_start(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_start) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
956# define vsf_timer_channel_stop(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_stop) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
957# define vsf_timer_channel_request_start(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_request_start)((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
958# define vsf_timer_channel_request_stop(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_request_stop) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
959# define vsf_timer_channel_ctrl(__TIME, ...) VSF_MCONNECT(VSF_TIMER_CFG_PREFIX, _timer_channel_ctrl) ((__vsf_timer_t *)(__TIME), ##__VA_ARGS__)
vsf_err_t
Definition __type.h:42
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_timer_irq_mask_t
Definition timer.h:132
vsf_timer_channel_mode_t
Definition timer.h:122
void vsf_timer_isr_handler_t(void *target_ptr, vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)
Definition timer.h:160
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned short uint16_t
Definition stdint.h:7
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
Definition vsf_template_timer.h:599
uint8_t support_output_compare
Definition vsf_template_timer.h:614
uint8_t timer_bitlen
Definition vsf_template_timer.h:607
vsf_timer_irq_mask_t irq_mask
Definition timer.h:232
inherit(vsf_peripheral_capability_t) vsf_timer_irq_mask_t irq_mask
uint8_t support_one_pulse
Definition vsf_template_timer.h:616
uint8_t channel_cnt
Definition vsf_template_timer.h:609
uint8_t support_input_capture
Definition vsf_template_timer.h:615
uint8_t support_pwm
Definition vsf_template_timer.h:613
timer configuration
Definition vsf_template_timer.h:499
uint32_t freq
Definition vsf_template_timer.h:502
uint32_t min_freq
Definition vsf_template_timer.h:503
uint32_t period
Period in Tick.
Definition vsf_template_timer.h:500
vsf_timer_isr_t isr
ISR config.
Definition vsf_template_timer.h:505
Definition vsf_template_timer.h:510
vsf_timer_channel_mode_t mode
Definition vsf_template_timer.h:511
uint32_t pulse
Definition vsf_template_timer.h:512
Definition vsf_template_timer.h:562
uint16_t length
Definition vsf_template_timer.h:563
uint32_t * pulse_buffer
Definition vsf_template_timer.h:568
uint32_t * channel_a_buffer
Definition vsf_template_timer.h:573
uint32_t * input_capture_buffer
Definition vsf_template_timer.h:570
uint32_t * channel_b_buffer
Definition vsf_template_timer.h:574
uint32_t * period_buffer
Definition vsf_template_timer.h:566
Definition vsf_template_timer.h:485
vsf_arch_prio_t prio
Definition vsf_template_timer.h:488
vsf_timer_isr_handler_t * handler_fn
Definition vsf_template_timer.h:486
void * target_ptr
Definition vsf_template_timer.h:487
Definition vsf_template_timer.h:620
TIMER status information structure Contains the current status of TIMER operations.
Definition vsf_template_timer.h:589
uint32_t value
Definition timer.h:220
Definition vsf_template_timer.h:630
const vsf_timer_op_t * op
Definition vsf_template_timer.h:631
fsm_rt_t
Definition vsf_fsm.h:315
struct vsf_timer_capability_t vsf_timer_capability_t
#define VSF_TIMER_APIS(__prefix_name)
Timer API template macros for generating timer function declarations and implementations.
Definition vsf_template_timer.h:216
void vsf_timer_fini(vsf_timer_t *timer_ptr)
Finalize a TIMER instance.
Definition timer_common.c:45
vsf_timer_irq_mask_t
Definition vsf_template_timer.h:449
@ VSF_TIMER_IRQ_MASK_OVERFLOW
Definition vsf_template_timer.h:450
vsf_err_t vsf_timer_set_period(vsf_timer_t *timer_ptr, uint32_t period)
TIMER set period (maximum count), used for change the period of TIMER dynamically.
Definition timer_common.c:109
vsf_err_t vsf_timer_channel_stop(vsf_timer_t *timer_ptr, uint8_t channel)
stop a TIMER channel
Definition timer_common.c:146
vsf_timer_status_t vsf_timer_status(vsf_timer_t *timer_ptr)
Get the status of TIMER instance.
Definition timer_common.c:91
struct vsf_timer_channel_cfg_t vsf_timer_channel_cfg_t
struct vsf_timer_channel_request_t vsf_timer_channel_request_t
@ VSF_TIMER_IRQ_ALL_BITS_MASK
Definition vsf_template_timer.h:475
@ VSF_TIMER_IRQ_COUNT
Definition vsf_template_timer.h:474
vsf_timer_channel_mode_t
Definition vsf_template_timer.h:238
@ VSF_TIMER_CHANNEL_MODE_BASE
Definition vsf_template_timer.h:241
@ VSF_TIMER_BASE_ONESHOT
Definition vsf_template_timer.h:289
@ VSF_TIMER_BASE_CONTINUES
Definition vsf_template_timer.h:291
vsf_err_t vsf_timer_channel_request_stop(vsf_timer_t *timer_ptr, uint8_t channel)
stop a TIMER channel request.
vsf_timer_capability_t vsf_timer_capability(vsf_timer_t *timer_ptr)
get the capability of TIMER instance.
Definition timer_common.c:100
vsf_timer_ctrl_t
Predefined VSF TIMER control command that can be reimplemented in specific hal drivers....
Definition vsf_template_timer.h:534
@ __VSF_TIMER_CTRL_DUMMY
Dummy value for compilation.
Definition vsf_template_timer.h:535
struct vsf_timer_isr_t vsf_timer_isr_t
void vsf_timer_isr_handler_t(void *target_ptr, vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)
Definition vsf_template_timer.h:481
void vsf_timer_irq_enable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)
Enable interrupt masks of TIMER instance.
Definition timer_common.c:72
vsf_err_t vsf_timer_channel_ctrl(vsf_timer_t *timer_ptr, uint8_t channel, vsf_timer_channel_ctrl_t ctrl, void *param)
Execute a control command on the TIMER channel.
Definition timer_common.c:155
vsf_err_t vsf_timer_channel_request_start(vsf_timer_t *timer_ptr, uint8_t channel, vsf_timer_channel_request_t *request_ptr)
start a TIMER channel request (usually based on DMA)
vsf_err_t vsf_timer_get_configuration(vsf_timer_t *timer_ptr, vsf_timer_cfg_t *cfg_ptr)
Get the current configuration of a TIMER instance.
Definition timer_common.c:165
vsf_err_t vsf_timer_ctrl(vsf_timer_t *timer_ptr, vsf_timer_ctrl_t ctrl, void *param)
Execute a control command on the TIMER instance.
Definition timer_common.c:118
void vsf_timer_irq_disable(vsf_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask)
Disable interrupt masks of TIMER instance.
Definition timer_common.c:81
struct vsf_timer_status_t vsf_timer_status_t
TIMER status information structure Contains the current status of TIMER operations.
@ VSF_TIMER_CHANNEL_MODE_ALL_MASK
Definition vsf_template_timer.h:443
@ VSF_TIMER_CHANNEL_MODE_MASK
Definition vsf_template_timer.h:415
@ VSF_TIMER_BASE_COUNTER_MASK
Definition vsf_template_timer.h:438
vsf_err_t vsf_timer_init(vsf_timer_t *timer_ptr, vsf_timer_cfg_t *cfg_ptr)
Initialize a Timer instance.
Definition timer_common.c:37
struct vsf_timer_cfg_t vsf_timer_cfg_t
timer configuration
fsm_rt_t vsf_timer_enable(vsf_timer_t *timer_ptr)
Enable a TIMER instance.
Definition timer_common.c:54
fsm_rt_t vsf_timer_disable(vsf_timer_t *timer_ptr)
Disable a TIMER instance.
Definition timer_common.c:63
vsf_timer_channel_ctrl_t
Predefined VSF TIMER control command that can be reimplemented in specific hal drivers....
Definition vsf_template_timer.h:556
@ __VSF_TIMER_CHANNEL_CTRL_DUMMY
Dummy value for compilation.
Definition vsf_template_timer.h:557
vsf_err_t vsf_timer_channel_config(vsf_timer_t *timer_ptr, uint8_t channel, vsf_timer_channel_cfg_t *channel_cfg_ptr)
TIMER set the period width and pulse width for a channel.
Definition timer_common.c:127
vsf_err_t vsf_timer_channel_start(vsf_timer_t *timer_ptr, uint8_t channel)
start a TIMER channel
Definition timer_common.c:137