Video library for GR-PEACH

Dependents:   Trace_Program2 GR-PEACH_Camera_in_barcode GR-PEACH_LCD_sample GR-PEACH_LCD_4_3inch_sample ... more

Embed: (wiki syntax)

« Back to documentation index

r_vdc5_shared_param.h File Reference

r_vdc5_shared_param.h File Reference

VDC5 driver shared parameter definitions. More...

Go to the source code of this file.

Enumerations

enum  vdc5_color_space_t { VDC5_COLOR_SPACE_GBR = 0, VDC5_COLOR_SPACE_YCBCR = 1 }
enum  vdc5_resource_state_t { VDC5_RESOURCE_ST_INVALID = 0, VDC5_RESOURCE_ST_VALID = 1 }
enum  vdc5_resource_type_t {
  VDC5_RESOURCE_PANEL_CLK = 0, VDC5_RESOURCE_VIDEO_IN, VDC5_RESOURCE_VSYNC, VDC5_RESOURCE_LCD_PANEL,
  VDC5_RESOURCE_LVDS_CLK
}

Functions

void VDC5_ShrdPrmInit (const vdc5_channel_t ch)
 Initializes variables of the VDC5 driver.
void VDC5_ShrdPrmSetInitParam (const vdc5_channel_t ch, const vdc5_init_t *const param)
 Sets the initialization parameter.
void VDC5_ShrdPrmSetTerminate (const vdc5_channel_t ch)
 Sets the termination parameter.
void VDC5_ShrdPrmSetInputParam (const vdc5_channel_t ch, const vdc5_input_t *const param)
 Sets the video input setup parameter.
void VDC5_ShrdPrmSetSyncParam (const vdc5_channel_t ch, const vdc5_sync_ctrl_t *const param)
 Sets the sync control parameter.
void VDC5_ShrdPrmSetOutputParam (const vdc5_channel_t ch, const vdc5_output_t *const param)
 Sets the display output configuration parameter.
void VDC5_ShrdPrmSetWriteParam (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id, const vdc5_write_t *const param)
 Sets the data write control parameter.
void VDC5_ShrdPrmSetChgWriteParam (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id, const vdc5_write_chg_t *const param)
 Sets the data write change parameter.
void VDC5_ShrdPrmSetReadParam (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id, const vdc5_read_t *const param)
 Sets the data read control parameter.
void VDC5_ShrdPrmSetChgReadParam (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id, const vdc5_read_chg_t *const param)
 Sets the data read change parameter.
void VDC5_ShrdPrmSetCascade (const vdc5_channel_t ch, const vdc5_onoff_t cascade)
 Sets the cascaded connection.
void VDC5_ShrdPrmSetUndSel (const vdc5_channel_t ch, const vdc5_onoff_t und_sel)
 Sets the selection of lower-layer plane in scaler.
vdc5_panel_clksel_t VDC5_ShrdPrmGetPanelClkSel (const vdc5_channel_t ch)
 Gets the panel clock select.
vdc5_onoff_t VDC5_ShrdPrmGetLvdsClkRef (void)
 Gets the reference to the LVDS PLL clock.
vdc5_color_space_t VDC5_ShrdPrmGetColorSpace (const vdc5_channel_t ch)
 Gets the color space of the input video image signal.
vdc5_input_sel_t VDC5_ShrdPrmGetInputSelect (const vdc5_channel_t ch)
 Gets the input select.
vdc5_res_vs_in_sel_t VDC5_ShrdPrmGetVsInSel (const vdc5_channel_t ch)
 Gets the sync signal output and full-screen enable signal select.
vdc5_onoff_t VDC5_ShrdPrmGetCascade (const vdc5_channel_t ch)
 Gets the cascaded connection.
vdc5_onoff_t VDC5_ShrdPrmGetUndSel (const vdc5_channel_t ch)
 Gets the selection of lower-layer plane in scaler.
uint32_t VDC5_ShrdPrmGetBgColor (const vdc5_channel_t ch, const vdc5_color_space_t color_space)
 Get the background color.
