ptpedmac_api_t Struct Reference

#include <r_ptpedmac_api.h>

Data Fields
ssp_err_t(*	open )(ptpedmac_ctrl_t *const p_ctrl, ptpedmac_cfg_t const *const p_cfg)
ssp_err_t(*	linkProcess )(ptpedmac_ctrl_t *const p_api_ctrl)
ssp_err_t(*	linkCheck )(ptpedmac_ctrl_t *const p_ctrl)
ssp_err_t(*	read )(ptpedmac_ctrl_t *const p_ctrl, uint32_t *p_channel, void *const p_buffer, int32_t *p_num_received)
ssp_err_t(*	close )(ptpedmac_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

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

Field Documentation

close

ssp_err_t(* ptpedmac_api_t::close) (ptpedmac_ctrl_t *const p_ctrl)

Close the PTPEDMAC driver module.

Implemented as

• R_PTPEDMAC_Close()

Parameters

[in]

p_ctrl

Pointer to the control structure

linkCheck

ssp_err_t(* ptpedmac_api_t::linkCheck) (ptpedmac_ctrl_t *const p_ctrl)

Checks host interface communication status

Implemented as

• R_PTPEDMAC_CheckLink()

Parameters

[in]

p_ctrl

Pointer to the control structure

linkProcess

ssp_err_t(* ptpedmac_api_t::linkProcess) (ptpedmac_ctrl_t *const p_api_ctrl)

Sets host interface to transfer PTP messages

Implemented as

• R_PTPEDMAC_LinkProcess()

Parameters

[in]

p_ctrl

Pointer to the control structure

open

ssp_err_t(* ptpedmac_api_t::open) (ptpedmac_ctrl_t *const p_ctrl, ptpedmac_cfg_t const *const p_cfg)

Open the PTPEDMAC driver module for reception of PTP messages.

Implemented as

• R_PTPEDMAC_Open()

Parameters

[in]	p_ctrl	Pointer to the control structure
[in]	p_cfg	Pointer to configuration structure

read

ssp_err_t(* ptpedmac_api_t::read) (ptpedmac_ctrl_t *const p_ctrl, uint32_t *p_channel, void *const p_buffer, int32_t *p_num_received)

Receives PTP message

Implemented as

• R_PTPEDMAC_Read()

Parameters

[in]	p_ctrl	Pointer to the control structure
[out]	p_channel	Pointer to received channel
[out]	p_buffer	Pointer to received data buffer
[out]	p_num_received	Pointer to number of received data

versionGet

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

Get the driver version based on compile time macros.

Implemented as

• R_PTPEDMAC_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_ptpedmac_api.h