1 /*
2 * Copyright (c) 2023 TOKITA Hiroshi
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7 #include <hardware/timer.h>
8
9 #include <zephyr/drivers/counter.h>
10 #include <zephyr/drivers/clock_control.h>
11 #include <zephyr/drivers/reset.h>
12 #include <zephyr/sys/atomic.h>
13 #include <zephyr/irq.h>
14 #include <cmsis_core.h>
15
16 #define LOG_LEVEL CONFIG_COUNTER_LOG_LEVEL
17 #include <zephyr/logging/log.h>
18
19 LOG_MODULE_REGISTER(counter_rpi_pico_timer, LOG_LEVEL);
20
21 #define DT_DRV_COMPAT raspberrypi_pico_timer
22
23 struct counter_rpi_pico_timer_ch_data {
24 counter_alarm_callback_t callback;
25 void *user_data;
26 };
27
28 struct counter_rpi_pico_timer_data {
29 struct counter_rpi_pico_timer_ch_data *ch_data;
30 uint32_t guard_period;
31 };
32
33 struct counter_rpi_pico_timer_config {
34 struct counter_config_info info;
35 timer_hw_t *timer;
36 void (*irq_config)();
37 const struct device *clk_dev;
38 clock_control_subsys_t clk_id;
39 const struct reset_dt_spec reset;
40 };
41
counter_rpi_pico_timer_start(const struct device * dev)42 static int counter_rpi_pico_timer_start(const struct device *dev)
43 {
44 const struct counter_rpi_pico_timer_config *config = dev->config;
45
46 config->timer->pause = 0;
47
48 return 0;
49 }
50
counter_rpi_pico_timer_stop(const struct device * dev)51 static int counter_rpi_pico_timer_stop(const struct device *dev)
52 {
53 const struct counter_rpi_pico_timer_config *config = dev->config;
54
55 config->timer->pause = 1u;
56 config->timer->timelw = 0;
57 config->timer->timehw = 0;
58
59 return 0;
60 }
61
counter_rpi_pico_timer_get_top_value(const struct device * dev)62 static uint32_t counter_rpi_pico_timer_get_top_value(const struct device *dev)
63 {
64 const struct counter_rpi_pico_timer_config *config = dev->config;
65
66 return config->info.max_top_value;
67 }
68
counter_rpi_pico_timer_get_value(const struct device * dev,uint32_t * ticks)69 static int counter_rpi_pico_timer_get_value(const struct device *dev, uint32_t *ticks)
70 {
71 const struct counter_rpi_pico_timer_config *config = dev->config;
72
73 *ticks = timer_time_us_32(config->timer);
74 return 0;
75 }
76
counter_rpi_pico_timer_set_alarm(const struct device * dev,uint8_t id,const struct counter_alarm_cfg * alarm_cfg)77 static int counter_rpi_pico_timer_set_alarm(const struct device *dev, uint8_t id,
78 const struct counter_alarm_cfg *alarm_cfg)
79 {
80 const struct counter_rpi_pico_timer_config *config = dev->config;
81 struct counter_rpi_pico_timer_data *data = dev->data;
82 struct counter_rpi_pico_timer_ch_data *chdata = &data->ch_data[id];
83 uint64_t target = (alarm_cfg->flags & COUNTER_ALARM_CFG_ABSOLUTE) ? 0 : alarm_cfg->ticks;
84 absolute_time_t alarm_at;
85 bool missed;
86
87 update_us_since_boot(&alarm_at, config->timer->timerawl + target);
88
89 if (alarm_cfg->ticks > counter_rpi_pico_timer_get_top_value(dev)) {
90 return -EINVAL;
91 }
92
93 if (chdata->callback) {
94 return -EBUSY;
95 }
96
97 chdata->callback = alarm_cfg->callback;
98 chdata->user_data = alarm_cfg->user_data;
99
100 missed = timer_hardware_alarm_set_target(config->timer, id, alarm_at);
101
102 if (missed) {
103 if (alarm_cfg->flags & COUNTER_ALARM_CFG_EXPIRE_WHEN_LATE) {
104 timer_hardware_alarm_force_irq(config->timer, id);
105 }
106 chdata->callback = NULL;
107 chdata->user_data = NULL;
108 return -ETIME;
109 }
110
111 return 0;
112 }
113
counter_rpi_pico_timer_cancel_alarm(const struct device * dev,uint8_t id)114 static int counter_rpi_pico_timer_cancel_alarm(const struct device *dev, uint8_t id)
115 {
116 struct counter_rpi_pico_timer_data *data = dev->data;
117 struct counter_rpi_pico_timer_ch_data *chdata = &data->ch_data[id];
118 const struct counter_rpi_pico_timer_config *config = dev->config;
119
120 chdata->callback = NULL;
121 chdata->user_data = NULL;
122 timer_hardware_alarm_cancel(config->timer, id);
123
124 return 0;
125 }
126
counter_rpi_pico_timer_set_top_value(const struct device * dev,const struct counter_top_cfg * cfg)127 static int counter_rpi_pico_timer_set_top_value(const struct device *dev,
128 const struct counter_top_cfg *cfg)
129 {
130 ARG_UNUSED(dev);
131 ARG_UNUSED(cfg);
132
133 return -ENOTSUP;
134 }
135
counter_rpi_pico_timer_get_pending_int(const struct device * dev)136 static uint32_t counter_rpi_pico_timer_get_pending_int(const struct device *dev)
137 {
138 return 0;
139 }
140
counter_rpi_pico_timer_get_guard_period(const struct device * dev,uint32_t flags)141 static uint32_t counter_rpi_pico_timer_get_guard_period(const struct device *dev, uint32_t flags)
142 {
143 struct counter_rpi_pico_timer_data *data = dev->data;
144
145 return data->guard_period;
146 }
147
counter_rpi_pico_timer_set_guard_period(const struct device * dev,uint32_t guard,uint32_t flags)148 static int counter_rpi_pico_timer_set_guard_period(const struct device *dev, uint32_t guard,
149 uint32_t flags)
150 {
151 struct counter_rpi_pico_timer_data *data = dev->data;
152
153 __ASSERT_NO_MSG(guard < counter_rpi_pico_timer_get_top_value(dev));
154
155 data->guard_period = guard;
156
157 return 0;
158 }
159
counter_rpi_pico_irq_handle(uint32_t ch,void * arg)160 static void counter_rpi_pico_irq_handle(uint32_t ch, void *arg)
161 {
162 struct device *dev = arg;
163 const struct counter_rpi_pico_timer_config *config = dev->config;
164 struct counter_rpi_pico_timer_data *data = dev->data;
165 counter_alarm_callback_t cb = data->ch_data[ch].callback;
166 void *user_data = data->ch_data[ch].user_data;
167
168 if (cb) {
169 data->ch_data[ch].callback = NULL;
170 data->ch_data[ch].user_data = NULL;
171 cb(dev, ch, timer_time_us_32(config->timer), user_data);
172 }
173 }
174
counter_rpi_pico_timer_init(const struct device * dev)175 static int counter_rpi_pico_timer_init(const struct device *dev)
176 {
177 const struct counter_rpi_pico_timer_config *config = dev->config;
178 int ret;
179
180 ret = clock_control_on(config->clk_dev, config->clk_id);
181 if (ret < 0) {
182 return ret;
183 }
184
185 ret = reset_line_toggle_dt(&config->reset);
186 if (ret < 0) {
187 return ret;
188 }
189
190 config->irq_config();
191
192 return 0;
193 }
194
195 static DEVICE_API(counter, counter_rpi_pico_driver_api) = {
196 .start = counter_rpi_pico_timer_start,
197 .stop = counter_rpi_pico_timer_stop,
198 .get_value = counter_rpi_pico_timer_get_value,
199 .set_alarm = counter_rpi_pico_timer_set_alarm,
200 .cancel_alarm = counter_rpi_pico_timer_cancel_alarm,
201 .set_top_value = counter_rpi_pico_timer_set_top_value,
202 .get_pending_int = counter_rpi_pico_timer_get_pending_int,
203 .get_top_value = counter_rpi_pico_timer_get_top_value,
204 .get_guard_period = counter_rpi_pico_timer_get_guard_period,
205 .set_guard_period = counter_rpi_pico_timer_set_guard_period,
206 };
207
208 #define RPI_PICO_TIMER_IRQ_ENABLE(node_id, name, idx) \
209 do { \
210 timer_hardware_alarm_set_callback((timer_hw_t *)DT_REG_ADDR(node_id), idx, \
211 counter_rpi_pico_irq_handle); \
212 IRQ_CONNECT((DT_IRQ_BY_IDX(node_id, idx, irq)), \
213 (DT_IRQ_BY_IDX(node_id, idx, priority)), hardware_alarm_irq_handler, \
214 (DEVICE_DT_GET(node_id)), 0); \
215 irq_enable((DT_IRQ_BY_IDX(node_id, idx, irq))); \
216 } while (false);
217
218 #define COUNTER_RPI_PICO_TIMER(inst) \
219 static void counter_irq_config##inst(void) \
220 { \
221 DT_INST_FOREACH_PROP_ELEM(inst, interrupt_names, RPI_PICO_TIMER_IRQ_ENABLE); \
222 } \
223 static struct counter_rpi_pico_timer_ch_data \
224 ch_data##inst[DT_NUM_IRQS(DT_DRV_INST(inst))]; \
225 static struct counter_rpi_pico_timer_data counter_##inst##_data = { \
226 .ch_data = ch_data##inst, \
227 }; \
228 static const struct counter_rpi_pico_timer_config counter_##inst##_config = { \
229 .timer = (timer_hw_t *)DT_INST_REG_ADDR(inst), \
230 .irq_config = counter_irq_config##inst, \
231 .info = \
232 { \
233 .max_top_value = UINT32_MAX, \
234 .freq = 1000000, \
235 .flags = COUNTER_CONFIG_INFO_COUNT_UP, \
236 .channels = ARRAY_SIZE(ch_data##inst), \
237 }, \
238 .clk_dev = DEVICE_DT_GET(DT_INST_CLOCKS_CTLR(inst)), \
239 .clk_id = (clock_control_subsys_t)DT_INST_PHA_BY_IDX(inst, clocks, 0, clk_id), \
240 .reset = RESET_DT_SPEC_INST_GET(inst), \
241 }; \
242 DEVICE_DT_INST_DEFINE(inst, counter_rpi_pico_timer_init, NULL, &counter_##inst##_data, \
243 &counter_##inst##_config, PRE_KERNEL_1, \
244 CONFIG_COUNTER_INIT_PRIORITY, &counter_rpi_pico_driver_api);
245
246 DT_INST_FOREACH_STATUS_OKAY(COUNTER_RPI_PICO_TIMER)
247
