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


fapex/abst_libhdmicec.h File Reference

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

Data Structures

struct  FAPEX_HDMICEC_GiveTunerDeviceStatusParamsT
 Set/Get the Give Tuner Device Status parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_SelectAnalogueServiceParamsT
 Set/Get the Select Analogue Service parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_SelectDigitalServiceParamsT
 Set/Get the Select Digital Service parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_TunerDeviceStatusParamsT
 Set/Get the Tuner Device Status parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_SetOSDStringParamsT
 Set/Get the Set OSD String parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_MenuRequestParamsT
 Set/Get the Menu Request parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_MenuStatusParamsT
 Set/Get the Menu Status parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_UserControlPressedParamsT
 Set/Get the User Control Pressed parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_ReportPowerStatusParamsT
 Set/Get the Report Power Status parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_CECVersionParamsT
 Set/Get the CEC version parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_ReportPhysicalAddressParamsT
 Set/Get the Report Physical Address parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_SetMenuLanguageParamsT
 Set/Get the Set Menu Language parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_FeatureAbortParamsT
 Set/Get the Feature Abort parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_ActiveSourceParamsT
 Set/Get the Active Source parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_InactiveSourceParamsT
 Set/Get the Inactive Source parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_RoutingChangeParamsT
 Set/Get the Routing Change parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_RoutingInformationParamsT
 Set/Get the Routing Information parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_SetStreamPathParamsT
 Set/Get the Set Stream Path parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_MessageParamsT
 Set/Get CEC parameters for the HDMI driver. More...
struct  FAPEX_HDMICEC_MessageParamStrT
 message parameters for the HDMICEC driver More...

Defines

#define FAPEX_HDMICEC_STATUS_ERR_BUSY   (FAPEX_HDMI_STATUS_ERR_BASE - 51)
 HDMI CEC is sending the message.
#define FAPEX_HDMICEC_STATUS_ERR_MESSAGE_BUFFER_EMPTY   (FAPEX_HDMI_STATUS_ERR_BASE - 55)
 HDMI CEC error of message buffer empty.
#define FAPEX_HDMICEC_STATUS_ERR_RECEIVE_PARAMETER   (FAPEX_HDMI_STATUS_ERR_BASE - 56)
 HDMI CEC error of receiving parameter.
#define FAPEX_HDMICEC_STATUS_ERR_SEND_PARAMETER   (FAPEX_HDMI_STATUS_ERR_BASE - 57)
 HDMI CEC error of sending parameter.
#define FAPEX_HDMICEC_STANDBY   (0x36)
#define FAPEX_HDMICEC_GIVE_TUNER_DEVICE_STATUS   (0x08)
#define FAPEX_HDMICEC_SELECT_ANALOGUE_SERVICE   (0x92)
#define FAPEX_HDMICEC_SELECT_DIGITAL_SERVICE   (0x93)
#define FAPEX_HDMICEC_TUNER_DEVICE_STATUS   (0x07)
#define FAPEX_HDMICEC_TUNER_STEP_DECREMENT   (0x06)
#define FAPEX_HDMICEC_TUNER_STEP_INCREMENT   (0x05)
#define FAPEX_HDMICEC_SET_OSD_STRING   (0x64)
#define FAPEX_HDMICEC_MENU_REQUEST   (0x8D)
#define FAPEX_HDMICEC_MENU_STATUS   (0x8E)
#define FAPEX_HDMICEC_USER_CONTROL_PRESSED   (0x44)
#define FAPEX_HDMICEC_USER_CONTROL_RELEASED   (0x45)
#define FAPEX_HDMICEC_GIVE_DEVICE_POWER_STATUS   (0x8F)
#define FAPEX_HDMICEC_REPORT_POWER_STATUS   (0x90)
#define FAPEX_HDMICEC_CEC_VERSION   (0x9e)
#define FAPEX_HDMICEC_GET_CEC_VERSION   (0x9F)
#define FAPEX_HDMICEC_GIVE_PHYSICAL_ADDRESS   (0x83)
#define FAPEX_HDMICEC_GET_MENU_LANGUAGE   (0x91)
#define FAPEX_HDMICEC_REPORT_PHYSICAL_ADDRESS   (0x84)
#define FAPEX_HDMICEC_POLLING_MESSAGE   (0xffff)
#define FAPEX_HDMICEC_SET_MENU_LANGUAGE   (0x32)
#define FAPEX_HDMICEC_FEATURE_ABORT   (0x00)
#define FAPEX_HDMICEC_ABORT   (0xff)
#define FAPEX_HDMICEC_ACTIVE_SOURCE   (0x82)
#define FAPEX_HDMICEC_IMAGE_VIEW_ON   (0x04)
#define FAPEX_HDMICEC_TEXT_VIEW_ON   (0x0D)
#define FAPEX_HDMICEC_INACTIVE_SOURCE   (0x9D)
#define FAPEX_HDMICEC_REQUEST_ACTIVE_SOURCE   (0x85)
#define FAPEX_HDMICEC_ROUTING_CHANGE   (0x80)
#define FAPEX_HDMICEC_ROUTING_INFORMATION   (0x81)
#define FAPEX_HDMICEC_SET_STREAM_PATH   (0x86)
#define FAPEX_HDMICEC_DEVICE_VENDOR_ID   (0x87)
#define FAPEX_HDMICEC_GIVE_DEVICE_VENDOR_ID   (0x8C)
#define FAPEX_HDMICEC_SET_SYSTEM_AUDIO_MODE   (0x72)
#define FAPEX_HDMICEC_AWAITING_SENDING   (0)
#define FAPEX_HDMICEC_DURING_SENDING   (1)
#define FAPEX_HDMICEC_SENDING_COMPLETE   (2)
#define FAPEX_HDMICEC_SENDING_ERROR   (3)
#define FAPEX_HDMICEC_AWAITING_RECEIVING   (0)
#define FAPEX_HDMICEC_DURING_RECEIVING   (1)
#define FAPEX_HDMICEC_RECEPTION_COMPLETE   (2)
#define FAPEX_HDMICEC_RECEPTION_ERROR   (3)
#define FAPEX_IOCCOM_HDMICEC_GET_SEND_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 0, uint32_t)
 ioctl specific command for the HDMI-CEC driver
