input_capture_api_t Struct Reference

#include <r_input_capture_api.h>

Data Fields
ssp_err_t(*	open )(input_capture_ctrl_t *const p_ctrl, input_capture_cfg_t const *const p_cfg)
ssp_err_t(*	disable )(input_capture_ctrl_t const *const p_ctrl)
ssp_err_t(*	enable )(input_capture_ctrl_t const *const p_ctrl)
ssp_err_t(*	infoGet )(input_capture_ctrl_t const *const p_ctrl, input_capture_info_t *const p_info)
ssp_err_t(*	lastCaptureGet )(input_capture_ctrl_t const *const p_ctrl, input_capture_capture_t *const p_counter)
ssp_err_t(*	close )(input_capture_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Input capture API structure. Functions implemented at the HAL layer will implement this API.

Field Documentation

close

ssp_err_t(* input_capture_api_t::close) (input_capture_ctrl_t *const p_ctrl)

Close the input capture operation. Allows driver to be reconfigured, and may reduce power consumption.

Implemented as

• R_GPT_InputCaptureClose()
• R_AGT_InputCaptureClose()

Parameters

[in]

p_ctrl

Pointer to control block initialized by input_capture_api_t::open call.

disable

ssp_err_t(* input_capture_api_t::disable) (input_capture_ctrl_t const *const p_ctrl)

Disables input capture measurement.

Implemented as

• R_GPT_InputCaptureDisable()
• R_AGT_InputCaptureDisable()

Parameters

[in]

p_ctrl

Pointer to control block initialized by input_capture_api_t::open call.

enable

ssp_err_t(* input_capture_api_t::enable) (input_capture_ctrl_t const *const p_ctrl)

Enables input capture measurement.

Implemented as

• R_GPT_InputCaptureEnable()
• R_AGT_InputCaptureEnable()

Parameters

[in]

p_ctrl

Pointer to control block initialized by input_capture_api_t::open call.

Note

Interrupts may already be enabled if specified by input_capture_cfg_t::irq_enable.

infoGet

ssp_err_t(* input_capture_api_t::infoGet) (input_capture_ctrl_t const *const p_ctrl, input_capture_info_t *const p_info)

Gets the status (running or not) of the measurement counter.

Implemented as

• R_GPT_InputCaptureInfoGet()
• R_AGT_InputCaptureInfoGet()

Parameters

[in]	p_ctrl	Pointer to control block initialized by input_capture_api_t::open call.
[out]	p_info	Pointer to returned status. Result will be one of input_capture_status_t.

lastCaptureGet

ssp_err_t(* input_capture_api_t::lastCaptureGet) (input_capture_ctrl_t const *const p_ctrl, input_capture_capture_t *const p_counter)

Gets the last captured timer/counter value

Implemented as

• R_GPT_InputCaptureLastCaptureGet()
• R_AGT_InputCaptureLastCaptureGet()

Parameters

[in]	p_ctrl	Pointer to control block initialized by input_capture_api_t::open call.
[out]	p_counter	Pointer to location to store last captured counter value.

open

ssp_err_t(* input_capture_api_t::open) (input_capture_ctrl_t *const p_ctrl, input_capture_cfg_t const *const p_cfg)

Initial configuration.

Implemented as

• R_GPT_InputCaptureOpen()
• R_AGT_InputCaptureOpen()

Note

To reconfigure after calling this function, call input_capture_api_t::close first.

Parameters

[in]	p_ctrl	Pointer to control block: memory allocated by caller, contents filled in by open.
[in]	p_cfg	Pointer to configuration structure. All elements of this structure must be set by user.

versionGet

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

Gets the version of this API and stores it in structure pointed to by p_version.

Implemented as

• R_GPT_InputCaptureVersionGet()
• R_AGT_InputCaptureVersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_input_capture_api.h