VSF Documented
timer_template.inc
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#if VSF_HAL_USE_TIMER == ENABLED
19
20/*============================ INCLUDES ======================================*/
21/*============================ MACROS ========================================*/
22
23#ifndef VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY
24# define VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY DISABLED
25#endif
26
27#ifndef VSF_TIMER_CFG_REIMPLEMENT_API_PWM_SET
28# define VSF_TIMER_CFG_REIMPLEMENT_API_PWM_SET DISABLED
29#endif
30
31#ifdef VSF_TIMER_CFG_IMP_REMAP_PREFIX
32# undef VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY
33# undef VSF_TIMER_CFG_REIMPLEMENT_API_PWM_SET
34# define VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY ENABLED
35# define VSF_TIMER_CFG_REIMPLEMENT_API_PWM_SET ENABLED
36#endif
37
38#if VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY == DISABLED
39# ifndef VSF_TIMER_CFG_CAPABILITY_IRQ_MASK
40# define VSF_TIMER_CFG_CAPABILITY_IRQ_MASK VSF_TIMER_IRQ_ALL_BITS_MASK
41# endif
42# ifndef VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN
43# define VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN 32
44# endif
45# ifndef VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM
46# define VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM 1
47# endif
48# ifndef VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT
49# define VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT 32
50# endif
51#endif
52
53/*============================ MACROFIED FUNCTIONS ===========================*/
54/*============================ TYPES =========================================*/
55/*============================ GLOBAL VARIABLES ==============================*/
56/*============================ LOCAL VARIABLES ===============================*/
57
58#define vsf_real_timer_t VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_t)
59#define vsf_real_timer_capability VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_capability)
60#define vsf_real_timer_pwm_set VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_pwm_set)
61
62/*============================ PROTOTYPES ====================================*/
63/*============================ IMPLEMENTATION ================================*/
64
65#if VSF_TIMER_CFG_REIMPLEMENT_API_PWM_SET == DISABLED
66vsf_err_t vsf_real_timer_pwm_set(vsf_real_timer_t *timer_ptr, uint8_t channel, uint32_t period, uint32_t pulse)
67{
68 VSF_HAL_ASSERT(NULL != timer_ptr);
69
70 VSF_HAL_ASSERT(0);
71 return VSF_ERR_FAIL;
72}
73#endif
74
75#if VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY == DISABLED
76vsf_timer_capability_t vsf_real_timer_capability(vsf_real_timer_t *timer_ptr)
77{
78 vsf_timer_capability_t timer_capability = {
79 .irq_mask = VSF_TIMER_CFG_CAPABILITY_IRQ_MASK,
80 .timer_bitlen = VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN,
81 .support_pwm = VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM,
82 .pwm_channel_cnt = VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT,
83 };
84
85 return timer_capability;
86}
87#endif
88
89/*============================ MACROS ========================================*/
90
91#undef VSF_TIMER_CFG_REIMPLEMENT_API_CAPABILITY
92#undef VSF_TIMER_CFG_CAPABILITY_IRQ_MASK
93#undef VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN
94#undef VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM
95#undef VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT
96#undef vsf_real_timer_t
97#undef vsf_real_timer_capability
98#undef vsf_real_timer_pwm_set
99
100/*============================ MACROS ========================================*/
101
102#ifdef VSF_TIMER_CFG_IMP_REMAP_PREFIX
103
104# define vsf_imp_timer_t VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_t)
105# define vsf_imp_timer_init VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_init)
106# define vsf_imp_timer_fini VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_fini)
107# define vsf_imp_timer_enable VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_enable)
108# define vsf_imp_timer_disable VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_disable)
109# define vsf_imp_timer_capability VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_capability)
110# define vsf_imp_timer_irq_enable VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_irq_enable)
111# define vsf_imp_timer_irq_disable VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_irq_disable)
112# define vsf_imp_timer_pwm_set VSF_MCONNECT(VSF_TIMER_CFG_IMP_PREFIX, _timer_pwm_set)
113
114# define vsf_remap_timer_t VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_t)
115# define vsf_remap_timer_init VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_init)
116# define vsf_remap_timer_fini VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_fini)
117# define vsf_remap_timer_enable VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_enable)
118# define vsf_remap_timer_disable VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_disable)
119# define vsf_remap_timer_capability VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_capability)
120# define vsf_remap_timer_irq_enable VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_irq_enable)
121# define vsf_remap_timer_irq_disable VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_irq_disable)
122# define vsf_remap_timer_pwm_set VSF_MCONNECT(VSF_TIMER_CFG_IMP_REMAP_PREFIX, _timer_pwm_set)
123
124# define VSF_TIMER_CFG_IMP_REMAP_FUNCTIONS \
125 vsf_err_t vsf_imp_timer_init(vsf_imp_timer_t *timer_ptr, vsf_timer_cfg_t *cfg_ptr) \
126 { \
127 VSF_HAL_ASSERT(timer_ptr != NULL); \
128 return vsf_remap_timer_init(timer_ptr, cfg_ptr); \
129 } \
130 void vsf_imp_timer_fini(vsf_imp_timer_t *timer_ptr) \
131 { \
132 VSF_HAL_ASSERT(timer_ptr != NULL); \
133 vsf_remap_timer_fini(timer_ptr); \
134 } \
135 fsm_rt_t vsf_imp_timer_enable(vsf_imp_timer_t *timer_ptr) \
136 { \
137 VSF_HAL_ASSERT(timer_ptr != NULL); \
138 return vsf_remap_timer_enable(timer_ptr); \
139 } \
140 fsm_rt_t vsf_imp_timer_disable(vsf_imp_timer_t *timer_ptr) \
141 { \
142 VSF_HAL_ASSERT(timer_ptr != NULL); \
143 return vsf_remap_timer_disable(timer_ptr); \
144 } \
145 void vsf_imp_timer_irq_enable(vsf_imp_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask) \
146 { \
147 VSF_HAL_ASSERT(timer_ptr != NULL); \
148 vsf_remap_timer_irq_enable(timer_ptr, irq_mask); \
149 } \
150 void vsf_imp_timer_irq_disable(vsf_imp_timer_t *timer_ptr, vsf_timer_irq_mask_t irq_mask) \
151 { \
152 VSF_HAL_ASSERT(timer_ptr != NULL); \
153 vsf_remap_timer_irq_disable(timer_ptr, irq_mask); \
154 } \
155 vsf_timer_capability_t vsf_imp_timer_capability(vsf_imp_timer_t *timer_ptr) \
156 { \
157 VSF_HAL_ASSERT(timer_ptr != NULL); \
158 return vsf_remap_timer_capability(timer_ptr); \
159 } \
160 vsf_err_t vsf_imp_timer_pwm_set(vsf_imp_timer_t *timer_ptr, uint8_t channel, uint32_t period, uint32_t pulse) \
161 { \
162 VSF_HAL_ASSERT(NULL != timer_ptr); \
163 return vsf_remap_timer_pwm_set(timer_ptr, channel, period, pulse); \
164 }
165#endif
166
167/*============================ GLOBAL VARIABLES ==============================*/
168
169#define VSF_HAL_TEMPLATE_IMP_NAME _timer
170#define VSF_HAL_TEMPLATE_IMP_UPCASE_NAME _TIMER
171
172#ifndef VSF_TIMER_CFG_IMP_PREFIX
173# error "Please define VSF_TIMER_CFG_IMP_PREFIX in timer driver"
174#endif
175
176#ifndef VSF_TIMER_CFG_IMP_UPCASE_PREFIX
177# error "Please define VSF_TIMER_CFG_IMP_UPCASE_PREFIX in timer driver"
178#endif
179
180#ifndef VSF_TIMER_CFG_IMP_COUNT_MASK_PREFIX
181# define VSF_TIMER_CFG_IMP_COUNT_MASK_PREFIX VSF_TIMER_CFG_IMP_UPCASE_PREFIX
182#endif
183
184#ifdef VSF_TIMER_CFG_IMP_REMAP_FUNCTIONS
185# define VSF_HAL_CFG_IMP_REMAP_FUNCTIONS VSF_TIMER_CFG_IMP_REMAP_FUNCTIONS
186#endif
187
188#include "hal/driver/common/template/vsf_template_instance_implementation.h"
189
190#undef VSF_TIMER_CFG_IMP_PREFIX
191#undef VSF_TIMER_CFG_IMP_COUNT_MASK_PREFIX
192#undef VSF_TIMER_CFG_IMP_UPCASE_PREFIX
193#undef VSF_TIMER_CFG_IMP_LV0
194#undef VSF_TIMER_CFG_IMP_REMAP_FUNCTIONS
195#undef VSF_TIMER_CFG_IMP_HAS_OP
196#undef VSF_TIMER_CFG_IMP_EXTERN_OP
197
198#undef vsf_imp_timer_t
199#undef vsf_imp_timer_init
200#undef vsf_imp_timer_fini
201#undef vsf_imp_timer_enable
202#undef vsf_imp_timer_disable
203#undef vsf_imp_timer_capability
204#undef vsf_imp_timer_irq_enable
205#undef vsf_imp_timer_irq_disable
206#undef vsf_imp_timer_pwm_set
207
208#undef vsf_remap_timer_t
209#undef vsf_remap_timer_init
210#undef vsf_remap_timer_fini
211#undef vsf_remap_timer_enable
212#undef vsf_remap_timer_disable
213#undef vsf_remap_timer_capability
214#undef vsf_remap_timer_irq_enable
215#undef vsf_remap_timer_irq_disable
216#undef vsf_remap_timer_pwm_set
217
218#endif /* VSF_HAL_USE_TIEMR */
vsf_err_t
vsf_err_t
Definition __type.h:42
VSF_ERR_FAIL
@ VSF_ERR_FAIL
failed
Definition __type.h:51
VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM
#define VSF_TIMER_CFG_CAPABILITY_SUPPORT_PWM
Definition timer.c:203
VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT
#define VSF_TIMER_CFG_CAPABILITY_PWM_CHANNEL_CNT
Definition timer.c:204
VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN
#define VSF_TIMER_CFG_CAPABILITY_TIMER_BITLEN
Definition timer.c:202
VSF_TIMER_CFG_CAPABILITY_IRQ_MASK
#define VSF_TIMER_CFG_CAPABILITY_IRQ_MASK
Definition timer.c:201
NULL
#define NULL
Definition stddef.h:52
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint8_t
unsigned char uint8_t
Definition stdint.h:5
vsf_timer_capability_t
Definition vsf_template_timer.h:161
vsf_timer_capability_t::timer_bitlen
uint8_t timer_bitlen
Definition vsf_template_timer.h:168
VSF_HAL_ASSERT
#define VSF_HAL_ASSERT(__CON)
all hal modules use this configuration file
Definition vsf_hal_cfg.h:36
vsf_template_instance_implementation.h
Generated by doxygen 1.9.8