Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


abst_libviout.c File Reference

abstraction library source file (Video Output driver). More...

Functions

FAPEXOPENRET_T FAPEX_VIOUT_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_VIOUT_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_VIOUT_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".
FAPEXMMPRET_T FAPEX_VIOUT_Mmap (FAPEXMMPARG1_T start, FAPEXMMPARG2_T length, FAPEXMMPARG3_T prot, FAPEXMMPARG4_T flags, FAPEXMMPARG5_T id, FAPEXMMPARG6_T offset)
 mmap method. This function is called with the systemcall "mmap".

FAPEXMUNMPRET_T FAPEX_VIOUT_Munmap (FAPEXMMPARG1_T start, FAPEXMMPARG2_T length)
 munmap method. This function is called with the systemcall "munmap".

Detailed Description

abstraction library source file (Video Output driver).

These function is executed in user space.

Attention:
This program is provided as is. You can redistribute it and/or modify it. Fujitsu Semiconductor Limited accepts no responsibility or liability for any errors or omissions.

Copyright (C) 2008-2010 Fujitsu Semiconductor Limited, All Rights Reserved.


Function Documentation

FAPEXOPENRET_T FAPEX_VIOUT_Open ( FAPEXOPENARG1_T  id,
FAPEXOPENARG2_T  flags,
FAPEXOPENARG3_T  argptr 
)

open method. This function is called with the systemcall "open".

Parameters:
idThe identifier for all layer (common descriptor).
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (FAPEX_VIOUT_OpenCmnParamStrT)
If descriptor for this 'id' has already been opened, this 'argptr' will be invalid.
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_VIOUT_Close ( FAPEXRELARG1_T  id )

release method. This function is called with the systemcall "close".

Parameters:
idThe identifier for all layer (common descriptor).
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_VIOUT_Ioctl ( FAPEXIOCARG1_T  id,
FAPEXIOCARG2_T  cmd,
FAPEXIOCARG3_T  pArg 
)

ioctl method. This function is called with the systemcall "ioctl".

Parameters:
idThe identifier for this descriptor.
cmdThe ioctl command.
pArgThe pointer to the argument of the ioctl command.
Return values:
0process OK
<0process fails, its value is set to errno.

ioctl command(cmd) type:

  • FAPEX_IOCCOM_VIOUT_SET_PLANEORDER
    set Plane Order.
    Set pointer of order array data field (int32_t order[6]) to pArg.
    (order[0]:video, order[1]:osd1, order[2]:osd2, order[3]:osd3, order[4]:osd4, order[5]:cp)
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_VIOUT_GET_PLANEORDER
    get Plane Order.
    Set pointer of order array data field (int32_t order[4]) to pArg.
    (order[0]:video, order[1]:osd1, order[2]:osd2, order[3]:cp) The order number value will be set to these field.
    If it is negative value, its plane is not shown.
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_VIOUT_GET_BGCOLOUR
    get back ground color.
    Set pointer of colour data field (uint32_t) to pArg.
    The colour value (bit23-16:Y bit15-8:Cr bit7-0:Cb) will be set to this field.
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_START
    start Video output layer. (pArg is ignored)
    When id is common descriptor, all Video output layers on the ready state will start.
    When id is sub descriptor on the ready state, only this layer will start.

  • FAPEX_IOCCOM_STOP
    stop Video Output. (pArg is ignored)
    When id is common descriptor, all Video output layers on the running state will stop.
    When id is sub descriptor on the running state, only this layer will stop.

  • FAPEX_IOCCOM_VIOUT_SET_SATURATION
    set the saturation.
    Set the saturation from the arg. The recommended saturation values run from 0 (0%) to +400 (400%). 0% saturation stands for complete Black & white video. 100% saturation stands for coded chrominance levels. 400% saturation stands for over saturated chrominance levels.
FAPEXMMPRET_T FAPEX_VIOUT_Mmap ( FAPEXMMPARG1_T  start,
FAPEXMMPARG2_T  length,
FAPEXMMPARG3_T  prot,
FAPEXMMPARG4_T  flags,
FAPEXMMPARG5_T  id,
FAPEXMMPARG6_T  offset 
)

mmap method. This function is called with the systemcall "mmap".

This function supports accessing of the mapped area for frame buffer of OSD1/OSD2/CursorPlane.
The 'length' should be computed by ((inputWindowWidth x inputWindowHeight x bpp) >> 3) of FAPEX_VIOUT_ScalerParamStrT structure.
This information of FAPEX_VIOUT_ScalerParamStrT is got by using FAPEX_IOCCOM_VIOUT_GET_SCALER_PARAMS command with FAPEX_VIOUT_Ioctl().

Parameters:
startThe memory mapping start pointer.
lengthThe memory mapping size.
protThe desired memory protection.
flagsThe mapping option.
idThe identifier for OSD1/OSD2/CursorPlane layer descriptor (sub descriptor).
offsetThe memory mapping offset value.
Return values:
>0process OK, its value is the mapping address.
<0process fails, its value is set to errno.
FAPEXMUNMPRET_T FAPEX_VIOUT_Munmap ( FAPEXMMPARG1_T  start,
FAPEXMMPARG2_T  length 
)

munmap method. This function is called with the systemcall "munmap".

Parameters:
startThe memory mapping start pointer.
lengthThe memory mapping size.
Return values:
0process OK
<0process fails, its value is set to errno.


Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives