Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
DisplayBase Class Reference
Display driver wrapper class for RGA. More...
#include <DisplayBace.h>
Detailed Description
Display driver wrapper class for RGA.
Definition at line 36 of file DisplayBace.h.
Member Enumeration Documentation
enum edge_t |
Edge of a signal.
Definition at line 138 of file DisplayBace.h.
enum extin_h_pos_t |
Y/Cb/Y/Cr data string start timing.
- Enumerator:
Definition at line 243 of file DisplayBace.h.
enum extin_input_line_t |
Number of lines for BT.656 external input.
Definition at line 235 of file DisplayBace.h.
enum graphics_error_t |
Error codes.
- Enumerator:
Definition at line 69 of file DisplayBace.h.
enum graphics_format_t |
Graphics layer read format selects.
- Enumerator:
Definition at line 83 of file DisplayBace.h.
enum graphics_layer_t |
Graphics layer select.
- Enumerator:
GRAPHICS_LAYER_0 Graphics layer 0
GRAPHICS_LAYER_1 Graphics layer 1
GRAPHICS_LAYER_2 Graphics layer 2
GRAPHICS_LAYER_3 Graphics layer 3
Definition at line 59 of file DisplayBace.h.
Video color system.
- Enumerator:
COL_SYS_NTSC_358 NTSC-3.58
COL_SYS_NTSC_443 NTSC-4.43
COL_SYS_PAL_443 PAL-4.43
COL_SYS_PAL_M PAL-M
COL_SYS_PAL_N PAL-N
COL_SYS_SECAM SECAM
COL_SYS_NTSC_443_60 NTSC-4.43 (60Hz)
COL_SYS_PAL_60 PAL-60
Definition at line 192 of file DisplayBace.h.
enum int_type_t |
Interrupt type.
- Enumerator:
Definition at line 162 of file DisplayBace.h.
enum lcd_outformat_t |
LCD output format selects.
- Enumerator:
LCD_OUTFORMAT_RGB888 RGB888 or LVDS
LCD_OUTFORMAT_RGB666 RGB666
LCD_OUTFORMAT_RGB565 RGB565
Definition at line 129 of file DisplayBace.h.
enum lcd_tcon_pin_t |
LCD tcon output pin selects.
- Enumerator:
LCD_TCON_PIN_NON Not using output
LCD_TCON_PIN_0 LCD_TCON0
LCD_TCON_PIN_1 LCD_TCON1
LCD_TCON_PIN_2 LCD_TCON2
LCD_TCON_PIN_3 LCD_TCON3
LCD_TCON_PIN_4 LCD_TCON4
Definition at line 117 of file DisplayBace.h.
enum lcd_type_t |
LCD type.
Definition at line 146 of file DisplayBace.h.
enum onoff_t |
enum sig_pol_t |
Polarity of a signal.
Definition at line 154 of file DisplayBace.h.
enum slide_t |
- Enumerator:
SLIDE_OUT_RIGHT -->
SLIDE_IN_RIGHT <--
SLIDE_OUT_BOTTOM \/
SLIDE_IN_BOTTOM /\
SLIDE_OUT_LEFT <--
SLIDE_IN_LEFT -->
SLIDE_OUT_TOP \/
SLIDE_IN_TOP /\
SLIDE_NONE
Definition at line 251 of file DisplayBace.h.
enum video_adc_vinsel_t |
Input pin control.
Definition at line 51 of file DisplayBace.h.
enum video_extin_format_t |
External input format select.
- Enumerator:
Definition at line 214 of file DisplayBace.h.
enum video_format_t |
Video writing format selects.
- Enumerator:
VIDEO_FORMAT_YCBCR422 YCbCr422 (2byte / px)
VIDEO_FORMAT_RGB565 RGB565 (2byte / px)
VIDEO_FORMAT_RGB888 RGB888 (4byte / px)
Definition at line 94 of file DisplayBace.h.
Video input channel select.
Definition at line 43 of file DisplayBace.h.
enum video_input_sel_t |
External Input select.
- Enumerator:
INPUT_SEL_VDEC Video decoder output signals
INPUT_SEL_EXT Signals supplied via the external input pins
Definition at line 206 of file DisplayBace.h.
enum wr_rd_swa_t |
Frame buffer swap setting.
- Enumerator:
Definition at line 103 of file DisplayBace.h.
Constructor & Destructor Documentation
DisplayBase | ( | void | ) |
Constructor method of display base object.
Constructor of the DisplayBase class.
- Parameters:
-
[in] None
- Return values:
-
None
Definition at line 32 of file DisplayBase.cpp.
Member Function Documentation
DisplayBase::graphics_error_t Graphics_Dvinput_Port_Init | ( | PinName * | pin, |
unsigned int | pin_count | ||
) |
Digital video input port initialization processing.
Digital video input I/O port initialization processing.
- Parameters:
-
[in] pin : Pin assign for digital video input port [in] pin_count : Total number of pin assign
- Return values:
-
Error code
- Parameters:
-
[in] pin : Pointer of the pin assignment [in] pin_count : Total number of the pin assignment
- Return values:
-
error code
Definition at line 188 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_init | ( | lcd_config_t * | lcd_config ) |
Graphics initialization processing
If not using display, set NULL in parameter.
Graphics initialization processing.
- Parameters:
-
[in] lcd_config : LCD configuration
- Return values:
-
Error code
- Parameters:
-
[in] lcd_config : LCD configuration
- Return values:
-
error code
Definition at line 84 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Irq_Handler_Set | ( | int_type_t | irq, |
unsigned short | num, | ||
void(*)(int_type_t) | callback | ||
) |
Interrupt callback setup This function performs the following processing:
- Enables the interrupt when the pointer to the corresponding interrupt callback function is specified.
IRQ interrupt handler setting.
- Registers the specified interrupt callback function.
- Disables the interrupt when the pointer to the corresponding interrupt callback function is not specified.
- Parameters:
-
[in] Graphics_Irq_Handler_Set : VDC5 interrupt type [in] num : Interrupt line number [in] callback : Interrupt callback function pointer
- Return values:
-
Error code
- Parameters:
-
[in] irq : VDC5 interrupt type [in] num : Interrupt line number [in] * callback : Interrupt callback function pointer
- Return values:
-
error code
Definition at line 201 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Lcd_Port_Init | ( | PinName * | pin, |
unsigned int | pin_count | ||
) |
LCD output port initialization processing.
LCD I/O initialization processing.
- Parameters:
-
[in] pin : Pin assign for LCD output [in] pin_count : Total number of pin assign
- Return values:
-
Error code
- Parameters:
-
[in] pin : Pointer of the pin assignment [in] pin_count : Total number of the pin assignment
- Return values:
-
error code
Definition at line 164 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Lvds_Port_Init | ( | PinName * | pin, |
unsigned int | pin_count | ||
) |
LVDS output port initialization processing.
LVDS I/O port initialization processing.
- Parameters:
-
[in] pin : Pin assign for LVDS output [in] pin_count : Total number of pin assign
- Return values:
-
Error code
- Parameters:
-
[in] pin : Pointer of the pin assignment [in] pin_count : Total number of the pin assignment
- Return values:
-
error code
Definition at line 176 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Read_Change | ( | graphics_layer_t | layer_id, |
void * | framebuff | ||
) |
Graphics surface read buffer change process.
Graphics surface read process changing.
- Parameters:
-
[in] layer_id : Graphics layer ID
- GRAPHICS_LAYER_0 : Layer 0
- GRAPHICS_LAYER_1 : Layer 1
- GRAPHICS_LAYER_2 : Layer 2
- GRAPHICS_LAYER_3 : Layer 3
[in] framebuff : Base address of the frame buffer(Not set NULL)
- Return values:
-
Error code
Description:
This function is used to swap buffers.
- Parameters:
-
[in] layer_id : Graphics layer ID [in] framebuff : Base address of the frame buffer
- Return values:
-
Error code
Definition at line 329 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Read_Change_More | ( | graphics_layer_t | layer_id, |
void * | framebuff, | ||
unsigned int | fb_stride, | ||
slide_t * | slide_dir | ||
) |
Graphics surface read buffer change process.
Graphics surface read process changing.
- Parameters:
-
[in] layer_id : Graphics layer ID
- GRAPHICS_LAYER_0 : Layer 0
- GRAPHICS_LAYER_1 : Layer 1
- GRAPHICS_LAYER_2 : Layer 2
- GRAPHICS_LAYER_3 : Layer 3
[in] framebuff : Base address of the frame buffer(Not set NULL) [in] fb_stride : stride of the framebuff [in] slide_dir : slide direction
- Return values:
-
Error code
Description:
This function is used to swap buffers.
- Parameters:
-
[in] layer_id : Graphics layer ID [in] framebuff : Base address of the frame buffer [in] fb_stride : stride of the framebuff [in] slide_dir : slide direction
- Return values:
-
Error code
Definition at line 348 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Read_Setting | ( | graphics_layer_t | layer_id, |
void * | framebuff, | ||
unsigned int | fb_stride, | ||
graphics_format_t | gr_format, | ||
wr_rd_swa_t | wr_rd_swa, | ||
rect_t * | gr_rect | ||
) |
Graphics surface read process setting.
- Parameters:
-
[in] layer_id : Graphics layer ID
- GRAPHICS_LAYER_0 : Layer 0
- GRAPHICS_LAYER_1 : Layer 1
- GRAPHICS_LAYER_2 : Layer 2
- GRAPHICS_LAYER_3 : Layer 3
[in] framebuff : Base address of the frame buffer(Not set NULL) [in] fb_stride : Line offset address of the frame buffer[byte]
Frame buffer stride should be set to a multiple of 32 or 128 in accordance with the frame buffer burst transfer mode.[in] gr_format : Format of the frame buffer read signal
- VIDEO_FORMAT_YCBCR422 : YCBCR422 (2byte/px)
- VIDEO_FORMAT_RGB565 : RGB565 (2byte/px)
- VIDEO_FORMAT_RGB888 : RGB888 (4byte/px)
- VIDEO_FORMAT_ARGB8888 : ARGB8888 (4byte/px)
[in] wr_rd_swa : frame buffer swap setting
- WR_RD_WRSWA_NON : Not swapped: 1-2-3-4-5-6-7-8
- WR_RD_WRSWA_8BIT : Swapped in 8-bit units: 2-1-4-3-6-5-8-7
- WR_RD_WRSWA_16BIT : Swapped in 16-bit units: 3-4-1-2-7-8-5-6
- WR_RD_WRSWA_16_8BIT : Swapped in 16-bit units + 8-bit units: 4-3-2-1-8-7-6-5
- WR_RD_WRSWA_32BIT : Swapped in 32-bit units: 5-6-7-8-1-2-3-4
- WR_RD_WRSWA_32_8BIT : Swapped in 32-bit units + 8-bit units: 6-5-8-7-2-1-4-3
- WR_RD_WRSWA_32_16BIT : Swapped in 32-bit units + 16-bit units: 7-8-5-6-3-4-1-2
- WR_RD_WRSWA_32_16_8BIT : Swapped in 32-bit units + 16-bit units + 8-bit units: 8-7-6-5-4-3-2-1
[in] gr_rect : Graphics display area
- Return values:
-
Error code
Description:
This function supports the following 4 image format. YCbCr422, RGB565, RGB888, ARGB8888
- Parameters:
-
[in] layer_id : Graphics layer ID [in] framebuff : Base address of the frame buffer [in] fb_stride : Line offset address of the frame buffer [in] gr_format : Format of the frame buffer read signal [in] wr_rd_swa : frame buffer swap setting - WR_RD_WRSWA_NON : Not swapped: 1-2-3-4-5-6-7-8
- WR_RD_WRSWA_8BIT : Swapped in 8-bit units: 2-1-4-3-6-5-8-7
- WR_RD_WRSWA_16BIT : Swapped in 16-bit units: 3-4-1-2-7-8-5-6
- WR_RD_WRSWA_16_8BIT : Swapped in 16-bit units + 8-bit units: 4-3-2-1-8-7-6-5
- WR_RD_WRSWA_32BIT : Swapped in 32-bit units: 5-6-7-8-1-2-3-4
- WR_RD_WRSWA_32_8BIT : Swapped in 32-bit units + 8-bit units: 6-5-8-7-2-1-4-3
- WR_RD_WRSWA_32_16BIT : Swapped in 32-bit units + 16-bit units: 7-8-5-6-3-4-1-2
- WR_RD_WRSWA_32_16_8BIT : Swapped in 32-bit units + 16-bit units + 8-bit units: 8-7-6-5-4-3-2-1
[in] gr_rect : Graphics display area
- Return values:
-
Error code
Definition at line 294 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Start | ( | graphics_layer_t | layer_id ) |
Start the graphics surface read process.
Graphics surface read start processing.
- Parameters:
-
[in] layer_id : Graphics layer ID
- GRAPHICS_LAYER_0 : Layer 0
- GRAPHICS_LAYER_1 : Layer 1
- GRAPHICS_LAYER_2 : Layer 2
- GRAPHICS_LAYER_3 : Layer 3
- Return values:
-
Error code
- Parameters:
-
[in] layer_id : Graphics layer ID
- Return values:
-
error code
Definition at line 212 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Stop | ( | graphics_layer_t | layer_id ) |
Stop the graphics surface read process.
Graphics surface read stop processing.
- Parameters:
-
[in] layer_id : Graphics layer ID
- GRAPHICS_LAYER_0 : Layer 0
- GRAPHICS_LAYER_1 : Layer 1
- GRAPHICS_LAYER_2 : Layer 2
- GRAPHICS_LAYER_3 : Layer 3
- Return values:
-
Error code
- Parameters:
-
[in] layer_id : Graphics layer ID
- Return values:
-
error code
Definition at line 223 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Graphics_Video_init | ( | video_input_sel_t | video_input_sel, |
video_ext_in_config_t * | video_ext_in_config | ||
) |
Graphics Video initialization processing
If setting INPUT_SEL_VDEC in video_input_sel parameter, set NULL in video_ext_in_config parameter.
Graphics Video initialization processing.
- Parameters:
-
[in] video_input_sel : Input select [in] video_ext_in_config : Video configuration
- Return values:
-
error code
- Parameters:
-
[in] video_input_sel : Input select [in] video_ext_in_config : Digtal video input configuration
- Return values:
-
error code
Definition at line 123 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Video_Start | ( | video_input_channel_t | video_input_channel ) |
Start the video surface write process.
Video surface write start processing.
- Parameters:
-
[in] video_input_channel : Video input channel
- VIDEO_INPUT_CHANNEL_0 : Video channel 0
- VIDEO_INPUT_CHANNEL_1 : Video channel 1
- Return values:
-
Error code
- Parameters:
-
[in] video_input_channel : Video input channel
- Return values:
-
error code
Definition at line 234 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Video_Stop | ( | video_input_channel_t | video_input_channel ) |
Stop the video surface write process.
Video surface write stop processing.
- Parameters:
-
[in] video_input_channel : Video input channel
- VIDEO_INPUT_CHANNEL_0 : Video channel 0
- VIDEO_INPUT_CHANNEL_1 : Video channel 1
- Return values:
-
Error code
- Parameters:
-
[in] video_input_channel : Video input channel
- Return values:
-
error code
Definition at line 255 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Video_Write_Change | ( | video_input_channel_t | video_input_channel, |
void * | framebuff, | ||
uint32_t | fb_stride | ||
) |
Video surface write buffer change process.
Graphics surface write process changing This function is used to swap buffers of the weave write processing.
- Parameters:
-
[in] video_input_channel : Video input channel
- VIDEO_INPUT_CHANNEL_0 : Video channel 0
- VIDEO_INPUT_CHANNEL_1 : Video channel 1
[in] framebuff : Base address of the frame buffer(Not set NULL) [in] fb_stride : Line offset address of the frame buffer
Frame buffer stride should be set to a multiple of 32 or 128 in accordance with the frame buffer burst transfer mode.
- Return values:
-
Error code
- Parameters:
-
[in] video_input_ch : Video input channle [in] framebuff : Base address of the frame buffer [in] fb_stride : Line offset address of the frame buffer
- Return values:
-
Error code
Definition at line 457 of file DisplayBase.cpp.
DisplayBase::graphics_error_t Video_Write_Setting | ( | video_input_channel_t | video_input_channel, |
graphics_video_col_sys_t | col_sys, | ||
void * | framebuff, | ||
unsigned int | fb_stride, | ||
video_format_t | video_format, | ||
wr_rd_swa_t | wr_rd_swa, | ||
unsigned short | write_buff_vw, | ||
unsigned short | write_buff_hw, | ||
video_adc_vinsel_t | video_adc_vinsel = VIDEO_ADC_VINSEL_VIN1 |
||
) |
Video surface write process setting.
Video surface write process setting This function set the video write process.
- Parameters:
-
[in] video_input_channel : Video input channel
If using digital input, this parameter is not referenced.
- VIDEO_INPUT_CHANNEL_0 : Video channel 0
- VIDEO_INPUT_CHANNEL_1 : Video channel 1
[in] col_sys : Analog video signal color system
If using digital input, this parameter is not referenced.
- COL_SYS_NTSC_358 : NTSC-3.58
- COL_SYS_NTSC_443 : NTSC-4.43
- COL_SYS_PAL_443 : PAL-4.43
- COL_SYS_PAL_M : PAL-M
- COL_SYS_PAL_N : PAL-N
- COL_SYS_SECAM : SECAM
- COL_SYS_NTSC_443_60 : NTSC-4.43 (60Hz)
- COL_SYS_PAL_60 : PAL-60
[in] framebuff : Base address of the frame buffer(Not set NULL) [in] fb_stride : Line offset address of the frame buffer[byte]
Frame buffer stride should be set to a multiple of 32 or 128 in accordance with the frame buffer burst transfer mode.[in] video_format : Frame buffer video-signal writing format
- VIDEO_FORMAT_YCBCR422 : YCBCR422 (2byte/px)
- VIDEO_FORMAT_RGB565 : RGB565 (2byte/px)
- VIDEO_FORMAT_RGB888 : RGB888 (4byte/px)
[in] wr_rd_swa : frame buffer swap setting
- WR_RD_WRSWA_NON : Not swapped: 1-2-3-4-5-6-7-8
- WR_RD_WRSWA_8BIT : Swapped in 8-bit units: 2-1-4-3-6-5-8-7
- WR_RD_WRSWA_16BIT : Swapped in 16-bit units: 3-4-1-2-7-8-5-6
- WR_RD_WRSWA_16_8BIT : Swapped in 16-bit units + 8-bit units: 4-3-2-1-8-7-6-5
- WR_RD_WRSWA_32BIT : Swapped in 32-bit units: 5-6-7-8-1-2-3-4
- WR_RD_WRSWA_32_8BIT : Swapped in 32-bit units + 8-bit units: 6-5-8-7-2-1-4-3
- WR_RD_WRSWA_32_16BIT : Swapped in 32-bit units + 16-bit units: 7-8-5-6-3-4-1-2
- WR_RD_WRSWA_32_16_8BIT : Swapped in 32-bit units + 16-bit units + 8-bit units: 8-7-6-5-4-3-2-1
[in] video_write_buff_vw : Output height[px]
- NTSC format : Max height is 480[px]
- PAL format : Max height is 520[px]
[in] video_write_buff_hw : Output width[px]
- Max width : 800[px]
[in] video_adc_vinsel : Input pin control
- VIDEO_ADC_VINSEL_VIN1 : VIN1 input
- VIDEO_ADC_VINSEL_VIN2 : VIN2 input
- Return values:
-
Error code
Input form is weave (progressive) mode fixed. This function supports the following 3 image format. YCbCr422, RGB565, RGB888
- Parameters:
-
[in] video_input_ch : Video input channel [in] col_sys : Analog video signal color system [in] adc_vinsel : Video input pin [in] framebuff : Base address of the frame buffer [in] fb_stride [byte] : Line offset address of the frame buffer [in] video_format : Frame buffer video-signal writing format - VIDEO_FORMAT_YCBCR422 : YCBCR422 (2byte/px)
- VIDEO_FORMAT_RGB565 : RGB565 (2byte/px)
- VIDEO_FORMAT_RGB888 : RGB888 (4byte/px)
[in] wr_rd_swa : frame buffer swap setting - WR_RD_WRSWA_NON : Not swapped: 1-2-3-4-5-6-7-8
- WR_RD_WRSWA_8BIT : Swapped in 8-bit units: 2-1-4-3-6-5-8-7
- WR_RD_WRSWA_16BIT : Swapped in 16-bit units: 3-4-1-2-7-8-5-6
- WR_RD_WRSWA_16_8BIT : Swapped in 16-bit units + 8-bit units: 4-3-2-1-8-7-6-5
- WR_RD_WRSWA_32BIT : Swapped in 32-bit units: 5-6-7-8-1-2-3-4
- WR_RD_WRSWA_32_8BIT : Swapped in 32-bit units + 8-bit units: 6-5-8-7-2-1-4-3
- WR_RD_WRSWA_32_16BIT : Swapped in 32-bit units + 16-bit units: 7-8-5-6-3-4-1-2
- WR_RD_WRSWA_32_16_8BIT : Swapped in 32-bit units + 16-bit units + 8-bit units: 8-7-6-5-4-3-2-1
[in] video_write_size_vw [px]: output v width [in] video_write_size_hw [px]: output h width [in] video_adc_vinsel : Input pin control
- Return values:
-
Error code
Definition at line 384 of file DisplayBase.cpp.
Generated on Tue Jul 12 2022 14:33:14 by
