Detailed Description

Interface for display panels.

Summary

The Display interface provides a general API for configuring and controlling display panels.

Data Structures
struct	display_timing_t

struct	display_color_t

struct	display_colorkeying_cfg_t

struct	display_input_cfg_t

struct	display_output_cfg_t

struct	display_callback_args_t

struct	display_cfg_t

struct	display_runtime_cfg_t

struct	display_status_t

struct	display_api_t

struct	display_instance_t

Typedefs
typedef void	display_ctrl_t

Enumerations
enum	display_frame_layer_t

enum	display_state_t

enum	display_event_t

enum	display_in_format_t

enum	display_out_format_t

enum	display_signal_polarity_t

enum	display_sync_edge_t

enum	display_color_keying_t

Data Structure Documentation

◆ display_timing_t

struct display_timing_t

Display signal timing setting

Data Fields
uint16_t	total_cyc	Total cycles in one line or total lines in one frame.
uint16_t	display_cyc	Active video cycles or lines.
uint16_t	back_porch	Back porch cycles or lines.
uint16_t	sync_width	Sync signal asserting width.
display_signal_polarity_t	sync_polarity	Sync signal polarity.

◆ display_color_t

struct display_color_t

RGB Color setting

◆ display_colorkeying_cfg_t

struct display_colorkeying_cfg_t

Color Keying enable or disable

Data Fields
display_color_t	src_color	Source color.
display_color_t	dst_color	Destination color.
display_color_keying_t	enable_ckey	Select enable or disable.

◆ display_input_cfg_t

struct display_input_cfg_t

Graphics plane input configuration structure

Data Fields
uint32_t *	p_base	Base address to the frame buffer.
uint16_t	hsize	Horizontal pixels in a line.
uint16_t	vsize	Vertical pixels in a frame.
uint16_t	coordinate_x	Coordinate X.
uint16_t	coordinate_y	Coordinate Y.
uint16_t	hstride	Memory stride (bytes) in a line.
display_in_format_t	format	Input format setting.
display_data_swap_t	data_swap	Input data swap_Setting.

◆ display_output_cfg_t

struct display_output_cfg_t

Display output configuration structure

Data Fields
display_timing_t	htiming	Horizontal display cycle setting.
display_timing_t	vtiming	Vertical display cycle setting.
display_out_format_t	format	Output format setting.
display_signal_polarity_t	data_enable_polarity	Data Enable signal polarity.
display_sync_edge_t	sync_edge	Signal sync edge selection.
display_color_t	bg_color	Background color.
bool	dithering_on	Dithering on/off.

◆ display_callback_args_t

struct display_callback_args_t

Display callback parameter definition

Data Fields
display_event_t	event	Event code.
void const *	p_context	Context provided to user during callback.

◆ display_cfg_t

struct display_cfg_t

Display main configuration structure

Data Fields
display_input_cfg_t	input [2]
	Graphics input frame setting. More...

display_output_cfg_t	output
	Graphics output frame setting.

void(*	p_callback )(display_callback_args_t *p_args)
	Pointer to callback function. More...

void const *	p_context
	User defined context passed into callback function.

void const *	p_extend
	Display hardware dependent configuration. More...

Field Documentation

◆ input

display_input_cfg_t display_cfg_t::input[2]

Graphics input frame setting.

Generic configuration for display devices

◆ p_callback

void(* display_cfg_t::p_callback) (display_callback_args_t *p_args)

Pointer to callback function.

Configuration for display event processing

◆ p_extend

void const* display_cfg_t::p_extend

Display hardware dependent configuration.

Pointer to display peripheral specific configuration

◆ display_runtime_cfg_t

struct display_runtime_cfg_t

Display main configuration structure

Data Fields
display_input_cfg_t	input	Graphics input frame setting. Generic configuration for display devices

◆ display_status_t

struct display_status_t

Display Status

Data Fields
display_state_t	state	Status of display module.

◆ display_api_t

struct display_api_t

Shared Interface definition for display peripheral

Data Fields
fsp_err_t(*	open )(display_ctrl_t const p_ctrl, display_cfg_t const const p_cfg)

fsp_err_t(*	close )(display_ctrl_t *const p_ctrl)

fsp_err_t(*	start )(display_ctrl_t *const p_ctrl)

fsp_err_t(*	stop )(display_ctrl_t *const p_ctrl)