#define FAPEX_IOCCOM_HDMICEC_GET_RECEIVE_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 1, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_CHECK_SEND_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 2, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_CHECK_RECEIVE_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 3, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_SET_MESSAGE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 4, FAPEX_HDMICEC_MessageParamStrT)
#define FAPEX_IOCCOM_HDMICEC_GET_MESSAGE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 4, FAPEX_HDMICEC_MessageParamStrT)
#define FAPEX_IOCCOM_HDMICEC_SEND_MESSAGE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 5, int32_t)
#define FAPEX_IOCCOM_HDMICEC_RECEIVE_MESSAGE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 6, int32_t)
#define FAPEX_IOCCOM_HDMICEC_SET_LOGICAL_ADDRESS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 7, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_GET_LOGICAL_ADDRESS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 8, uint32_t)

Enumerations

enum  FAPEX_HDMICEC_LogicalAddressEnumT {
  FAPEX_HDMICEC_LOGICAL_ADDRESS_TV = 0, FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE1, FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE2, FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER1,
  FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE1, FAPEX_HDMICEC_LOGICAL_ADDRESS_AUDIO_SYSTEM, FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER2, FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER3,
  FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE2, FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE3, FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER4, FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE3,
  FAPEX_HDMICEC_LOGICAL_ADDRESSS_RESERVED1, FAPEX_HDMICEC_LOGICAL_ADDRESSS_RESERVED2, FAPEX_HDMICEC_LOGICAL_ADDRESSS_FREE_USE, FAPEX_HDMICEC_LOGICAL_ADDRESSS_UNREGISTERED_BROADCAST
}
 

Logic address of an HDMI device of a connection point.

More...

Functions

FAPEXOPENRET_T FAPEX_HDMICEC_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_HDMICEC_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_HDMICEC_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-CEC 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_HDMICEC_STATUS_ERR_BUSY   (FAPEX_HDMI_STATUS_ERR_BASE - 51)

HDMI CEC is sending the message.

#define FAPEX_HDMICEC_STATUS_ERR_MESSAGE_BUFFER_EMPTY   (FAPEX_HDMI_STATUS_ERR_BASE - 55)

HDMI CEC error of message buffer empty.

#define FAPEX_HDMICEC_STATUS_ERR_RECEIVE_PARAMETER   (FAPEX_HDMI_STATUS_ERR_BASE - 56)

HDMI CEC error of receiving parameter.

#define FAPEX_HDMICEC_STATUS_ERR_SEND_PARAMETER   (FAPEX_HDMI_STATUS_ERR_BASE - 57)

HDMI CEC error of sending parameter.

