VSF Documented
vsf_template_adc.h
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#ifndef __VSF_TEMPLATE_ADC_H__
19#define __VSF_TEMPLATE_ADC_H__
20
21/*============================ INCLUDES ======================================*/
22
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ MACROS ========================================*/
31
39#ifndef VSF_ADC_CFG_MULTI_CLASS
40# define VSF_ADC_CFG_MULTI_CLASS ENABLED
41#endif
42
50#if defined(VSF_HW_ADC_COUNT) && !defined(VSF_HW_ADC_MASK)
51# define VSF_HW_ADC_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_ADC_COUNT)
52#endif
53
61#if defined(VSF_HW_ADC_MASK) && !defined(VSF_HW_ADC_COUNT)
62# define VSF_HW_ADC_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_ADC_MASK)
63#endif
64
74#ifndef VSF_ADC_CFG_PREFIX
75# if VSF_ADC_CFG_MULTI_CLASS == ENABLED
76# define VSF_ADC_CFG_PREFIX vsf
77# elif defined(VSF_HW_ADC_COUNT) && (VSF_HW_ADC_COUNT != 0)
78# define VSF_ADC_CFG_PREFIX vsf_hw
79# else
80# define VSF_ADC_CFG_PREFIX vsf
81# endif
82#endif
83
93#ifndef VSF_ADC_CFG_FUNCTION_RENAME
94# define VSF_ADC_CFG_FUNCTION_RENAME ENABLED
95#endif
96
105#ifndef VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE
106# define VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE DISABLED
107#endif
108
117#ifndef VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE
118# define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE DISABLED
119#endif
120
129#ifndef VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK
130# define VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
131#endif
132
144#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == DISABLED
145# define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG DISABLED
146#endif
147
160#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
161# define VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG DISABLED
162#endif
163
173#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
174# define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
175#endif
176
186#ifndef VSF_ADC_CFG_INHERIT_HAL_CAPABILITY
187# define VSF_ADC_CFG_INHERIT_HAL_CAPABILITY ENABLED
188#endif
189
190/*============================ MACROFIED FUNCTIONS ===========================*/
191
201#define VSF_ADC_APIS(__PREFIX_NAME) \
202 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, init, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_cfg_t *cfg_ptr) \
203 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, fini, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
204 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t, adc, enable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
205 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t, adc, disable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
206 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_adc_status_t, adc, status, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
207 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_adc_capability_t, adc, capability, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr) \
208 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, irq_enable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_irq_mask_t irq_mask) \
209 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void, adc, irq_disable, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_irq_mask_t irq_mask) \
210 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_request_once, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_channel_cfg_t *channel_cfg, void *buffer_ptr) \
211 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_config, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, vsf_adc_channel_cfg_t *channel_cfgs_ptr, uint32_t channel_cfgs_cnt) \
212 __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t, adc, channel_request, VSF_MCONNECT(__PREFIX_NAME, _adc_t) *adc_ptr, void *buffer_ptr, uint_fast32_t count)
213
214/*============================ TYPES =========================================*/
215
216#if VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
261typedef enum vsf_adc_mode_t {
271
281
291
301
311
321
331
341
351
361
372#endif
373
374enum {
380
384
388
393
399};
400
401#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE == DISABLED
455
465
475
485
495
505
515
525
535
546#endif
547
548enum {
556
562
567};
568
569#if VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
593typedef enum vsf_adc_irq_mask_t {
594 VSF_ADC_IRQ_MASK_CPL = (0x1ul << 0),
596#endif
597
598enum {
601};
602
604#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == DISABLED
612typedef struct vsf_adc_channel_cfg_t {
617#endif
618
619#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
620typedef struct vsf_adc_t vsf_adc_t;
621typedef void vsf_adc_isr_handler_t(void *target_ptr,
622 vsf_adc_t *adc_ptr,
625typedef struct vsf_adc_isr_t {
630
638typedef struct vsf_adc_cfg_t {
643#endif
644
645#if VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
660typedef struct vsf_adc_status_t {
661 union {
663 struct {
664 uint32_t is_busy : 1;
665 };
667 };
669#endif
670
671#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
688typedef struct vsf_adc_capability_t {
689#if VSF_ADC_CFG_INHERIT_HAL_CAPABILITY == ENABLED
691#endif
693
697#endif
698
699typedef struct vsf_adc_op_t {
701#undef __VSF_HAL_TEMPLATE_API
702#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
704
705 VSF_ADC_APIS(vsf)
707
708#if VSF_ADC_CFG_MULTI_CLASS == ENABLED
709struct vsf_adc_t {
711};
712#endif
713
714/*============================ PROTOTYPES ====================================*/
715
735extern vsf_err_t vsf_adc_init(vsf_adc_t *adc_ptr, vsf_adc_cfg_t *cfg_ptr);
736
748extern void vsf_adc_fini(vsf_adc_t *adc_ptr);
749
761extern fsm_rt_t vsf_adc_enable(vsf_adc_t *adc_ptr);
762
774extern fsm_rt_t vsf_adc_disable(vsf_adc_t *adc_ptr);
775
792
807
820
833
850 vsf_adc_channel_cfg_t *channel_cfg,
851 void *buffer_ptr);
852
869 vsf_adc_channel_cfg_t *cfgs_ptr,
870 uint32_t cnt);
871
888 void *buffer_ptr,
889 uint_fast32_t count);
890
891/*============================ MACROFIED FUNCTIONS ===========================*/
892
894#if VSF_ADC_CFG_FUNCTION_RENAME == ENABLED
895# define __vsf_adc_t VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_t)
896# define vsf_adc_init(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_init) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
897# define vsf_adc_fini(__ADC) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_fini) ((__vsf_adc_t *)(__ADC))
898# define vsf_adc_enable(__ADC) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_enable) ((__vsf_adc_t *)(__ADC))
899# define vsf_adc_disable(__ADC) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_disable) ((__vsf_adc_t *)(__ADC))
900# define vsf_adc_status(__ADC) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_status) ((__vsf_adc_t *)(__ADC))
901# define vsf_adc_capability(__ADC) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_capability) ((__vsf_adc_t *)(__ADC))
902# define vsf_adc_irq_enable(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_enable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
903# define vsf_adc_irq_disable(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_irq_disable) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
904# define vsf_adc_channel_request_once(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request_once) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
905# define vsf_adc_channel_config(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_config) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
906# define vsf_adc_channel_request(__ADC, ...) VSF_MCONNECT(VSF_ADC_CFG_PREFIX, _adc_channel_request) ((__vsf_adc_t *)(__ADC), ##__VA_ARGS__)
907#endif
909
910#ifdef __cplusplus
911}
912#endif
913
914#endif /*__VSF_TEMPLATE_ADC_H__*/
vsf_err_t
Definition __type.h:42
vsf_arch_prio_t
Definition cortex_a_generic.h:88
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 int uint_fast32_t
Definition stdint.h:27
unsigned char uint8_t
Definition stdint.h:5
Predefined VSF ADC capability that can be reimplemented in specific HAL drivers.
Definition vsf_template_adc.h:688
inherit(vsf_peripheral_capability_t) vsf_adc_irq_mask_t irq_mask
uint8_t max_data_bits
Definition vsf_template_adc.h:694
uint8_t channel_count
Definition vsf_template_adc.h:695
Configuration structure for ADC.
Definition vsf_template_adc.h:638
vsf_adc_isr_t isr
Interrupt service routine configuration.
Definition vsf_template_adc.h:640
uint32_t clock_hz
Clock frequency in Hertz.
Definition vsf_template_adc.h:641
vsf_adc_mode_t mode
ADC working mode.
Definition vsf_template_adc.h:639
adc channel configuration
Definition vsf_template_adc.h:612
vsf_adc_channel_mode_t mode
Channel mode.
Definition vsf_template_adc.h:613
uint16_t sample_cycles
Sample cycles.
Definition vsf_template_adc.h:614
uint8_t channel
Channel Index.
Definition vsf_template_adc.h:615
adc isr for api
Definition vsf_template_adc.h:625
vsf_arch_prio_t prio
Definition vsf_template_adc.h:628
void * target_ptr
Definition vsf_template_adc.h:627
vsf_adc_isr_handler_t * handler_fn
Definition vsf_template_adc.h:626
Definition vsf_template_adc.h:699
Predefined VSF ADC status that can be reimplemented in specific HAL drivers.
Definition vsf_template_adc.h:660
uint32_t value
Definition vsf_template_adc.h:666
Definition vsf_template_adc.h:709
const vsf_adc_op_t * op
Definition vsf_template_adc.h:710
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
void vsf_adc_isr_handler_t(void *target_ptr, vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
Definition adc.h:151
vsf_adc_irq_mask_t
Definition adc.h:132
vsf_adc_mode_t
Definition adc.h:116
fsm_rt_t
Definition vsf_fsm.h:315
void vsf_adc_isr_handler_t(void *target_ptr, vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
Definition vsf_template_adc.h:621
vsf_adc_capability_t vsf_adc_capability(vsf_adc_t *adc_ptr)
Get the capability of ADC instance.
Definition adc_common.c:101
fsm_rt_t vsf_adc_disable(vsf_adc_t *adc_ptr)
Disable an ADC instance.
Definition adc_common.c:65
vsf_err_t vsf_adc_channel_request_once(vsf_adc_t *adc_ptr, vsf_adc_channel_cfg_t *channel_cfg, void *buffer_ptr)
ADC request sampling once.
Definition adc_common.c:110
void vsf_adc_irq_enable(vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
Enable interrupt masks of ADC instance.
Definition adc_common.c:74
struct vsf_adc_capability_t vsf_adc_capability_t
Predefined VSF ADC capability that can be reimplemented in specific HAL drivers.
struct vsf_adc_status_t vsf_adc_status_t
Predefined VSF ADC status that can be reimplemented in specific HAL drivers.
@ VSF_ADC_MODE_ALL_BITS_MASK
Definition vsf_template_adc.h:395
@ VSF_ADC_EXTERN_TRIGGER_COUNT
Definition vsf_template_adc.h:389
@ VSF_ADC_MODE_MASK_COUNT
Definition vsf_template_adc.h:394
@ VSF_ADC_REF_VDD_MASK
Definition vsf_template_adc.h:376
@ VSF_ADC_REF_VDD_COUNT
Definition vsf_template_adc.h:375
@ VSF_ADC_DATA_ALIGN_MASK
Definition vsf_template_adc.h:382
@ VSF_ADC_DATA_ALIGN_COUNT
Definition vsf_template_adc.h:381
@ VSF_ADC_SCAN_CONV_MASK
Definition vsf_template_adc.h:386
@ VSF_ADC_EXTERN_TRIGGER_MASK
Definition vsf_template_adc.h:390
@ VSF_ADC_SCAN_CONV_COUNT
Definition vsf_template_adc.h:385
vsf_err_t vsf_adc_channel_request(vsf_adc_t *adc_ptr, void *buffer_ptr, uint_fast32_t count)
ADC channel request.
Definition adc_common.c:128
@ VSF_ADC_CHANNEL_GAIN_MASK
Definition vsf_template_adc.h:550
@ VSF_ADC_CHANNEL_MODE_ALL_BITS_MASK
Definition vsf_template_adc.h:564
@ VSF_ADC_CHANNEL_MODE_MASK_COUNT
Definition vsf_template_adc.h:563
@ VSF_ADC_CHANNEL_REF_VDD_MASK
Definition vsf_template_adc.h:558
@ VSF_ADC_CHANNEL_GAIN_COUNT
Definition vsf_template_adc.h:549
@ VSF_ADC_CHANNEL_REF_VDD_COUNT
Definition vsf_template_adc.h:557
vsf_adc_status_t vsf_adc_status(vsf_adc_t *adc_ptr)
Get the status of ADC instance.
Definition adc_common.c:92
vsf_err_t vsf_adc_channel_config(vsf_adc_t *adc_ptr, vsf_adc_channel_cfg_t *cfgs_ptr, uint32_t cnt)
ADC channel configuration.
Definition adc_common.c:119
fsm_rt_t vsf_adc_enable(vsf_adc_t *adc_ptr)
Enable an ADC instance.
Definition adc_common.c:56
vsf_adc_irq_mask_t
Predefined VSF ADC interrupt that can be reimplemented in specific HAL drivers.
Definition vsf_template_adc.h:593
@ VSF_ADC_IRQ_MASK_CPL
Conversion complete interrupt.
Definition vsf_template_adc.h:594
@ VSF_ADC_IRQ_COUNT
Definition vsf_template_adc.h:599
@ VSF_ADC_IRQ_ALL_BITS_MASK
Definition vsf_template_adc.h:600
vsf_adc_channel_mode_t
Predefined VSF ADC channel modes that can be reimplemented in specific HAL drivers.
Definition vsf_template_adc.h:445
@ VSF_ADC_CHANNEL_REF_VDD_1_3
Channel reference voltage set to VDD/1.3. Uses VDD/1.3 as reference voltage for this channel.
Definition vsf_template_adc.h:534
@ VSF_ADC_CHANNEL_REF_VDD_1_2
Channel reference voltage set to VDD/1.2. Uses VDD/1.2 as reference voltage for this channel.
Definition vsf_template_adc.h:524
@ VSF_ADC_CHANNEL_REF_VDD_1
Channel reference voltage set to VDD/1. Uses the full supply voltage as reference for this channel.
Definition vsf_template_adc.h:514
@ VSF_ADC_CHANNEL_GAIN_1_4
Channel gain set to 1/4. Input signal is attenuated to 1/4 of its original value.
Definition vsf_template_adc.h:474
@ VSF_ADC_CHANNEL_GAIN_1_5
Channel gain set to 1/5. Input signal is attenuated to 1/5 of its original value.
Definition vsf_template_adc.h:464
@ VSF_ADC_CHANNEL_GAIN_1_2
Channel gain set to 1/2. Input signal is attenuated to 1/2 of its original value.
Definition vsf_template_adc.h:494
@ VSF_ADC_CHANNEL_GAIN_1
Channel gain set to 1. Input signal remains at its original value (no amplification or attenuation).
Definition vsf_template_adc.h:504
@ VSF_ADC_CHANNEL_REF_VDD_1_4
Channel reference voltage set to VDD/1.4. Uses VDD/1.4 as reference voltage for this channel.
Definition vsf_template_adc.h:544
@ VSF_ADC_CHANNEL_GAIN_1_3
Channel gain set to 1/3. Input signal is attenuated to 1/3 of its original value.
Definition vsf_template_adc.h:484
@ VSF_ADC_CHANNEL_GAIN_1_6
Channel gain set to 1/6. Input signal is attenuated to 1/6 of its original value.
Definition vsf_template_adc.h:454
vsf_err_t vsf_adc_init(vsf_adc_t *adc_ptr, vsf_adc_cfg_t *cfg_ptr)
Initialize an ADC instance.
Definition adc_common.c:38
vsf_adc_mode_t
Predefined VSF ADC modes that can be reimplemented in specific HAL drivers.
Definition vsf_template_adc.h:261
@ VSF_ADC_EXTERN_TRIGGER_2
External trigger source 2. Selects the third external event source to trigger conversion.
Definition vsf_template_adc.h:370
@ VSF_ADC_DATA_ALIGN_LEFT
Data alignment set to left. The converted data is left-aligned in the data register.
Definition vsf_template_adc.h:320
@ VSF_ADC_REF_VDD_1_2
Reference voltage set to VDD/2. Uses half of the supply voltage as reference for ADC conversion.
Definition vsf_template_adc.h:280
@ VSF_ADC_DATA_ALIGN_RIGHT
Data alignment set to right. The converted data is right-aligned in the data register.
Definition vsf_template_adc.h:310
@ VSF_ADC_REF_VDD_1_4
Reference voltage set to VDD/4. Uses one-fourth of the supply voltage as reference for ADC conversion...
Definition vsf_template_adc.h:300
@ VSF_ADC_EXTERN_TRIGGER_1
External trigger source 1. Selects the second external event source to trigger conversion.
Definition vsf_template_adc.h:360
@ VSF_ADC_REF_VDD_1_3
Reference voltage set to VDD/3. Uses one-third of the supply voltage as reference for ADC conversion.
Definition vsf_template_adc.h:290
@ VSF_ADC_EXTERN_TRIGGER_0
External trigger source 0. Selects the first external event source to trigger conversion.
Definition vsf_template_adc.h:350
@ VSF_ADC_SCAN_CONV_SINGLE_MODE
Single conversion mode. Conversion is performed once for a single channel.
Definition vsf_template_adc.h:330
@ VSF_ADC_SCAN_CONV_SEQUENCE_MODE
Sequence conversion mode. Conversions are performed in sequence for multiple channels.
Definition vsf_template_adc.h:340
@ VSF_ADC_REF_VDD_1
Reference voltage set to VDD. Uses the full supply voltage as reference for ADC conversion.
Definition vsf_template_adc.h:270
struct vsf_adc_isr_t vsf_adc_isr_t
adc isr for api
void vsf_adc_fini(vsf_adc_t *adc_ptr)
Finalize an ADC instance.
Definition adc_common.c:47
void vsf_adc_irq_disable(vsf_adc_t *adc_ptr, vsf_adc_irq_mask_t irq_mask)
Disable interrupt masks of ADC instance.
Definition adc_common.c:83
#define VSF_ADC_APIS(__PREFIX_NAME)
ADC API template, used to generate ADC type, specific prefix function declarations,...
Definition vsf_template_adc.h:201
struct vsf_adc_cfg_t vsf_adc_cfg_t
Configuration structure for ADC.
Generated from commit: vsfteam/vsf@2b286be