Abstract LED service interface. More...

#include "cfn_sal.h"

Data Structures
struct	cfn_sal_dev_led_color_t

struct	cfn_sal_dev_led_config_t

struct	cfn_sal_dev_led_api_s
	LED Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_DEV_TYPE_LED CFN_SAL_TYPE('L', 'E', 'D')

Typedefs
typedef struct cfn_sal_dev_led_s	cfn_sal_dev_led_t

typedef struct cfn_sal_dev_led_api_s	cfn_sal_dev_led_api_t

typedef void(*	cfn_sal_dev_led_callback_t) (cfn_sal_dev_led_t driver, uint32_t event, uint32_t error, void user_arg)

Enumerations
enum	cfn_sal_dev_led_state_t { CFN_SAL_DEV_LED_STATE_OFF = 0 , CFN_SAL_DEV_LED_STATE_ON }

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_dev_led_api_s)

	CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_led, cfn_sal_dev_led_config_t, cfn_sal_dev_led_api_t, cfn_sal_phy_t, cfn_sal_dev_led_callback_t)

CFN_HAL_INLINE void	cfn_sal_dev_led_populate (cfn_sal_dev_led_t driver, uint32_t peripheral_id, void dependency, const cfn_sal_dev_led_api_t api, const cfn_sal_phy_t phy, const cfn_sal_dev_led_config_t config, cfn_sal_dev_led_callback_t callback, void user_arg)

cfn_hal_error_code_t	cfn_sal_dev_led_construct (cfn_sal_dev_led_t driver, const cfn_sal_dev_led_config_t config, const cfn_sal_phy_t phy, void dependency, cfn_sal_dev_led_callback_t callback, void *user_arg)

