summaryrefslogtreecommitdiff
path: root/bsp/hc32f4a0/drivers/drv_pulse_encoder.c
blob: ee68f5e80894005e903d327fdd11a4543608589e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
/*
 * Copyright (C) 2020, Huada Semiconductor Co., Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2020-10-30     CDT          first version
 */

#include <rtdevice.h>
#include <rtdbg.h>

#ifdef RT_USING_PULSE_ENCODER

#if !defined(BSP_USING_PULSE_ENCODER1)  && !defined(BSP_USING_PULSE_ENCODER2)  && !defined(BSP_USING_PULSE_ENCODER3) && \
    !defined(BSP_USING_PULSE_ENCODER4)  && !defined(BSP_USING_PULSE_ENCODER5)  && !defined(BSP_USING_PULSE_ENCODER6) && \
    !defined(BSP_USING_PULSE_ENCODER7)  && !defined(BSP_USING_PULSE_ENCODER8)  && !defined(BSP_USING_PULSE_ENCODER9) && \
    !defined(BSP_USING_PULSE_ENCODER10) && !defined(BSP_USING_PULSE_ENCODER11) && !defined(BSP_USING_PULSE_ENCODER12)
#error "Please define at least one BSP_USING_PULSE_ENCODERx"
/* this driver can be disabled at menuconfig -> Hardware Drivers Config -> On-chip Peripheral Drivers -> Enable Pulse Encoder */
#endif

#include "drv_pulse_encoder.h"
#include "drv_irq.h"

#define TIMER_AUTO_RELOAD_VALUE         (0xFFFFU)

enum
{
#ifdef BSP_USING_PULSE_ENCODER1
    PULSE_ENCODER1_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER2
    PULSE_ENCODER2_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER3
    PULSE_ENCODER3_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER4
    PULSE_ENCODER4_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER5
    PULSE_ENCODER5_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER6
    PULSE_ENCODER6_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER7
    PULSE_ENCODER7_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER8
    PULSE_ENCODER8_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER9
    PULSE_ENCODER9_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER10
    PULSE_ENCODER10_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER11
    PULSE_ENCODER11_INDEX,
#endif
#ifdef BSP_USING_PULSE_ENCODER12
    PULSE_ENCODER12_INDEX,
#endif
};

#ifdef BSP_USING_PULSE_ENCODER1
static void pulse_encoder1_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER2
static void pulse_encoder2_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER3
static void pulse_encoder3_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER4
static void pulse_encoder4_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER5
static void pulse_encoder5_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER6
static void pulse_encoder6_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER7
static void pulse_encoder7_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER8
static void pulse_encoder8_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER9
static void pulse_encoder9_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER10
static void pulse_encoder10_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER11
static void pulse_encoder11_irq_handler(void);
#endif
#ifdef BSP_USING_PULSE_ENCODER12
static void pulse_encoder12_irq_handler(void);
#endif

struct hc32_pulse_encoder_config
{
    struct rt_pulse_encoder_device pulse_encoder;
    M4_TMRA_TypeDef        *timer_periph;
    struct hc32_irq_config ovf_irq_config;
    struct hc32_irq_config udf_irq_config;
    func_ptr_t             irq_callback;
    rt_int32_t             ovf_udf_count;
    char                   *name;
};

#ifndef HC32_PULSE_ENCODER_CONFIG
#define HC32_PULSE_ENCODER_CONFIG(periph, irq, label, ovf_src, udf_src,        \
                                  ovf_irq_info, udf_irq_info)                  \
    {                                                                          \
        .timer_periph           = periph,                                      \
        .irq_callback           = irq,                                         \
        .name                   = label,                                       \
        .ovf_irq_config         = ovf_irq_info,                                \
        .udf_irq_config         = udf_irq_info,                                \
        .ovf_irq_config.int_src = ovf_src,                                     \
        .udf_irq_config.int_src = udf_src,                                     \
    }
#endif /* HC32_PULSE_ENCODER_CONFIG */

