Abstract Color Sensor service interface. More...

#include "cfn_sal.h"

Data Structures
struct	cfn_sal_dev_color_config_t

struct	cfn_sal_dev_color_api_s
	Color Sensor Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_DEV_TYPE_COLOR CFN_SAL_TYPE('C', 'L', 'R')

Typedefs
typedef struct cfn_sal_dev_color_s	cfn_sal_dev_color_t

typedef struct cfn_sal_dev_color_api_s	cfn_sal_dev_color_api_t

typedef void(*	cfn_sal_dev_color_callback_t) (cfn_sal_dev_color_t driver, uint32_t event, uint32_t error, void user_arg)

Enumerations
enum	cfn_sal_dev_color_event_t { CFN_SAL_DEV_COLOR_EVENT_NONE = 0 , CFN_SAL_DEV_COLOR_EVENT_DATA_READY = CFN_HAL_BIT(0) , CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_HIGH = CFN_HAL_BIT(1) , CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_LOW = CFN_HAL_BIT(2) }

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_dev_color_api_s)

	CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_color, cfn_sal_dev_color_config_t, cfn_sal_dev_color_api_t, cfn_sal_phy_t, cfn_sal_dev_color_callback_t)

CFN_HAL_INLINE void	cfn_sal_dev_color_populate (cfn_sal_dev_color_t driver, uint32_t peripheral_id, void dependency, const cfn_sal_dev_color_api_t api, const cfn_sal_phy_t phy, const cfn_sal_dev_color_config_t config, cfn_sal_dev_color_callback_t callback, void user_arg)

cfn_hal_error_code_t	cfn_sal_dev_color_construct (cfn_sal_dev_color_t driver, const cfn_sal_dev_color_config_t config, const cfn_sal_phy_t phy, void dependency, cfn_sal_dev_color_callback_t callback, void *user_arg)

cfn_hal_error_code_t	cfn_sal_dev_color_destruct (cfn_sal_dev_color_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_init (cfn_sal_dev_color_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_deinit (cfn_sal_dev_color_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_config_set (cfn_sal_dev_color_t driver, const cfn_sal_dev_color_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_config_get (cfn_sal_dev_color_t driver, cfn_sal_dev_color_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_callback_register (cfn_sal_dev_color_t driver, cfn_sal_dev_color_callback_t callback, void user_arg)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_power_state_set (cfn_sal_dev_color_t *driver, cfn_hal_power_state_t state)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_event_enable (cfn_sal_dev_color_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_event_disable (cfn_sal_dev_color_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_event_get (cfn_sal_dev_color_t driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_error_enable (cfn_sal_dev_color_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_error_disable (cfn_sal_dev_color_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_error_get (cfn_sal_dev_color_t driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_read_xyz (cfn_sal_dev_color_t driver, float x, float y, float z)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_read_cct (cfn_sal_dev_color_t driver, float cct_k)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_read_raw_channels (cfn_sal_dev_color_t driver, uint32_t ch0, uint32_t ch1, uint32_t ch2, uint32_t *ch3)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_get_status (cfn_sal_dev_color_t driver, uint32_t status_flags)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_color_get_id (cfn_sal_dev_color_t driver, uint32_t id_out)

CFN_HAL_INLINE void	cfn_sal_dev_color_handle_interrupt (cfn_sal_dev_color_t *driver)

Detailed Description

Abstract Color Sensor service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_COLOR

#define CFN_SAL_DEV_TYPE_COLOR CFN_SAL_TYPE('C', 'L', 'R')

Typedef Documentation

◆ cfn_sal_dev_color_api_t

typedef struct cfn_sal_dev_color_api_s cfn_sal_dev_color_api_t

◆ cfn_sal_dev_color_callback_t

typedef void(* cfn_sal_dev_color_callback_t) (cfn_sal_dev_color_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_color_t

typedef struct cfn_sal_dev_color_s cfn_sal_dev_color_t

Enumeration Type Documentation

◆ cfn_sal_dev_color_event_t

enum cfn_sal_dev_color_event_t

Enumerator
CFN_SAL_DEV_COLOR_EVENT_NONE
CFN_SAL_DEV_COLOR_EVENT_DATA_READY
CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_HIGH
CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_LOW

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_color_api_s )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_dev_color	,
		cfn_sal_dev_color_config_t	,
		cfn_sal_dev_color_api_t	,
		cfn_sal_phy_t	,
		cfn_sal_dev_color_callback_t
	)

◆ cfn_sal_dev_color_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_callback_register	(	cfn_sal_dev_color_t *	driver,
		cfn_sal_dev_color_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_color_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_config_get	(	cfn_sal_dev_color_t *	driver,
		cfn_sal_dev_color_config_t *	config
	)

◆ cfn_sal_dev_color_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_config_set	(	cfn_sal_dev_color_t *	driver,
		const cfn_sal_dev_color_config_t *	config
	)

◆ cfn_sal_dev_color_construct()

cfn_hal_error_code_t cfn_sal_dev_color_construct	(	cfn_sal_dev_color_t *	driver,
		const cfn_sal_dev_color_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_sal_dev_color_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_color_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_deinit ( cfn_sal_dev_color_t * driver )

◆ cfn_sal_dev_color_destruct()

cfn_hal_error_code_t cfn_sal_dev_color_destruct ( cfn_sal_dev_color_t * driver )

◆ cfn_sal_dev_color_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_disable	(	cfn_sal_dev_color_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_dev_color_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_enable	(	cfn_sal_dev_color_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_dev_color_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_get	(	cfn_sal_dev_color_t *	driver,
		uint32_t *	error_mask
	)

◆ cfn_sal_dev_color_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_disable	(	cfn_sal_dev_color_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_dev_color_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_enable	(	cfn_sal_dev_color_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_dev_color_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_get	(	cfn_sal_dev_color_t *	driver,
		uint32_t *	event_mask
	)

◆ cfn_sal_dev_color_get_id()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_get_id	(	cfn_sal_dev_color_t *	driver,
		uint32_t *	id_out
	)

◆ cfn_sal_dev_color_get_status()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_get_status	(	cfn_sal_dev_color_t *	driver,
		uint32_t *	status_flags
	)

◆ cfn_sal_dev_color_handle_interrupt()

CFN_HAL_INLINE void cfn_sal_dev_color_handle_interrupt ( cfn_sal_dev_color_t * driver )

◆ cfn_sal_dev_color_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_init ( cfn_sal_dev_color_t * driver )

◆ cfn_sal_dev_color_populate()

CFN_HAL_INLINE void cfn_sal_dev_color_populate	(	cfn_sal_dev_color_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_dev_color_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_dev_color_config_t *	config,
		cfn_sal_dev_color_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_color_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_power_state_set	(	cfn_sal_dev_color_t *	driver,
		cfn_hal_power_state_t	state
	)

◆ cfn_sal_dev_color_read_cct()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_cct	(	cfn_sal_dev_color_t *	driver,
		float *	cct_k
	)

◆ cfn_sal_dev_color_read_raw_channels()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_raw_channels	(	cfn_sal_dev_color_t *	driver,
		uint32_t *	ch0,
		uint32_t *	ch1,
		uint32_t *	ch2,
		uint32_t *	ch3
	)

◆ cfn_sal_dev_color_read_xyz()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_xyz	(	cfn_sal_dev_color_t *	driver,
		float *	x,
		float *	y,
		float *	z
	)

Data Structures

Macros

Typedefs

Enumerations

Functions