fsp_err_t(*	layerChange )(display_ctrl_t const const p_ctrl, display_runtime_cfg_t const const p_cfg, display_frame_layer_t layer)

fsp_err_t(*	bufferChange )(display_ctrl_t const const p_ctrl, uint8_t const framebuffer, display_frame_layer_t layer)

fsp_err_t(*	colorKeySet )(display_ctrl_t const *const p_ctrl, display_colorkeying_layer_t key_cfg, display_frame_layer_t layer)

fsp_err_t(*	statusGet )(display_ctrl_t const const p_ctrl, display_status_t const p_status)

Field Documentation

◆ open

fsp_err_t(* display_api_t::open) (display_ctrl_t *const p_ctrl, display_cfg_t const *const p_cfg)

Open display device.

Implemented as

R_LCDC_Open()

Parameters

[in,out]	p_ctrl	Pointer to display interface control block.
[in]	p_cfg	Pointer to display configuration structure.

◆ close

fsp_err_t(* display_api_t::close) (display_ctrl_t *const p_ctrl)

Close display device.

Implemented as

R_LCDC_Close()

Parameters

[in] p_ctrl Pointer to display interface control block.

◆ start

fsp_err_t(* display_api_t::start) (display_ctrl_t *const p_ctrl)

Display start.

Implemented as

R_LCDC_Start()

Parameters

[in] p_ctrl Pointer to display interface control block.

◆ stop

fsp_err_t(* display_api_t::stop) (display_ctrl_t *const p_ctrl)

Display stop.

Implemented as

R_LCDC_Stop()

Parameters

[in] p_ctrl Pointer to display interface control block.

◆ layerChange

fsp_err_t(* display_api_t::layerChange) (display_ctrl_t const *const p_ctrl, display_runtime_cfg_t const *const p_cfg, display_frame_layer_t layer)

Change layer parameters at runtime.

Implemented as

R_LCDC_LayerChange()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	p_cfg	Pointer to run-time layer configuration structure.
[in]	layer	Graphics layer to configure.

◆ bufferChange

fsp_err_t(* display_api_t::bufferChange) (display_ctrl_t const *const p_ctrl, uint8_t *const framebuffer, display_frame_layer_t layer)

Change layer framebuffer pointer.

Implemented as

R_LCDC_BufferChange()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	framebuffer	Pointer to desired framebuffer.
[in]	layer	Layer to set framebuffer.

◆ colorKeySet

fsp_err_t(* display_api_t::colorKeySet) (display_ctrl_t const *const p_ctrl, display_colorkeying_layer_t key_cfg, display_frame_layer_t layer)

Configure color keying.

Implemented as

R_LCDC_ColorKeySet()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	key_cfg	Pointer to color keying configuration.
[in]	layer	Layer to apply color keying.

◆ statusGet

fsp_err_t(* display_api_t::statusGet) (display_ctrl_t const *const p_ctrl, display_status_t *const p_status)

Get status for display device.

Implemented as

R_LCDC_StatusGet()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	status	Pointer to display interface status structure.

◆ display_instance_t

struct display_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
display_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
display_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
display_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

◆ display_ctrl_t

typedef void display_ctrl_t

Display control block. Allocate an instance specific control block to pass into the display API calls.

Implemented as

glcdc_instance_ctrl_t
lcdc_instance_ctrl_tDisplay control block

Enumeration Type Documentation

◆ display_frame_layer_t

enum display_frame_layer_t

Display frame number

Enumerator
DISPLAY_FRAME_LAYER_1	Frame layer 1.
DISPLAY_FRAME_LAYER_2	Frame layer 2.

◆ display_state_t

enum display_state_t

Display interface operation state

Enumerator
DISPLAY_STATE_CLOSED	Display closed.
DISPLAY_STATE_OPENED	Display opened.
DISPLAY_STATE_DISPLAYING	Displaying.

◆ display_event_t

enum display_event_t

Display event codes

Enumerator
DISPLAY_EVENT_UNDERFLOW	Graphics frame underflow occurs.
DISPLAY_EVENT_LINE_DETECTION	Specified line is processed.
DISPLAY_EVENT_FRAME_END	Frame end is processed.

◆ display_in_format_t

enum display_in_format_t

Input format setting