static struct hc32_pulse_encoder_config pulse_encoder_obj[] =
{
#ifdef BSP_USING_PULSE_ENCODER1
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_1,  pulse_encoder1_irq_handler,  "pulse1",  INT_TMRA_1_OVF,  INT_TMRA_1_UDF,
                              PULSE_ENCODER1_OVF_IRQ_CONFIG,  PULSE_ENCODER1_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER2
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_2,  pulse_encoder2_irq_handler,  "pulse2",  INT_TMRA_2_OVF,  INT_TMRA_2_UDF,
                              PULSE_ENCODER2_OVF_IRQ_CONFIG,  PULSE_ENCODER2_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER3
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_3,  pulse_encoder3_irq_handler,  "pulse3",  INT_TMRA_3_OVF,  INT_TMRA_3_UDF,
                              PULSE_ENCODER3_OVF_IRQ_CONFIG,  PULSE_ENCODER3_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER4
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_4,  pulse_encoder4_irq_handler,  "pulse4",  INT_TMRA_4_OVF,  INT_TMRA_4_UDF,
                              PULSE_ENCODER4_OVF_IRQ_CONFIG,  PULSE_ENCODER4_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER5
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_5,  pulse_encoder5_irq_handler,  "pulse5",  INT_TMRA_5_OVF,  INT_TMRA_5_UDF,
                              PULSE_ENCODER5_OVF_IRQ_CONFIG,  PULSE_ENCODER5_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER6
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_6,  pulse_encoder6_irq_handler,  "pulse6",  INT_TMRA_6_OVF,  INT_TMRA_6_UDF,
                              PULSE_ENCODER6_OVF_IRQ_CONFIG,  PULSE_ENCODER6_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER7
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_7,  pulse_encoder7_irq_handler,  "pulse7",  INT_TMRA_7_OVF,  INT_TMRA_7_UDF,
                              PULSE_ENCODER7_OVF_IRQ_CONFIG,  PULSE_ENCODER7_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER8
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_8,  pulse_encoder8_irq_handler,  "pulse8",  INT_TMRA_8_OVF,  INT_TMRA_8_UDF,
                              PULSE_ENCODER8_OVF_IRQ_CONFIG,  PULSE_ENCODER8_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER9
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_9,  pulse_encoder9_irq_handler,  "pulse9",  INT_TMRA_9_OVF,  INT_TMRA_9_UDF,
                              PULSE_ENCODER9_OVF_IRQ_CONFIG,  PULSE_ENCODER9_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER10
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_10, pulse_encoder10_irq_handler, "pulse10", INT_TMRA_10_OVF, INT_TMRA_10_UDF,
                              PULSE_ENCODER10_OVF_IRQ_CONFIG,  PULSE_ENCODER10_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER11
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_11, pulse_encoder11_irq_handler, "pulse11", INT_TMRA_11_OVF, INT_TMRA_11_UDF,
                              PULSE_ENCODER11_OVF_IRQ_CONFIG,  PULSE_ENCODER11_UDF_IRQ_CONFIG),
#endif
#ifdef BSP_USING_PULSE_ENCODER12
    HC32_PULSE_ENCODER_CONFIG(M4_TMRA_12, pulse_encoder12_irq_handler, "pulse12", INT_TMRA_12_OVF, INT_TMRA_12_UDF,
                              PULSE_ENCODER12_OVF_IRQ_CONFIG,  PULSE_ENCODER12_UDF_IRQ_CONFIG),
#endif
};

static void hc32_pulse_encoder_irq_handler(struct hc32_pulse_encoder_config *pulse_encoder_config)
{
    if (Set == TMRA_GetStatus(pulse_encoder_config->timer_periph, TMRA_FLAG_OVF))
    {
        pulse_encoder_config->ovf_udf_count++;
        TMRA_ClrStatus(pulse_encoder_config->timer_periph, TMRA_FLAG_OVF);
    }
    if (Set == TMRA_GetStatus(pulse_encoder_config->timer_periph, TMRA_FLAG_UNF))
    {
        pulse_encoder_config->ovf_udf_count--;
        TMRA_ClrStatus(pulse_encoder_config->timer_periph, TMRA_FLAG_UNF);
    }
}

