Adc

This section introduces the Analog-to-Digital Converter (ADC) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions. More...

Overview

This section introduces the Analog-to-Digital Converter (ADC) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions.

Terms and Acronyms

Terms	Details
ADC	ADC is an Analog-to-Digital Converter.
DMA	Direct Memory Access.
FIFO	First In, First Out.

Supported Features

See Supported Features for the details of Supported Features.

How to use this driver

• How to develop user application by using OS-HAL API:
  
  • sample code (this is the user application sample code on freeRTos):

    - ADC one shot mode:
    
        -Initialize the ADC module.
            - Call mtk_os_hal_adc_ctlr_init(void)
    
        //One shot mode will use fifo RX data, The user needs to pass
        //the data storage address to driver, HW will put sampling data
        //to this buf, Each sampling data takes 4 bytes, bit[3:0] is the
        //channel number information, bit[15:4] is the sample raw data,
        //bit[32:16] is debug info, no need to care.
        //When use one shot mode, please select
        //adc_fsm_parameter->fifo_mode = ADC_FIFO_DIRECT.
        -Set one shot state machine parameters.
            -Call mtk_os_hal_adc_fsm_param_set(
            struct adc_fsm_param *adc_fsm_parameter)
    
        -Start the ADC module.
            - Call mtk_os_hal_adc_trigger_one_shot_once(void)
    
        -ADC hw is no longer in use,  to return the ADC module back
        to its original state.
            - Call mtk_os_hal_adc_ctlr_deinit(void)
    
    
    - ADC Periodic mode with DMA:
    
        -Initialize the ADC module.
            - Call mtk_os_hal_adc_ctlr_init(void)
    
        //Periodic mode will use DMA RX data, The user needs to pass
        //the data storage address to driver, HW will put sampling data
        //to this buf, Each sampling data takes 4 bytes, bit[3:0] is the
        //channel number information, bit[15:4] is the sample raw data,
        //bit[32:16] is debug info, no need to care.
        //When use periodic mode, please select
        //adc_fsm_parameter->fifo_mode = ADC_FIFO_DMA.
        -Set dma state machine parameters.
            - Call mtk_os_hal_adc_fsm_param_set(
            struct adc_fsm_param *adc_fsm_parameter)
    
        -Start the ADC module.
            - Call mtk_os_hal_adc_period_start(void)
    
        //There is no need to continue sampling data, stop the ADC.
        -Stop the ADC module.
            - Call mtk_os_hal_adc_period_stop(void)
    
        -ADC hw is no longer in use,  to return the ADC module back
        to its original state.
            - Call mtk_os_hal_adc_ctlr_deinit(void)

Modules
	Function
	OS-HAL ADC function list information, including ADC hardware initializing and de-initializing, enabling and disabling ADC hardware output, gets ADC sample data using one shot mode.