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


fapex/abst_libhdmi.h File Reference

abstraction library header file (HDMI driver) More...

Data Structures

struct  FAPEX_HDMI_EdidInfoStrT
 get the EDID information data More...

Defines

#define FAPEX_HDMI_ERR_BASE   (FAPEX_HDMI_MODULE_BASE + FAPEX_RET_ERR_BASE)
#define FAPEX_HDMI_ERR_BAD_PARAMETER   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)
#define FAPEX_HDMI_ERR_OUT_OF_MEMORY   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)
#define FAPEX_HDMI_ERR_TIMEOUT   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_TIMEOUT)
#define FAPEX_HDMI_ERR_INVALID_STATUS   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)
#define FAPEX_HDMI_STATUS_OK   (FAPEX_OK)
 HDMI status ok.
#define FAPEX_HDMI_STATUS_ERR_BASE   (FAPEX_HDMI_MODULE_BASE - 100)
#define FAPEX_HDMI_STATUS_ERR_EDID   (FAPEX_HDMI_STATUS_ERR_BASE - 20)
 HDMI EDID read error.
#define FAPEX_HDMI_STATUS_ERR_DDC_TIMEOUT   (FAPEX_HDMI_STATUS_ERR_BASE - 21)
 HDMI DDC timeout error.
#define FAPEX_HDMI_STATUS_ERR_HDCP_TIMEOUT   (FAPEX_HDMI_STATUS_ERR_BASE - 30)
 HDMI HDCP timeout occured.
#define FAPEX_HDMI_STATUS_ERR_HDCP_MAX_DEVS_EXCEED   (FAPEX_HDMI_STATUS_ERR_BASE - 31)
 HDMI HDCP exceed device count.
#define FAPEX_HDMI_STATUS_ERR_HDCP_MAX_CASCADE_EXCEEDED   (FAPEX_HDMI_STATUS_ERR_BASE - 32)
 HDMI HDCP cascade exceeded.
#define FAPEX_HDMI_STATUS_ERR_HDCP_SHA_1_MISMATCH   (FAPEX_HDMI_STATUS_ERR_BASE - 33)
 HDMI HDCP SHA-1 mismatch.
#define FAPEX_HDMI_STATUS_ERR_HDCP_AN_DDC   (FAPEX_HDMI_STATUS_ERR_BASE - 34)
 HDMI HDCP AN DDC Error.
#define FAPEX_HDMI_STATUS_ERR_HDCP_AKSV_DDC   (FAPEX_HDMI_STATUS_ERR_BASE - 35)
 HDMI HDCP AKSV DDC Error.
#define FAPEX_HDMI_STATUS_ERR_HDCP_BKSV   (FAPEX_HDMI_STATUS_ERR_BASE - 36)
 HDMI HDCP BKSV Error.
#define FAPEX_HDMI_STATUS_ERR_HDCP_RI_FAILURE   (FAPEX_HDMI_STATUS_ERR_BASE - 37)
 HDMI HDCP RI failure.
#define FAPEX_HDMI_STATUS_ERR_HDCP_RI_NOT_ABAILABLE   (FAPEX_HDMI_STATUS_ERR_BASE - 38)
 HDMI HDCP RI failure.
#define FAPEX_HDMI_STATUS_ERR_HPD_NOT_DETECT   (FAPEX_HDMI_STATUS_ERR_BASE - 40)
 HDMI HPD not detect.
#define FAPEX_HDMI_STATUS_ERR_EXIST_IN_REVOCATION_LISTS   (FAPEX_HDMI_STATUS_ERR_BASE - 41)
 HDMI HDCP BKSV exist in Revocation Lists.
#define FAPEX_HDMI_STATUS_ERR_HDCP_NOT_SUPPORT   (FAPEX_HDMI_STATUS_ERR_BASE - 42)
#define FAPEX_HDMI_STATUS_ERR_HDCP_AKSV   (FAPEX_HDMI_STATUS_ERR_BASE - 43)
 HDMI HDCP AKSV Error.
#define FAPEX_HDMI_RGB   0
 RGB.
#define FAPEX_HDMI_YUV422   1
 YUV422.
#define FAPEX_HDMI_YUV444   2
 YUV444.
#define FAPEX_HDMI_SCAN_NO_DATA   0
 No data.
#define FAPEX_HDMI_OVERSCAN   1
 overscanned display
#define FAPEX_HDMI_UNDERSCAN   2
 underscanned display