#ifdef BSP_USING_PULSE_ENCODER1
static void pulse_encoder1_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER1_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER2
static void pulse_encoder2_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER2_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER3
static void pulse_encoder3_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER3_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER4
static void pulse_encoder4_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER4_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER5
static void pulse_encoder5_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER5_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER6
static void pulse_encoder6_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER6_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER7
static void pulse_encoder7_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER7_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER8
static void pulse_encoder8_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER8_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER9
static void pulse_encoder9_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER9_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER10
static void pulse_encoder10_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER10_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER11
static void pulse_encoder11_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER11_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

#ifdef BSP_USING_PULSE_ENCODER12
static void pulse_encoder12_irq_handler(void)
{
    /* enter interrupt */
    rt_interrupt_enter();
    hc32_pulse_encoder_irq_handler(&pulse_encoder_obj[PULSE_ENCODER12_INDEX]);
    /* leave interrupt */
    rt_interrupt_leave();
}
#endif

static rt_uint16_t hc32_timer_get_unit_number(M4_TMRA_TypeDef *TMRAx)
{
    rt_uint16_t unit_num;
    const rt_uint32_t unit_step = 0x400U;

    if (((rt_uint32_t)TMRAx) >= ((rt_uint32_t)M4_TMRA_1))
    {
        unit_num = (((rt_uint32_t)TMRAx) - ((rt_uint32_t)M4_TMRA_1)) / unit_step;
    }
    else
    {
        unit_num = (((rt_uint32_t)TMRAx) - ((rt_uint32_t)M4_TMRA_5)) / unit_step + 4;
    }

    return unit_num;
}

static void hc32_timer_clock_config(M4_TMRA_TypeDef *TMRAx, en_functional_state_t enNewState)
{
    rt_uint32_t timer_periph;
    rt_uint16_t unit_num;

    unit_num     = hc32_timer_get_unit_number(TMRAx);
    timer_periph = PWC_FCG2_TMRA_1 << unit_num;
    PWC_Fcg2PeriphClockCmd(timer_periph, enNewState);
}

extern rt_err_t rt_hw_board_pulse_encoder_init(M4_TMRA_TypeDef *TMRAx);

rt_err_t hc32_pulse_encoder_init(struct rt_pulse_encoder_device *pulse_encoder)
{
    struct hc32_pulse_encoder_config *pulse_encoder_device;
    stc_tmra_init_t stcTmraInit;
    rt_err_t result;

    RT_ASSERT(pulse_encoder != RT_NULL);
    pulse_encoder_device = (struct hc32_pulse_encoder_config*)pulse_encoder;
    /* Enable Timer peripheral clock. */
    hc32_timer_clock_config(pulse_encoder_device->timer_periph, Enable);
    /* pwm pin configuration */
    result = rt_hw_board_pulse_encoder_init(pulse_encoder_device->timer_periph);
    if (RT_EOK == result)
    {
        TMRA_DeInit(pulse_encoder_device->timer_periph);
        TMRA_StructInit(&stcTmraInit);
        stcTmraInit.u32PeriodVal = TIMER_AUTO_RELOAD_VALUE;
        stcTmraInit.u32ClkSrc    = TMRA_CLK_HW_UP_CLKBH_CLKAR | TMRA_CLK_HW_DOWN_CLKBL_CLKAR;
        TMRA_Init(pulse_encoder_device->timer_periph, &stcTmraInit);
        LOG_D("%s init success", pulse_encoder_device->name);

        hc32_install_irq_handler(&pulse_encoder_device->ovf_irq_config, pulse_encoder_device->irq_callback, RT_FALSE);
        NVIC_EnableIRQ(pulse_encoder_device->ovf_irq_config.irq);
        hc32_install_irq_handler(&pulse_encoder_device->udf_irq_config, pulse_encoder_device->irq_callback, RT_FALSE);
        NVIC_EnableIRQ(pulse_encoder_device->udf_irq_config.irq);
        /* clear update flag */
        TMRA_ClrStatus(pulse_encoder_device->timer_periph, (TMRA_FLAG_OVF | TMRA_FLAG_UNF));
    }

    return result;
}

