SARADC

[English]

Beken chip supports get every adc channel value function for user.

ADC API Status

API

BK7235A

BK7235B

BK7235

bk_adc_driver_init()

Y

Y

Y

bk_adc_aquire()

Y

Y

Y

bk_adc_release()

Y

Y

Y

bk_adc_driver_deinit()

Y

Y

Y

bk_adc_init()

Y

Y

Y

bk_adc_deinit()

Y

Y

Y

bk_adc_start()

Y

Y

Y

bk_adc_stop()

Y

Y

Y

bk_adc_read_raw()

Y

Y

Y

bk_adc_read()

Y

Y

Y

bk_adc_register_isr()

Y

Y

Y

bk_adc_set_clk()

Y

Y

Y

bk_adc_set_channel()

Y

Y

Y

bk_adc_set_sample_rate()

Y

Y

Y

bk_adc_set_filter()

Y

Y

Y

bk_adc_set_steady_time()

Y

Y

Y

bk_adc_set_sample_cnt()

Y

Y

Y

bk_adc_enable_saturate()

Y

Y

Y

bk_adc_disable_saturate()

Y

Y

Y

bk_adc_set_saturate()

Y

Y

Y

bk_adc_get_saturate()

Y

Y

Y

bk_adc_set_config()

Y

Y

Y

bk_adc_set_mode()

Y

Y

Y

bk_adc_get_mode()

Y

Y

Y

ADC Channel Number

Capability

BK7235A

BK7235B

BK7235

Channel Number

6

6

6

ADC API Reference

Header File

Functions

bk_err_t bk_adc_driver_init(void)

Init the ADC driver.

This API init the resoure common to all ADC id:

  • Init ADC driver control memory

Attention

1. This API should be called before any other ADC APIs.

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_acquire(void)

lock the runing ADC channel

This API lock ADC channel which is runing.

Parameters

id – ADC id

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_release()

release the runing ADC channel

This API release ADC channel which is runing.

Parameters

id – ADC id

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_driver_deinit(void)

Deinit the ADC driver.

This API free all resource related to ADC and power down all ADC.

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_init(adc_chan_t adc_id)

Init the ADC.

This API init the ADC:

  • Power up the ADC

  • Map the ADC id to dedicated GPIO port

  • Set adc work channel

Parameters

  • id – ADC channel

  • size – ADC recieve data size

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_NOT_INIT: ADC driver not init

  • BK_ERR_ADC_INVALID_ID: ADC id is invalid

  • others: other errors.

bk_err_t bk_adc_deinit(adc_chan_t id)

Deinit the ADC id.

This API deinit the ADC id:

  • Stop the ADC

  • Disable the ADC id interrupt

  • Power down the ADC

  • Unmap gpio id

Attention

1. This API should be called before use adc.

Parameters

id – ADC id

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_NOT_INIT: ADC driver not init

  • BK_ERR_ADC_INVALID_ID: ADC id is invalid

  • others: other errors.

bk_err_t bk_adc_start(void)

Start the ADC.

This API start adc:

  • enable the ADC id interrupt

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_BUSY: ADC is busy

  • others: other errors.

bk_err_t bk_adc_stop(void)

Stop the ADC.

This API stop adc:

  • disable the ADC en bit

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_BUSY: ADC is busy

  • others: other errors.

bk_err_t bk_adc_read_raw(uint16_t *read_buf, uint32_t size, uint32_t timeout)

Start read the raw ADC data.

Attention

1. The read_buf is in unit of uint16_t, the application needs to malloc (size * 2) bytes for read_buf.

2. The maximum value of size is CONFIG_ADC_BUF_SIZE, if the size exceeds CONFIG_ADC_BUF_SIZE, the API returns BK_ERR_ADC_SIZE_TOO_BIG.

Parameters

  • read_buf – application malloc buffer which save the current adc value

  • size – the size of read_buf, the unit of size is uint16_t

  • timeout – adc read semaphore timeout

Returns

  • BK_ERR_ADC_BUSY: ADC is busy

  • BK_ERR_ADC_INVALID_MODE: ADC mode is invalid

  • BK_ERR_ADC_SIZE_TOO_BIG: size is too big

  • others: other errors.