Enumerator
DISPLAY_IN_FORMAT_32BITS_ARGB8888	ARGB8888, 32 bits.
DISPLAY_IN_FORMAT_32BITS_RGB888	RGB888, 32 bits.
DISPLAY_IN_FORMAT_16BITS_RGB565	RGB565, 16 bits.
DISPLAY_IN_FORMAT_16BITS_ARGB1555	ARGB1555, 16 bits.
DISPLAY_IN_FORMAT_16BITS_ARGB4444	ARGB4444, 16 bits.
DISPLAY_IN_FORMAT_CLUT8	CLUT8.
DISPLAY_IN_FORMAT_CLUT4	CLUT4.
DISPLAY_IN_FORMAT_CLUT1	CLUT1.
DISPLAY_IN_FORMAT_32BITS_RGBA8888	RGBA8888, 32 bits.
DISPLAY_IN_FORMAT_24BITS_BGR888	BGR888, 24 bits.
DISPLAY_IN_FORMAT_24BITS_RGB888	RGB888, 24 bits.
DISPLAY_IN_FORMAT_32BITS_ABGR8888	ABGR8888, 32 bits.
DISPLAY_IN_FORMAT_24BITS_YCBCR444_INTERLEAVED	YCbCr444 interleaved, 24 bits.
DISPLAY_IN_FORMAT_16BITS_YCBCR422_INTERLEAVED_TYPE0_UYVY	YCbCr422 interleaved type0 UYVY, 16 bits.
DISPLAY_IN_FORMAT_16BITS_YCBCR422_INTERLEAVED_TYPE0_YUY2	YCbCr422 interleaved type0 YUY2, 16 bits.
DISPLAY_IN_FORMAT_16BITS_YCBCR422_INTERLEAVED_TYPE0_YVYU	YCbCr422 interleaved type0 YVYU, 16 bits.
DISPLAY_IN_FORMAT_16BITS_YCBCR422_INTERLEAVED_TYPE1	YCbCr420 interleaved type1, 16 bits.
DISPLAY_IN_FORMAT_16BITS_YCBCR420_INTERLEAVED	YCbCr420 interleaved, 12 bits.
DISPLAY_IN_FORMAT_CUSTOM	All other options start at this value.

◆ display_out_format_t

enum display_out_format_t

Output format setting

Enumerator
DISPLAY_OUT_FORMAT_24BITS_RGB888	RGB888, 24 bits.
DISPLAY_OUT_FORMAT_18BITS_RGB666	RGB666, 18 bits.
DISPLAY_OUT_FORMAT_16BITS_RGB565	RGB565, 16 bits.
DISPLAY_OUT_FORMAT_8BITS_SERIAL	SERIAL, 8 bits.
DISPLAY_OUT_FORMAT_CUSTOM	All other options start at this value.

◆ display_signal_polarity_t

enum display_signal_polarity_t

Polarity of a signal select

Enumerator
DISPLAY_SIGNAL_POLARITY_LOACTIVE	Low active signal.
DISPLAY_SIGNAL_POLARITY_HIACTIVE	High active signal.

◆ display_sync_edge_t

enum display_sync_edge_t

Signal synchronization edge select

Enumerator
DISPLAY_SIGNAL_SYNC_EDGE_RISING	Signal is synchronized to rising edge.
DISPLAY_SIGNAL_SYNC_EDGE_FALLING	Signal is synchronized to falling edge.

◆ display_color_keying_t

enum display_color_keying_t

Color Keying enable or disable

Enumerator
DISPLAY_COLOR_KEYING_DISABLE	Color keying disable.
DISPLAY_COLOR_KEYING_ENABLE	Color keying enable.

Detailed Description

Summary

Data Structures

Typedefs

Enumerations

Data Structure Documentation

◆ display_timing_t

◆ display_color_t

◆ display_colorkeying_cfg_t

◆ display_input_cfg_t

◆ display_output_cfg_t

◆ display_callback_args_t

◆ display_cfg_t

Data Fields

Field Documentation

◆ input

◆ p_callback

◆ p_extend

◆ display_runtime_cfg_t

◆ display_status_t

◆ display_api_t

Data Fields

Field Documentation

◆ open

◆ close

◆ start

◆ stop

◆ layerChange

◆ bufferChange

◆ colorKeySet

◆ statusGet

◆ display_instance_t

Typedef Documentation

◆ display_ctrl_t

Enumeration Type Documentation

◆ display_frame_layer_t

◆ display_state_t

◆ display_event_t

◆ display_in_format_t

◆ display_out_format_t

◆ display_signal_polarity_t

◆ display_sync_edge_t

◆ display_color_keying_t