BK_SADC

[English]

BK_SADC API Status

API

bk_sadc_open()

bk_sadc_close()

bk_sadc_get()

bk_sadc_convert_to_voltage()

BK_SADC API Reference

Header File

Functions

uint32_t bk_sadc_open(uint32_t dev_index)

beken SADC open.

使用之前需要先open,参数是设备index,从0开始

参数:

dev_index[in] device index, from 0(the first device)

返回值:
  • 0 – fail

  • other – success

返回:

handle

int32_t bk_sadc_close(uint32_t handle)

beken SADC close.

使用SADC结束后需要close,和 bk_sadc_open() 是配对的

参数:

handle[in] return value of bk_sadc_open()

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

int32_t bk_sadc_get(uint32_t handle, bk_sadc_blk_t *pt_blk)

beken SADC get data.

使用SADC来接收一些采样到的数据,该函数是一个异步函数

参数:
  • handle[in] return value of bk_sadc_open()

  • pt_blk[in] 指向一个接收信息的结构体。pt_blk->pu2_out指向待接收数据的buffer,其长度是 pt_blk->out_size 接收的结果会通过 pt_blk->pfn_cb 来通知

返回值:
  • 0 – success [BK_RET_OK]

  • other – fail

返回:

result

uint32_t bk_sadc_convert_to_voltage(uint32_t adc_out_data)

将adc采样的数据转换成输入端的毫伏电压

备注

该函数在callback中调用才会得到正确的值

参数:

adc_out_data[in] adc output data

返回:

input voltage in mV

Structures

struct _bk_sadc_blk_t

Macros

SADC_CHN_0_GPIO6
SADC_CHN_1_VREF
SADC_CHN_2_VBAT
SADC_CHN_3_VTEMP
SADC_CHN_4_HALF_VUSB
SADC_CHN_5_GPIO9
SADC_CHN_7_GPIO12
SADC_CHN_8_TOUCH
SADC_CHN_9_GPIO13
SADC_CHN_10_GPIO14
SADC_CHN_11_GPIO15
SADC_CHN_12_GPIO16

Type Definitions

typedef void (*pfunc_bk_sadc_cb_t)(uint32_t handle, int32_t err_code, void *pv_arg)
typedef struct _bk_sadc_blk_t bk_sadc_blk_t