#include "tmNxTypes.h"
#include "tmdlHdmiTx_Types.h"
Include dependency graph for tmdlHdmiTx_Functions.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Functions | |
tmErrorCode_t | tmdlHdmiTxGetSWVersion (tmSWVersion_t *pSWVersion) |
Get the software version of the driver. | |
tmErrorCode_t | tmdlHdmiTxGetNumberOfUnits (UInt32 *pUnitCount) |
Get the number of available HDMI transmitters devices in the system. A unit directly represents a physical device. | |
tmErrorCode_t | tmdlHdmiTxGetCapabilities (tmdlHdmiTxCapabilities_t *pCapabilities) |
Get the capabilities of unit 0. Capabilities are stored into a dedicated structure and are directly read from the HW device. | |
tmErrorCode_t | tmdlHdmiTxGetCapabilitiesM (tmUnitSelect_t unit, tmdlHdmiTxCapabilities_t *pCapabilities) |
Get the capabilities of a specific unit. Capabilities are stored into a dedicated structure and are directly read from the HW device. | |
tmErrorCode_t | tmdlHdmiTxOpen (tmInstance_t *pInstance) |
Open unit 0 of HdmiTx driver and provides the instance number to the caller. Note that one unit of HdmiTx represents one physical HDMI transmitter and that only one instance per unit can be opened. | |
tmErrorCode_t | tmdlHdmiTxOpenM (tmInstance_t *pInstance, tmUnitSelect_t unit) |
Open a specific unit of HdmiTx driver and provides the instance number to the caller. Note that one unit of HdmiTx represents one physical HDMI transmitter and that only one instance per unit can be opened. This function switches driver's state machine to "initialized" state. | |
tmErrorCode_t | tmdlHdmiTxClose (tmInstance_t instance) |
Close an instance of HdmiTx driver. | |
tmErrorCode_t | tmdlHdmiTxSetPowerState (tmInstance_t instance, tmPowerState_t powerState) |
Set the power state of an instance of the HDMI transmitter. | |
tmErrorCode_t | tmdlHdmiTxGetPowerState (tmInstance_t instance, tmPowerState_t *pPowerState) |
Get the power state of an instance of the HDMI transmitter. | |
tmErrorCode_t | tmdlHdmiTxInstanceConfig (tmInstance_t instance) |
Set the configuration of instance attributes. This function is required by DVP architecture rules but actually does nothing in this driver. | |
tmErrorCode_t | tmdlHdmiTxInstanceSetup (tmInstance_t instance, tmdlHdmiTxInstanceSetupInfo_t *pSetupInfo) |
Setup the instance with its configuration parameters. This function allows basic instance configuration like enabling HDCP, choosing HDCP encryption mode or enabling HDCP repeater mode. | |
tmErrorCode_t | tmdlHdmiTxGetInstanceSetup (tmInstance_t instance, tmdlHdmiTxInstanceSetupInfo_t *pSetupInfo) |
Get instance setup parameters. | |
tmErrorCode_t | tmdlHdmiTxHandleInterrupt (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. | |
tmErrorCode_t | tmdlHdmiTxRegisterCallbacks (tmInstance_t instance, ptmdlHdmiTxCallback_t pCallback) |
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 | tmdlHdmiTxEnableEvent (tmInstance_t instance, tmdlHdmiTxEvent_t event) |
This function allows enabling a specific event. By default, all events are disabled, except input lock. | |
tmErrorCode_t | tmdlHdmiTxDisableEvent (tmInstance_t instance, tmdlHdmiTxEvent_t event) |
This function allows disabling a specific event. By default, all events are disabled, except input lock. | |
tmErrorCode_t | tmdlHdmiTxGetVideoFormatSpecs (tmInstance_t instance, tmdlHdmiTxVidFmt_t resolutionID, tmdlHdmiTxVidFmtSpecs_t *pResolutionSpecs) |
Get specifications of a given video format. Application can use this function to retreives all specifications (frequencies, resolution, etc.) of a given IA/CEA 861-D video format. This function is synchronous. This function is ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetInputOutput (tmInstance_t instance, tmdlHdmiTxVideoInConfig_t videoInputConfig, tmdlHdmiTxVideoOutConfig_t videoOutputConfig, tmdlHdmiTxAudioInConfig_t audioInputConfig, tmdlHdmiTxSinkType_t sinkType) |
Configures all input and output parameters : format, modes, rates, etc. This is the main configuration function of the driver. Here are transmitted all crucial input and output parameters of the device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetAudioInput (tmInstance_t instance, tmdlHdmiTxAudioInConfig_t audioInputConfig, tmdlHdmiTxSinkType_t sinkType) |
Configures audio input parameters : format, rate, etc. This function is similar to tmdlHdmiTxSetInputOutput except that video is not reconfigured. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetVideoInfoframe (tmInstance_t instance, Bool enable, tmdlHdmiTxAviIfData_t *pAviIfData) |
Defines the content of AVI infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetAudioInfoframe (tmInstance_t instance, Bool enable, tmdlHdmiTxAudIfData_t *pAudIfData) |
Defines the content of AUD infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetACPPacket (tmInstance_t instance, Bool enable, tmdlHdmiTxAcpPktData_t *pAcpPktData) |
Defines the content of the audio content protection packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetGeneralControlPacket (tmInstance_t instance, Bool enable, tmdlHdmiTxGcpPktData_t *pGcpPktData) |
Defines the content of the General Control packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetISRC1Packet (tmInstance_t instance, Bool enable, tmdlHdmiTxIsrc1PktData_t *pIsrc1PktData) |
Defines the content of ISRC1 packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetISRC2Packet (tmInstance_t instance, Bool enable, tmdlHdmiTxIsrc2PktData_t *pIsrc2PktData) |
Defines the content of ISRC2 packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetMPSInfoframe (tmInstance_t instance, Bool enable, tmdlHdmiTxMpsIfData_t *pMpsIfData) |
Defines the content of MPS infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetSpdInfoframe (tmInstance_t instance, Bool enable, tmdlHdmiTxSpdIfData_t *pSpdIfData) |
Defines the content of SPD infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetVsInfoframe (tmInstance_t instance, Bool enable, tmdlHdmiTxVsPktData_t *pVsIfData) |
Defines the content of VS infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxDebugSetNullPacket (tmInstance_t instance, Bool enable) |
Enables/disables NULL packet sending (only used for debug purpose). This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxDebugSetSingleNullPacket (tmInstance_t instance) |
Send one single NULL packet (only used for debug purpose). This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetAudioMute (tmInstance_t instance, Bool audioMute) |
Set the audio output mute status. This function can be used to mute audio output, without muting video. This can be typically used when reconfiguring the audio HW after a sample rate change. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxResetAudioCts (tmInstance_t instance) |
Reset audio CTS. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidStatus (tmInstance_t instance, tmdlHdmiTxEdidStatus_t *pEdidStatus, UInt8 *pEdidBlkCount) |
Retrieve EDID Status from driver. This function is synchronous. This function is ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidAudioCaps (tmInstance_t instance, tmdlHdmiTxEdidAudioDesc_t *pAudioDescs, UInt maxAudioDescs, UInt *pWrittenAudioDescs, UInt8 *pAudioFlags) |
Retrieves audio descriptors from receiver's EDID. This function parses the EDID of Tx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidVideoCaps (tmInstance_t instance, tmdlHdmiTxShortVidDesc_t *pVideoDesc, UInt maxVideoFormats, UInt *pWrittenVideoFormats, UInt8 *pVideoFlags) |
Retrieves supported video formats (short descriptors) from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidVideoPreferred (tmInstance_t instance, tmdlHdmiTxEdidVideoTimings_t *pNativeVideoFormat) |
Retrieves supported video formats (short descriptors) from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidSinkType (tmInstance_t instance, tmdlHdmiTxSinkType_t *pSinkType) |
Retrieves the sink type from receiver's EDID (HDMI or DVI). This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidSourceAddress (tmInstance_t instance, UInt16 *pSourceAddress) |
Retrieves source address from receivers's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetKsvList (tmInstance_t instance, UInt8 *pKsv, UInt8 maxKsv, UInt8 *pWrittenKsv, UInt8 *pDepth, Bool *pMaxCascExd, Bool *pMaxDevsExd) |
Retreives KSV list received by Tx device. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetHdcp (tmInstance_t instance, Bool hdcpEnable) |
Enable/Disable HDCP encryption. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetHdcpState (tmInstance_t instance, tmdlHdmiTxHdcpCheck_t *pHdcpCheckState) |
Get the driver HDCP state. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxHdcpCheck (tmInstance_t instance, UInt16 timeSinceLastCall) |
Check the result of an HDCP encryption attempt, called at intervals (set by timeSinceLastCall) after tmdlHdmiTxSetHdcp(true). This API must be used only in case of No Operating System. if OS, this is manage internally of this device library. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetGamutPacket (tmInstance_t instance, Bool enable, tmdlHdmiTxGamutData_t *pGamutData) |
This function loads a gamut metadata packet into the HW. HW will actually send it at the beginning of next VS, during the vertical blanking. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidDetailledTimingDescriptors (tmInstance_t instance, tmdlHdmiTxEdidVideoTimings_t *pDTDescriptors, UInt8 maxDTDesc, UInt8 *pWrittenDTDesc) |
Retrieves supported detailled video descriptors from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidMonitorDescriptors (tmInstance_t instance, tmdlHdmiTxEdidFirstMD_t *pEdidFirstMD, tmdlHdmiTxEdidSecondMD_t *pEdidSecondMD, tmdlHdmiTxEdidOtherMD_t *pEdidOtherMD, UInt8 maxOtherMD, UInt8 *pWrittenOtherMD) |
Retrieves supported monitor descriptor from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetEdidTVPictureRatio (tmInstance_t instance, tmdlHdmiTxPictAspectRatio_t *pEdidTvPictureRatio) |
Retrieves TV picture ratio from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetHDCPRevocationList (tmInstance_t instance, void *listPtr, UInt32 length) |
tmErrorCode_t | tmdlHdmiTxGetHdcpFailStatus (tmInstance_t instance, tmdlHdmiTxHdcpStatus_t *pHdcpStatus, UInt8 *pRawStatus) |
Retreives current HDCP link status. This function is typically used when an "HDCP INACTIVE" event is received to know why HDCP is INACTIVE. | |
tmErrorCode_t | tmdlHdmiTxGetEdidLatencyInfo (tmInstance_t instance, tmdlHdmiTxEdidLatency_t *pLatency) |
Retrieves latency information from receiver's EDID. This function is synchronous. This function is not ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxSetBScreen (tmInstance_t instance, tmdlHdmiTxTestPattern_t pattern) |
tmErrorCode_t | tmdlHdmiTxRemoveBScreen (tmInstance_t instance) |
tmdlHdmiTxVidFmt_t | tmdlHdmiTxConvertDTDtoCEA (tmInstance_t instance, tmdlHdmiTxEdidVideoTimings_t *pDTDescriptors) |
tmErrorCode_t | tmdlHdmiTxGetHPDStatus (tmInstance_t instance, tmdlHdmiTxHotPlug_t *pHPDStatus) |
Retrieve HPD status from driver. This function is synchronous. This function is ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxGetRXSenseStatus (tmInstance_t instance, tmdlHdmiTxRxSense_t *pRXSenseStatus) |
Retrieve RXSense status from driver. This function is synchronous. This function is ISR friendly. | |
tmErrorCode_t | tmdlHdmiTxTmdsSetOutputsMute (tmInstance_t instance, Bool muteTmdsOut) |
Copyright (C) 2007 NXP N.V., All Rights Reserved. This source code and any compilation or derivative thereof is the proprietary information of NXP N.V. and is confidential in nature. Under no circumstances is this software to be exposed to or placed under an Open Source License of any type without the expressed written permission of NXP N.V.
\section refs Reference Documents HDMI Tx Driver - FRS.doc, HDMI Tx Driver - tmdlHdmiTx - SCS.doc
\section info Change Information
$History: tmdlHdmiTx_Functions.h $ * * ***************** Version 1 ***************** * User: Demoment Date: 02/08/07 Time: 8:32 * Updated in $/Source/tmdlHdmiTx/inc * initial version *
Definition in file tmdlHdmiTx_Functions.h.
|
Close an instance of HdmiTx driver.
|
|
|
|
Enables/disables NULL packet sending (only used for debug purpose). This function is synchronous. This function is not ISR friendly.
|
|
Send one single NULL packet (only used for debug purpose). This function is synchronous. This function is not ISR friendly.
|
|
This function allows disabling a specific event. By default, all events are disabled, except input lock.
|
|
This function allows enabling a specific event. By default, all events are disabled, except input lock.
|
|
Get the capabilities of unit 0. Capabilities are stored into a dedicated structure and are directly read from the HW device.
|
|
Get the capabilities of a specific unit. Capabilities are stored into a dedicated structure and are directly read from the HW device.
|
|
Retrieves audio descriptors from receiver's EDID. This function parses the EDID of Tx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves supported detailled video descriptors from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves latency information from receiver's EDID. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves supported monitor descriptor from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves the sink type from receiver's EDID (HDMI or DVI). This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves source address from receivers's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieve EDID Status from driver. This function is synchronous. This function is ISR friendly.
|
|
Retrieves TV picture ratio from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves supported video formats (short descriptors) from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retrieves supported video formats (short descriptors) from receiver's EDID. This function parses the EDID of Rx device to get the relevant data. This function is synchronous. This function is not ISR friendly.
|
|
Retreives current HDCP link status. This function is typically used when an "HDCP INACTIVE" event is received to know why HDCP is INACTIVE.
|
|
Get the driver HDCP state. This function is synchronous. This function is not ISR friendly.
|
|
Retrieve HPD status from driver. This function is synchronous. This function is ISR friendly.
|
|
Get instance setup parameters.
|
|
Retreives KSV list received by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Get the number of available HDMI transmitters devices in the system. A unit directly represents a physical device.
|
|
Get the power state of an instance of the HDMI transmitter.
|
|
Retrieve RXSense status from driver. This function is synchronous. This function is ISR friendly.
|
|
Get the software version of the driver.
|
|
Get specifications of a given video format. Application can use this function to retreives all specifications (frequencies, resolution, etc.) of a given IA/CEA 861-D video format. This function is synchronous. This function is ISR friendly.
|
|
Make device library handle an incoming interrupt. This function is used by application to tell the device library that the hardware sent an interrupt.
|
|
Check the result of an HDCP encryption attempt, called at intervals (set by timeSinceLastCall) after tmdlHdmiTxSetHdcp(true). This API must be used only in case of No Operating System. if OS, this is manage internally of this device library. This function is synchronous. This function is not ISR friendly.
|
|
Set the configuration of instance attributes. This function is required by DVP architecture rules but actually does nothing in this driver.
|
|
Setup the instance with its configuration parameters. This function allows basic instance configuration like enabling HDCP, choosing HDCP encryption mode or enabling HDCP repeater mode.
|
|
Open unit 0 of HdmiTx driver and provides the instance number to the caller. Note that one unit of HdmiTx represents one physical HDMI transmitter and that only one instance per unit can be opened.
|
|
Open a specific unit of HdmiTx driver and provides the instance number to the caller. Note that one unit of HdmiTx represents one physical HDMI transmitter and that only one instance per unit can be opened. This function switches driver's state machine to "initialized" state.
|
|
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.
|
|
|
|
Reset audio CTS. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of the audio content protection packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of AUD infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Configures audio input parameters : format, rate, etc. This function is similar to tmdlHdmiTxSetInputOutput except that video is not reconfigured. This function is synchronous. This function is not ISR friendly.
|
|
Set the audio output mute status. This function can be used to mute audio output, without muting video. This can be typically used when reconfiguring the audio HW after a sample rate change. This function is synchronous. This function is not ISR friendly.
|
|
|
|
This function loads a gamut metadata packet into the HW. HW will actually send it at the beginning of next VS, during the vertical blanking. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of the General Control packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Enable/Disable HDCP encryption. This function is synchronous. This function is not ISR friendly.
|
|
|
|
Configures all input and output parameters : format, modes, rates, etc. This is the main configuration function of the driver. Here are transmitted all crucial input and output parameters of the device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of ISRC1 packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of ISRC2 packet to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of MPS infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Set the power state of an instance of the HDMI transmitter.
|
|
Defines the content of SPD infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of AVI infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
Defines the content of VS infoframe to be sent by Tx device. This function is synchronous. This function is not ISR friendly.
|
|
|
Hdmi version Tx_4.26 - Generated on Tue Jan 26 09:25:07 2010 - tmdlHdmiTx component API |
![]() |