rt_err_t hc32_pulse_encoder_clear_count(struct rt_pulse_encoder_device *pulse_encoder)
{
    struct hc32_pulse_encoder_config *pulse_encoder_device;

    pulse_encoder_device = (struct hc32_pulse_encoder_config*)pulse_encoder;
    pulse_encoder_device->ovf_udf_count = 0;
    TMRA_Stop(pulse_encoder_device->timer_periph);
    TMRA_SetCntVal(pulse_encoder_device->timer_periph, 0);
    TMRA_ClrStatus(pulse_encoder_device->timer_periph, (TMRA_FLAG_OVF | TMRA_FLAG_UNF));
    TMRA_Start(pulse_encoder_device->timer_periph);  

    return RT_EOK;
}

rt_int32_t hc32_pulse_encoder_get_count(struct rt_pulse_encoder_device *pulse_encoder)
{
    struct hc32_pulse_encoder_config *pulse_encoder_device;
    rt_int32_t period_val;
    rt_int32_t count_val;

    pulse_encoder_device = (struct hc32_pulse_encoder_config*)pulse_encoder;
    period_val = TMRA_GetCntVal(pulse_encoder_device->timer_periph);
    count_val = period_val + pulse_encoder_device->ovf_udf_count * TIMER_AUTO_RELOAD_VALUE;

    return count_val;
}

rt_err_t hc32_pulse_encoder_control(struct rt_pulse_encoder_device *pulse_encoder, rt_uint32_t cmd, void *args)
{
    rt_err_t result = RT_EOK;
    struct hc32_pulse_encoder_config *pulse_encoder_device;
    pulse_encoder_device = (struct hc32_pulse_encoder_config*)pulse_encoder;

    switch (cmd)
    {
    case PULSE_ENCODER_CMD_ENABLE:
        TMRA_IntCmd(pulse_encoder_device->timer_periph, (TMRA_INT_OVF | TMRA_INT_UNF), Enable);
        TMRA_Start(pulse_encoder_device->timer_periph);
        break;
    case PULSE_ENCODER_CMD_DISABLE:
        TMRA_Stop(pulse_encoder_device->timer_periph);
        TMRA_IntCmd(pulse_encoder_device->timer_periph, (TMRA_INT_OVF | TMRA_INT_UNF), Disable);
        break;
    default:
        result = -RT_ENOSYS;
        break;
    }

    return result;
}

static const struct rt_pulse_encoder_ops pulse_encoder_ops =
{
    .init        = hc32_pulse_encoder_init,
    .get_count   = hc32_pulse_encoder_get_count,
    .clear_count = hc32_pulse_encoder_clear_count,
    .control     = hc32_pulse_encoder_control,
};

int hw_pulse_encoder_init(void)
{
    int i;
    int result;

    result = RT_EOK;
    for (i = 0; i < sizeof(pulse_encoder_obj) / sizeof(pulse_encoder_obj[0]); i++)
    {
        pulse_encoder_obj[i].pulse_encoder.type = AB_PHASE_PULSE_ENCODER;
        pulse_encoder_obj[i].pulse_encoder.ops  = &pulse_encoder_ops;

        if (rt_device_pulse_encoder_register(&pulse_encoder_obj[i].pulse_encoder, pulse_encoder_obj[i].name, pulse_encoder_obj[i].timer_periph) != RT_EOK)
        {
            LOG_E("%s register failed", pulse_encoder_obj[i].name);
            result = -RT_ERROR;
        }
    }

    return result;
}
INIT_BOARD_EXPORT(hw_pulse_encoder_init);

#endif