vdc5_wr_md_t VDC5_ShrdPrmGetWritingMode (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id)
 Get the frame buffer writing mode for image processing.
vdc5_res_inter_t VDC5_ShrdPrmGetInterlace (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id)
 Gets the field operating mode select.
vdc5_color_space_t VDC5_ShrdPrmGetColorSpaceFbWr (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id)
 Gets the color space of the frame buffer writing format.
void * VDC5_ShrdPrmGetFrBuffBtm (const vdc5_channel_t ch, const vdc5_scaling_type_t scaling_id)
 Gets the frame buffer base address for bottom.
vdc5_gr_ln_off_dir_t VDC5_ShrdPrmGetLineOfsAddrDir (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the line offset address direction of the frame buffer.
vdc5_gr_flm_sel_t VDC5_ShrdPrmGetSelFbAddrSig (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the frame buffer address setting signal.
vdc5_gr_format_t VDC5_ShrdPrmGetGraphicsFormat (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the format of the frame buffer read signal.
vdc5_color_space_t VDC5_ShrdPrmGetColorSpaceFbRd (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the color space of the frame buffer reading format.
vdc5_onoff_t VDC5_ShrdPrmGetMeasureFolding (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the folding handling.
vdc5_period_rect_tVDC5_ShrdPrmGetDisplayArea (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the graphics display area.
vdc5_width_read_fb_tVDC5_ShrdPrmGetFrBuffWidth_Rd (const vdc5_channel_t ch, const vdc5_graphics_type_t graphics_id)
 Gets the size of the frame buffer to be read.
vdc5_channel_t VDC5_ShrdPrmGetLvdsCh (void)
 Gets the VDC5 channel whose data is to be output through the LVDS.
void VDC5_ShrdPrmSetResource (const vdc5_channel_t ch, const vdc5_resource_type_t rsrc_type, const vdc5_resource_state_t rsrc_state)
 Updates the resource state.
void VDC5_ShrdPrmSetLayerResource (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id, const vdc5_resource_state_t rsrc_state)
 Updates the layer resource state.
vdc5_resource_state_t VDC5_ShrdPrmGetResource (const vdc5_channel_t ch, const vdc5_resource_type_t rsrc_type)
 Gets the resource state.
vdc5_resource_state_t VDC5_ShrdPrmGetLayerResource (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id)
 Gets the layer resource state.
void VDC5_ShrdPrmSetRwProcEnable (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id)
 Makes the data write/read processing enabled.
void VDC5_ShrdPrmSetRwProcDisable (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id)
 Makes the data write/read processing disabled.
vdc5_resource_state_t VDC5_ShrdPrmGetRwProcReady (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id)
 Gets the state whether the specified layer is ready or not.
vdc5_resource_state_t VDC5_ShrdPrmGetRwProcEnabled (const vdc5_channel_t ch, const vdc5_layer_id_t layer_id)
 Gets the state whether the specified layer is already run or not.
vdc5_resource_state_t VDC5_ShrdPrmGetOirRwProcEnabled (const vdc5_channel_t ch)
 Gets the state whether the OIR is already run or not.

Detailed Description

VDC5 driver shared parameter definitions.

Version:
1.00
Rev:
199
Date:
2014-05-23 16:33:52 +0900#

Definition in file r_vdc5_shared_param.h.


Enumeration Type Documentation

Color space

Enumerator:
VDC5_COLOR_SPACE_GBR 

GBR

VDC5_COLOR_SPACE_YCBCR 

YCbCr

Definition at line 49 of file r_vdc5_shared_param.h.

Resource state

Enumerator:
VDC5_RESOURCE_ST_INVALID 

Invalid

VDC5_RESOURCE_ST_VALID 

Valid

Definition at line 55 of file r_vdc5_shared_param.h.

Resource type

Enumerator:
VDC5_RESOURCE_PANEL_CLK 

Panel clock

VDC5_RESOURCE_VIDEO_IN 

Input video

VDC5_RESOURCE_VSYNC 

Vsync signal

VDC5_RESOURCE_LCD_PANEL 

LCD panel (output video)

VDC5_RESOURCE_LVDS_CLK 

LVDS PLL clock

Definition at line 61 of file r_vdc5_shared_param.h.


Function Documentation

uint32_t VDC5_ShrdPrmGetBgColor ( const vdc5_channel_t  ch,
const vdc5_color_space_t  color_space 
)

Get the background color.

Parameters:
[in]ch: Channel
[in]color_space: Color space
Return values:
Backgroundcolor in 24-bit RGB color format or CrYCb format

Definition at line 629 of file r_vdc5_shared_param.c.

vdc5_onoff_t VDC5_ShrdPrmGetCascade ( const vdc5_channel_t  ch )

Gets the cascaded connection.

Parameters:
[in]ch: Channel
Return values:
Cascadedconnection (on/off)

Definition at line 606 of file r_vdc5_shared_param.c.

vdc5_color_space_t VDC5_ShrdPrmGetColorSpace ( const vdc5_channel_t  ch )

Gets the color space of the input video image signal.

Parameters:
[in]ch: Channel
Return values:
Colorspace of the input video image signal

Definition at line 574 of file r_vdc5_shared_param.c.

vdc5_color_space_t VDC5_ShrdPrmGetColorSpaceFbRd ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the color space of the frame buffer reading format.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Colorspace of the frame buffer reading format

Definition at line 717 of file r_vdc5_shared_param.c.

vdc5_color_space_t VDC5_ShrdPrmGetColorSpaceFbWr ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id 
)

Gets the color space of the frame buffer writing format.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
Return values:
Colorspace of the frame buffer writing format

Definition at line 662 of file r_vdc5_shared_param.c.

vdc5_period_rect_t* VDC5_ShrdPrmGetDisplayArea ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the graphics display area.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Graphicsdisplay area

Definition at line 739 of file r_vdc5_shared_param.c.

void* VDC5_ShrdPrmGetFrBuffBtm ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id 
)

Gets the frame buffer base address for bottom.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
Return values:
Framebuffer base address for bottom

Definition at line 673 of file r_vdc5_shared_param.c.

vdc5_width_read_fb_t* VDC5_ShrdPrmGetFrBuffWidth_Rd ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the size of the frame buffer to be read.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Sizeof the frame buffer to be read

Definition at line 750 of file r_vdc5_shared_param.c.

vdc5_gr_format_t VDC5_ShrdPrmGetGraphicsFormat ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the format of the frame buffer read signal.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Formatof the frame buffer read signal

Definition at line 706 of file r_vdc5_shared_param.c.

vdc5_input_sel_t VDC5_ShrdPrmGetInputSelect ( const vdc5_channel_t  ch )

Gets the input select.

Parameters:
[in]ch: Channel
Return values:
Inputselect

Definition at line 584 of file r_vdc5_shared_param.c.

vdc5_res_inter_t VDC5_ShrdPrmGetInterlace ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id 
)

Gets the field operating mode select.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
Return values:
Fieldoperating mode select

Definition at line 651 of file r_vdc5_shared_param.c.

vdc5_resource_state_t VDC5_ShrdPrmGetLayerResource ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id 
)

Gets the layer resource state.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
Return values:
Layerresource state

Definition at line 839 of file r_vdc5_shared_param.c.

vdc5_gr_ln_off_dir_t VDC5_ShrdPrmGetLineOfsAddrDir ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the line offset address direction of the frame buffer.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Lineoffset address direction of the frame buffer

Definition at line 684 of file r_vdc5_shared_param.c.

vdc5_channel_t VDC5_ShrdPrmGetLvdsCh ( void   )

Gets the VDC5 channel whose data is to be output through the LVDS.

Parameters:
[in]void
Return values:
Achannel in VDC5 whose data is to be output through the LVDS

Definition at line 762 of file r_vdc5_shared_param.c.

vdc5_onoff_t VDC5_ShrdPrmGetLvdsClkRef ( void   )

Gets the reference to the LVDS PLL clock.

Parameters:
[in]void
Return values:
Referenceto the LVDS PLL clock

Definition at line 557 of file r_vdc5_shared_param.c.

vdc5_onoff_t VDC5_ShrdPrmGetMeasureFolding ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the folding handling.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Foldinghandling (on/off)

Definition at line 728 of file r_vdc5_shared_param.c.

vdc5_resource_state_t VDC5_ShrdPrmGetOirRwProcEnabled ( const vdc5_channel_t  ch )

Gets the state whether the OIR is already run or not.

Parameters:
[in]ch: Channel
Return values:
Resourcestate

  • VDC5_RESOURCE_ST_VALID: The layer resource state of the OIR is valid and the data write/read processing in the OIR is enabled.
  • VDC5_RESOURCE_ST_INVALID: The OIR is not enabled.

Definition at line 926 of file r_vdc5_shared_param.c.

vdc5_panel_clksel_t VDC5_ShrdPrmGetPanelClkSel ( const vdc5_channel_t  ch )

Gets the panel clock select.

Parameters:
[in]ch: Channel
Return values:
Panelclock select

Definition at line 547 of file r_vdc5_shared_param.c.

vdc5_resource_state_t VDC5_ShrdPrmGetResource ( const vdc5_channel_t  ch,
const vdc5_resource_type_t  rsrc_type 
)

Gets the resource state.

Parameters:
[in]ch: Channel
[in]rsrc_type: Resource type
Return values:
Resourcestate

Definition at line 819 of file r_vdc5_shared_param.c.

vdc5_resource_state_t VDC5_ShrdPrmGetRwProcEnabled ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id 
)

Gets the state whether the specified layer is already run or not.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
Return values:
Resourcestate

  • VDC5_RESOURCE_ST_VALID: The layer resource state of the specified layer is valid and the data write/read processing in the layer is enabled.
  • VDC5_RESOURCE_ST_INVALID: The specified layer is not enabled.

Definition at line 905 of file r_vdc5_shared_param.c.

vdc5_resource_state_t VDC5_ShrdPrmGetRwProcReady ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id 
)

