Main Page   Data Structures   File List   Data Fields   Globals  

tmdlHdmiCEC_Functions.h File Reference

This provides interfaces description of CEC messages. More...

#include "tmNxTypes.h"

Include dependency graph for tmdlHdmiCEC_Functions.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Functions

tmErrorCode_t tmdlHdmiCecAbortMessage (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is reserved for testing purposes.

tmErrorCode_t tmdlHdmiCecActiveSource (tmInstance_t Instance, UInt16 PhysicalAddress)
 This message is used by a new source to indicate that it has started to transmit a stream OR used in reponse to a <Request Active Source>.

tmErrorCode_t tmdlHdmiCecVersion (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECVersion_t CECVersion)
 This message is used to indicate the supported CEC version in response to a <Get CEC Version>.

tmErrorCode_t tmdlHdmiCecClearAnalogueTimer (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType, UInt16 AnalogueFrequency, tmdlHdmiCECBroadcastSystem_t BroadcastSystem)
 This message is used to clear an Analogue timer block of a device.

tmErrorCode_t tmdlHdmiCecClearDigitalTimer (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification)
 This message is used to clear a digital timer block of a device.

tmErrorCode_t tmdlHdmiCecClearExternalTimerWithExternalPlug (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECExternalPlug_t ExternalPlug)
 This message is used to clear a digital timer block of a device.

tmErrorCode_t tmdlHdmiCecClearExternalTimerWithPhysicalAddress (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECExternalPhysicalAddress_t ExternalPhysicalAddress)
 This message is used to clear a digital timer block of a device.

tmErrorCode_t tmdlHdmiCecDeckControl (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECDecControlMode_t DeckControlMode)
 This message is used to conrol a device's media functions.

tmErrorCode_t tmdlHdmiCecDeckStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECDecInfo_t DeckInfo)
 This message is used to provide a deck's status to the initiator of the <Give Deck Status> message.

tmErrorCode_t tmdlHdmiCecDeviceVendorID (tmInstance_t Instance, UInt32 VendorID)
 This message report the vendor ID of this device.

tmErrorCode_t tmdlHdmiCecFeatureAbort (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECFeatureOpcode_t FeatureOpcode, tmdlHdmiCECAbortReason_t AbortReason)
 This message is used as a reponse to indicate that the device does not support the requested message type, or that it cannot execute it at the present time.