#define FAPEX_HDMI_HDCP_STATUS_FIRST_AUTHENTICATION   (0x10)
#define FAPEX_HDMI_HDCP_STATUS_WAIT_FOR_RXRDY   (0x30)
#define FAPEX_HDMI_HDCP_STATUS_SECOND_AUTHENTICATION   (0x40)
#define FAPEX_HDMI_HDCP_STATUS_WAIT_FIFORDY   (0x50)
#define FAPEX_HDMI_HDCP_STATUS_FINISH_REPEATER_CHECK   (0x60)
#define FAPEX_HDMI_HDCP_STATUS_THIRD_AUTHENTICATION   (0x70)
#define FAPEX_HDMI_HDCP_STATUS_REQ_NOHDCP   (0x80)
#define FAPEX_HDMI_HDCP_STATUS_NO_ENCRYPTION   (0x90)
#define FAPEX_HDMI_HDCP_DYNAMIC_ON   1
 HDCP Dynamic ON.
#define FAPEX_HDMI_HDCP_DYNAMIC_OFF   0
 HDCP Dynamic OFF.
#define FAPEX_IOCCOM_HDMI_CHECK_HPD   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 0, int32_t)
 ioctl specific command for the HDMI driver
#define FAPEX_IOCCOM_HDMI_READ_EDID   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 1, int32_t)
#define FAPEX_IOCCOM_HDMI_GET_EDID_INFO   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 2, FAPEX_HDMI_EdidInfoStrT)
#define FAPEX_IOCCOM_HDMI_GET_EDID_PHYSADDR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 3, uint32_t)
#define FAPEX_IOCCOM_HDMI_LINK_HDCP   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 4, int32_t)
#define FAPEX_IOCCOM_HDMI_CHECK_HDCP_STATE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 5, int32_t)
#define FAPEX_IOCCOM_HDMI_SET_DYNAMIC_HDCP   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 6, int32_t)

Functions

FAPEXOPENRET_T FAPEX_HDMI_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_HDMI_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_HDMI_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".

Detailed Description

abstraction library header file (HDMI driver)

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.


Define Documentation

#define FAPEX_HDMI_ERR_BASE   (FAPEX_HDMI_MODULE_BASE + FAPEX_RET_ERR_BASE)

FAPex HDMI error code base value

#define FAPEX_HDMI_ERR_BAD_PARAMETER   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)

Bad parameter passed.

#define FAPEX_HDMI_ERR_OUT_OF_MEMORY   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)

Memory allocation failed.

#define FAPEX_HDMI_ERR_TIMEOUT   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_TIMEOUT)

Timeout occured.

#define FAPEX_HDMI_ERR_INVALID_STATUS   (FAPEX_HDMI_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)

Invalid status.

#define FAPEX_HDMI_STATUS_OK   (FAPEX_OK)

HDMI status ok.

driver status error codes

#define FAPEX_HDMI_STATUS_ERR_BASE   (FAPEX_HDMI_MODULE_BASE - 100)
#define FAPEX_HDMI_STATUS_ERR_EDID   (FAPEX_HDMI_STATUS_ERR_BASE - 20)

HDMI EDID read error.

#define FAPEX_HDMI_STATUS_ERR_DDC_TIMEOUT   (FAPEX_HDMI_STATUS_ERR_BASE - 21)

HDMI DDC timeout error.

#define FAPEX_HDMI_STATUS_ERR_HDCP_TIMEOUT   (FAPEX_HDMI_STATUS_ERR_BASE - 30)

HDMI HDCP timeout occured.

#define FAPEX_HDMI_STATUS_ERR_HDCP_MAX_DEVS_EXCEED   (FAPEX_HDMI_STATUS_ERR_BASE - 31)

HDMI HDCP exceed device count.

#define FAPEX_HDMI_STATUS_ERR_HDCP_MAX_CASCADE_EXCEEDED   (FAPEX_HDMI_STATUS_ERR_BASE - 32)

HDMI HDCP cascade exceeded.

#define FAPEX_HDMI_STATUS_ERR_HDCP_SHA_1_MISMATCH   (FAPEX_HDMI_STATUS_ERR_BASE - 33)

HDMI HDCP SHA-1 mismatch.

#define FAPEX_HDMI_STATUS_ERR_HDCP_AN_DDC   (FAPEX_HDMI_STATUS_ERR_BASE - 34)

HDMI HDCP AN DDC Error.

#define FAPEX_HDMI_STATUS_ERR_HDCP_AKSV_DDC   (FAPEX_HDMI_STATUS_ERR_BASE - 35)