Gets the state whether the specified layer is ready or not.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
Return values:
Resourcestate

  • VDC5_RESOURCE_ST_VALID: The layer resource state of the specified layer is valid and the data write/read processing in the layer is disabled.
  • VDC5_RESOURCE_ST_INVALID: The specified layer is not ready.

Definition at line 883 of file r_vdc5_shared_param.c.

vdc5_gr_flm_sel_t VDC5_ShrdPrmGetSelFbAddrSig ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id 
)

Gets the frame buffer address setting signal.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
Return values:
Framebuffer address setting signal

Definition at line 695 of file r_vdc5_shared_param.c.

vdc5_onoff_t VDC5_ShrdPrmGetUndSel ( const vdc5_channel_t  ch )

Gets the selection of lower-layer plane in scaler.

Parameters:
[in]ch: Channel
Return values:
Selectionof lower-layer plane in scaler

  • VDC5_OFF: Selects graphics 0 as lower-layer graphics and graphics 1 as current graphics
  • VDC5_ON: Selects graphics 1 as lower-layer graphics and graphics 0 as current graphics

Definition at line 618 of file r_vdc5_shared_param.c.

vdc5_res_vs_in_sel_t VDC5_ShrdPrmGetVsInSel ( const vdc5_channel_t  ch )

Gets the sync signal output and full-screen enable signal select.