bk_err_t bk_adc_read(uint16_t *data, uint32_t timeout)

Start read the average value of sampling data.

  • BK_ERR_ADC_BUSY: ADC is busy

  • BK_ERR_ADC_INVALID_MODE: ADC mode is invalid

  • others: other errors.

Parameters

  • data – store the average value of all sample values in ADC software buffers

  • timeout – adc read semaphore timeout

Returns

bk_err_t bk_adc_register_isr(adc_isr_t isr, uint32_t param)

Register the adc interrupt service routine.

Parameters

  • isr – ADC intterrupt callback

  • param – ADC sample data size which depend on user

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_NOT_INIT: adc not init

  • others: other errors.

bk_err_t bk_adc_set_clk(adc_src_clk_t src_clk, uint32_t clk)

set ADC source clock and work frequence

This API set adc clock source and frequence

Parameters

  • src_clk – adc source clock

  • clk – adc work clock :adc clk

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_INVALID_SCLK_MODE: ADC source clock is invalid

  • others: other errors.

bk_err_t bk_adc_set_channel(adc_chan_t adc_id)

set ADC work channel

This API set adc work channel

Parameters

adc_id – adc channel

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_INVALID_ID: ADC invalid id

  • others: other errors.

bk_err_t bk_adc_set_sample_rate(uint32_t sample_rate)

set ADC sample rate

This API set adc work sample rate, period = (16 + sample_rate)*adc_clk mcu output 16 adc_clks every period

Parameters

sample_rate – adc sample rate

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_set_filter(uint32_t filter)

set ADC filter

This API set adc filter, the value default < 64, data output rate = period/(filter + 1)

Parameters

filter – adc filter

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_set_steady_time(uint32_t steady_ctrl)

set ADC steady time

This API set adc filter, adc wait (steady_ctrl +1)*8 adc_clks to send valid

Parameters

steady_ctrl – adc steady time

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_set_sample_cnt(uint32_t cnt)

set ADC sample cnt

This API sets ADC sample cnt per-interrupt, the ADC raises the interrupt when every time it samples number of cnt times. The maximum value of cnt is 32.

Parameters

cnt – per-interrupt sample cnt

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_set_saturate_mode(adc_saturate_mode_t mode)

set adc saturate

This API set adc saturate, auto process adc fifo data in cpu ,just get the data from reg ADC_DATA_16

Parameters

mode – adc saturate

Returns

  • BK_OK: succeed

  • others: other errors.

bk_err_t bk_adc_get_saturate(adc_saturate_mode_t *mode)

get adc saturate

This API get adc saturate

Returns

  • adc_saturate_mode_t: adc saturate mode

bk_err_t bk_adc_enable_bypass_clalibration(void)

enable ADC bypass calibration

Returns

  • BK_OK: succeed

bk_err_t bk_adc_disable_bypass_clalibration(void)

disable ADC bypass calibration

Returns

  • BK_OK: succeed

bk_err_t bk_adc_set_config(adc_config_t *config)

adc set config

This API config adc params

Parameters

config – adc parameter settings

Returns

  • BK_OK: succeed

  • BK_ERR_NULL_PARAM : param is null

  • BK_ERR_ADC_INVALID_MODE:adc invalid mode

  • BK_ERR_ADC_INVALID_SCLK_MODE: ADC source clock is invalid

  • BK_ERR_ADC_INVALID_ID: ADC id is invalid

  • others: other errors.

bk_err_t bk_adc_set_mode(adc_mode_t adc_mode)

adc set mode

This API config adc mode

Parameters

mode – : adc mode:

  • 0: sleep mode: adc is power down in this mode

  • 1: single step mode: adc finish sample data convesion once after enable adc and wait mcu to read sample data. The mode will turn to sleep mode after mcu read this sample date It must be enabled again when you want to sample next data.

  • 2: software control mode: adc gengerate interrupt after sample data convesion wait mcu to read sample data. adc will convert sample data after mcu reading this sample date from data register and software cleaning int flag.

  • 3: continous mode:adc wait adc_setting time to sample data, and generate int flag after finish sample data convesion, then always repeat last sample way. This mode don’t depend on muc reading data register.

