fmi_api_t Struct Reference

#include <r_fmi_api.h>

Data Fields
ssp_err_t(*	init )(void)
ssp_err_t(*	productInfoGet )(fmi_product_info_t **pp_product_info)
ssp_err_t(*	uniqueIdGet )(fmi_unique_id_t *p_unique_id)
ssp_err_t(*	productFeatureGet )(ssp_feature_t const *const p_feature, fmi_feature_info_t *const p_info)
ssp_err_t(*	eventInfoGet )(ssp_feature_t const *const p_feature, ssp_signal_t signal, fmi_event_info_t *const p_info)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

fmi driver structure. General fmi functions implemented at the HAL layer will follow this API.

Field Documentation

eventInfoGet

ssp_err_t(* fmi_api_t::eventInfoGet) (ssp_feature_t const *const p_feature, ssp_signal_t signal, fmi_event_info_t *const p_info)

Get event information and store it in p_info.

Parameters

[in]	p_feature	Definition of SSP feature.
[in]	signal	Feature signal ID.
[out]	p_info	Event information for feature signal.

Implemented as

• R_FMI_EventInfoGet()

init

ssp_err_t(* fmi_api_t::init) (void)

Initialize the FMI base pointer.

Implemented as

• R_FMI_Init()

productFeatureGet

ssp_err_t(* fmi_api_t::productFeatureGet) (ssp_feature_t const *const p_feature, fmi_feature_info_t *const p_info)

Get feature information and store it in p_info.

Parameters

[in]	p_feature	Definition of SSP feature.
[out]	p_info	Feature specific information.

Implemented as

• R_FMI_ProductFeatureGet()

productInfoGet

ssp_err_t(* fmi_api_t::productInfoGet) (fmi_product_info_t **pp_product_info)

Get product information record address into caller's pointer.

Warning

fmi_product_info_t::unique_id is deprecated and will not contain a unique ID if the factory MCU information is linked in by the application code. Use fmi_api_t::uniqueIdGet for the unique ID.

Parameters

[in,out]

pp_product_info

Pointer to store pointer to product info.

Implemented as

• R_FMI_ProductInfoGet()

uniqueIdGet

ssp_err_t(* fmi_api_t::uniqueIdGet) (fmi_unique_id_t *p_unique_id)

Copy unique ID into p_unique_id.

Parameters

[out]

p_unique_id

Pointer to unique ID.

Implemented as

• R_FMI_UniqueIdGet()

versionGet

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

Get the driver version based on compile time macros.

Implemented as

• R_FMI_VersionGet()

---

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

• r_fmi_api.h