tmErrorCode_t tmdlHdmiCecGetCecVersion (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used by a device to enquire which version of CEC the target supports.

tmErrorCode_t tmdlHdmiCecGetMenuLanguage (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is sent by a device capable of character generation (for OSD and Menus) to a TV in order to discover the currently selected Menu Language. Also used by a TV during installation to dicover the currently set menu language of other devices.

tmErrorCode_t tmdlHdmiCecGiveAudioStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is requests an amplifier to send its volume and mute status.

tmErrorCode_t tmdlHdmiCecGiveDeckStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECStatusRequest_t StatusRequest)
 This message is used to request the status of a device regardless of whether or not it is the current active source.

tmErrorCode_t tmdlHdmiCecGiveDevicePowerStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used to determine the current power status of a target device.

tmErrorCode_t tmdlHdmiCecGiveDeviceVendorID (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is request the vendor ID from a device.

tmErrorCode_t tmdlHdmiCecGiveOsdName (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used to request preferred OSD name of a device for use in menus associated with that device.

tmErrorCode_t tmdlHdmiCecGivePhysicalAddress (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is a request to a device to return its physical Address.

tmErrorCode_t tmdlHdmiCecGiveSystemAudioModeStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message request the status of the system audio mode.

tmErrorCode_t tmdlHdmiCecGiveTunerDeviceStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECStatusRequest_t StatusRequest)
 This message is used to request the status of a tuner device.

tmErrorCode_t tmdlHdmiCecImageViewOn (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message sent by a source device to the TV whenever it enters the active state.

tmErrorCode_t tmdlHdmiCecInactiveSource (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECExternalPhysicalAddress_t PhysicalAddress)
 This message is used by the currently active source to inform the TV that it has no video to be presented to the user, or is going into standby as the result of a lcoal user command on the device.

tmErrorCode_t tmdlHdmiCecMenuRequest (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECMenuRequestType_t MenuRequestType)
 This message request from the TV for a device to show/remove a menu or to query if a device is currently showing a menu.

tmErrorCode_t tmdlHdmiCecMenuStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECMenuState_t MenuState)
 This message is used to indicate to the TV that the device is showing/has removed a menu and requets the remote control keys to be passed though.

tmErrorCode_t tmdlHdmiCecPlay (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECPlayMode_t PlayMode)
 This message is used to control the playback behaviour of a source device.

tmErrorCode_t tmdlHdmiCecPollingMessage (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used by any device for device discovery - similar to ping in other protocols.

tmErrorCode_t tmdlHdmiCecRecordOff (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message request a device to stop a recording.

tmErrorCode_t tmdlHdmiCecRecordOnAnalogueService (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType, UInt16 AnalogueFrequency, tmdlHdmiCECBroadcastSystem_t BroadcastSystem)
 This message attempt to record analogue source.

tmErrorCode_t tmdlHdmiCecRecordOnDigitalService (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification)
 This message attempt to record digital source.

tmErrorCode_t tmdlHdmiCecRecordOnExternalPhysicalAddress (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECExternalPhysicalAddress_t ExternalPhysicalAddress)
 This message attempt to record an external physical address source.

tmErrorCode_t tmdlHdmiCecRecordOnExternalPlug (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECExternalPlug_t ExternalPlug)
 This message attempt to record an external plug source.

tmErrorCode_t tmdlHdmiCecRecordOnOwnSource (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message attempt to record an external plug source.

tmErrorCode_t tmdlHdmiCecRecordStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECRecordStatusInfo_t RecordStatusInfo)
 This message is used by a recording device to inform the initiator of the message <Record On> about its status.

tmErrorCode_t tmdlHdmiCecRecordTvScreen (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message request by the recording device to record the presently displayed source.

tmErrorCode_t tmdlHdmiCecReportAudioStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, ptmdlHdmiCECAudioStatus_t pAudioStatus)
 This message report an amplifier's volume and mute.

tmErrorCode_t tmdlHdmiCecReportShortAudioDescriptor (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt32 ShortAudioDecriptor)
tmErrorCode_t tmdlHdmiCecRequestShortAudioDescriptor (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 AudioFormatID, UInt8 AudioFormatCode)
tmErrorCode_t tmdlHdmiCecIniateARC (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecReportArcInitiated (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecReportArcTerminated (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecRequestArcInitiation (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecRequestArcTerminiation (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecTerminateARC (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
tmErrorCode_t tmdlHdmiCecReportPhysicalAddress (tmInstance_t Instance, UInt16 PhysicalAddress, tmdlHdmiCECDeviceType_t DeviceType)
 This message is used to inform all other devices of the mapping between physical and logical address of the initiator.

tmErrorCode_t tmdlHdmiCecReportPowerStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECPowerStatus_t PowerStatus)
 This message is used to inform a requesting device of the current power status.

tmErrorCode_t tmdlHdmiCecRequestActiveSource (tmInstance_t Instance)
 This message is used by a new device to discover the status of the system.

tmErrorCode_t tmdlHdmiCecRoutingChange (tmInstance_t Instance, UInt16 OriginalAddress, UInt16 NewAddress)
 This message is sent by a CEC switch when it is manually switched to inform all other devices on the network that the active route below the switch has changed.

tmErrorCode_t tmdlHdmiCecRoutingInformation (tmInstance_t Instance, UInt16 PhysicalAddress)
 This message is sent by a CEC switch to indicate the active route below the switch.

tmErrorCode_t tmdlHdmiCecSelectAnalogueService (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType, UInt16 AnalogueFrequency, tmdlHdmiCECBroadcastSystem_t BroadcastSystem)
 This message select directly an analogue TV Service.

tmErrorCode_t tmdlHdmiCecSelectDigitalService (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, ptmdlHdmiCECDigitalServiceIdentification_t pServiceIdentification)
 This message select directly a digital TV, Radio or Data Broadcast Service.

tmErrorCode_t tmdlHdmiCecSetAnalogueTimer (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType, UInt16 AnalogueFrequency, tmdlHdmiCECBroadcastSystem_t BroadcastSystem)
 This message is used to set asingle timer block on an analogue recording device.

tmErrorCode_t tmdlHdmiCecSetAudioRate (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECAudioRate_t AudioRate)
 This message is used to control audio rate from Source device.

tmErrorCode_t tmdlHdmiCecSetDigitalTimer (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification)
 This message is used to set a digital timer block on a digital recording device.

tmErrorCode_t tmdlHdmiCecSetExternalTimerWithExternalPlug (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECExternalPlug_t ExternalPlug)
 This message is used to set a single timer block to record from an external device.

tmErrorCode_t tmdlHdmiCecSetExternalTimerWithPhysicalAddress (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 DayOfMonth, UInt8 MonthOfYear, UInt16 StartTime, tmdlHdmiCECDuration_t *pDuration, UInt8 RecordingSequence, tmdlHdmiCECExternalPhysicalAddress_t ExternalPhysicalAddress)
 This message is used to set a single timer block to record from an external device.

tmErrorCode_t tmdlHdmiCecSetMenuLanguage (tmInstance_t Instance, const char *pLanguage)
 This message is used by a TV or another device to indicate the menu Language.

tmErrorCode_t tmdlHdmiCecSetOsdName (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, const char *pOsdName, UInt8 OsdNameLength)
 This message is used to set the preferred OSD name of a device for use in manus associated with that device.

tmErrorCode_t tmdlHdmiCecSetOsdString (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECDisplayControl_t DisplayControl, const char *pOsdString, UInt8 OsdStringLength)
 This message is used to send a test message to output on a TV.

tmErrorCode_t tmdlHdmiCecSetStreamPath (tmInstance_t Instance, UInt16 PhysicalAddress)
 This message is used by a TV to request a streaming path from the specified physical address.

tmErrorCode_t tmdlHdmiCecSetSystemAudioMode (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus)
 This message turn the system audio Mode ON or OFF.

tmErrorCode_t tmdlHdmiCecSetTimerProgramTitle (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, const char *pProgramTitleString, UInt8 ProgramTitleLength)
 This message is used to set the name of a program associated with a timer block.Sent directly after sending a <Set analogue Timer> or <Set Digital Timer> message. The name is then associated with that timer block.

tmErrorCode_t tmdlHdmiCecStandby (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message switches one or all devices into standby mode.Can be be used as a broadcast message o be addressed to a specific device.

tmErrorCode_t tmdlHdmiCecSystemAudioModeRequest (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt16 PhysicalAddress)
 A device implementing System Audio Control and which has volume control RC button(eg TV or STB) request to use System Audio Mode to the amplifier.

tmErrorCode_t tmdlHdmiCecSystemAudioModeStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus)
 Reports the current status of the System Audio Mode.

tmErrorCode_t tmdlHdmiCecTextViewOn (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message as <Image View On>, but should also remove any text, menus and PIP windows from the TV's display.

tmErrorCode_t tmdlHdmiCecTimerClearedStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECTimerClearedStatusData_t TimerClearedStatusData)
 This message is used to give the status of a <Cleared Analogue Timer>, <Clear Digital Timer> or <Clear External Timer> message.

tmErrorCode_t tmdlHdmiCecTimerStatus (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECTimerStatusData_t *pTimerStatusData)
 This message is used to send timer status to the initiator of a <Set Timer> message.

tmErrorCode_t tmdlHdmiCecTunerDeviceStatusAnalogue (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECRecordingFlag_t RecordingFlag, tmdlHdmiCECTunerDisplayInfo_t TunerDisplayInfo, tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType, UInt16 AnalogueFrequency, tmdlHdmiCECBroadcastSystem_t BroadcastSystem)
 This message is used by a tuner device to provide its status to the initiator of the <Give Tuner Device Status> message.

tmErrorCode_t tmdlHdmiCecTunerDeviceStatusDigital (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECRecordingFlag_t RecordingFlag, tmdlHdmiCECTunerDisplayInfo_t TunerDisplayInfo, ptmdlHdmiCECDigitalServiceIdentification_t pServiceIdentification)
 This message is used by a tuner device to provide its status to the initiator of the <Give Tuner Device Status> message.

tmErrorCode_t tmdlHdmiCecTunerStepDecrement (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used to tune to next lowest service in a tuner's service list.Can be used for PIP.

tmErrorCode_t tmdlHdmiCecTunerStepIncrement (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used to tune to next highest service in a tuner's service list.Can be used for PIP.

tmErrorCode_t tmdlHdmiCecUserControlPressed (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECUserRemoteControlCommand_t UICommand)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlPressedPlay (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECPlayMode_t PlayMode)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAudioInput (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 SelectAudioInput)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAVInput (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 SelectAVInput)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectMedia (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 SelectMedia)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlPressedTune (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, tmdlHdmiCECChannelIdentifier_t *pChannelIdentifier)
 This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

tmErrorCode_t tmdlHdmiCecUserControlReleased (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message is used to indicate that the user released a remote button The last one indicated by the <User Control Pressed> Message.

tmErrorCode_t tmdlHdmiCecVendorCommand (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 *pVendorSpecificData, UInt8 VendorSpecificDataLength)
 This message is allows vendor specific commands to be sent between two devices.

tmErrorCode_t tmdlHdmiCecVendorCommandWithID (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt32 VendorID, UInt8 *pVendorSpecificData, UInt8 VendorSpecificDataLength)
 This message is allows vendor specific commands to be sent between two devices or broadcast.

tmErrorCode_t tmdlHdmiCecVendorRemoteButtonDown (tmInstance_t Instance, UInt8 ReceiverLogicalAddress, UInt8 *pVendorSpecificRcCode, UInt8 VendorSpecificRcCodeLength)
 This message indicates that a remote control button has been depressed.

tmErrorCode_t tmdlHdmiCecVendorRemoteButtonUp (tmInstance_t Instance, UInt8 ReceiverLogicalAddress)
 This message indicates that a remote control button (the last button pressed indicated by the <Vendor remote button down > message) has been released.

tmErrorCode_t tmdlHdmiCecGetSWVersion (tmSWVersion_t *pSWVersion)
 Get the software version of the driver. This function is synchronous. This function is ISR friendly.

tmErrorCode_t tmdlHdmiCecGetNumberOfUnits (UInt32 *pUnitCount)
 Get the number of available CEC devices in the system. A unit directly represents a physical device. This function is synchronous. This function is ISR friendly.

tmErrorCode_t tmdlHdmiCecGetCapabilities (tmdlHdmiCecCapabilities_t *pCapabilities)
 Get the capabilities of unit 0. Capabilities are stored into a dedicated structure. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecGetCapabilitiesM (tmUnitSelect_t unit, tmdlHdmiCecCapabilities_t *pCapabilities)
 Get the capabilities of a specific unit. Capabilities are stored into a dedicated structure This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecOpen (tmInstance_t *pInstance)
 Open unit 0 of CEC driver and provides the instance number to the caller. Note that one unit of CEC represents one physical CEC device and that only one instance per unit can be opened. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecOpenM (tmInstance_t *pInstance, tmUnitSelect_t unit)
 Open a specific unit of CEC driver and provides the instance number to the caller. Note that one unit of CEC represents one physical CEC device and that only one instance per unit can be opened. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecClose (tmInstance_t instance)
 Close an instance of CEC driver. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecSetPowerState (tmInstance_t instance, tmPowerState_t powerState)
 Set the power state of an instance of the CEC device. ON state corresponds to a fully supplied, up and running device. Other modes correspond to the powerdown state of the device. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecGetPowerState (tmInstance_t instance, tmPowerState_t *pPowerState)
 Get the power state of an instance of the CEC device. ON state corresponds to a fully supplied, up and running device. Other modes correspond to the powerdown state of the device. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecInstanceConfig (tmInstance_t instance)
 Set the configuration of instance attributes. This function is required by DVP architecture rules but actually does nothing in this driver This function is synchronous. This function is ISR friendly.

tmErrorCode_t tmdlHdmiCecInstanceSetup (tmInstance_t instance, ptmdlHdmiCecInstanceSetup_t pSetupInfo)
 Setup the instance with its configuration parameters. This function allows basic instance configuration like Logical Address or device state. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecGetInstanceSetup (tmInstance_t instance, ptmdlHdmiCecInstanceSetup_t pSetupInfo)
 Get instance setup parameters.

tmErrorCode_t tmdlHdmiCecHandleInterrupt (tmInstance_t instance)
 Make device library handle an incoming interrupt. This function is used by application to tell the device library that the hardware sent an interrupt. It can also be used to poll the interrupt status of the device if the interrupt line is not physically connected to the CPU. This function is synchronous. This function is ISR friendly.

tmErrorCode_t tmdlHdmiCecRegisterCallbacks (tmInstance_t instance, ptmdlHdmiCecCallbackFunc_t pkCallback)
 Register event callbacks. Only one callback is registered through this API. This callback will received the type of event that occured throug a dedicated parameter and will be called as many times as there is pending events. This function is synchronous. This function is ISR friendly.

tmErrorCode_t tmdlHdmiCecSetLogicalAddress (tmInstance_t instance, tmdlHdmiCECLogicalAddress_t LogicalAddress)
tmErrorCode_t tmdlHdmiCecSetRetry (tmInstance_t instance, UInt8 NbRetry)
tmErrorCode_t getCecLastMessage (tmdlHdmiCecSaveMessage_t *pSaveMessage)
tmErrorCode_t tmdlHdmiCecEnableEvent (tmInstance_t instance, tmdlHdmiCecEvent_t event)
 This function allows enabling a specific event of devlib. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecDisableEvent (tmInstance_t instance, tmdlHdmiCecEvent_t event)
 This function allows disabling a specific event of devlib. This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecEnableCalibration (tmInstance_t instance, tmdlHdmiCecClockSource_t cecClockSource)
 This function enables calibration depending on CEC clock source This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecDisableCalibration (tmInstance_t instance)
 This function disable calibration depending on CEC clock source This function is synchronous. This function is not ISR friendly.

tmErrorCode_t tmdlHdmiCecSendMessage (tmInstance_t instance, UInt8 *pData, UInt16 lenData)
 This function allow to send a generic CEC message This function has to be used when CEC messages are construct in the middleware.

unsigned char tmdlHdmiCecGetRegister (tmInstance_t instance, UInt32 offset)
tmErrorCode_t tmdlHdmiCecSetRegister (tmInstance_t instance, UInt32 offset, UInt32 value)


Detailed Description

This provides interfaces description of CEC messages.

Version:
1.0
Date:
04/07/2007

\section refs Reference Documents TDA998X Driver - tmdlHdmiCec - SCS.doc

Note:
None.
HISTORY :
     Date          Modified by CRPRNr  TASKNr  Maintenance description
     -------------|-----------|-------|-------|-----------------------------------
     04/07/2007   |  F.G      |       |       | Creation.
     -------------|-----------|-------|-------|-----------------------------------
    

Definition in file tmdlHdmiCEC_Functions.h.


Function Documentation

tmErrorCode_t getCecLastMessage tmdlHdmiCecSaveMessage_t   pSaveMessage
 

tmErrorCode_t tmdlHdmiCecAbortMessage tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is reserved for testing purposes.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecActiveSource tmInstance_t    Instance,
UInt16    PhysicalAddress
 

This message is used by a new source to indicate that it has started to transmit a stream OR used in reponse to a <Request Active Source>.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  PhysicalAddress
Physical address of the device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent

tmErrorCode_t tmdlHdmiCecClearAnalogueTimer tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECAnalogueBroadcastType_t    AnalogueBroadcastType,
UInt16    AnalogueFrequency,
tmdlHdmiCECBroadcastSystem_t    BroadcastSystem
 

This message is used to clear an Analogue timer block of a device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType
"Cable,Sattellite,Terrestrial".
UInt16  AnalogueFrequency
Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).
tmdlHdmiCECBroadcastSystem_t  BroadcastSystem
Specify information about the colour system, the sound carrier and the IF-frequency.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecClearDigitalTimer tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECDigitalServiceIdentification_t   pServiceIdentification
 

This message is used to clear a digital timer block of a device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECDigitalServiceIdentification_t  *pServiceIdentification
Pointer to the structure Digital Service Identification
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecClearExternalTimerWithExternalPlug tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECExternalPlug_t    ExternalPlug
 

This message is used to clear a digital timer block of a device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECExternalPlug_t  ExternalPlug
indicates external plug number (1 to 255 )on the recording device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecClearExternalTimerWithPhysicalAddress tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECExternalPhysicalAddress_t    ExternalPhysicalAddress
 

This message is used to clear a digital timer block of a device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress
Defines the path between the TV an a device-thus giving it a physical address within the cluster.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecClose tmInstance_t    instance
 

Close an instance of CEC driver. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecDeckControl tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECDecControlMode_t    DeckControlMode
 

This message is used to conrol a device's media functions.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECDecControlMode_t  DeckControlMode
Used in message <Deck Control>
Note:
The "Skip Forward / Wind" and "Skip Reverse / Rewind" values are used for example in a DVD as next xhapter and previous chapter and in a VCR as wind and rewind.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecDeckStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECDecInfo_t    DeckInfo
 

This message is used to provide a deck's status to the initiator of the <Give Deck Status> message.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECDecInfo_t  DeckInfo
Information on the device's current status
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecDeviceVendorID tmInstance_t    Instance,
UInt32    VendorID
 

This message report the vendor ID of this device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt32  VendorID
Indentifier for a specific Vendor
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecDisableCalibration tmInstance_t    instance
 

This function disable calibration depending on CEC clock source This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.

tmErrorCode_t tmdlHdmiCecDisableEvent tmInstance_t    instance,
tmdlHdmiCecEvent_t    event
 

This function allows disabling a specific event of devlib. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
event  Event to disable
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecEnableCalibration tmInstance_t    instance,
tmdlHdmiCecClockSource_t    cecClockSource
 

This function enables calibration depending on CEC clock source This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
cecClockSource  CEC clock source
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecEnableEvent tmInstance_t    instance,
tmdlHdmiCecEvent_t    event
 

This function allows enabling a specific event of devlib. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
event  Event to enable
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecFeatureAbort tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECFeatureOpcode_t    FeatureOpcode,
tmdlHdmiCECAbortReason_t    AbortReason
 

This message is used as a reponse to indicate that the device does not support the requested message type, or that it cannot execute it at the present time.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECFeatureOpcode_t  FeatureOpcode
Opcode of the aborted message.
tmdlHdmiCECAbortReason_t  AbortReason
The reason why message cannot respond.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecGetCapabilities tmdlHdmiCecCapabilities_t   pCapabilities
 

Get the capabilities of unit 0. Capabilities are stored into a dedicated structure. This function is synchronous. This function is not ISR friendly.

Parameters:
pCapabilities  Pointer to the capabilities structure.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or the receiver instance is not initialised
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecGetCapabilitiesM tmUnitSelect_t    unit,
tmdlHdmiCecCapabilities_t   pCapabilities
 

Get the capabilities of a specific unit. Capabilities are stored into a dedicated structure This function is synchronous. This function is not ISR friendly.

Parameters:
unit  Unit to be probed.
pCapabilities  Pointer to the capabilities structure.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or the receiver instance is not initialised
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecGetCecVersion tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used by a device to enquire which version of CEC the target supports.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGetInstanceSetup tmInstance_t    instance,
ptmdlHdmiCecInstanceSetup_t    pSetupInfo
 

Get instance setup parameters.

Parameters:
instance  Instance identifier.
pSetupInfo  Pointer to the structure that will receive setup parameters This function is synchronous. This function is not ISR friendly.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent

tmErrorCode_t tmdlHdmiCecGetMenuLanguage tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is sent by a device capable of character generation (for OSD and Menus) to a TV in order to discover the currently selected Menu Language. Also used by a TV during installation to dicover the currently set menu language of other devices.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGetNumberOfUnits UInt32 *    pUnitCount
 

Get the number of available CEC devices in the system. A unit directly represents a physical device. This function is synchronous. This function is ISR friendly.

Parameters:
pUnitCount  Pointer to the number of available units.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent

tmErrorCode_t tmdlHdmiCecGetPowerState tmInstance_t    instance,
tmPowerState_t *    pPowerState
 

Get the power state of an instance of the CEC device. ON state corresponds to a fully supplied, up and running device. Other modes correspond to the powerdown state of the device. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
pPowerState  Pointer to the power state.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent

unsigned char tmdlHdmiCecGetRegister tmInstance_t    instance,
UInt32    offset
 

tmErrorCode_t tmdlHdmiCecGetSWVersion tmSWVersion_t *    pSWVersion
 

Get the software version of the driver. This function is synchronous. This function is ISR friendly.

Parameters:
pSWVersion  Pointer to the version structure
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent

tmErrorCode_t tmdlHdmiCecGiveAudioStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is requests an amplifier to send its volume and mute status.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveDeckStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECStatusRequest_t    StatusRequest
 

This message is used to request the status of a device regardless of whether or not it is the current active source.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECStatusRequest_t  StatusRequest
Allows the initiator to request the status once or on all future state change. Or to cancel a previous <Give Deck Status > ["On"] request.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveDevicePowerStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used to determine the current power status of a target device.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveDeviceVendorID tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is request the vendor ID from a device.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveOsdName tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used to request preferred OSD name of a device for use in menus associated with that device.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGivePhysicalAddress tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is a request to a device to return its physical Address.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveSystemAudioModeStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message request the status of the system audio mode.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecGiveTunerDeviceStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECStatusRequest_t    StatusRequest
 

This message is used to request the status of a tuner device.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECStatusRequest_t  StatusRequest
Allows the initiator to request the status once or on all future state change. Or to cancel a previous <Give Tuner Device Status > ["On"] request.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecHandleInterrupt tmInstance_t    instance
 

Make device library handle an incoming interrupt. This function is used by application to tell the device library that the hardware sent an interrupt. It can also be used to poll the interrupt status of the device if the interrupt line is not physically connected to the CPU. This function is synchronous. This function is ISR friendly.

Parameters:
instance  Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_HANDLE: the handle number is wrong
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_FULL: the queue is full

tmErrorCode_t tmdlHdmiCecImageViewOn tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message sent by a source device to the TV whenever it enters the active state.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receivers.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecInactiveSource tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECExternalPhysicalAddress_t    PhysicalAddress
 

This message is used by the currently active source to inform the TV that it has no video to be presented to the user, or is going into standby as the result of a lcoal user command on the device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress,
Address of message receiver.
tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress
Physical Address of the device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecIniateARC tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecInstanceConfig tmInstance_t    instance
 

Set the configuration of instance attributes. This function is required by DVP architecture rules but actually does nothing in this driver This function is synchronous. This function is ISR friendly.

Parameters:
instance  Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecInstanceSetup tmInstance_t    instance,
ptmdlHdmiCecInstanceSetup_t    pSetupInfo
 

Setup the instance with its configuration parameters. This function allows basic instance configuration like Logical Address or device state. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
pSetupInfo  Pointer to the structure containing all setup parameters
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecMenuRequest tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECMenuRequestType_t    MenuRequestType
 

This message request from the TV for a device to show/remove a menu or to query if a device is currently showing a menu.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECMenuRequestType_t  MenuRequestType
Indicates if the menu request is to activate or deactivate the devices menu or simply query the devices menu status.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecMenuStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECMenuState_t    MenuState
 

This message is used to indicate to the TV that the device is showing/has removed a menu and requets the remote control keys to be passed though.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECMenuState_t  MenuState
Indicates if the device is in the 'Device Menu Active' state or 'Device Menu Inactive' state.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecOpen tmInstance_t *    pInstance
 

Open unit 0 of CEC driver and provides the instance number to the caller. Note that one unit of CEC represents one physical CEC device and that only one instance per unit can be opened. This function is synchronous. This function is not ISR friendly.

Parameters:
pInstance  Pointer to the variable that will receive the instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or the receiver instance is not initialised
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_OWNED: the resource is already in use
  • TMDL_ERR_DLHDMICEC_INIT_FAILED: the unit instance is already initialised or something wrong happened at lower level.
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent
  • TMDL_ERR_DLHDMICEC_NO_RESOURCES: the resource is not available

tmErrorCode_t tmdlHdmiCecOpenM tmInstance_t *    pInstance,
tmUnitSelect_t    unit
 

Open a specific unit of CEC driver and provides the instance number to the caller. Note that one unit of CEC represents one physical CEC device and that only one instance per unit can be opened. This function is synchronous. This function is not ISR friendly.

Parameters:
pInstance  Pointer to the structure that will receive the instance identifier.
unit  Unit number to be opened.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or the receiver instance is not initialised
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_OWNED: the resource is already in use
  • TMDL_ERR_DLHDMICEC_INIT_FAILED: the unit instance is already initialised or something wrong happened at lower level.
  • TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is inconsistent
  • TMDL_ERR_DLHDMICEC_NO_RESOURCES: the resource is not available

tmErrorCode_t tmdlHdmiCecPlay tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECPlayMode_t    PlayMode
 

This message is used to control the playback behaviour of a source device.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECPlayMode_t  PlayMode
In which mode to play media.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecPollingMessage tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used by any device for device discovery - similar to ping in other protocols.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecRecordOff tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message request a device to stop a recording.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecRecordOnAnalogueService tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECAnalogueBroadcastType_t    AnalogueBroadcastType,
UInt16    AnalogueFrequency,
tmdlHdmiCECBroadcastSystem_t    BroadcastSystem
 

This message attempt to record analogue source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType
"Cable,Sattellite,Terrestrial".
UInt16  AnalogueFrequency
Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).
tmdlHdmiCECBroadcastSystem_t  BroadcastSystem
Specify information about the colour system, the sound carrier and the IF-frequency.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordOnDigitalService tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECDigitalServiceIdentification_t   pServiceIdentification
 

This message attempt to record digital source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECDigitalServiceIdentification_t  *pServiceIdentification
Pointer to the structure Digital Service Identification
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordOnExternalPhysicalAddress tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECExternalPhysicalAddress_t    ExternalPhysicalAddress
 

This message attempt to record an external physical address source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress
Defines the path between the TV an a device-thus giving it a physical address within the cluster.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordOnExternalPlug tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECExternalPlug_t    ExternalPlug
 

This message attempt to record an external plug source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECExternalPlug_t  ExternalPlug
indicates external plug number (1 to 255 )on the recording device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordOnOwnSource tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message attempt to record an external plug source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECRecordStatusInfo_t    RecordStatusInfo
 

This message is used by a recording device to inform the initiator of the message <Record On> about its status.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECRecordStatusInfo_t  RecordStatusInfo
The recording status of the device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRecordTvScreen tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message request by the recording device to record the presently displayed source.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecRegisterCallbacks tmInstance_t    instance,
ptmdlHdmiCecCallbackFunc_t    pkCallback
 

Register event callbacks. Only one callback is registered through this API. This callback will received the type of event that occured throug a dedicated parameter and will be called as many times as there is pending events. This function is synchronous. This function is ISR friendly.

Parameters:
instance  Instance identifier.
pCallback  Pointer to the callback function that will handle events from the devlib.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_INVALID_STATE: the state is invalid for the function

tmErrorCode_t tmdlHdmiCecReportArcInitiated tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecReportArcTerminated tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecReportAudioStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
ptmdlHdmiCECAudioStatus_t    pAudioStatus
 

This message report an amplifier's volume and mute.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECAudioStatus_t  AudioStatus
Volume and mute status.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecReportPhysicalAddress tmInstance_t    Instance,
UInt16    PhysicalAddress,
tmdlHdmiCECDeviceType_t    DeviceType
 

This message is used to inform all other devices of the mapping between physical and logical address of the initiator.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  PhysicalAddress
Device physical address within the cluster.
tmdlHdmiCECDeviceType_t  DeviceType
Type of the device (TV, Playback, tuner,...).
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecReportPowerStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECPowerStatus_t    PowerStatus
 

This message is used to inform a requesting device of the current power status.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECPowerStatus_t  PowerStatus
Current power status.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecReportShortAudioDescriptor tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt32    ShortAudioDecriptor
 

tmErrorCode_t tmdlHdmiCecRequestActiveSource tmInstance_t    Instance
 

This message is used by a new device to discover the status of the system.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecRequestArcInitiation tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecRequestArcTerminiation tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecRequestShortAudioDescriptor tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    AudioFormatID,
UInt8    AudioFormatCode
 

tmErrorCode_t tmdlHdmiCecRoutingChange tmInstance_t    Instance,
UInt16    OriginalAddress,
UInt16    NewAddress
 

This message is sent by a CEC switch when it is manually switched to inform all other devices on the network that the active route below the switch has changed.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  OriginalAddress
Previous address that the switch was switched to.
UInt16  NewAddress
The new address it has been moved to.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecRoutingInformation tmInstance_t    Instance,
UInt16    PhysicalAddress
 

This message is sent by a CEC switch to indicate the active route below the switch.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  PhysicalAddress
The current active route to the sink in the CEC switch.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSelectAnalogueService tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECAnalogueBroadcastType_t    AnalogueBroadcastType,
UInt16    AnalogueFrequency,
tmdlHdmiCECBroadcastSystem_t    BroadcastSystem
 

This message select directly an analogue TV Service.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType
"Cable,Sattellite,Terrestrial".
UInt16  AnalogueFrequency
Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).
tmdlHdmiCECBroadcastSystem_t  BroadcastSystem
Specify information about the colour system, the sound carrier and the IF-frequency.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSelectDigitalService tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
ptmdlHdmiCECDigitalServiceIdentification_t    pServiceIdentification
 

This message select directly a digital TV, Radio or Data Broadcast Service.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECDigitalServiceIdentification_t  *pServiceIdentification
Pointer to the structure Digital Service Identification
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSendMessage tmInstance_t    instance,
UInt8 *    pData,
UInt16    lenData
 

This function allow to send a generic CEC message This function has to be used when CEC messages are construct in the middleware.

Parameters:
instance  Instance identifier.
pData  Pointer to the CEC data buffer
lenData  Lenght of I2C data buffer
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecSetAnalogueTimer tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECAnalogueBroadcastType_t    AnalogueBroadcastType,
UInt16    AnalogueFrequency,
tmdlHdmiCECBroadcastSystem_t    BroadcastSystem
 

This message is used to set asingle timer block on an analogue recording device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType
"Cable,Sattellite,Terrestrial".
UInt16  AnalogueFrequency
Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).
tmdlHdmiCECBroadcastSystem_t  BroadcastSystem
Specify information about the colour system, the sound carrier and the IF-frequency.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetAudioRate tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECAudioRate_t    AudioRate
 

This message is used to control audio rate from Source device.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECAudioRate_t  AudioRate
The audio rate requested.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetDigitalTimer tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECDigitalServiceIdentification_t   pServiceIdentification
 

This message is used to set a digital timer block on a digital recording device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECDigitalServiceIdentification_t  *pServiceIdentification
Pointer to the structure Digital Service Identification
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetExternalTimerWithExternalPlug tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECExternalPlug_t    ExternalPlug
 

This message is used to set a single timer block to record from an external device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECExternalPlug_t  ExternalPlug
indicates external plug number (1 to 255 )on the recording device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetExternalTimerWithPhysicalAddress tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    DayOfMonth,
UInt8    MonthOfYear,
UInt16    StartTime,
tmdlHdmiCECDuration_t   pDuration,
UInt8    RecordingSequence,
tmdlHdmiCECExternalPhysicalAddress_t    ExternalPhysicalAddress
 

This message is used to set a single timer block to record from an external device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  DayOfMonth
Day of the month.
UInt8  MonthOfYear
Month of the year.
UInt16  StartTime
Start time for a timer based recording.
UInt16  Duration
Pointer to the structure tmdlHdmiCECDuration_t in BCD format.
UInt8  Recording Sequence
Indicates if recording is repeated and, if so, on which day For repeated recording the recording sequence value is the bitwise OR of the days when recordings are required Shall be set to 0x00 when recording is not repeated.
tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress
Defines the path between the TV an a device-thus giving it a physical address within the cluster.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetLogicalAddress tmInstance_t    instance,
tmdlHdmiCECLogicalAddress_t    LogicalAddress
 

tmErrorCode_t tmdlHdmiCecSetMenuLanguage tmInstance_t    Instance,
const char *    pLanguage
 

This message is used by a TV or another device to indicate the menu Language.

Parameters:
tmInstance_t  Instance
Instance identifier.
const  char *pLanguage
Pointer on the user's menu language choice.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetOsdName tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
const char *    pOsdName,
UInt8    OsdNameLength
 

This message is used to set the preferred OSD name of a device for use in manus associated with that device.

Parameters:
tmInstance_t  Instance
Instance identifier.
const  char *pOsdName
Pointer on the preferred name of the device.
UInt8  OsdNameLength
Length of Osd Name String.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetOsdString tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECDisplayControl_t    DisplayControl,
const char *    pOsdString,
UInt8    OsdStringLength
 

This message is used to send a test message to output on a TV.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECDisplayControl_t  DisplayControl
Display timing.
const  char *pOsdString
Pointer on the Text to display.
UInt8  OsdStringLength
Length of Osd String.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetPowerState tmInstance_t    instance,
tmPowerState_t    powerState
 

Set the power state of an instance of the CEC device. ON state corresponds to a fully supplied, up and running device. Other modes correspond to the powerdown state of the device. This function is synchronous. This function is not ISR friendly.

Parameters:
instance  Instance identifier.
powerState  Power state to set.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetRegister tmInstance_t    instance,
UInt32    offset,
UInt32    value
 

tmErrorCode_t tmdlHdmiCecSetRetry tmInstance_t    instance,
UInt8    NbRetry
 

tmErrorCode_t tmdlHdmiCecSetStreamPath tmInstance_t    Instance,
UInt16    PhysicalAddress
 

This message is used by a TV to request a streaming path from the specified physical address.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  PhysicalAddress
Physical address of the device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetSystemAudioMode tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECSystemAudioStatus_t    SystemAudioStatus
 

This message turn the system audio Mode ON or OFF.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECSystemAudioStatus_t  SystemAudioStatus
Specifies if the system audio mode is ON or OFF.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSetTimerProgramTitle tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
const char *    pProgramTitleString,
UInt8    ProgramTitleLength
 

This message is used to set the name of a program associated with a timer block.Sent directly after sending a <Set analogue Timer> or <Set Digital Timer> message. The name is then associated with that timer block.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
const  char *pProgramTitleString
Pointer on the program title.
UInt8  ProgramTitleLength
Length of Program Title String.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecStandby tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message switches one or all devices into standby mode.Can be be used as a broadcast message o be addressed to a specific device.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSystemAudioModeRequest tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt16    PhysicalAddress
 

A device implementing System Audio Control and which has volume control RC button(eg TV or STB) request to use System Audio Mode to the amplifier.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt16  PhysicalAddress
Physical address of the device.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecSystemAudioModeStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECSystemAudioStatus_t    SystemAudioStatus
 

Reports the current status of the System Audio Mode.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECSystemAudioStatus_t  SystemAudioStatus
Current system audio mode.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range

tmErrorCode_t tmdlHdmiCecTerminateARC tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

tmErrorCode_t tmdlHdmiCecTextViewOn tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message as <Image View On>, but should also remove any text, menus and PIP windows from the TV's display.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTimerClearedStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECTimerClearedStatusData_t    TimerClearedStatusData
 

This message is used to give the status of a <Cleared Analogue Timer>, <Clear Digital Timer> or <Clear External Timer> message.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECTimerClearedStatusData_t  TimerClearedStatusData
Indicates if the timer was cleared successfully.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTimerStatus tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECTimerStatusData_t   pTimerStatusData
 

This message is used to send timer status to the initiator of a <Set Timer> message.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECTimerStatusData_t  *pTimerStatusData
Pointer on the Timer status.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTunerDeviceStatusAnalogue tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECRecordingFlag_t    RecordingFlag,
tmdlHdmiCECTunerDisplayInfo_t    TunerDisplayInfo,
tmdlHdmiCECAnalogueBroadcastType_t    AnalogueBroadcastType,
UInt16    AnalogueFrequency,
tmdlHdmiCECBroadcastSystem_t    BroadcastSystem
 

This message is used by a tuner device to provide its status to the initiator of the <Give Tuner Device Status> message.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECRecordingFlag_t  RecordingFlag
Indicates if the tuner is being used as a source of a recording.
tmdlHdmiCECTunerDisplayInfo_t  TunerDisplayInfo
Indicates if the the device is currently deplaying its tuner or not.
tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType
"Cable,Sattellite,Terrestrial".
UInt16  AnalogueFrequency
Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).
tmdlHdmiCECBroadcastSystem_t  BroadcastSystem
Specify information about the colour system, the sound carrier and the IF-frequency.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTunerDeviceStatusDigital tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECRecordingFlag_t    RecordingFlag,
tmdlHdmiCECTunerDisplayInfo_t    TunerDisplayInfo,
ptmdlHdmiCECDigitalServiceIdentification_t    pServiceIdentification
 

This message is used by a tuner device to provide its status to the initiator of the <Give Tuner Device Status> message.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECRecordingFlag_t  RecordingFlag
Indicates if the tuner is being used as a source of a recording.
tmdlHdmiCECTunerDisplayInfo_t  TunerDisplayInfo
Indicates if the the device is currently deplaying its tuner or not.
tmdlHdmiCECDigitalServiceIdentification_t  *pServiceIdentification
Pointer to the structure Digital Service Identification
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTunerStepDecrement tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used to tune to next lowest service in a tuner's service list.Can be used for PIP.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecTunerStepIncrement tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used to tune to next highest service in a tuner's service list.Can be used for PIP.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressed tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECUserRemoteControlCommand_t    UICommand
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECUserRemoteControlCommand_t  UICommand
Relevant UI command issued by user.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressedPlay tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECPlayMode_t    PlayMode
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECPlayMode_t  PlayMode
In which mode to play media.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAudioInput tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    SelectAudioInput
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  SelectAudioInput
Number of the Audio Input (Audio input number between 1 and 255).
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAVInput tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    SelectAVInput
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  SelectAVInput
Number of the A/V Input (A/V input number between 1 and 255).
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressedSelectMedia tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8    SelectMedia
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  SelectMedia
Number of Media (Media number between 1 and 255).
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlPressedTune tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECChannelIdentifier_t   pChannelIdentifier
 

This message is used to indicate that the user pressed a remote button or switched from one remote control button to another.

Parameters:
tmInstance_t  Instance
Instance identifier.
tmdlHdmiCECChannelIdentifier_t  *pChannelIdentifier
Pointer to the structure of Major and Minor Channel number
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecUserControlReleased tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message is used to indicate that the user released a remote button The last one indicated by the <User Control Pressed> Message.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecVendorCommand tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8 *    pVendorSpecificData,
UInt8    VendorSpecificDataLength
 

This message is allows vendor specific commands to be sent between two devices.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  *pVendorSpecificData
Pointer to the Vendor Specific datas
UInt8  VendorSpecificDataLength
Length of VendorSpecificData.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecVendorCommandWithID tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt32    VendorID,
UInt8 *    pVendorSpecificData,
UInt8    VendorSpecificDataLength
 

This message is allows vendor specific commands to be sent between two devices or broadcast.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt32  VendorID
Indentifier for a specific Vendor
UInt8  *pVendorSpecificData
Pointer to the Vendor Specific datas
UInt8  VendorSpecificDataLength
Length of VendorSpecificData.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecVendorRemoteButtonDown tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
UInt8 *    pVendorSpecificRcCode,
UInt8    VendorSpecificRcCodeLength
 

This message indicates that a remote control button has been depressed.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  *pVendorSpecificRcCode
Pointer to the Vendor Specific remote control code. its recommended t keep this to a minimum size. The maximum length shall not exceed 14 data blocks to avoid saturating bus
UInt8  VendorSpecificRcCodeLength
Length of VendorSpecificRcCode.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecVendorRemoteButtonUp tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress
 

This message indicates that a remote control button (the last button pressed indicated by the <Vendor remote button down > message) has been released.

Parameters:
tmInstance_t  Instance
Instance identifier.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own the resource

tmErrorCode_t tmdlHdmiCecVersion tmInstance_t    Instance,
UInt8    ReceiverLogicalAddress,
tmdlHdmiCECVersion_t    CECVersion
 

This message is used to indicate the supported CEC version in response to a <Get CEC Version>.

Parameters:
tmInstance_t  Instance
Instance identifier.
UInt8  ReceiverLogicalAddress
Address of message receiver.
tmdlHdmiCECVersion_t  CECVersion
Supported CEC Version.
Returns:
The call result:
  • TM_OK: the call was successful
  • TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or out of range
  • TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out of range


Hdmi version Tx_4.26 - Generated on Tue Jan 26 09:25:06 2010 - tmdmHdmiCEC component API
PHILIPS