doc_api_t Struct Reference

#include <r_doc_api.h>

Data Fields
ssp_err_t(*	open )(doc_ctrl_t *const p_ctrl, doc_cfg_t const *const p_cfg)
ssp_err_t(*	close )(doc_ctrl_t *const p_ctrl)
ssp_err_t(*	statusGet )(doc_ctrl_t *const p_ctrl, doc_status_t *p_status)
ssp_err_t(*	statusClear )(doc_ctrl_t *const p_ctrl)
ssp_err_t(*	write )(doc_ctrl_t *const p_ctrl, doc_data_t *const p_data)
ssp_err_t(*	inputRegisterWrite )(doc_ctrl_t *const p_ctrl, doc_size_t data)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Data Operation Circuit (DOC) API structure. DOC functions implemented at the HAL layer will follow this API.

Field Documentation

close

ssp_err_t(* doc_api_t::close) (doc_ctrl_t *const p_ctrl)

Allow the driver to be reconfigured. Will reduce power consumption.

Implemented as

• R_DOC_Close()

Parameters

[in]

p_ctrl

Control block set in doc_api_t::open call.

inputRegisterWrite

ssp_err_t(* doc_api_t::inputRegisterWrite) (doc_ctrl_t *const p_ctrl, doc_size_t data)

Write to the DODIR register.

Implemented as

• R_DOC_InputRegisterWrite()

Precondition

Call doc_api_t::open to configure the DOC before using this function.

Parameters

[in]	p_ctrl	Control block set in doc_api_t::open call.
[in]	data	Data to be written to DOC DODIR register.

open

ssp_err_t(* doc_api_t::open) (doc_ctrl_t *const p_ctrl, doc_cfg_t const *const p_cfg)

Initial configuration.

Implemented as

• R_DOC_Open()

Precondition

Peripheral clocks should be configured prior to calling this function.

Parameters

[in]	p_ctrl	Pointer to control block. Must be declared by user. Elements set here.
[in]	p_cfg	Pointer to configuration structure. All elements of this structure must be set by user.

statusClear

ssp_err_t(* doc_api_t::statusClear) (doc_ctrl_t *const p_ctrl)

Clear DOPCF status flag.

Implemented as

• R_DOC_StatusClear()

Precondition

Call doc_api_t::open to configure the DOC before using this function.

Parameters

[in]

p_ctrl

Control block set in doc_api_t::open call.

statusGet

ssp_err_t(* doc_api_t::statusGet) (doc_ctrl_t *const p_ctrl, doc_status_t *p_status)

Get the DOC status and stores it in the provided pointer p_status.

Implemented as

• R_DOC_StatusGet()

Precondition

Call doc_api_t::open to configure the DOC before using this function.

Parameters

[in]	p_ctrl	Control block set in doc_api_t::open call.
[out]	p_status	Indicates the status of the comparison/addition/subtraction operation. Result will be one of doc_status_t.

versionGet

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

Get version and stores it in provided pointer p_version.

Implemented as

• R_DOC_VersionGet()

Parameters

[out]

p_version

Code and API version used.

write

ssp_err_t(* doc_api_t::write) (doc_ctrl_t *const p_ctrl, doc_data_t *const p_data)

Write to the DODIR and DODSR registers.

Implemented as

• R_DOC_Write()

Precondition

Call doc_api_t::open to configure the DOC before using this function.

Parameters

[in]	p_ctrl	Control block set in doc_api_t::open call.
[in]	p_data	Pointer to data to be written to DOC DODIR and DODSR registers.

---

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

• r_doc_api.h