HDMI HDCP AKSV DDC Error.

#define FAPEX_HDMI_STATUS_ERR_HDCP_BKSV   (FAPEX_HDMI_STATUS_ERR_BASE - 36)

HDMI HDCP BKSV Error.

#define FAPEX_HDMI_STATUS_ERR_HDCP_RI_FAILURE   (FAPEX_HDMI_STATUS_ERR_BASE - 37)

HDMI HDCP RI failure.

#define FAPEX_HDMI_STATUS_ERR_HDCP_RI_NOT_ABAILABLE   (FAPEX_HDMI_STATUS_ERR_BASE - 38)

HDMI HDCP RI failure.

#define FAPEX_HDMI_STATUS_ERR_HPD_NOT_DETECT   (FAPEX_HDMI_STATUS_ERR_BASE - 40)

HDMI HPD not detect.

#define FAPEX_HDMI_STATUS_ERR_EXIST_IN_REVOCATION_LISTS   (FAPEX_HDMI_STATUS_ERR_BASE - 41)

HDMI HDCP BKSV exist in Revocation Lists.

#define FAPEX_HDMI_STATUS_ERR_HDCP_NOT_SUPPORT   (FAPEX_HDMI_STATUS_ERR_BASE - 42)

|brief HDCP feature is not available.

#define FAPEX_HDMI_STATUS_ERR_HDCP_AKSV   (FAPEX_HDMI_STATUS_ERR_BASE - 43)

HDMI HDCP AKSV Error.

#define FAPEX_HDMI_RGB   0

RGB.

#define FAPEX_HDMI_YUV422   1

YUV422.

#define FAPEX_HDMI_YUV444   2

YUV444.

#define FAPEX_HDMI_SCAN_NO_DATA   0

No data.

#define FAPEX_HDMI_OVERSCAN   1

overscanned display

#define FAPEX_HDMI_UNDERSCAN   2

underscanned display

#define FAPEX_HDMI_HDCP_STATUS_FIRST_AUTHENTICATION   (0x10)
#define FAPEX_HDMI_HDCP_STATUS_WAIT_FOR_RXRDY   (0x30)
#define FAPEX_HDMI_HDCP_STATUS_SECOND_AUTHENTICATION   (0x40)
#define FAPEX_HDMI_HDCP_STATUS_WAIT_FIFORDY   (0x50)
#define FAPEX_HDMI_HDCP_STATUS_FINISH_REPEATER_CHECK   (0x60)
#define FAPEX_HDMI_HDCP_STATUS_THIRD_AUTHENTICATION   (0x70)
#define FAPEX_HDMI_HDCP_STATUS_REQ_NOHDCP   (0x80)
#define FAPEX_HDMI_HDCP_STATUS_NO_ENCRYPTION   (0x90)
#define FAPEX_HDMI_HDCP_DYNAMIC_ON   1

HDCP Dynamic ON.

#define FAPEX_HDMI_HDCP_DYNAMIC_OFF   0

HDCP Dynamic OFF.

#define FAPEX_IOCCOM_HDMI_CHECK_HPD   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 0, int32_t)

ioctl specific command for the HDMI driver

#define FAPEX_IOCCOM_HDMI_READ_EDID   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 1, int32_t)
#define FAPEX_IOCCOM_HDMI_GET_EDID_INFO   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 2, FAPEX_HDMI_EdidInfoStrT)
#define FAPEX_IOCCOM_HDMI_GET_EDID_PHYSADDR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 3, uint32_t)
#define FAPEX_IOCCOM_HDMI_LINK_HDCP   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 4, int32_t)
#define FAPEX_IOCCOM_HDMI_CHECK_HDCP_STATE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 5, int32_t)
#define FAPEX_IOCCOM_HDMI_SET_DYNAMIC_HDCP   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMI + 6, int32_t)

Function Documentation

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

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

Parameters:
idThe device identifier.
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (NULL)
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_HDMI_Close ( FAPEXRELARG1_T  id )

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

Parameters:
idThe identifier for this descriptor.
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_HDMI_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_HDMI_CHECK_HPD
    check HPD status.
    Set pointer of status data field (int32_t) to pArg.
    The status value (bit6: HPD_int bit5: RSEN_int bit2: HPD_status bit1: RSEN_status) will be set to this field.

  • FAPEX_IOCCOM_HDMI_GET_EDID_PHYSADDR
    get the physical address in EDID.
    Set pointer of address data field (uint32_t) to pArg.
    The physical address value will be set to this field.



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