cfn_sal_dev_composite.h File Reference

Standardized shared state for composite (multi-function) sensors. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures
struct	cfn_sal_dev_composite_shared_t
	Standardized shared state for composite (multi-function) sensors. This structure should be embedded within a composite sensor struct to manage shared hardware resources and initialization counts across multiple polymorphic interfaces. More...

Functions
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_composite_init (cfn_sal_dev_composite_shared_t *state, const cfn_sal_phy_t *phy)
	Initialize the shared composite state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_composite_deinit (cfn_sal_dev_composite_shared_t *state)
	Deinitialize the shared composite state.

Detailed Description

Standardized shared state for composite (multi-function) sensors.

Function Documentation

cfn_sal_dev_composite_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_composite_deinit

(

cfn_sal_dev_composite_shared_t *

state

)

Deinitialize the shared composite state.

Parameters

state

Pointer to the shared state structure.

Returns

CFN_HAL_ERROR_OK on success.

cfn_sal_dev_composite_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_composite_init	(	cfn_sal_dev_composite_shared_t *	state,
		const cfn_sal_phy_t *	phy
	)

Initialize the shared composite state.

Parameters

state	Pointer to the shared state structure.
phy	Pointer to the shared physical interface mapping.

Returns

CFN_HAL_ERROR_OK on success.