cfn_sal_dev_button_api_s Struct Reference

Button Virtual Method Table (VMT). More...

#include <cfn_sal_dev_button.h>

Data Fields
cfn_hal_api_base_t	base
cfn_hal_error_code_t(*	get_state )(cfn_sal_dev_button_t *driver, cfn_sal_dev_button_state_t *state_out)
cfn_hal_error_code_t(*	set_debounce_time )(cfn_sal_dev_button_t *driver, uint32_t ms)
cfn_hal_error_code_t(*	is_pressed )(cfn_sal_dev_button_t *driver, bool *pressed_out)
cfn_hal_error_code_t(*	is_released )(cfn_sal_dev_button_t *driver, bool *released_out)
cfn_hal_error_code_t(*	get_click_count )(cfn_sal_dev_button_t *driver, uint8_t *count_out)
cfn_hal_error_code_t(*	get_hold_time_ms )(cfn_sal_dev_button_t *driver, uint32_t *time_out)

Detailed Description

Button Virtual Method Table (VMT).

Field Documentation

base

cfn_hal_api_base_t cfn_sal_dev_button_api_s::base

get_click_count

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::get_click_count) (cfn_sal_dev_button_t *driver, uint8_t *count_out)

get_hold_time_ms

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::get_hold_time_ms) (cfn_sal_dev_button_t *driver, uint32_t *time_out)

get_state

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::get_state) (cfn_sal_dev_button_t *driver, cfn_sal_dev_button_state_t *state_out)

is_pressed

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::is_pressed) (cfn_sal_dev_button_t *driver, bool *pressed_out)

is_released

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::is_released) (cfn_sal_dev_button_t *driver, bool *released_out)

set_debounce_time

cfn_hal_error_code_t(* cfn_sal_dev_button_api_s::set_debounce_time) (cfn_sal_dev_button_t *driver, uint32_t ms)

---

The documentation for this struct was generated from the following file:

• include/devices/cfn_sal_dev_button.h