![]() |
RZA Flexible Software Package Documentation
Release v1.1.0
|
|
Interface for display panels.
The Display interface provides a general API for configuring and controlling display panels.
Implemented by: LCD Controller (r_lcdc)
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 |
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. |
struct display_color_t |
RGB Color setting
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. |
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. |
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. |
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. |
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... | |
display_input_cfg_t display_cfg_t::input[2] |
Graphics input frame setting.
Generic configuration for display devices
void(* display_cfg_t::p_callback) (display_callback_args_t *p_args) |
Pointer to callback function.
Configuration for display event processing
void const* display_cfg_t::p_extend |
Display hardware dependent configuration.
Pointer to display peripheral specific configuration
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 |
struct display_status_t |
Display Status
Data Fields | ||
---|---|---|
display_state_t | state | Status of display module. |
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) |
fsp_err_t(* display_api_t::open) (display_ctrl_t *const p_ctrl, display_cfg_t const *const p_cfg) |
Open display device.
[in,out] | p_ctrl | Pointer to display interface control block. |
[in] | p_cfg | Pointer to display configuration structure. |
fsp_err_t(* display_api_t::close) (display_ctrl_t *const p_ctrl) |
Close display device.
[in] | p_ctrl | Pointer to display interface control block. |
fsp_err_t(* display_api_t::start) (display_ctrl_t *const p_ctrl) |
Display start.
[in] | p_ctrl | Pointer to display interface control block. |
fsp_err_t(* display_api_t::stop) (display_ctrl_t *const p_ctrl) |
Display stop.
[in] | p_ctrl | Pointer to display interface control block. |
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.
[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. |
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.
[in] | p_ctrl | Pointer to display interface control block. |
[in] | framebuffer | Pointer to desired framebuffer. |
[in] | layer | Layer to set framebuffer. |
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.
[in] | p_ctrl | Pointer to display interface control block. |
[in] | key_cfg | Pointer to color keying configuration. |
[in] | layer | Layer to apply color keying. |
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.
[in] | p_ctrl | Pointer to display interface control block. |
[in] | status | Pointer to display interface status structure. |
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 void display_ctrl_t |
Display control block. Allocate an instance specific control block to pass into the display API calls.
enum display_state_t |
enum display_event_t |
enum display_in_format_t |
Input format setting
enum display_out_format_t |
enum display_sync_edge_t |