Parameters:
[in]ch: Channel
Return values:
Horizontal/verticalsync signal output and full-screen enable signal select

  • VDC5_RES_VS_IN_SEL_SC0: Sync signal output and full-screen enable signal from scaler 0
  • VDC5_RES_VS_IN_SEL_SC1: Sync signal output and full-screen enable signal from scaler 1

Definition at line 596 of file r_vdc5_shared_param.c.

vdc5_wr_md_t VDC5_ShrdPrmGetWritingMode ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id 
)

Get the frame buffer writing mode for image processing.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
Return values:
Framebuffer writing mode for image processing

Definition at line 640 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmInit ( const vdc5_channel_t  ch )

Initializes variables of the VDC5 driver.

Parameters:
[in]ch: Channel
Return values:
None

Definition at line 139 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetCascade ( const vdc5_channel_t  ch,
const vdc5_onoff_t  cascade 
)

Sets the cascaded connection.

Parameters:
[in]ch: Channel
[in]cascade: Cascaded connection
Return values:
None

Definition at line 526 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetChgReadParam ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id,
const vdc5_read_chg_t *const   param 
)

Sets the data read change parameter.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
[in]param: Data read change parameter
Return values:
None

Definition at line 499 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetChgWriteParam ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id,
const vdc5_write_chg_t *const   param 
)