#define FAPEX_HDMICEC_STANDBY   (0x36)
#define FAPEX_HDMICEC_GIVE_TUNER_DEVICE_STATUS   (0x08)
#define FAPEX_HDMICEC_SELECT_ANALOGUE_SERVICE   (0x92)
#define FAPEX_HDMICEC_SELECT_DIGITAL_SERVICE   (0x93)
#define FAPEX_HDMICEC_TUNER_DEVICE_STATUS   (0x07)
#define FAPEX_HDMICEC_TUNER_STEP_DECREMENT   (0x06)
#define FAPEX_HDMICEC_TUNER_STEP_INCREMENT   (0x05)
#define FAPEX_HDMICEC_SET_OSD_STRING   (0x64)
#define FAPEX_HDMICEC_MENU_REQUEST   (0x8D)
#define FAPEX_HDMICEC_MENU_STATUS   (0x8E)
#define FAPEX_HDMICEC_USER_CONTROL_PRESSED   (0x44)
#define FAPEX_HDMICEC_USER_CONTROL_RELEASED   (0x45)
#define FAPEX_HDMICEC_GIVE_DEVICE_POWER_STATUS   (0x8F)
#define FAPEX_HDMICEC_REPORT_POWER_STATUS   (0x90)
#define FAPEX_HDMICEC_CEC_VERSION   (0x9e)
#define FAPEX_HDMICEC_GET_CEC_VERSION   (0x9F)
#define FAPEX_HDMICEC_GIVE_PHYSICAL_ADDRESS   (0x83)
#define FAPEX_HDMICEC_GET_MENU_LANGUAGE   (0x91)
#define FAPEX_HDMICEC_REPORT_PHYSICAL_ADDRESS   (0x84)
#define FAPEX_HDMICEC_POLLING_MESSAGE   (0xffff)
#define FAPEX_HDMICEC_SET_MENU_LANGUAGE   (0x32)
#define FAPEX_HDMICEC_FEATURE_ABORT   (0x00)
#define FAPEX_HDMICEC_ABORT   (0xff)
#define FAPEX_HDMICEC_ACTIVE_SOURCE   (0x82)
#define FAPEX_HDMICEC_IMAGE_VIEW_ON   (0x04)
#define FAPEX_HDMICEC_TEXT_VIEW_ON   (0x0D)
#define FAPEX_HDMICEC_INACTIVE_SOURCE   (0x9D)
#define FAPEX_HDMICEC_REQUEST_ACTIVE_SOURCE   (0x85)
#define FAPEX_HDMICEC_ROUTING_CHANGE   (0x80)
#define FAPEX_HDMICEC_ROUTING_INFORMATION   (0x81)
#define FAPEX_HDMICEC_SET_STREAM_PATH   (0x86)
#define FAPEX_HDMICEC_DEVICE_VENDOR_ID   (0x87)
#define FAPEX_HDMICEC_GIVE_DEVICE_VENDOR_ID   (0x8C)
#define FAPEX_HDMICEC_SET_SYSTEM_AUDIO_MODE   (0x72)
#define FAPEX_HDMICEC_AWAITING_SENDING   (0)
#define FAPEX_HDMICEC_DURING_SENDING   (1)
#define FAPEX_HDMICEC_SENDING_COMPLETE   (2)
#define FAPEX_HDMICEC_SENDING_ERROR   (3)
#define FAPEX_HDMICEC_AWAITING_RECEIVING   (0)
#define FAPEX_HDMICEC_DURING_RECEIVING   (1)
#define FAPEX_HDMICEC_RECEPTION_COMPLETE   (2)
#define FAPEX_HDMICEC_RECEPTION_ERROR   (3)
#define FAPEX_IOCCOM_HDMICEC_GET_SEND_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 0, uint32_t)

ioctl specific command for the HDMI-CEC driver

#define FAPEX_IOCCOM_HDMICEC_GET_RECEIVE_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 1, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_CHECK_SEND_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 2, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_CHECK_RECEIVE_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 3, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_SET_MESSAGE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 4, FAPEX_HDMICEC_MessageParamStrT)
#define FAPEX_IOCCOM_HDMICEC_GET_MESSAGE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 4, FAPEX_HDMICEC_MessageParamStrT)
#define FAPEX_IOCCOM_HDMICEC_SEND_MESSAGE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 5, int32_t)
#define FAPEX_IOCCOM_HDMICEC_RECEIVE_MESSAGE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 6, int32_t)
#define FAPEX_IOCCOM_HDMICEC_SET_LOGICAL_ADDRESS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 7, uint32_t)
#define FAPEX_IOCCOM_HDMICEC_GET_LOGICAL_ADDRESS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_HDMICEC + 8, uint32_t)

Enumeration Type Documentation

Logic address of an HDMI device of a connection point.

This enumeration contains the IDs of the supported logical address.

Note:
The logical address(s) actual available is restricted by the HDMI device which was connected
Enumerator:
FAPEX_HDMICEC_LOGICAL_ADDRESS_TV 

TV.

FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE1 

Recording device1.

FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE2 

Recording device2.

FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER1 

Tuner1.

FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE1 

Playback device1.

FAPEX_HDMICEC_LOGICAL_ADDRESS_AUDIO_SYSTEM 

Audio System.

FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER2 

Tuner2.

FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER3 

Tuner3.

FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE2 

Playback device2.

FAPEX_HDMICEC_LOGICAL_ADDRESS_RECORDING_DEVICE3 

Recording device3.

FAPEX_HDMICEC_LOGICAL_ADDRESS_TUNER4 

Tuner4.

FAPEX_HDMICEC_LOGICAL_ADDRESS_PLAYBACK_DEVICE3 

Playback device3.

FAPEX_HDMICEC_LOGICAL_ADDRESSS_RESERVED1 

Reserved1.

FAPEX_HDMICEC_LOGICAL_ADDRESSS_RESERVED2 

Reserved2.

FAPEX_HDMICEC_LOGICAL_ADDRESSS_FREE_USE 

Free Use.

FAPEX_HDMICEC_LOGICAL_ADDRESSS_UNREGISTERED_BROADCAST 

Unregistered(as initiator address),Broadcast(as definition address)


Function Documentation

FAPEXOPENRET_T FAPEX_HDMICEC_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_HDMICEC_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_HDMICEC_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:



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