pdc_api_t Struct Reference

#include <r_pdc_api.h>

Data Fields
ssp_err_t(*	open )(pdc_ctrl_t *const p_ctrl, pdc_cfg_t const *const p_cfg)
ssp_err_t(*	close )(pdc_ctrl_t *const p_ctrl)
ssp_err_t(*	captureStart )(pdc_ctrl_t *const p_ctrl, uint8_t *const p_buffer)
ssp_err_t(*	stateGet )(pdc_ctrl_t *const p_ctrl, pdc_state_t *p_state)
ssp_err_t(*	versionGet )(ssp_version_t *const p_data)

Detailed Description

PDC functions implemented at the HAL layer will follow this API.

Field Documentation

captureStart

ssp_err_t(* pdc_api_t::captureStart) (pdc_ctrl_t *const p_ctrl, uint8_t *const p_buffer)

Start a capture.

Implemented as

• R_PDC_CaptureStart()

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_buffer	Pointer to store captured image data.

close

ssp_err_t(* pdc_api_t::close) (pdc_ctrl_t *const p_ctrl)

Closes the driver and allows reconfiguration. May reduce power consumption.

Implemented as

• R_PDC_Close()

Parameters

[in]

p_ctrl

Pointer to control structure.

open

ssp_err_t(* pdc_api_t::open) (pdc_ctrl_t *const p_ctrl, pdc_cfg_t const *const p_cfg)

Initial configuration.

Implemented as

• R_PDC_Open()

Note

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

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to pin configuration structure.

stateGet

ssp_err_t(* pdc_api_t::stateGet) (pdc_ctrl_t *const p_ctrl, pdc_state_t *p_state)

Get the state of the VSYNC and HSYNC pins.

Implemented as

• R_PDC_StateGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_state	Pointer to store state data.

versionGet

ssp_err_t(* pdc_api_t::versionGet) (ssp_version_t *const p_data)

Return the version of the driver.

Implemented as

• R_PDC_VersionGet()

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_data	Memory address to return version information to.

---

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

• r_pdc_api.h