Returns

  • BK_OK: succeed

  • BK_ERR_ADC_INVALID_MODE:adc invalid mode

  • others: other errors.

adc_mode_t bk_adc_get_mode(void)

get adc mode

This API get adc work mode

Returns

  • adc_mode_t: adc_mode

ADC API Typedefs

Header File

Macros

BK_ERR_ADC_NOT_INIT

ADC driver not init

BK_ERR_ADC_INVALID_CHAN

ADC chan number is invalid

BK_ERR_ADC_BUSY

ADC channel is busy

BK_ERR_ADC_INVALID_MODE

ADC invalid mode

BK_ERR_ADC_CHAN_NOT_INIT

ADC chan not init

BK_ERR_ADC_INVALID_SCLK_MODE

ADC no such source clock

BK_ERR_ADC_INIT_MUTEX

ADC mutex lock

BK_ERR_ADC_GET_READ_SEMA

ADC get semaphore error

BK_ERR_ADC_INIT_READ_SEMA

ADC read data error

BK_ERR_ADC_SIZE_TOO_BIG

ADC read size is bigger than adc driver buffer size

CONFIG_ADC_BUF_SIZE

Type Definitions

typedef void (*adc_isr_t)(uint32_t param)

ADC interrupt service routine.

Header File

Structures

struct adc_config_t

Public Members

uint32_t clk

ADC sample clock division: adc_clk=clk/[2*(pre_div +1)]

uint32_t sample_rate

ADC sample rate, every period ouput 16 adc_clks in continuous mode period = (16+samp_rate)*adc_clk

uint32_t adc_filter

ADC filter: the output data rate = period/(adc_filter +1)

uint32_t steady_ctrl

ADC steady_ctrl : steady time = (steady_ctrl +1)*8 adc_clk

adc_mode_t adc_mode

ADC mode set

adc_src_clk_t src_clk

ADC source clcok choose

adc_chan_t chan

ADC work channel

adc_saturate_mode_t saturate_mode

ADC saturate_mode

uint32_t is_open

ADC channel is open or not

uint16_t *output_buf

ADC channel output buffer

int32_t output_buf_len

ADC channel output buffer length

struct adc_gpio_map_t

Macros

CONFIG_ADC_STATIS
ADC_ACURACY_10_BIT
ADC_ACURACY_12_BIT
ADC_READ_SEMAPHORE_WAIT_TIME
ADC_SRC_DCO_CLK
ADC_SRC_DPLL_CLK
ADC_SRC_26M_CLK
ADC_SRC_32M_CLK
ADC_FIFO_LEVEL_MAX

Enumerations

enum adc_src_clk_t

Values:

enumerator ADC_SCLK_DCO

ADC source clock dco

enumerator ADC_SCLK_XTAL_26M

ADC source clock xtal 26M

enumerator ADC_SCLK_DPLL

ADC source clock dpll

enumerator ADC_SCLK_32M

ADC source clock 32M

enumerator ADC_SCLK_NONE

ADC has not such source clock

enum adc_mode_t

Values:

enumerator ADC_SLEEP_MODE

ADC sleep mode

enumerator ADC_SINGLE_STEP_MODE

ADC single step mode

enumerator ADC_SOFTWARE_CONTRL_MODE

ADC software control mode

enumerator ADC_CONTINUOUS_MODE

ADC continuous mode

enumerator ADC_NONE_MODE
enum adc_chan_t

Values:

enumerator ADC_1
enumerator ADC_2
enumerator ADC_3
enumerator ADC_4
enumerator ADC_5
enumerator ADC_6
enumerator ADC_7
enumerator ADC_8
enumerator ADC_9
enumerator ADC_10
enumerator ADC_11
enumerator ADC_12
enumerator ADC_13
enumerator ADC_MAX
enum adc_saturate_mode_t

Values:

enumerator ADC_SATURATE_MODE_NONE
enumerator ADC_SATURATE_MODE_0
enumerator ADC_SATURATE_MODE_1
enumerator ADC_SATURATE_MODE_2
enumerator ADC_SATURATE_MODE_3