cfn_sal_dev_display.h File Reference

Abstract Display service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures
struct	cfn_sal_dev_display_config_t
struct	cfn_sal_dev_display_api_s
	Display Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_DEV_TYPE_DISPLAY   CFN_SAL_TYPE('D', 'S', 'P')

Typedefs
typedef struct cfn_sal_dev_display_s	cfn_sal_dev_display_t
typedef struct cfn_sal_dev_display_api_s	cfn_sal_dev_display_api_t
typedef void(*	cfn_sal_dev_display_callback_t) (cfn_sal_dev_display_t *driver, uint32_t event, uint32_t error, void *user_arg)

Enumerations
enum	cfn_sal_dev_display_event_t { CFN_SAL_DEV_DISPLAY_EVENT_NONE = 0 , CFN_SAL_DEV_DISPLAY_EVENT_REFRESH_DONE = CFN_HAL_BIT(0) }

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_dev_display_api_s)
	CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_display, cfn_sal_dev_display_config_t, cfn_sal_dev_display_api_t, cfn_sal_phy_t, cfn_sal_dev_display_callback_t)
CFN_HAL_INLINE void	cfn_sal_dev_display_populate (cfn_sal_dev_display_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_dev_display_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_dev_display_config_t *config, cfn_sal_dev_display_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_dev_display_construct (cfn_sal_dev_display_t *driver, const cfn_sal_dev_display_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_dev_display_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_dev_display_destruct (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_init (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_deinit (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_config_set (cfn_sal_dev_display_t *driver, const cfn_sal_dev_display_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_config_get (cfn_sal_dev_display_t *driver, cfn_sal_dev_display_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_callback_register (cfn_sal_dev_display_t *driver, cfn_sal_dev_display_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_power_state_set (cfn_sal_dev_display_t *driver, cfn_hal_power_state_t state)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_event_enable (cfn_sal_dev_display_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_event_disable (cfn_sal_dev_display_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_event_get (cfn_sal_dev_display_t *driver, uint32_t *event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_error_enable (cfn_sal_dev_display_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_error_disable (cfn_sal_dev_display_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_error_get (cfn_sal_dev_display_t *driver, uint32_t *error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_turn_on (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_turn_off (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_set_brightness (cfn_sal_dev_display_t *driver, uint8_t percent)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_draw_pixel (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y, uint32_t color)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_fill_rect (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint32_t color)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_draw_bitmap (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y, uint16_t w, uint16_t h, const uint8_t *data)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_clear (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_update (cfn_sal_dev_display_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_set_backlight (cfn_sal_dev_display_t *driver, uint8_t percent)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_draw_line (cfn_sal_dev_display_t *driver, uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint32_t color)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_draw_rect (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint32_t color)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_clear_window (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y, uint16_t w, uint16_t h)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_set_cursor (cfn_sal_dev_display_t *driver, uint16_t x, uint16_t y)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_write_data (cfn_sal_dev_display_t *driver, const uint8_t *data, size_t len)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_write_command (cfn_sal_dev_display_t *driver, uint8_t cmd)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_dev_display_set_orientation (cfn_sal_dev_display_t *driver, uint8_t orientation)

Detailed Description

Abstract Display service interface.

Macro Definition Documentation

CFN_SAL_DEV_TYPE_DISPLAY

#define CFN_SAL_DEV_TYPE_DISPLAY   CFN_SAL_TYPE('D', 'S', 'P')

Typedef Documentation

cfn_sal_dev_display_api_t

typedef struct cfn_sal_dev_display_api_s cfn_sal_dev_display_api_t

cfn_sal_dev_display_callback_t

typedef void(* cfn_sal_dev_display_callback_t) (cfn_sal_dev_display_t *driver, uint32_t event, uint32_t error, void *user_arg)

cfn_sal_dev_display_t

typedef struct cfn_sal_dev_display_s cfn_sal_dev_display_t

Enumeration Type Documentation

cfn_sal_dev_display_event_t

enum cfn_sal_dev_display_event_t

Enumerator
CFN_SAL_DEV_DISPLAY_EVENT_NONE
CFN_SAL_DEV_DISPLAY_EVENT_REFRESH_DONE

Function Documentation

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_sal_dev_display_api_s

)

CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_dev_display	,
		cfn_sal_dev_display_config_t	,
		cfn_sal_dev_display_api_t	,
		cfn_sal_phy_t	,
		cfn_sal_dev_display_callback_t
	)

cfn_sal_dev_display_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_callback_register	(	cfn_sal_dev_display_t *	driver,
		cfn_sal_dev_display_callback_t	callback,
		void *	user_arg
	)

cfn_sal_dev_display_clear()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_clear

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_clear_window()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_clear_window	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h
	)

cfn_sal_dev_display_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_config_get	(	cfn_sal_dev_display_t *	driver,
		cfn_sal_dev_display_config_t *	config
	)

cfn_sal_dev_display_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_config_set	(	cfn_sal_dev_display_t *	driver,
		const cfn_sal_dev_display_config_t *	config
	)

cfn_sal_dev_display_construct()

cfn_hal_error_code_t cfn_sal_dev_display_construct	(	cfn_sal_dev_display_t *	driver,
		const cfn_sal_dev_display_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_sal_dev_display_callback_t	callback,
		void *	user_arg
	)

cfn_sal_dev_display_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_deinit

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_destruct()

cfn_hal_error_code_t cfn_sal_dev_display_destruct

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_draw_bitmap()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_draw_bitmap	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h,
		const uint8_t *	data
	)

cfn_sal_dev_display_draw_line()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_draw_line	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x0,
		uint16_t	y0,
		uint16_t	x1,
		uint16_t	y1,
		uint32_t	color
	)

cfn_sal_dev_display_draw_pixel()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_draw_pixel	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y,
		uint32_t	color
	)

cfn_sal_dev_display_draw_rect()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_draw_rect	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h,
		uint32_t	color
	)

cfn_sal_dev_display_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_error_disable	(	cfn_sal_dev_display_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_dev_display_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_error_enable	(	cfn_sal_dev_display_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_dev_display_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_error_get	(	cfn_sal_dev_display_t *	driver,
		uint32_t *	error_mask
	)

cfn_sal_dev_display_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_event_disable	(	cfn_sal_dev_display_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_dev_display_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_event_enable	(	cfn_sal_dev_display_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_dev_display_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_event_get	(	cfn_sal_dev_display_t *	driver,
		uint32_t *	event_mask
	)

cfn_sal_dev_display_fill_rect()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_fill_rect	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h,
		uint32_t	color
	)

cfn_sal_dev_display_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_init

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_populate()

CFN_HAL_INLINE void cfn_sal_dev_display_populate	(	cfn_sal_dev_display_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_dev_display_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_dev_display_config_t *	config,
		cfn_sal_dev_display_callback_t	callback,
		void *	user_arg
	)

cfn_sal_dev_display_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_power_state_set	(	cfn_sal_dev_display_t *	driver,
		cfn_hal_power_state_t	state
	)

cfn_sal_dev_display_set_backlight()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_set_backlight	(	cfn_sal_dev_display_t *	driver,
		uint8_t	percent
	)

cfn_sal_dev_display_set_brightness()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_set_brightness	(	cfn_sal_dev_display_t *	driver,
		uint8_t	percent
	)

cfn_sal_dev_display_set_cursor()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_set_cursor	(	cfn_sal_dev_display_t *	driver,
		uint16_t	x,
		uint16_t	y
	)

cfn_sal_dev_display_set_orientation()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_set_orientation	(	cfn_sal_dev_display_t *	driver,
		uint8_t	orientation
	)

cfn_sal_dev_display_turn_off()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_turn_off

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_turn_on()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_turn_on

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_update()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_update

(

cfn_sal_dev_display_t *

driver

)

cfn_sal_dev_display_write_command()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_write_command	(	cfn_sal_dev_display_t *	driver,
		uint8_t	cmd
	)

cfn_sal_dev_display_write_data()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_display_write_data	(	cfn_sal_dev_display_t *	driver,
		const uint8_t *	data,
		size_t	len
	)