can_api_t Struct Reference

#include <r_can_api.h>

Data Fields
ssp_err_t(*	open )(can_ctrl_t *const p_ctrl, can_cfg_t const *const p_cfg)
ssp_err_t(*	read )(can_ctrl_t *const p_ctrl, uint32_t mailbox, can_frame_t *const p_frame)
ssp_err_t(*	write )(can_ctrl_t *const p_ctrl, uint32_t mailbox, can_frame_t *const p_frame)
ssp_err_t(*	close )(can_ctrl_t *const p_ctrl)
ssp_err_t(*	control )(can_ctrl_t *const p_ctrl, can_command_t const command, void *p_data)
ssp_err_t(*	infoGet )(can_ctrl_t *const p_ctrl, can_info_t *const p_info)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Shared Interface definition for CAN

Field Documentation

close

ssp_err_t(* can_api_t::close) (can_ctrl_t *const p_ctrl)

Close function for CAN device

Implemented as

• R_CAN_Close()

Parameters

[in]

p_ctrl

Pointer to the CAN control block.

control

ssp_err_t(* can_api_t::control) (can_ctrl_t *const p_ctrl, can_command_t const command, void *p_data)

Control function for CAN device

Implemented as

• R_CAN_Control()

Parameters

[in]	p_ctrl	Pointer to the CAN control block.
[in]	command	Command type.
[in]	p_data	Command data.

infoGet

ssp_err_t(* can_api_t::infoGet) (can_ctrl_t *const p_ctrl, can_info_t *const p_info)

Get CAN channel info.

Implemented as

• R_CAN_InfoGet()

Parameters

[in]	p_ctrl	Handle for channel (pointer to channel control block)
[out]	p_info	Memory address to return channel specific data to.

open

ssp_err_t(* can_api_t::open) (can_ctrl_t *const p_ctrl, can_cfg_t const *const p_cfg)

Open function for CAN device

Implemented as

• R_CAN_Open()

Parameters

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

read

ssp_err_t(* can_api_t::read) (can_ctrl_t *const p_ctrl, uint32_t mailbox, can_frame_t *const p_frame)

Read function for CAN device, non-Blocking.

Implemented as

• R_CAN_Read()

Parameters

[in]	p_ctrl	Pointer to the CAN control block for the channel.
[in]	mailbox	Mailbox to read from.
[out]	p_frame	Pointer for frame of CAN ID, DLC, data and frame type.

versionGet

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

Version get function for CAN device

Implemented as

• R_CAN_VersionGet()

Parameters

[in]

p_version

Pointer to the memory to store the version information

write

ssp_err_t(* can_api_t::write) (can_ctrl_t *const p_ctrl, uint32_t mailbox, can_frame_t *const p_frame)

Write function for CAN device

Implemented as

• R_CAN_Write()

Parameters

[in]	p_ctrl	Pointer to the CAN control block.
[in]	mailbox	Mailbox to write to.
[in]	p_frame	Pointer for frame of CAN ID, DLC, data and frame type to write.

---

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

• r_can_api.h