keymatrix_api_t Struct Reference

#include <r_keymatrix_api.h>

Data Fields
ssp_err_t(*	open )(keymatrix_ctrl_t *const p_ctrl, keymatrix_cfg_t const *const p_cfg)
ssp_err_t(*	enable )(keymatrix_ctrl_t *const p_ctrl)
ssp_err_t(*	disable )(keymatrix_ctrl_t *const p_ctrl)
ssp_err_t(*	triggerSet )(keymatrix_ctrl_t *const p_ctrl, keymatrix_trigger_t const trigger)
ssp_err_t(*	close )(keymatrix_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Key Matrix driver structure. Key Matrix functions implemented at the HAL layer will use this API.

Field Documentation

close

ssp_err_t(* keymatrix_api_t::close) (keymatrix_ctrl_t *const p_ctrl)

Allow driver to be reconfigured. May reduce power consumption.

Implemented as

• R_KINT_KEYMATRIX_Close()

Parameters

[in]

p_ctrl

Control block pointer set in Open call for this Key interrupt.

disable

ssp_err_t(* keymatrix_api_t::disable) (keymatrix_ctrl_t *const p_ctrl)

Disable Key interrupt.

Implemented as

• R_KINT_KEYMATRIX_Disable()

Parameters

[in]

p_ctrl

Control block pointer set in Open call for this Key interrupt.

enable

ssp_err_t(* keymatrix_api_t::enable) (keymatrix_ctrl_t *const p_ctrl)

Enable Key interrupt

Implemented as

• R_KINT_KEYMATRIX_Enable()

Parameters

[in]

p_ctrl

Control block pointer set in Open call for this Key interrupt.

open

ssp_err_t(* keymatrix_api_t::open) (keymatrix_ctrl_t *const p_ctrl, keymatrix_cfg_t const *const p_cfg)

Initial configuration.

Implemented as

• R_KINT_KEYMATRIX_Open()

Parameters

[out]	p_ctrl	Pointer to control block. Must be declared by user. Value set in this function.
[in]	p_cfg	Pointer to configuration structure. All elements of the structure must be set by user.

triggerSet

ssp_err_t(* keymatrix_api_t::triggerSet) (keymatrix_ctrl_t *const p_ctrl, keymatrix_trigger_t const trigger)

Set trigger for Key interrupt.

Implemented as

• R_KINT_KEYMATRIX_TriggerSet()

Parameters

[in]	p_ctrl	Control block pointer set in Open call for this Key interrupt.
[in]	trigger	Trigger source for key interrupt; defined in enumeration of keymatrix_trigger_t.

versionGet

ssp_err_t(* keymatrix_api_t::versionGet) (ssp_version_t *const p_version)

Get version and store it in provided pointer p_version.

Implemented as

• R_KINT_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_keymatrix_api.h