Sets the data write change parameter.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
[in]param: Data write change parameter
Return values:
None

Definition at line 406 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetInitParam ( const vdc5_channel_t  ch,
const vdc5_init_t *const   param 
)

Sets the initialization parameter.

Parameters:
[in]ch: Channel
[in]param: Initialization parameter
Return values:
None

Definition at line 216 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetInputParam ( const vdc5_channel_t  ch,
const vdc5_input_t *const   param 
)

Sets the video input setup parameter.

Parameters:
[in]ch: Channel
[in]param: Video input setup parameter
Return values:
None

Definition at line 255 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetLayerResource ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id,
const vdc5_resource_state_t  rsrc_state 
)

Updates the layer resource state.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
[in]rsrc_state: Resource state
Return values:
None

Definition at line 795 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetOutputParam ( const vdc5_channel_t  ch,
const vdc5_output_t *const   param 
)

Sets the display output configuration parameter.

Parameters:
[in]ch: Channel
[in]param: Display output configuration parameter
Return values:
None

Definition at line 302 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetReadParam ( const vdc5_channel_t  ch,
const vdc5_graphics_type_t  graphics_id,
const vdc5_read_t *const   param 
)

Sets the data read control parameter.

Parameters:
[in]ch: Channel
[in]graphics_id: Graphics type ID
[in]param: Data read control parameter
Return values:
None

Definition at line 438 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetResource ( const vdc5_channel_t  ch,
const vdc5_resource_type_t  rsrc_type,
const vdc5_resource_state_t  rsrc_state 
)

Updates the resource state.

Parameters:
[in]ch: Channel
[in]rsrc_type: Resource type
[in]rsrc_state: Resource state
Return values:
None

Definition at line 775 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetRwProcDisable ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id 
)

Makes the data write/read processing disabled.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
Return values:
None

Definition at line 865 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetRwProcEnable ( const vdc5_channel_t  ch,
const vdc5_layer_id_t  layer_id 
)

Makes the data write/read processing enabled.

Parameters:
[in]ch: Channel
[in]layer_id: Layer ID
Return values:
None

Definition at line 850 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetSyncParam ( const vdc5_channel_t  ch,
const vdc5_sync_ctrl_t *const   param 
)

Sets the sync control parameter.

Parameters:
[in]ch: Channel
[in]param: Sync control parameter
Return values:
None

Definition at line 287 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetTerminate ( const vdc5_channel_t  ch )

Sets the termination parameter.

Parameters:
[in]ch: Channel
Return values:
None

Definition at line 239 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetUndSel ( const vdc5_channel_t  ch,
const vdc5_onoff_t  und_sel 
)

Sets the selection of lower-layer plane in scaler.

Parameters:
[in]ch: Channel
[in]und_sel: Selection of lower-layer plane in scaler
Return values:
None

Definition at line 537 of file r_vdc5_shared_param.c.

void VDC5_ShrdPrmSetWriteParam ( const vdc5_channel_t  ch,
const vdc5_scaling_type_t  scaling_id,
const vdc5_write_t *const   param 
)

Sets the data write control parameter.

Parameters:
[in]ch: Channel
[in]scaling_id: Scaling type ID
[in]param: Data write control parameter
Return values:
None

Definition at line 358 of file r_vdc5_shared_param.c.