GPIO API

[中文]

GPIO (General Purpose Input/Output) API interface.

Header File

gpio.h

Functions

bk_err_t bk_gpio_driver_init(void)

Init the GPIO driver.

This API init the resoure common to all GPIO channels:

Init GPIO driver control memory

This API should be called before any other GPIO APIs.

Returns

BK_OK: succeed
others: other errors.

bk_err_t bk_gpio_driver_deinit(void)

Deinit the GPIO driver.

This API free all resource related to GPIO and power down all GPIO channels.

Returns

BK_OK: succeed
others: other errors.

void bk_gpio_set_value(gpio_id_t id, uint32_t v)

Direct set GPIO config value.

@NOTES Please be care to use this API,unless you know the detail mean, because it will set the GPIO config value. Sometimes the special GPIO needs to re-used by one more owner, after the second owner re-used it, it should restore the config value. Before re-use a GPIO, the owner can call bk_gpio_get_value and bakup it, after re-used finish, it call bk_gpio_set_value to restore the prevous value.

uint32_t bk_gpio_get_value(gpio_id_t id): get GPIO config value.

bk_err_t bk_gpio_enable_output(gpio_id_t gpio_id)

enable GPIO output mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_disable_output(gpio_id_t gpio_id)

disable GPIO output mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_enable_input(gpio_id_t gpio_id)

enable GPIO input mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_disable_input(gpio_id_t gpio_id)

disable GPIO input mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_enable_pull(gpio_id_t gpio_id)

enable GPIO pull mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_disable_pull(gpio_id_t gpio_id)

disable gpio pull mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_pull_up(gpio_id_t gpio_id)

set GPIO as pull up mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_pull_down(gpio_id_t gpio_id)

set GPIO as pull down mode

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_set_config(gpio_id_t gpio_id, const gpio_config_t *config)

Config the GPIO mode.

This API config GPIO’s mode

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_INVALID_MODE: invalid GPIO’s io_mode/pull_mode
BK_ERR_GPIO_INTERNAL_USED:GPIO was map to another device
others: other errors.

bk_err_t bk_gpio_set_output_high(gpio_id_t gpio_id)

Set the GPIO output high,.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_OUTPUT_MODE:GPIO not in output mode
others: other errors.

bk_err_t bk_gpio_set_output_low(gpio_id_t gpio_id)

Set the GPIO output low,.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_OUTPUT_MODE:GPIO not in output mode
others: other errors.

bool bk_gpio_get_input(gpio_id_t gpio_id)

Get the GPIO input value,.

This API get GPIO’s input level: 0 :low_level 1:high_level.

Returns

input value
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_INPUT_MODE : GPIO is not input mode
others: other errors.

bool bk_gpio_get_output(gpio_id_t gpio_id)

Get the GPIO output value,.

This API get GPIO’s output level: 0 :low_level 1:high_level.

Returns

output value
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_INPUT_MODE : GPIO is not input mode
others: other errors.

bool bk_gpio_set_capacity(gpio_id_t gpio_id, uint32 capacity)

Set the GPIO driver capacity.

This API Set GPIO’s output driver capacity which range is 0~3.

Returns

input value
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_INPUT_MODE : GPIO is not input mode
others: other errors.

bk_err_t bk_gpio_set_interrupt_type(gpio_id_t gpio_id, gpio_int_type_t type)

Config the GPIO intterrupt type mode when use gpio intterrupt mode,.

This API config all GPIO channels’ intterrupt mode, the mode included in gpio_int_type_t.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_INVALID_INT_TYPE: invalid GPIO int type
others: other errors.

bk_err_t bk_gpio_enable_interrupt(gpio_id_t id)

Enable GPIO intterrupt.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
BK_ERR_GPIO_NOT_INPUT_MODE : GPIO is not input mode
others: other errors.

bk_err_t bk_gpio_disable_interrupt(gpio_id_t id)

Disable GPIO intterrupt.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid GPIO channel
others: other errors.

bk_err_t bk_gpio_clear_interrupt(gpio_id_t gpio_id)

Clear GPIO intterrupt.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid gpio channel
others: other errors.

bk_err_t bk_gpio_register_isr(gpio_id_t id, gpio_isr_t isr)

Register the interrupt service routine for GPIO channel.

This API regist gpio isr callback function.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid gpio channel
others: other errors.

bk_err_t bk_gpio_unregister_isr(gpio_id_t id)

Unregister the interrupt service routine for GPIO channel.

This API deregist gpio isr callback function.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid gpio channel
others: other errors.

bk_err_t bk_gpio_register_lowpower_keep_status(gpio_id_t gpio_id, const gpio_config_t *config)

Register the GPIO channel to keep status.

This API regist gpio to keep status when enter low power or deepsleep.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid gpio channel
CONFIG_GPIO_DYNAMIC_KEEP_STATUS_MAX_CNT: too many gpio is register to keep status default max value is: CONFIG_GPIO_DYNAMIC_KEEP_STATUS_MAX_CNT
others: other errors.

bk_err_t bk_gpio_unregister_lowpower_keep_status(gpio_id_t gpio_id)

Unregister the GPIO channel from keep status.

This API unregist gpio from keep status.

Returns

BK_OK: succeed
BK_ERR_GPIO_CHAN_ID: invalid gpio channel
others: other errors.

bk_err_t bk_gpio_reg_save(uint32_t *gpio_cfg)

Register save all gpio reg value.

This API save all gpio reg value function.

Returns

BK_OK: succeed
others: other errors.

bk_err_t bk_gpio_reg_restore(uint32_t *gpio_cfg)

Register restore all gpio reg value.

This API restore all gpio reg value function.

Returns

BK_OK: succeed
others: other errors.

bk_err_t bk_gpio_wakeup_enable(int64_t index, uint64_t type_l, uint64_t type_h)

Register configue the gpio wakeup value.

This API configue the gpio wakeup value function.

Returns

BK_OK: succeed
others: other errors.

bk_err_t bk_gpio_wakeup_interrupt_clear()

Register clear wake up interrupt.

This API clear wake up interrupt function.

Returns

BK_OK: succeed
others: other errors.

bk_err_t bk_gpio_ctrl_external_ldo(gpio_ctrl_ldo_module_e module, gpio_id_t gpio_id, gpio_output_state_e value)

using the gpio to control the external ldo

control the external ldo,multi modules power on use one gpio control

Attention

This API is used to use the specific gpio(define in GPIO_CTRL_LDO_MAP in gpio_map.h) control the external ldo(multi modules power on use one gpio control)

Parameters

-module:gpio – ctrl ldo module name -gpio_id:gpio id -value:gpio output state

Returns

BK_OK: succeed
others: other errors.