cfn_hal_error_code_t	cfn_sal_dev_led_destruct (cfn_sal_dev_led_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_init (cfn_sal_dev_led_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_deinit (cfn_sal_dev_led_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_config_set (cfn_sal_dev_led_t driver, const cfn_sal_dev_led_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_config_get (cfn_sal_dev_led_t driver, cfn_sal_dev_led_config_t config)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_callback_register (cfn_sal_dev_led_t driver, cfn_sal_dev_led_callback_t callback, void user_arg)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_power_state_set (cfn_sal_dev_led_t *driver, cfn_hal_power_state_t state)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_event_enable (cfn_sal_dev_led_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_event_disable (cfn_sal_dev_led_t *driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_event_get (cfn_sal_dev_led_t driver, uint32_t event_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_error_enable (cfn_sal_dev_led_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_error_disable (cfn_sal_dev_led_t *driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_error_get (cfn_sal_dev_led_t driver, uint32_t error_mask)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_set_state (cfn_sal_dev_led_t *driver, cfn_sal_dev_led_state_t state)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_get_state (cfn_sal_dev_led_t driver, cfn_sal_dev_led_state_t state_out)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_toggle (cfn_sal_dev_led_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_set_brightness (cfn_sal_dev_led_t *driver, uint8_t percent)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_get_brightness (cfn_sal_dev_led_t driver, uint8_t percent_out)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_set_color (cfn_sal_dev_led_t *driver, cfn_sal_dev_led_color_t color)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_blink_start (cfn_sal_dev_led_t *driver, uint32_t period_ms)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_blink_stop (cfn_sal_dev_led_t *driver)

CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_led_set_blink (cfn_sal_dev_led_t *driver, uint32_t interval_ms, uint32_t count)

Detailed Description

Abstract LED service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_LED

#define CFN_SAL_DEV_TYPE_LED CFN_SAL_TYPE('L', 'E', 'D')

Typedef Documentation

◆ cfn_sal_dev_led_api_t

typedef struct cfn_sal_dev_led_api_s cfn_sal_dev_led_api_t

◆ cfn_sal_dev_led_callback_t

typedef void(* cfn_sal_dev_led_callback_t) (cfn_sal_dev_led_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_led_t

typedef struct cfn_sal_dev_led_s cfn_sal_dev_led_t

Enumeration Type Documentation

◆ cfn_sal_dev_led_state_t

enum cfn_sal_dev_led_state_t

Enumerator
CFN_SAL_DEV_LED_STATE_OFF
CFN_SAL_DEV_LED_STATE_ON

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_led_api_s )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_dev_led	,
		cfn_sal_dev_led_config_t	,
		cfn_sal_dev_led_api_t	,
		cfn_sal_phy_t	,
		cfn_sal_dev_led_callback_t
	)

◆ cfn_sal_dev_led_blink_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_blink_start	(	cfn_sal_dev_led_t *	driver,
		uint32_t	period_ms
	)

◆ cfn_sal_dev_led_blink_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_blink_stop ( cfn_sal_dev_led_t * driver )

◆ cfn_sal_dev_led_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_callback_register	(	cfn_sal_dev_led_t *	driver,
		cfn_sal_dev_led_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_led_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_config_get	(	cfn_sal_dev_led_t *	driver,
		cfn_sal_dev_led_config_t *	config
	)

◆ cfn_sal_dev_led_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_config_set	(	cfn_sal_dev_led_t *	driver,
		const cfn_sal_dev_led_config_t *	config
	)

◆ cfn_sal_dev_led_construct()

cfn_hal_error_code_t cfn_sal_dev_led_construct	(	cfn_sal_dev_led_t *	driver,
		const cfn_sal_dev_led_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_sal_dev_led_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_led_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_deinit ( cfn_sal_dev_led_t * driver )

◆ cfn_sal_dev_led_destruct()

cfn_hal_error_code_t cfn_sal_dev_led_destruct ( cfn_sal_dev_led_t * driver )

◆ cfn_sal_dev_led_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_error_disable	(	cfn_sal_dev_led_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_dev_led_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_error_enable	(	cfn_sal_dev_led_t *	driver,
		uint32_t	error_mask
	)

◆ cfn_sal_dev_led_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_error_get	(	cfn_sal_dev_led_t *	driver,
		uint32_t *	error_mask
	)

◆ cfn_sal_dev_led_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_event_disable	(	cfn_sal_dev_led_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_dev_led_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_event_enable	(	cfn_sal_dev_led_t *	driver,
		uint32_t	event_mask
	)

◆ cfn_sal_dev_led_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_event_get	(	cfn_sal_dev_led_t *	driver,
		uint32_t *	event_mask
	)

◆ cfn_sal_dev_led_get_brightness()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_get_brightness	(	cfn_sal_dev_led_t *	driver,
		uint8_t *	percent_out
	)

◆ cfn_sal_dev_led_get_state()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_get_state	(	cfn_sal_dev_led_t *	driver,
		cfn_sal_dev_led_state_t *	state_out
	)

◆ cfn_sal_dev_led_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_init ( cfn_sal_dev_led_t * driver )

◆ cfn_sal_dev_led_populate()

CFN_HAL_INLINE void cfn_sal_dev_led_populate	(	cfn_sal_dev_led_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_dev_led_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_dev_led_config_t *	config,
		cfn_sal_dev_led_callback_t	callback,
		void *	user_arg
	)

◆ cfn_sal_dev_led_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_power_state_set	(	cfn_sal_dev_led_t *	driver,
		cfn_hal_power_state_t	state
	)

◆ cfn_sal_dev_led_set_blink()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_set_blink	(	cfn_sal_dev_led_t *	driver,
		uint32_t	interval_ms,
		uint32_t	count
	)

◆ cfn_sal_dev_led_set_brightness()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_set_brightness	(	cfn_sal_dev_led_t *	driver,
		uint8_t	percent
	)

◆ cfn_sal_dev_led_set_color()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_set_color	(	cfn_sal_dev_led_t *	driver,
		cfn_sal_dev_led_color_t	color
	)

◆ cfn_sal_dev_led_set_state()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_set_state	(	cfn_sal_dev_led_t *	driver,
		cfn_sal_dev_led_state_t	state
	)

◆ cfn_sal_dev_led_toggle()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_led_toggle ( cfn_sal_dev_led_t * driver )

Data Structures

Macros

Typedefs

Enumerations

Functions