Main Page   Data Structures   File List   Data Fields   Globals  

tmdlHdmiCEC_Functions.h

Go to the documentation of this file.
00001 //=============================================================================
00002 // Copyright (C) 2007 NXP N.V., All Rights Reserved.
00003 // This source code and any compilation or derivative thereof is the proprietary
00004 // information of NXP N.V. and is confidential in nature. Under no circumstances
00005 // is this software to be  exposed to or placed under an Open Source License of
00006 // any type without the expressed written permission of NXP N.V.
00007 //=============================================================================
00008 /*!
00009     \file    tmdlHdmiCEC_Functions.h
00010 
00011     \version 1.0
00012 
00013     \date    04/07/2007
00014 
00015     \brief   This provides interfaces description of CEC messages.
00016 
00017     \section refs  Reference Documents
00018              TDA998X Driver - tmdlHdmiCec - SCS.doc
00019     \note    None.
00020  
00021     HISTORY :
00022     \verbatim
00023      Date          Modified by CRPRNr  TASKNr  Maintenance description
00024      -------------|-----------|-------|-------|-----------------------------------
00025      04/07/2007   |  F.G      |       |       | Creation.
00026      -------------|-----------|-------|-------|-----------------------------------
00027     \endverbatim
00028 */
00029 //==========================================================================
00030 
00031 #ifndef TMDLHDMICEC_FUNCTIONS_H
00032 #define TMDLHDMICEC_FUNCTIONS_H
00033 
00034 /*============================================================================*/
00035 /*                       INCLUDE FILES                                        */
00036 /*============================================================================*/
00037 
00038 #include "tmNxTypes.h"
00039 
00040 #ifdef __cplusplus
00041 extern "C" {
00042 #endif
00043 
00044 
00045 /*============================================================================*/
00046 /*                       PUBLIC FUNCTION DECLARATION                          */
00047 /*============================================================================*/
00048 
00049 //==========================================================================
00050 /*!
00051     \brief This message is reserved for testing purposes
00052 
00053     \param tmInstance_t Instance \n
00054            Instance identifier. \n
00055 
00056     \param UInt8 ReceiverLogicalAddress\n
00057            Address of message receiver. \n
00058 
00059     \return The call result:
00060             - TM_OK: the call was successful
00061             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00062               out of range
00063             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00064               the resource
00065 
00066 */
00067 //==========================================================================
00068 tmErrorCode_t tmdlHdmiCecAbortMessage
00069 (
00070    tmInstance_t   Instance,
00071    UInt8          ReceiverLogicalAddress
00072 );
00073 
00074 //==========================================================================
00075 /*!
00076     \brief This message is used by a new source to indicate that it has started
00077            to transmit a stream OR used in reponse to a <Request Active Source>
00078 
00079     \param tmInstance_t Instance \n
00080            Instance identifier. \n
00081            
00082     \param UInt16 PhysicalAddress \n
00083            Physical address of the device.\n
00084     
00085     \return The call result:
00086             - TM_OK: the call was successful
00087             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00088               out of range
00089             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00090               of range
00091             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
00092               inconsistent
00093 
00094 */
00095 //==========================================================================
00096 tmErrorCode_t tmdlHdmiCecActiveSource
00097 (
00098    tmInstance_t   Instance,
00099    UInt16         PhysicalAddress
00100 );
00101 
00102 //==========================================================================
00103 /*!
00104     \brief This message is used to indicate the supported CEC version in response
00105            to a <Get CEC Version>
00106 
00107     \param tmInstance_t Instance \n
00108            Instance identifier. \n
00109          
00110     \param UInt8 ReceiverLogicalAddress\n
00111            Address of message receiver. \n
00112 
00113     \param tmdlHdmiCECVersion_t CECVersion \n
00114            Supported CEC Version.\n
00115     
00116     \return The call result:
00117             - TM_OK: the call was successful
00118             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00119               out of range
00120             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00121               of range
00122 */
00123 //==========================================================================
00124 tmErrorCode_t tmdlHdmiCecVersion
00125 (
00126    tmInstance_t         Instance,
00127    UInt8                ReceiverLogicalAddress,
00128    tmdlHdmiCECVersion_t CECVersion
00129 );
00130 
00131 //==========================================================================
00132 /*!
00133     \brief This message is used to clear an Analogue timer block of a device
00134 
00135     \param tmInstance_t Instance \n
00136            Instance identifier. \n
00137     
00138     \param UInt8 ReceiverLogicalAddress \n
00139            Address of message receiver. \n
00140            
00141     \param UInt8  DayOfMonth \n
00142            Day of the month.\n
00143     
00144     \param UInt8  MonthOfYear \n
00145            Month of the year.\n
00146            
00147     \param UInt16 StartTime \n
00148            Start time for a timer based recording.\n
00149            
00150     \param UInt16 Duration \n
00151            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
00152     
00153     \param UInt8 Recording Sequence \n
00154            Indicates if recording is repeated and, if so, on which day
00155            For repeated recording the recording sequence value is the
00156            bitwise OR of the days when recordings are required
00157            Shall be set to 0x00 when recording is not repeated.\n
00158     
00159     \param tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType \n
00160            "Cable,Sattellite,Terrestrial".\n 
00161            
00162     \param UInt16 AnalogueFrequency \n
00163            Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).\n
00164     
00165     \param tmdlHdmiCECBroadcastSystem_t BroadcastSystem \n
00166            Specify information about the colour system, the sound carrier and
00167            the IF-frequency.\n
00168            
00169     \return The call result:
00170             - TM_OK: the call was successful
00171             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00172               out of range
00173             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00174               of range
00175 */
00176 //==========================================================================
00177 tmErrorCode_t tmdlHdmiCecClearAnalogueTimer
00178 (
00179    tmInstance_t                        Instance,
00180    UInt8                               ReceiverLogicalAddress,
00181    UInt8                               DayOfMonth,
00182    UInt8                               MonthOfYear,
00183    UInt16                              StartTime,
00184    tmdlHdmiCECDuration_t              *pDuration,
00185    UInt8                               RecordingSequence,
00186    tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType,
00187    UInt16                              AnalogueFrequency,
00188    tmdlHdmiCECBroadcastSystem_t        BroadcastSystem
00189 );
00190 
00191 
00192 //==========================================================================
00193 /*!
00194     \brief This message is used to clear a digital timer block of a device
00195 
00196     \param tmInstance_t Instance \n
00197            Instance identifier. \n
00198            
00199     \param UInt8 ReceiverLogicalAddress \n
00200            Address of message receiver. \n
00201            
00202     \param UInt8  DayOfMonth \n
00203            Day of the month.\n
00204     
00205     \param UInt8  MonthOfYear \n
00206            Month of the year.\n
00207            
00208     \param UInt16 StartTime \n
00209            Start time for a timer based recording.\n
00210            
00211     \param UInt16 Duration \n
00212            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
00213     
00214     \param UInt8 Recording Sequence \n
00215            Indicates if recording is repeated and, if so, on which day
00216            For repeated recording the recording sequence value is the
00217            bitwise OR of the days when recordings are required
00218            Shall be set to 0x00 when recording is not repeated.\n
00219     
00220     \param tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification \n
00221            Pointer to the structure Digital Service Identification
00222 
00223     \return The call result:
00224             - TM_OK: the call was successful
00225             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00226               out of range
00227             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00228               of range
00229 */
00230 //==========================================================================
00231 tmErrorCode_t tmdlHdmiCecClearDigitalTimer
00232 (
00233    tmInstance_t                               Instance,
00234    UInt8                                      ReceiverLogicalAddress,
00235    UInt8                                      DayOfMonth,
00236    UInt8                                      MonthOfYear,
00237    UInt16                                     StartTime,
00238    tmdlHdmiCECDuration_t                     *pDuration,
00239    UInt8                                      RecordingSequence,
00240    tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification
00241 );
00242 
00243 //==========================================================================
00244 /*!
00245     \brief This message is used to clear a digital timer block of a device
00246 
00247     \param tmInstance_t Instance \n
00248            Instance identifier. \n
00249     
00250     \param UInt8 ReceiverLogicalAddress \n
00251            Address of message receiver. \n
00252            
00253     \param UInt8  DayOfMonth \n
00254            Day of the month.\n
00255     
00256     \param UInt8  MonthOfYear \n
00257            Month of the year.\n
00258            
00259     \param UInt16 StartTime \n
00260            Start time for a timer based recording.\n
00261            
00262     \param UInt16 Duration \n
00263            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
00264     
00265     \param UInt8 Recording Sequence \n
00266            Indicates if recording is repeated and, if so, on which day
00267            For repeated recording the recording sequence value is the
00268            bitwise OR of the days when recordings are required
00269            Shall be set to 0x00 when recording is not repeated.\n
00270     
00271     \param tmdlHdmiCECExternalPlug_t  ExternalPlug \n
00272            indicates external plug number (1 to 255 )on the recording device.\n
00273 
00274     \return The call result:
00275             - TM_OK: the call was successful
00276             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00277               out of range
00278             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00279               of range
00280 */
00281 //==========================================================================
00282 tmErrorCode_t tmdlHdmiCecClearExternalTimerWithExternalPlug
00283 (
00284    tmInstance_t                Instance,
00285    UInt8                       ReceiverLogicalAddress,
00286    UInt8                       DayOfMonth,
00287    UInt8                       MonthOfYear,
00288    UInt16                      StartTime,
00289    tmdlHdmiCECDuration_t      *pDuration,
00290    UInt8                       RecordingSequence,
00291    tmdlHdmiCECExternalPlug_t  ExternalPlug
00292 );
00293 
00294 //==========================================================================
00295 /*!
00296     \brief This message is used to clear a digital timer block of a device
00297 
00298     \param tmInstance_t Instance \n
00299            Instance identifier. \n
00300            
00301     \param UInt8 ReceiverLogicalAddress \n
00302            Address of message receiver. \n
00303            
00304     \param UInt8  DayOfMonth \n
00305            Day of the month.\n
00306     
00307     \param UInt8  MonthOfYear \n
00308            Month of the year.\n
00309            
00310     \param UInt16 StartTime \n
00311            Start time for a timer based recording.\n
00312            
00313     \param UInt16 Duration \n
00314            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
00315     
00316     \param UInt8 Recording Sequence \n
00317            Indicates if recording is repeated and, if so, on which day
00318            For repeated recording the recording sequence value is the
00319            bitwise OR of the days when recordings are required
00320            Shall be set to 0x00 when recording is not repeated.\n
00321     
00322     \param tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress \n
00323            Defines the path between the TV an a device-thus giving it a physical
00324            address within the cluster.\n
00325 
00326     \return The call result:
00327             - TM_OK: the call was successful
00328             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00329               out of range
00330             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00331               of range
00332 */
00333 //==========================================================================
00334 tmErrorCode_t tmdlHdmiCecClearExternalTimerWithPhysicalAddress
00335 (
00336    tmInstance_t                           Instance,
00337    UInt8                                  ReceiverLogicalAddress,
00338    UInt8                                  DayOfMonth,
00339    UInt8                                  MonthOfYear,
00340    UInt16                                 StartTime,
00341    tmdlHdmiCECDuration_t                 *pDuration,
00342    UInt8                                  RecordingSequence,
00343    tmdlHdmiCECExternalPhysicalAddress_t  ExternalPhysicalAddress
00344 );
00345 
00346 //==========================================================================
00347 /*!
00348     \brief This message is used to conrol a device's media functions
00349 
00350     \param tmInstance_t Instance \n
00351            Instance identifier. \n
00352            
00353     \param tmdlHdmiCECDecControlMode_t DeckControlMode \n
00354            Used in message <Deck Control>\n
00355     
00356     \note  The "Skip Forward / Wind" and "Skip Reverse / Rewind" values are
00357            used for example in a DVD as next xhapter and previous chapter and
00358            in a VCR as wind and rewind. \n
00359            
00360     \return The call result:
00361             - TM_OK: the call was successful
00362             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00363               out of range
00364             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00365               of range
00366 */
00367 //==========================================================================
00368 tmErrorCode_t tmdlHdmiCecDeckControl
00369 (
00370    tmInstance_t                Instance,
00371    UInt8                       ReceiverLogicalAddress,
00372    tmdlHdmiCECDecControlMode_t DeckControlMode
00373 );
00374 
00375 //==========================================================================
00376 /*!
00377     \brief This message is used to provide a deck's status to the initiator
00378            of the <Give Deck Status> message 
00379 
00380     \param tmInstance_t Instance \n
00381            Instance identifier. \n
00382            
00383     \param tmdlHdmiCECDecInfo_t DeckInfo \n
00384            Information on the device's current status \n
00385     
00386     \return The call result:
00387             - TM_OK: the call was successful
00388             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00389               out of range
00390             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00391               of range
00392 */
00393 //==========================================================================
00394 tmErrorCode_t tmdlHdmiCecDeckStatus
00395 (
00396    tmInstance_t         Instance,
00397    UInt8                ReceiverLogicalAddress,
00398    tmdlHdmiCECDecInfo_t DeckInfo
00399 );
00400 
00401 //==========================================================================
00402 /*!
00403     \brief This message report the vendor ID of this device
00404 
00405     \param tmInstance_t Instance \n
00406            Instance identifier. \n
00407            
00408     \param UInt32 VendorID \n
00409            Indentifier for a specific Vendor \n
00410     
00411     \return The call result:
00412             - TM_OK: the call was successful
00413             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00414               out of range
00415             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00416               of range
00417 */
00418 //==========================================================================
00419 tmErrorCode_t tmdlHdmiCecDeviceVendorID
00420 (
00421    tmInstance_t Instance,
00422    UInt32       VendorID
00423 );
00424 
00425 //==========================================================================
00426 /*!
00427     \brief This message is used as a reponse to indicate that the device does
00428            not support the requested message type, or that it cannot execute it
00429            at the present time.
00430 
00431     \param tmInstance_t Instance \n
00432            Instance identifier. \n
00433            
00434     \param tmdlHdmiCECFeatureOpcode_t FeatureOpcode \n
00435            Opcode of the aborted message. \n
00436     
00437     \param tmdlHdmiCECAbortReason_t   AbortReason \n
00438            The reason why message cannot respond. \n
00439     
00440     \return The call result:
00441             - TM_OK: the call was successful
00442             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00443               out of range
00444             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00445               of range
00446 */
00447 //==========================================================================
00448 tmErrorCode_t tmdlHdmiCecFeatureAbort
00449 (
00450    tmInstance_t               Instance,
00451    UInt8                      ReceiverLogicalAddress,
00452    tmdlHdmiCECFeatureOpcode_t FeatureOpcode,
00453    tmdlHdmiCECAbortReason_t   AbortReason
00454 );
00455 
00456 //==========================================================================
00457 /*!
00458     \brief This message is used by a device to enquire which version of CEC
00459            the target supports
00460 
00461     \param tmInstance_t Instance \n
00462            Instance identifier. \n
00463 
00464     \return The call result:
00465             - TM_OK: the call was successful
00466             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00467               out of range
00468             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00469               the resource
00470 
00471 */
00472 //==========================================================================
00473 tmErrorCode_t tmdlHdmiCecGetCecVersion
00474 (
00475    tmInstance_t   Instance,
00476    UInt8          ReceiverLogicalAddress
00477 );
00478 
00479 //==========================================================================
00480 /*!
00481     \brief This message is sent by a device capable of character generation
00482            (for OSD and Menus) to a TV in order to discover the currently selected
00483            Menu Language. Also used by a TV during installation to dicover the
00484            currently set menu language of other devices.
00485 
00486     \param tmInstance_t Instance \n
00487            Instance identifier. \n
00488 
00489     \return The call result:
00490             - TM_OK: the call was successful
00491             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00492               out of range
00493             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00494               the resource
00495 
00496 */
00497 //==========================================================================
00498 tmErrorCode_t tmdlHdmiCecGetMenuLanguage
00499 (
00500    tmInstance_t   Instance,
00501    UInt8          ReceiverLogicalAddress
00502 );
00503 
00504 //==========================================================================
00505 /*!
00506     \brief This message is requests an amplifier to send its volume and mute status
00507 
00508     \param tmInstance_t Instance \n
00509            Instance identifier. \n
00510 
00511     \return The call result:
00512             - TM_OK: the call was successful
00513             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00514               out of range
00515             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00516               the resource
00517 
00518 */
00519 //==========================================================================
00520 tmErrorCode_t tmdlHdmiCecGiveAudioStatus
00521 (
00522    tmInstance_t   Instance,
00523    UInt8          ReceiverLogicalAddress
00524 );
00525 
00526 //==========================================================================
00527 /*!
00528     \brief This message is used to request the status of a device regardless
00529            of whether or not it is the current active source.
00530 
00531     \param tmInstance_t Instance \n
00532            Instance identifier. \n
00533            
00534     \param tmdlHdmiCECStatusRequest_t StatusRequest \n
00535            Allows the initiator to request the status once or on all future state
00536            change. Or to cancel a previous <Give Deck Status > ["On"] request. \n
00537 
00538     \return The call result:
00539             - TM_OK: the call was successful
00540             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00541               out of range
00542             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00543               the resource
00544 
00545 */
00546 //==========================================================================
00547 tmErrorCode_t tmdlHdmiCecGiveDeckStatus
00548 (
00549    tmInstance_t               Instance,
00550    UInt8                      ReceiverLogicalAddress,
00551    tmdlHdmiCECStatusRequest_t StatusRequest
00552 );
00553 
00554 //==========================================================================
00555 /*!
00556     \brief This message is used to determine the current power status of a 
00557            target device
00558 
00559     \param tmInstance_t Instance \n
00560            Instance identifier. \n
00561 
00562     \return The call result:
00563             - TM_OK: the call was successful
00564             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00565               out of range
00566             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00567               the resource
00568 
00569 */
00570 //==========================================================================
00571 tmErrorCode_t tmdlHdmiCecGiveDevicePowerStatus
00572 (
00573    tmInstance_t   Instance,
00574    UInt8          ReceiverLogicalAddress
00575 );
00576 
00577 //==========================================================================
00578 /*!
00579     \brief This message is request the vendor ID from a device
00580 
00581     \param tmInstance_t Instance \n
00582            Instance identifier. \n
00583 
00584     \return The call result:
00585             - TM_OK: the call was successful
00586             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00587               out of range
00588             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00589               the resource
00590 
00591 */
00592 //==========================================================================
00593 tmErrorCode_t tmdlHdmiCecGiveDeviceVendorID
00594 (
00595    tmInstance_t   Instance,
00596    UInt8          ReceiverLogicalAddress
00597 );
00598 
00599 //==========================================================================
00600 /*!
00601     \brief This message is used to request preferred OSD name of a device
00602            for use in menus associated with that device
00603 
00604     \param tmInstance_t Instance \n
00605            Instance identifier. \n
00606 
00607     \return The call result:
00608             - TM_OK: the call was successful
00609             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00610               out of range
00611             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00612               the resource
00613 
00614 */
00615 //==========================================================================
00616 tmErrorCode_t tmdlHdmiCecGiveOsdName
00617 (
00618    tmInstance_t   Instance,
00619    UInt8          ReceiverLogicalAddress
00620 );
00621 
00622 //==========================================================================
00623 /*!
00624     \brief This message is a request to a device to return its physical Address
00625 
00626     \param tmInstance_t Instance \n
00627            Instance identifier. \n
00628 
00629     \return The call result:
00630             - TM_OK: the call was successful
00631             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00632               out of range
00633             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00634               the resource
00635 
00636 */
00637 //==========================================================================
00638 tmErrorCode_t tmdlHdmiCecGivePhysicalAddress
00639 (
00640    tmInstance_t   Instance,
00641    UInt8          ReceiverLogicalAddress
00642 );
00643 
00644 //==========================================================================
00645 /*!
00646     \brief This message request the status of the system audio mode
00647 
00648     \param tmInstance_t Instance \n
00649            Instance identifier. \n
00650 
00651     \return The call result:
00652             - TM_OK: the call was successful
00653             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00654               out of range
00655             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00656               the resource
00657 
00658 */
00659 //==========================================================================
00660 tmErrorCode_t tmdlHdmiCecGiveSystemAudioModeStatus
00661 (
00662    tmInstance_t   Instance,
00663    UInt8          ReceiverLogicalAddress
00664 );
00665 
00666 //==========================================================================
00667 /*!
00668     \brief This message is used to request the status of a tuner device
00669     
00670     \param tmInstance_t Instance \n
00671            Instance identifier. \n
00672            
00673     \param tmdlHdmiCECStatusRequest_t StatusRequest \n
00674            Allows the initiator to request the status once or on all future state
00675            change. Or to cancel a previous <Give Tuner Device Status > ["On"] request. \n
00676 
00677     \return The call result:
00678             - TM_OK: the call was successful
00679             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00680               out of range
00681             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00682               the resource
00683 
00684 */
00685 //==========================================================================
00686 tmErrorCode_t tmdlHdmiCecGiveTunerDeviceStatus
00687 (
00688    tmInstance_t               Instance,
00689    UInt8                      ReceiverLogicalAddress,
00690    tmdlHdmiCECStatusRequest_t StatusRequest
00691 );
00692 
00693 //==========================================================================
00694 /*!
00695     \brief This message sent by a source device to the TV whenever it enters
00696            the active state
00697 
00698     \param tmInstance_t Instance \n
00699            Instance identifier. \n
00700            
00701     \param UInt8    ReceiverLogicalAddress \n
00702            Address of message receivers. \n
00703 
00704     \return The call result:
00705             - TM_OK: the call was successful
00706             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00707               out of range
00708             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00709               the resource
00710 
00711 */
00712 //==========================================================================
00713 tmErrorCode_t tmdlHdmiCecImageViewOn
00714 (
00715    tmInstance_t   Instance,
00716    UInt8          ReceiverLogicalAddress
00717 );
00718 
00719 //==========================================================================
00720 /*!
00721     \brief This message is used by the currently active source to inform the
00722            TV that it has no video to be presented to the user, or is going
00723            into standby as the result of a lcoal user command on the device.
00724     
00725     \param tmInstance_t Instance \n
00726            Instance identifier. \n
00727            
00728     \param UInt8 ReceiverLogicalAddress, \n
00729            Address of message receiver. \n
00730            
00731     \param tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress \n
00732            Physical Address of the device. \n
00733 
00734     \return The call result:
00735             - TM_OK: the call was successful
00736             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00737               out of range
00738             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00739               the resource
00740 
00741 */
00742 //==========================================================================
00743 tmErrorCode_t tmdlHdmiCecInactiveSource
00744 (
00745    tmInstance_t                          Instance,
00746    UInt8                                 ReceiverLogicalAddress,
00747    tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress
00748 );
00749 
00750 //==========================================================================
00751 /*!
00752     \brief This message request from the TV for a device to show/remove a
00753            menu or to query if a device is currently showing a menu
00754     
00755     \param tmInstance_t Instance \n
00756            Instance identifier. \n
00757            
00758     \param tmdlHdmiCECMenuRequestType_t  MenuRequestType \n
00759            Indicates if the menu request is to activate or deactivate the 
00760            devices menu or simply query the devices menu status. \n
00761 
00762     \return The call result:
00763             - TM_OK: the call was successful
00764             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00765               out of range
00766             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00767               the resource
00768 
00769 */
00770 //==========================================================================
00771 tmErrorCode_t tmdlHdmiCecMenuRequest
00772 (
00773    tmInstance_t                  Instance,
00774    UInt8                         ReceiverLogicalAddress,
00775    tmdlHdmiCECMenuRequestType_t  MenuRequestType
00776 );
00777 
00778 //==========================================================================
00779 /*!
00780     \brief This message is used to indicate to the TV that the device is 
00781            showing/has removed a menu and requets the remote control keys to
00782            be passed though
00783     
00784     \param tmInstance_t Instance \n
00785            Instance identifier. \n
00786            
00787     \param tmdlHdmiCECMenuState_t  MenuState \n
00788            Indicates if the device is in the 'Device Menu Active' state or
00789            'Device Menu Inactive' state. \n
00790 
00791     \return The call result:
00792             - TM_OK: the call was successful
00793             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00794               out of range
00795             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00796               the resource
00797 
00798 */
00799 //==========================================================================
00800 tmErrorCode_t tmdlHdmiCecMenuStatus
00801 (
00802    tmInstance_t            Instance,
00803    UInt8                   ReceiverLogicalAddress,
00804    tmdlHdmiCECMenuState_t  MenuState
00805 );
00806 
00807 //==========================================================================
00808 /*!
00809     \brief This message is used to control the playback behaviour of a source
00810            device
00811     
00812     \param tmInstance_t Instance \n
00813            Instance identifier. \n
00814            
00815     \param tmdlHdmiCECPlayMode_t  PlayMode \n
00816            In which mode to play media. \n
00817 
00818     \return The call result:
00819             - TM_OK: the call was successful
00820             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00821               out of range
00822             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00823               the resource
00824 
00825 */
00826 //==========================================================================
00827 tmErrorCode_t tmdlHdmiCecPlay
00828 (
00829    tmInstance_t           Instance,
00830    UInt8                  ReceiverLogicalAddress,
00831    tmdlHdmiCECPlayMode_t  PlayMode
00832 );
00833 
00834 //==========================================================================
00835 /*!
00836     \brief This message is used by any device for device discovery - similar to
00837            ping in other protocols
00838 
00839     \param tmInstance_t Instance \n
00840            Instance identifier. \n
00841 
00842     \return The call result:
00843             - TM_OK: the call was successful
00844             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00845               out of range
00846             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00847               the resource
00848 
00849 */
00850 //==========================================================================
00851 tmErrorCode_t tmdlHdmiCecPollingMessage
00852 (
00853    tmInstance_t   Instance,
00854    UInt8          ReceiverLogicalAddress
00855 );
00856 
00857 //==========================================================================
00858 /*!
00859     \brief This message request a device to stop a recording
00860 
00861     \param tmInstance_t Instance \n
00862            Instance identifier. \n
00863            
00864     \param UInt8    ReceiverLogicalAddress \n
00865            Address of message receiver. \n
00866 
00867     \return The call result:
00868             - TM_OK: the call was successful
00869             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00870               out of range
00871             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00872               the resource
00873 
00874 */
00875 //==========================================================================
00876 tmErrorCode_t tmdlHdmiCecRecordOff
00877 (
00878    tmInstance_t  Instance,
00879    UInt8         ReceiverLogicalAddress
00880 );
00881 
00882 //==========================================================================
00883 /*!
00884     \brief This message attempt to record analogue source
00885 
00886     \param tmInstance_t Instance \n
00887            Instance identifier. \n
00888            
00889     \param UInt8    ReceiverLogicalAddress \n
00890            Address of message receiver. \n
00891 
00892     \param tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType \n
00893            "Cable,Sattellite,Terrestrial".\n 
00894            
00895     \param UInt16 AnalogueFrequency \n
00896            Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).\n
00897     
00898     \param tmdlHdmiCECBroadcastSystem_t BroadcastSystem \n
00899            Specify information about the colour system, the sound carrier and
00900            the IF-frequency.\n       
00901            
00902     \return The call result:
00903             - TM_OK: the call was successful
00904             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00905               out of range
00906             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00907               the resource
00908             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00909               of range
00910 
00911 */
00912 //==========================================================================
00913 tmErrorCode_t tmdlHdmiCecRecordOnAnalogueService
00914 (
00915    tmInstance_t                        Instance,
00916    UInt8                               ReceiverLogicalAddress,
00917    tmdlHdmiCECAnalogueBroadcastType_t  AnalogueBroadcastType,
00918    UInt16                              AnalogueFrequency,
00919    tmdlHdmiCECBroadcastSystem_t        BroadcastSystem
00920 );
00921 
00922 //==========================================================================
00923 /*!
00924     \brief This message attempt to record digital source
00925 
00926     \param tmInstance_t Instance \n
00927            Instance identifier. \n
00928     
00929     \param UInt8    ReceiverLogicalAddress \n
00930            Address of message receiver. \n
00931 
00932     \param tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification \n
00933            Pointer to the structure Digital Service Identification
00934            
00935     \return The call result:
00936             - TM_OK: the call was successful
00937             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00938               out of range
00939             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00940               the resource
00941             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00942               of range
00943 
00944 */
00945 //==========================================================================
00946 tmErrorCode_t tmdlHdmiCecRecordOnDigitalService
00947 (
00948    tmInstance_t                              Instance,
00949    UInt8                                     ReceiverLogicalAddress,
00950    tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification
00951 );
00952 
00953 //==========================================================================
00954 /*!
00955     \brief This message attempt to record an external physical address source
00956 
00957     \param tmInstance_t Instance \n
00958            Instance identifier. \n
00959            
00960     \param UInt8    ReceiverLogicalAddress \n
00961            Address of message receiver. \n
00962 
00963     \param tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress \n
00964            Defines the path between the TV an a device-thus giving it a physical
00965            address within the cluster.\n
00966     
00967     \return The call result:
00968             - TM_OK: the call was successful
00969             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
00970               out of range
00971             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
00972               the resource
00973             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
00974               of range
00975 
00976 */
00977 //==========================================================================
00978 tmErrorCode_t tmdlHdmiCecRecordOnExternalPhysicalAddress
00979 (
00980    tmInstance_t                         Instance,
00981    UInt8                                ReceiverLogicalAddress,
00982    tmdlHdmiCECExternalPhysicalAddress_t ExternalPhysicalAddress
00983 );
00984 
00985 //==========================================================================
00986 /*!
00987     \brief This message attempt to record an external plug source
00988 
00989     \param tmInstance_t Instance \n
00990            Instance identifier. \n
00991     
00992     \param UInt8    ReceiverLogicalAddress \n
00993            Address of message receiver. \n
00994 
00995     \param tmdlHdmiCECExternalPlug_t  ExternalPlug \n
00996            indicates external plug number (1 to 255 )on the recording device.\n
00997     
00998     \return The call result:
00999             - TM_OK: the call was successful
01000             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01001               out of range
01002             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01003               the resource
01004             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01005               of range
01006 
01007 */
01008 //==========================================================================
01009 tmErrorCode_t tmdlHdmiCecRecordOnExternalPlug
01010 (
01011    tmInstance_t                   Instance,
01012    UInt8                          ReceiverLogicalAddress,
01013    tmdlHdmiCECExternalPlug_t      ExternalPlug
01014 );
01015 
01016 //==========================================================================
01017 /*!
01018     \brief This message attempt to record an external plug source
01019 
01020     \param tmInstance_t Instance \n
01021            Instance identifier. \n
01022            
01023     \param UInt8    ReceiverLogicalAddress \n
01024            Address of message receiver. \n
01025 
01026     \return The call result:
01027             - TM_OK: the call was successful
01028             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01029               out of range
01030             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01031               the resource
01032             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01033               of range
01034 
01035 */
01036 //==========================================================================
01037 tmErrorCode_t tmdlHdmiCecRecordOnOwnSource
01038 (
01039    tmInstance_t                   Instance,
01040    UInt8                          ReceiverLogicalAddress
01041 );
01042 
01043 //==========================================================================
01044 /*!
01045     \brief This message is used by a recording device to inform the initiator
01046            of the message <Record On> about its status.
01047 
01048     \param tmInstance_t Instance \n
01049            Instance identifier. \n
01050            
01051     \param UInt8    ReceiverLogicalAddress \n
01052            Address of message receiver. \n
01053 
01054     \param tmdlHdmiCECRecordStatusInfo_t  RecordStatusInfo \n
01055            The recording status of the device.\n        
01056     
01057     \return The call result:
01058             - TM_OK: the call was successful
01059             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01060               out of range
01061             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01062               the resource
01063             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01064               of range
01065 
01066 */
01067 //==========================================================================
01068 tmErrorCode_t tmdlHdmiCecRecordStatus
01069 (
01070    tmInstance_t                   Instance,
01071    UInt8                          ReceiverLogicalAddress,
01072    tmdlHdmiCECRecordStatusInfo_t  RecordStatusInfo
01073 );
01074 
01075 //==========================================================================
01076 /*!
01077     \brief This message request by the recording device to record the presently
01078            displayed source.
01079 
01080     \param tmInstance_t Instance \n
01081            Instance identifier. \n
01082     
01083     \param UInt8    ReceiverLogicalAddress \n
01084            Address of message receiver. \n
01085 
01086     \return The call result:
01087             - TM_OK: the call was successful
01088             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01089               out of range
01090             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01091               the resource
01092 
01093 */
01094 //==========================================================================
01095 tmErrorCode_t tmdlHdmiCecRecordTvScreen
01096 (
01097    tmInstance_t  Instance,
01098    UInt8         ReceiverLogicalAddress
01099 );
01100 
01101 //==========================================================================
01102 /*!
01103     \brief This message report an amplifier's volume and mute.
01104 
01105     \param tmInstance_t Instance \n
01106            Instance identifier. \n
01107            
01108     \param tmdlHdmiCECAudioStatus_t AudioStatus \n
01109            Volume and mute status. \n
01110 
01111     \return The call result:
01112             - TM_OK: the call was successful
01113             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01114               out of range
01115             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01116               the resource
01117             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01118               of range
01119 
01120 */
01121 //==========================================================================
01122 tmErrorCode_t tmdlHdmiCecReportAudioStatus
01123 (
01124    tmInstance_t              Instance,
01125    UInt8                     ReceiverLogicalAddress,
01126    ptmdlHdmiCECAudioStatus_t pAudioStatus
01127 );
01128 
01129 //==========================================================================
01130 /*!
01131     \fn tmErrorCode_t tmdlHdmiCecReportShortAudioDescriptor( )
01132     \brief This message Report Audio Capability.
01133 
01134     \param tmInstance_t Instance \n
01135            Instance identifier. \n
01136        
01137     \param UInt8    ReceiverLogicalAddress \n
01138            Address of message receiver. \n
01139 
01140     \param UInt32 ShortAudioDecriptor \n
01141            Audio Descriptor. \n
01142 
01143     \return The call result:
01144             - TM_OK: the call was successful
01145             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01146               out of range
01147             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01148               the resource
01149             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01150               of range
01151 
01152 */
01153 //==========================================================================
01154 tmErrorCode_t tmdlHdmiCecReportShortAudioDescriptor
01155 (
01156    tmInstance_t   Instance,
01157    UInt8          ReceiverLogicalAddress,
01158    UInt32         ShortAudioDecriptor
01159 );
01160 
01161 //==========================================================================
01162 /*!
01163     \fn tmErrorCode_t tmdlHdmiCecRequestShortAudioDescriptor( )
01164     \brief This message Request Audio Capability.
01165 
01166     \param tmInstance_t Instance \n
01167            Instance identifier. \n
01168        
01169     \param UInt8    ReceiverLogicalAddress \n
01170            Address of message receiver. \n
01171 
01172     \param UInt8 AudioFormatID \n
01173        
01174     \param UInt8 AudioFormatCode \n
01175 
01176     \return The call result:
01177             - TM_OK: the call was successful
01178             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01179               out of range
01180             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01181               the resource
01182             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01183               of range
01184 
01185 */
01186 //==========================================================================
01187 tmErrorCode_t tmdlHdmiCecRequestShortAudioDescriptor
01188 (
01189    tmInstance_t   Instance,
01190    UInt8          ReceiverLogicalAddress,
01191    UInt8          AudioFormatID,
01192    UInt8          AudioFormatCode
01193    
01194 );
01195 
01196 //==========================================================================
01197 /*!
01198     \fn tmErrorCode_t tmdlHdmiCecIniateARC( )
01199     \brief This message Used by an ARC RX device to activate the
01200            ARC functionality in an ARC TX device
01201 
01202     \param tmInstance_t Instance \n
01203            Instance identifier. \n
01204        
01205     \param UInt8    ReceiverLogicalAddress \n
01206            Address of message receiver. \n
01207 
01208     \return The call result:
01209             - TM_OK: the call was successful
01210             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01211               out of range
01212             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01213               the resource
01214             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01215               of range
01216 
01217 */
01218 //==========================================================================
01219 tmErrorCode_t tmdlHdmiCecIniateARC
01220 (
01221    tmInstance_t   Instance,
01222    UInt8          ReceiverLogicalAddress
01223 );
01224 
01225 //==========================================================================
01226 /*!
01227     \fn tmErrorCode_t tmdlHdmiCecReportArcInitiated( )
01228     \brief This message Used by an ARC TX device to indicate that
01229            its ARC functionality has been activated
01230 
01231     \param tmInstance_t Instance \n
01232            Instance identifier. \n
01233        
01234     \param UInt8    ReceiverLogicalAddress \n
01235            Address of message receiver. \n
01236 
01237     \return The call result:
01238             - TM_OK: the call was successful
01239             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01240               out of range
01241             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01242               the resource
01243             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01244               of range
01245 
01246 */
01247 //==========================================================================
01248 tmErrorCode_t tmdlHdmiCecReportArcInitiated
01249 (
01250    tmInstance_t   Instance,
01251    UInt8          ReceiverLogicalAddress
01252 );
01253 
01254 //==========================================================================
01255 /*!
01256     \fn tmErrorCode_t tmdlHdmiCecReportArcTerminated( )
01257     \brief This message Used by an ARC TX device to indicate that its ARC functionality
01258            has been deactivated.
01259 
01260     \param tmInstance_t Instance \n
01261            Instance identifier. \n
01262        
01263     \param UInt8    ReceiverLogicalAddress \n
01264            Address of message receiver. \n
01265 
01266     \return The call result:
01267             - TM_OK: the call was successful
01268             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01269               out of range
01270             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01271               the resource
01272             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01273               of range
01274 
01275 */
01276 //==========================================================================
01277 tmErrorCode_t tmdlHdmiCecReportArcTerminated
01278 (
01279    tmInstance_t   Instance,
01280    UInt8          ReceiverLogicalAddress
01281 );
01282 
01283 //==========================================================================
01284 /*!
01285     \fn tmErrorCode_t tmdlHdmiCecRequestArcInitiation( )
01286     \brief This message Used by an ARC TX device to request an ARC RX device to
01287            activate the ARC functionality in the ARC TX device.
01288 
01289     \param tmInstance_t Instance \n
01290            Instance identifier. \n
01291        
01292     \param UInt8    ReceiverLogicalAddress \n
01293            Address of message receiver. \n
01294 
01295     \return The call result:
01296             - TM_OK: the call was successful
01297             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01298               out of range
01299             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01300               the resource
01301             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01302               of range
01303 
01304 */
01305 //==========================================================================
01306 tmErrorCode_t tmdlHdmiCecRequestArcInitiation
01307 (
01308    tmInstance_t   Instance,
01309    UInt8          ReceiverLogicalAddress
01310 );
01311 
01312 //==========================================================================
01313 /*!
01314     \fn tmErrorCode_t tmdlHdmiCecRequestArcTerminiation( )
01315     \brief Used by an ARC TX device to request an ARC RX device to deactivate 
01316            the ARC functionality in the ARC TX device.
01317 
01318     \param tmInstance_t Instance \n
01319            Instance identifier. \n
01320        
01321     \param UInt8    ReceiverLogicalAddress \n
01322            Address of message receiver. \n
01323 
01324     \return The call result:
01325             - TM_OK: the call was successful
01326             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01327               out of range
01328             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01329               the resource
01330             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01331               of range
01332 
01333 */
01334 //==========================================================================
01335 tmErrorCode_t tmdlHdmiCecRequestArcTerminiation
01336 (
01337    tmInstance_t   Instance,
01338    UInt8          ReceiverLogicalAddress
01339 );
01340 
01341 //==========================================================================
01342 /*!
01343     \fn tmErrorCode_t tmdlHdmiCecTerminateARC( )
01344     \brief Used by an ARC TX device to request an ARC RX device to deactivate 
01345            the ARC functionality in the ARC TX device.
01346 
01347     \param tmInstance_t Instance \n
01348            Instance identifier. \n
01349        
01350     \param UInt8    ReceiverLogicalAddress \n
01351            Address of message receiver. \n
01352 
01353     \return The call result:
01354             - TM_OK: the call was successful
01355             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01356               out of range
01357             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01358               the resource
01359             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01360               of range
01361 
01362 */
01363 //==========================================================================
01364 tmErrorCode_t tmdlHdmiCecTerminateARC
01365 (
01366    tmInstance_t   Instance,
01367    UInt8          ReceiverLogicalAddress
01368 );
01369 
01370 //==========================================================================
01371 /*!
01372     \brief This message is used to inform all other devices of the mapping
01373            between physical and logical address of the initiator.
01374 
01375     \param tmInstance_t Instance \n
01376            Instance identifier. \n
01377            
01378     \param UInt16 PhysicalAddress \n
01379            Device physical address within the cluster. \n
01380            
01381     \param tmdlHdmiCECDeviceType_t DeviceType \n
01382            Type of the device (TV, Playback, tuner,...). \n
01383 
01384     \return The call result:
01385             - TM_OK: the call was successful
01386             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01387               out of range
01388             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01389               the resource
01390             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01391               of range
01392 
01393 */
01394 //==========================================================================
01395 tmErrorCode_t tmdlHdmiCecReportPhysicalAddress
01396 (
01397    tmInstance_t             Instance,
01398    UInt16                   PhysicalAddress,
01399    tmdlHdmiCECDeviceType_t  DeviceType
01400 );
01401 
01402 //==========================================================================
01403 /*!
01404     \brief This message is used to inform a requesting device of the current
01405            power status.
01406 
01407     \param tmInstance_t Instance \n
01408            Instance identifier. \n
01409            
01410     \param tmdlHdmiCECPowerStatus_t PowerStatus \n
01411            Current power status. \n
01412 
01413     \return The call result:
01414             - TM_OK: the call was successful
01415             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01416               out of range
01417             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01418               the resource
01419             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01420               of range
01421 
01422 */
01423 //==========================================================================
01424 tmErrorCode_t tmdlHdmiCecReportPowerStatus
01425 (
01426    tmInstance_t             Instance,
01427    UInt8                    ReceiverLogicalAddress,
01428    tmdlHdmiCECPowerStatus_t PowerStatus
01429 );
01430 
01431 //==========================================================================
01432 /*!
01433     \brief This message is used by a new device to discover the status of
01434            the system.
01435 
01436     \param tmInstance_t Instance \n
01437            Instance identifier. \n
01438 
01439     \return The call result:
01440             - TM_OK: the call was successful
01441             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01442               out of range
01443             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01444               the resource
01445 
01446 */
01447 //==========================================================================
01448 tmErrorCode_t tmdlHdmiCecRequestActiveSource
01449 (
01450    tmInstance_t  Instance
01451 );
01452 
01453 //==========================================================================
01454 /*!
01455     \brief This message is sent by a CEC switch when it is manually switched to 
01456            inform all other devices on the network that the active route below
01457            the switch has changed.
01458 
01459     \param tmInstance_t Instance \n
01460            Instance identifier. \n
01461            
01462     \param UInt16 OriginalAddress \n
01463            Previous address that the switch was switched to. \n
01464            
01465     \param UInt16 NewAddress \n
01466            The new address it has been moved to. \n
01467 
01468     \return The call result:
01469             - TM_OK: the call was successful
01470             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01471               out of range
01472             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01473               the resource
01474             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01475               of range
01476 
01477 */
01478 //==========================================================================
01479 tmErrorCode_t tmdlHdmiCecRoutingChange
01480 (
01481    tmInstance_t  Instance,
01482    UInt16        OriginalAddress,
01483    UInt16        NewAddress
01484 );
01485 
01486 //==========================================================================
01487 /*!
01488     \brief This message is sent by a CEC switch to indicate the active route
01489            below the switch.
01490 
01491     \param tmInstance_t Instance \n
01492            Instance identifier. \n
01493            
01494     \param UInt16 PhysicalAddress \n
01495            The current active route to the sink in the CEC switch. \n
01496 
01497     \return The call result:
01498             - TM_OK: the call was successful
01499             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01500               out of range
01501             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01502               the resource
01503             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01504               of range
01505 
01506 */
01507 //==========================================================================
01508 tmErrorCode_t tmdlHdmiCecRoutingInformation
01509 (
01510    tmInstance_t  Instance,
01511    UInt16        PhysicalAddress
01512 );
01513 
01514 //==========================================================================
01515 /*!
01516     \brief This message select directly an analogue TV Service.
01517 
01518     \param tmInstance_t Instance \n
01519            Instance identifier. \n
01520     
01521     \param tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType \n
01522            "Cable,Sattellite,Terrestrial".\n 
01523            
01524     \param UInt16 AnalogueFrequency \n
01525            Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).\n
01526     
01527     \param tmdlHdmiCECBroadcastSystem_t BroadcastSystem \n
01528            Specify information about the colour system, the sound carrier and
01529            the IF-frequency.\n
01530            
01531     \return The call result:
01532             - TM_OK: the call was successful
01533             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01534               out of range
01535             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01536               the resource
01537             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01538               of range
01539 
01540 */
01541 //==========================================================================
01542 tmErrorCode_t tmdlHdmiCecSelectAnalogueService
01543 (
01544    tmInstance_t                       Instance,
01545    UInt8                              ReceiverLogicalAddress,
01546    tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType,
01547    UInt16                             AnalogueFrequency,
01548    tmdlHdmiCECBroadcastSystem_t       BroadcastSystem
01549 );
01550 
01551 //==========================================================================
01552 /*!
01553     \brief This message select directly a digital TV, Radio or Data Broadcast
01554            Service.
01555 
01556     \param tmInstance_t Instance \n
01557            Instance identifier. \n
01558     
01559     \param tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification \n
01560            Pointer to the structure Digital Service Identification
01561            
01562     \return The call result:
01563             - TM_OK: the call was successful
01564             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01565               out of range
01566             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01567               the resource
01568             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01569               of range
01570 
01571 */
01572 //==========================================================================
01573 tmErrorCode_t tmdlHdmiCecSelectDigitalService
01574 (
01575    tmInstance_t                                Instance,
01576    UInt8                                       ReceiverLogicalAddress,
01577    ptmdlHdmiCECDigitalServiceIdentification_t  pServiceIdentification
01578 );
01579 
01580 //==========================================================================
01581 /*!
01582     \brief This message is used to set asingle timer block on an analogue 
01583            recording device.
01584 
01585     \param tmInstance_t Instance \n
01586            Instance identifier. \n
01587            
01588     \param UInt8 ReceiverLogicalAddress \n
01589            Address of message receiver. \n
01590            
01591     \param UInt8  DayOfMonth \n
01592            Day of the month.\n
01593     
01594     \param UInt8  MonthOfYear \n
01595            Month of the year.\n
01596            
01597     \param UInt16 StartTime \n
01598            Start time for a timer based recording.\n
01599            
01600     \param UInt16 Duration \n
01601            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
01602     
01603     \param UInt8 Recording Sequence \n
01604            Indicates if recording is repeated and, if so, on which day
01605            For repeated recording the recording sequence value is the
01606            bitwise OR of the days when recordings are required
01607            Shall be set to 0x00 when recording is not repeated.\n
01608     
01609     \param tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType \n
01610            "Cable,Sattellite,Terrestrial".\n 
01611            
01612     \param UInt16 AnalogueFrequency \n
01613            Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).\n
01614     
01615     \param tmdlHdmiCECBroadcastSystem_t BroadcastSystem \n
01616            Specify information about the colour system, the sound carrier and
01617            the IF-frequency.\n
01618            
01619     \return The call result:
01620             - TM_OK: the call was successful
01621             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01622               out of range
01623             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01624               of range
01625 */
01626 //==========================================================================
01627 tmErrorCode_t tmdlHdmiCecSetAnalogueTimer
01628 (
01629    tmInstance_t                        Instance,
01630    UInt8                               ReceiverLogicalAddress,
01631    UInt8                               DayOfMonth,
01632    UInt8                               MonthOfYear,
01633    UInt16                              StartTime,
01634    tmdlHdmiCECDuration_t              *pDuration,
01635    UInt8                               RecordingSequence,
01636    tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType,
01637    UInt16                              AnalogueFrequency,
01638    tmdlHdmiCECBroadcastSystem_t       BroadcastSystem
01639 );
01640 
01641 //==========================================================================
01642 /*!
01643     \brief This message is used to control audio rate from Source device.
01644 
01645     \param tmInstance_t Instance \n
01646            Instance identifier. \n
01647     
01648     \param tmdlHdmiCECAudioRate_t AudioRate \n
01649            The audio rate requested. \n
01650            
01651     \return The call result:
01652             - TM_OK: the call was successful
01653             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01654               out of range
01655             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01656               the resource
01657             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01658               of range
01659 
01660 */
01661 //==========================================================================
01662 tmErrorCode_t tmdlHdmiCecSetAudioRate
01663 (
01664    tmInstance_t           Instance,
01665    UInt8                  ReceiverLogicalAddress,
01666    tmdlHdmiCECAudioRate_t AudioRate
01667 );
01668 
01669 //==========================================================================
01670 /*!
01671     \brief This message is used to set a digital timer block on a digital
01672            recording device
01673 
01674     \param tmInstance_t Instance \n
01675            Instance identifier. \n
01676            
01677     \param UInt8 ReceiverLogicalAddress \n
01678            Address of message receiver. \n
01679            
01680     \param UInt8  DayOfMonth \n
01681            Day of the month.\n
01682     
01683     \param UInt8  MonthOfYear \n
01684            Month of the year.\n
01685            
01686     \param UInt16 StartTime \n
01687            Start time for a timer based recording.\n
01688            
01689     \param UInt16 Duration \n
01690            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
01691     
01692     \param UInt8 Recording Sequence \n
01693            Indicates if recording is repeated and, if so, on which day
01694            For repeated recording the recording sequence value is the
01695            bitwise OR of the days when recordings are required
01696            Shall be set to 0x00 when recording is not repeated.\n
01697     
01698     \param tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification \n
01699            Pointer to the structure Digital Service Identification
01700 
01701     \return The call result:
01702             - TM_OK: the call was successful
01703             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01704               out of range
01705             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01706               of range
01707 */
01708 //==========================================================================
01709 tmErrorCode_t tmdlHdmiCecSetDigitalTimer
01710 (
01711    tmInstance_t                               Instance,
01712     UInt8                                     ReceiverLogicalAddress,
01713    UInt8                                      DayOfMonth,
01714    UInt8                                      MonthOfYear,
01715    UInt16                                     StartTime,
01716    tmdlHdmiCECDuration_t                     *pDuration,
01717    UInt8                                      RecordingSequence,
01718    tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification
01719 );
01720 
01721 //==========================================================================
01722 /*!
01723     \brief This message is used to set a single timer block to record from an
01724            external device
01725 
01726     \param tmInstance_t Instance \n
01727            Instance identifier. \n
01728            
01729     \param UInt8  DayOfMonth \n
01730            Day of the month.\n
01731     
01732     \param UInt8  MonthOfYear \n
01733            Month of the year.\n
01734            
01735     \param UInt16 StartTime \n
01736            Start time for a timer based recording.\n
01737            
01738     \param UInt16 Duration \n
01739            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
01740     
01741     \param UInt8 Recording Sequence \n
01742            Indicates if recording is repeated and, if so, on which day
01743            For repeated recording the recording sequence value is the
01744            bitwise OR of the days when recordings are required
01745            Shall be set to 0x00 when recording is not repeated.\n
01746     
01747     \param tmdlHdmiCECExternalPlug_t  ExternalPlug \n
01748            indicates external plug number (1 to 255 )on the recording device.\n
01749 
01750     \return The call result:
01751             - TM_OK: the call was successful
01752             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01753               out of range
01754             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01755               of range
01756 */
01757 //==========================================================================
01758 tmErrorCode_t tmdlHdmiCecSetExternalTimerWithExternalPlug
01759 (
01760    tmInstance_t                Instance,
01761    UInt8                       ReceiverLogicalAddress,
01762    UInt8                       DayOfMonth,
01763    UInt8                       MonthOfYear,
01764    UInt16                      StartTime,
01765    tmdlHdmiCECDuration_t      *pDuration,
01766    UInt8                       RecordingSequence,
01767    tmdlHdmiCECExternalPlug_t  ExternalPlug
01768 );
01769 
01770 //==========================================================================
01771 /*!
01772     \brief This message is used to set a single timer block to record from an
01773            external device
01774 
01775     \param tmInstance_t Instance \n
01776            Instance identifier. \n
01777            
01778     \param UInt8  DayOfMonth \n
01779            Day of the month.\n
01780     
01781     \param UInt8  MonthOfYear \n
01782            Month of the year.\n
01783            
01784     \param UInt16 StartTime \n
01785            Start time for a timer based recording.\n
01786            
01787     \param UInt16 Duration \n
01788            Pointer to the structure tmdlHdmiCECDuration_t in BCD format.\n
01789     
01790     \param UInt8 Recording Sequence \n
01791            Indicates if recording is repeated and, if so, on which day
01792            For repeated recording the recording sequence value is the
01793            bitwise OR of the days when recordings are required
01794            Shall be set to 0x00 when recording is not repeated.\n
01795     
01796     \param tmdlHdmiCECExternalPhysicalAddress_t  PhysicalAddress \n
01797            Defines the path between the TV an a device-thus giving it a physical
01798            address within the cluster.\n
01799 
01800     \return The call result:
01801             - TM_OK: the call was successful
01802             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01803               out of range
01804             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01805               of range
01806 */
01807 //==========================================================================
01808 tmErrorCode_t tmdlHdmiCecSetExternalTimerWithPhysicalAddress
01809 (
01810    tmInstance_t                           Instance,
01811    UInt8                                  ReceiverLogicalAddress,
01812    UInt8                                  DayOfMonth,
01813    UInt8                                  MonthOfYear,
01814    UInt16                                 StartTime,
01815    tmdlHdmiCECDuration_t                 *pDuration,
01816    UInt8                                  RecordingSequence,
01817    tmdlHdmiCECExternalPhysicalAddress_t  ExternalPhysicalAddress
01818 );
01819 
01820 //==========================================================================
01821 /*!
01822     \brief This message is used by a TV or another device to indicate the menu
01823            Language.
01824 
01825     \param tmInstance_t Instance \n
01826            Instance identifier. \n
01827     
01828     \param const char *pLanguage \n
01829            Pointer on the user's menu language choice. \n
01830     
01831     \return The call result:
01832             - TM_OK: the call was successful
01833             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01834               out of range
01835             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01836               the resource
01837             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01838               of range
01839 
01840 */
01841 //==========================================================================
01842 tmErrorCode_t tmdlHdmiCecSetMenuLanguage
01843 (
01844    tmInstance_t Instance,
01845    const char   *pLanguage
01846 );
01847 
01848 //==========================================================================
01849 /*!
01850     \brief This message is used to set the preferred OSD name of a device 
01851            for use in manus associated with that device.
01852 
01853     \param tmInstance_t Instance \n
01854            Instance identifier. \n
01855     
01856     \param const char *pOsdName \n
01857            Pointer on the preferred name of the device. \n
01858            
01859     \param UInt8    OsdNameLength \n
01860            Length of Osd Name String. \n
01861     
01862     \return The call result:
01863             - TM_OK: the call was successful
01864             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01865               out of range
01866             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01867               the resource
01868             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01869               of range
01870 
01871 */
01872 //==========================================================================
01873 tmErrorCode_t tmdlHdmiCecSetOsdName
01874 (
01875    tmInstance_t Instance,
01876    UInt8        ReceiverLogicalAddress,
01877    const char   *pOsdName,
01878    UInt8        OsdNameLength
01879 );
01880 
01881 //==========================================================================
01882 /*!
01883     \brief This message is used to send a test message to output on a TV.
01884 
01885     \param tmInstance_t Instance \n
01886            Instance identifier. \n
01887            
01888     \param tmdlHdmiCECDisplayControl_t DisplayControl \n
01889            Display timing. \n
01890     
01891     \param const char *pOsdString \n
01892            Pointer on the Text to display. \n
01893      
01894     \param UInt8    OsdStringLength \n
01895            Length of Osd String. \n
01896     
01897     \return The call result:
01898             - TM_OK: the call was successful
01899             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01900               out of range
01901             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01902               the resource
01903             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01904               of range
01905 
01906 */
01907 //==========================================================================
01908 tmErrorCode_t tmdlHdmiCecSetOsdString
01909 (
01910    tmInstance_t                 Instance,
01911    UInt8                        ReceiverLogicalAddress,
01912    tmdlHdmiCECDisplayControl_t  DisplayControl,
01913    const char                   *pOsdString,
01914    UInt8                        OsdStringLength
01915 );
01916 
01917 //==========================================================================
01918 /*!
01919     \brief This message is used by a TV to request a streaming path from
01920            the specified physical address.
01921 
01922     \param tmInstance_t Instance \n
01923            Instance identifier. \n
01924            
01925     \param UInt16 PhysicalAddress \n
01926            Physical address of the device.\n
01927     
01928     \return The call result:
01929             - TM_OK: the call was successful
01930             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01931               out of range
01932             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01933               the resource
01934             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01935               of range
01936 
01937 */
01938 //==========================================================================
01939 tmErrorCode_t tmdlHdmiCecSetStreamPath
01940 (
01941    tmInstance_t  Instance,
01942    UInt16        PhysicalAddress
01943 );
01944 
01945 //==========================================================================
01946 /*!
01947     \brief This message turn the system audio Mode ON or OFF.
01948 
01949     \param tmInstance_t Instance \n
01950            Instance identifier. \n
01951            
01952     \param tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus \n
01953            Specifies if the system audio mode is ON or OFF.\n
01954     
01955     \return The call result:
01956             - TM_OK: the call was successful
01957             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01958               out of range
01959             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01960               the resource
01961             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01962               of range
01963 
01964 */
01965 //==========================================================================
01966 tmErrorCode_t tmdlHdmiCecSetSystemAudioMode
01967 (
01968    tmInstance_t                   Instance,
01969    UInt8                          ReceiverLogicalAddress,
01970    tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus
01971 );
01972 
01973 //==========================================================================
01974 /*!
01975     \brief This message is used to set the name of a program associated
01976            with a timer block.Sent directly after sending a 
01977            <Set analogue Timer> or <Set Digital Timer> message. The name
01978            is then associated with that timer block.
01979 
01980     \param tmInstance_t Instance \n
01981            Instance identifier. \n
01982     
01983     \param UInt8    ReceiverLogicalAddress \n
01984            Address of message receiver. \n
01985     
01986     \param const char *pProgramTitleString \n
01987            Pointer on the program title. \n
01988            
01989     \param UInt8    ProgramTitleLength \n
01990            Length of Program Title String. \n
01991     
01992     \return The call result:
01993             - TM_OK: the call was successful
01994             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
01995               out of range
01996             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
01997               the resource
01998             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
01999               of range
02000 
02001 */
02002 //==========================================================================
02003 tmErrorCode_t tmdlHdmiCecSetTimerProgramTitle
02004 (
02005    tmInstance_t Instance,
02006    UInt8        ReceiverLogicalAddress,
02007    const char   *pProgramTitleString,
02008    UInt8        ProgramTitleLength
02009 );
02010 
02011 //==========================================================================
02012 /*!
02013     \brief This message switches one or all devices into standby mode.Can be
02014            be used as a broadcast message o be addressed to a specific device.
02015 
02016     \param tmInstance_t Instance \n
02017            Instance identifier. \n
02018     
02019     \param UInt8    ReceiverLogicalAddress \n
02020            Address of message receiver. \n
02021     
02022     \return The call result:
02023             - TM_OK: the call was successful
02024             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02025               out of range
02026             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02027               the resource
02028             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02029               of range
02030 
02031 */
02032 //==========================================================================
02033 tmErrorCode_t tmdlHdmiCecStandby
02034 (
02035    tmInstance_t Instance,
02036    UInt8        ReceiverLogicalAddress
02037 );
02038 
02039 //==========================================================================
02040 /*!
02041     \brief A device implementing System Audio Control and which has volume
02042            control RC button(eg TV or STB) request to use System Audio Mode
02043            to the amplifier.
02044 
02045     \param tmInstance_t Instance \n
02046            Instance identifier. \n
02047            
02048     \param UInt16 PhysicalAddress \n
02049            Physical address of the device.\n
02050     
02051     \return The call result:
02052             - TM_OK: the call was successful
02053             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02054               out of range
02055             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02056               the resource
02057             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02058               of range
02059 
02060 */
02061 //==========================================================================
02062 tmErrorCode_t tmdlHdmiCecSystemAudioModeRequest
02063 (
02064    tmInstance_t  Instance,
02065    UInt8         ReceiverLogicalAddress,
02066    UInt16        PhysicalAddress
02067 );
02068 
02069 //==========================================================================
02070 /*!
02071     \brief Reports the current status of the System Audio Mode.
02072 
02073     \param tmInstance_t Instance \n
02074            Instance identifier. \n
02075            
02076     \param tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus \n
02077            Current system audio mode.\n
02078     
02079     \return The call result:
02080             - TM_OK: the call was successful
02081             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02082               out of range
02083             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02084               the resource
02085             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02086               of range
02087 
02088 */
02089 //==========================================================================
02090 tmErrorCode_t tmdlHdmiCecSystemAudioModeStatus
02091 (
02092    tmInstance_t                   Instance,
02093    UInt8                          ReceiverLogicalAddress,
02094    tmdlHdmiCECSystemAudioStatus_t SystemAudioStatus
02095 );
02096 
02097 //==========================================================================
02098 /*!
02099     \brief This message as <Image View On>, but should also remove any text,
02100            menus and PIP windows from the TV's display
02101 
02102     \param tmInstance_t Instance \n
02103            Instance identifier. \n
02104            
02105     \param UInt8    ReceiverLogicalAddress \n
02106            Address of message receiver. \n
02107 
02108     \return The call result:
02109             - TM_OK: the call was successful
02110             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02111               out of range
02112             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02113               the resource
02114 
02115 */
02116 //==========================================================================
02117 tmErrorCode_t tmdlHdmiCecTextViewOn
02118 (
02119    tmInstance_t   Instance,
02120    UInt8          ReceiverLogicalAddress
02121 );
02122 
02123 //==========================================================================
02124 /*!
02125     \brief This message is used to give the status of a <Cleared Analogue Timer>,
02126            <Clear Digital Timer> or <Clear External Timer> message.
02127 
02128     \param tmInstance_t Instance \n
02129            Instance identifier. \n
02130            
02131     \param tmdlHdmiCECTimerClearedStatusData_t TimerClearedStatusData \n
02132            Indicates if the timer was cleared successfully. \n
02133 
02134     \return The call result:
02135             - TM_OK: the call was successful
02136             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02137               out of range
02138             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02139               the resource
02140 
02141 */
02142 //==========================================================================
02143 tmErrorCode_t tmdlHdmiCecTimerClearedStatus
02144 (
02145    tmInstance_t                        Instance,
02146    UInt8                               ReceiverLogicalAddress,
02147    tmdlHdmiCECTimerClearedStatusData_t TimerClearedStatusData
02148 );
02149 
02150 //==========================================================================
02151 /*!
02152     \brief This message is used to send timer status to the initiator of a
02153            <Set Timer> message.
02154 
02155     \param tmInstance_t Instance \n
02156            Instance identifier. \n
02157            
02158     \param tmdlHdmiCECTimerStatusData_t *pTimerStatusData \n
02159            Pointer on the Timer status. \n
02160 
02161     \return The call result:
02162             - TM_OK: the call was successful
02163             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02164               out of range
02165             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02166               the resource
02167 
02168 */
02169 //==========================================================================
02170 tmErrorCode_t tmdlHdmiCecTimerStatus
02171 (
02172    tmInstance_t                 Instance,
02173    UInt8                        ReceiverLogicalAddress,
02174    tmdlHdmiCECTimerStatusData_t *pTimerStatusData
02175 );
02176 
02177 //==========================================================================
02178 /*!
02179     \brief This message is used by a tuner device to provide its status to the
02180            initiator of the <Give Tuner Device Status> message.
02181 
02182     \param tmInstance_t Instance \n
02183            Instance identifier. \n
02184     
02185     \param tmdlHdmiCECRecordingFlag_t RecordingFlag \n
02186            Indicates if the tuner is being used as a source of a recording. \n
02187            
02188     \param tmdlHdmiCECTunerDisplayInfo_t TunerDisplayInfo \n
02189            Indicates if the the device is currently deplaying its tuner or not. \n
02190            
02191     \param tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType \n
02192            "Cable,Sattellite,Terrestrial".\n 
02193            
02194     \param UInt16 AnalogueFrequency \n
02195            Specify frequency used by analogue tuner (0x0000<=N<=0xFFFF).\n
02196     
02197     \param tmdlHdmiCECBroadcastSystem_t BroadcastSystem \n
02198            Specify information about the colour system, the sound carrier and
02199            the IF-frequency.\n
02200 
02201     \return The call result:
02202             - TM_OK: the call was successful
02203             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02204               out of range
02205             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02206               the resource
02207 
02208 */
02209 //==========================================================================
02210 tmErrorCode_t tmdlHdmiCecTunerDeviceStatusAnalogue
02211 (
02212    tmInstance_t                       Instance,
02213    UInt8                              ReceiverLogicalAddress,
02214    tmdlHdmiCECRecordingFlag_t         RecordingFlag,
02215    tmdlHdmiCECTunerDisplayInfo_t      TunerDisplayInfo,
02216    tmdlHdmiCECAnalogueBroadcastType_t AnalogueBroadcastType,
02217    UInt16                             AnalogueFrequency,
02218    tmdlHdmiCECBroadcastSystem_t       BroadcastSystem
02219 );
02220 
02221 //==========================================================================
02222 /*!
02223     \brief This message is used by a tuner device to provide its status to the
02224            initiator of the <Give Tuner Device Status> message.
02225 
02226     \param tmInstance_t Instance \n
02227            Instance identifier. \n
02228     
02229     \param tmdlHdmiCECRecordingFlag_t RecordingFlag \n
02230            Indicates if the tuner is being used as a source of a recording. \n
02231            
02232     \param tmdlHdmiCECTunerDisplayInfo_t TunerDisplayInfo \n
02233            Indicates if the the device is currently deplaying its tuner or not. \n
02234            
02235     \param tmdlHdmiCECDigitalServiceIdentification_t *pServiceIdentification \n
02236            Pointer to the structure Digital Service Identification
02237 
02238     \return The call result:
02239             - TM_OK: the call was successful
02240             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02241               out of range
02242             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02243               the resource
02244 
02245 */
02246 //==========================================================================
02247 tmErrorCode_t tmdlHdmiCecTunerDeviceStatusDigital
02248 (
02249    tmInstance_t                               Instance,
02250    UInt8                                      ReceiverLogicalAddress,
02251    tmdlHdmiCECRecordingFlag_t                 RecordingFlag,
02252    tmdlHdmiCECTunerDisplayInfo_t              TunerDisplayInfo,
02253    ptmdlHdmiCECDigitalServiceIdentification_t pServiceIdentification
02254 );
02255 
02256 //==========================================================================
02257 /*!
02258     \brief This message is used to tune to next lowest service in a tuner's
02259            service list.Can be used for PIP.
02260 
02261     \param tmInstance_t Instance \n
02262            Instance identifier. \n
02263 
02264     \return The call result:
02265             - TM_OK: the call was successful
02266             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02267               out of range
02268             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02269               the resource
02270 
02271 */
02272 //==========================================================================
02273 tmErrorCode_t tmdlHdmiCecTunerStepDecrement
02274 (
02275    tmInstance_t   Instance,
02276    UInt8          ReceiverLogicalAddress
02277 );
02278 
02279 //==========================================================================
02280 /*!
02281     \brief This message is used to tune to next highest service in a tuner's
02282            service list.Can be used for PIP.
02283 
02284     \param tmInstance_t Instance \n
02285            Instance identifier. \n
02286 
02287     \return The call result:
02288             - TM_OK: the call was successful
02289             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02290               out of range
02291             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02292               the resource
02293 
02294 */
02295 //==========================================================================
02296 tmErrorCode_t tmdlHdmiCecTunerStepIncrement
02297 (
02298    tmInstance_t   Instance,
02299    UInt8          ReceiverLogicalAddress
02300 );
02301 
02302 //==========================================================================
02303 /*!
02304     \brief This message is used to indicate that the user pressed a remote button
02305            or switched from one remote control button to another.
02306 
02307     \param tmInstance_t Instance \n
02308            Instance identifier. \n
02309            
02310     \param tmdlHdmiCECUserRemoteControlCommand_t UICommand \n
02311            Relevant UI command issued by user. \n
02312 
02313     \return The call result:
02314             - TM_OK: the call was successful
02315             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02316               out of range
02317             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02318               the resource
02319 
02320 */
02321 //==========================================================================
02322 tmErrorCode_t tmdlHdmiCecUserControlPressed
02323 (
02324    tmInstance_t                          Instance,
02325    UInt8                                 ReceiverLogicalAddress,
02326    tmdlHdmiCECUserRemoteControlCommand_t UICommand
02327 );
02328 
02329 //==========================================================================
02330 /*!
02331     \brief This message is used to indicate that the user pressed a remote button
02332            or switched from one remote control button to another.
02333 
02334     \param tmInstance_t Instance \n
02335            Instance identifier. \n
02336            
02337     \param tmdlHdmiCECPlayMode_t PlayMode \n
02338            In which mode to play media. \n
02339 
02340     \return The call result:
02341             - TM_OK: the call was successful
02342             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02343               out of range
02344             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02345               the resource
02346 
02347 */
02348 //==========================================================================
02349 tmErrorCode_t tmdlHdmiCecUserControlPressedPlay
02350 (
02351    tmInstance_t                          Instance,
02352    UInt8                                 ReceiverLogicalAddress,
02353    tmdlHdmiCECPlayMode_t                 PlayMode
02354 );
02355 
02356 //==========================================================================
02357 /*!
02358     \brief This message is used to indicate that the user pressed a remote button
02359            or switched from one remote control button to another.
02360 
02361     \param tmInstance_t Instance \n
02362            Instance identifier. \n
02363            
02364     \param UInt8 SelectAudioInput \n
02365            Number of the Audio Input (Audio input number between 1 and 255). \n
02366 
02367     \return The call result:
02368             - TM_OK: the call was successful
02369             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02370               out of range
02371             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02372               the resource
02373 
02374 */
02375 //==========================================================================
02376 tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAudioInput
02377 (
02378    tmInstance_t                          Instance,
02379    UInt8                                 ReceiverLogicalAddress,
02380    UInt8                                 SelectAudioInput
02381 );
02382 
02383 //==========================================================================
02384 /*!
02385     \brief This message is used to indicate that the user pressed a remote button
02386            or switched from one remote control button to another.
02387 
02388     \param tmInstance_t Instance \n
02389            Instance identifier. \n
02390            
02391     \param UInt8 SelectAVInput \n
02392            Number of the A/V Input (A/V input number between 1 and 255). \n
02393 
02394     \return The call result:
02395             - TM_OK: the call was successful
02396             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02397               out of range
02398             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02399               the resource
02400 
02401 */
02402 //==========================================================================
02403 tmErrorCode_t tmdlHdmiCecUserControlPressedSelectAVInput
02404 (
02405    tmInstance_t                          Instance,
02406    UInt8                                 ReceiverLogicalAddress,
02407    UInt8                                 SelectAVInput
02408 );
02409 
02410 //==========================================================================
02411 /*!
02412     \brief This message is used to indicate that the user pressed a remote button
02413            or switched from one remote control button to another.
02414 
02415     \param tmInstance_t Instance \n
02416            Instance identifier. \n
02417            
02418     \param UInt8 SelectMedia \n
02419            Number of Media (Media number between 1 and 255). \n
02420 
02421     \return The call result:
02422             - TM_OK: the call was successful
02423             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02424               out of range
02425             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02426               the resource
02427 
02428 */
02429 //==========================================================================
02430 tmErrorCode_t tmdlHdmiCecUserControlPressedSelectMedia
02431 (
02432    tmInstance_t                          Instance,
02433    UInt8                                 ReceiverLogicalAddress,
02434    UInt8                                 SelectMedia
02435 );
02436 
02437 //==========================================================================
02438 /*!
02439     \brief This message is used to indicate that the user pressed a remote button
02440            or switched from one remote control button to another.
02441 
02442     \param tmInstance_t Instance \n
02443            Instance identifier. \n
02444            
02445     \param tmdlHdmiCECChannelIdentifier_t  *pChannelIdentifier \n
02446            Pointer to the structure of Major and Minor Channel number
02447 
02448     \return The call result:
02449             - TM_OK: the call was successful
02450             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02451               out of range
02452             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02453               the resource
02454 
02455 */
02456 //==========================================================================
02457 tmErrorCode_t tmdlHdmiCecUserControlPressedTune
02458 (
02459    tmInstance_t                          Instance,
02460    UInt8                                 ReceiverLogicalAddress,
02461    tmdlHdmiCECChannelIdentifier_t        *pChannelIdentifier
02462 );
02463 
02464 //==========================================================================
02465 /*!
02466     \brief This message is used to indicate that the user released a remote button
02467            The last one indicated by the <User Control Pressed> Message.
02468 
02469     \param tmInstance_t Instance \n
02470            Instance identifier. \n
02471            
02472     \return The call result:
02473             - TM_OK: the call was successful
02474             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02475               out of range
02476             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02477               the resource
02478 
02479 */
02480 //==========================================================================
02481 tmErrorCode_t tmdlHdmiCecUserControlReleased
02482 (
02483    tmInstance_t  Instance,
02484    UInt8         ReceiverLogicalAddress
02485 );
02486 
02487 //==========================================================================
02488 /*!
02489     \brief This message is allows vendor specific commands to be sent between 
02490            two devices.
02491 
02492     \param tmInstance_t Instance \n
02493            Instance identifier. \n
02494     
02495     \param UInt8  *pVendorSpecificData \n
02496            Pointer to the Vendor Specific datas
02497            
02498     \param UInt8    VendorSpecificDataLength \n
02499            Length of VendorSpecificData. \n
02500            
02501     \return The call result:
02502             - TM_OK: the call was successful
02503             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02504               out of range
02505             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02506               the resource
02507 
02508 */
02509 //==========================================================================
02510 tmErrorCode_t tmdlHdmiCecVendorCommand
02511 (
02512    tmInstance_t  Instance,
02513    UInt8         ReceiverLogicalAddress,
02514    UInt8         *pVendorSpecificData,
02515    UInt8         VendorSpecificDataLength
02516 );
02517 
02518 //==========================================================================
02519 /*!
02520     \brief This message is allows vendor specific commands to be sent between 
02521            two devices or broadcast.
02522 
02523     \param tmInstance_t Instance \n
02524            Instance identifier. \n
02525            
02526     \param UInt32 VendorID \n
02527            Indentifier for a specific Vendor \n
02528     
02529     \param UInt8  *pVendorSpecificData \n
02530            Pointer to the Vendor Specific datas
02531            
02532     \param UInt8    VendorSpecificDataLength \n
02533            Length of VendorSpecificData. \n
02534            
02535     \return The call result:
02536             - TM_OK: the call was successful
02537             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02538               out of range
02539             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02540               the resource
02541 
02542 */
02543 //==========================================================================
02544 tmErrorCode_t tmdlHdmiCecVendorCommandWithID
02545 (
02546    tmInstance_t  Instance,
02547    UInt8         ReceiverLogicalAddress,
02548    UInt32        VendorID,
02549    UInt8         *pVendorSpecificData,
02550    UInt8         VendorSpecificDataLength
02551 );
02552 
02553 //==========================================================================
02554 /*!
02555     \brief This message indicates that a remote control button has been depressed.
02556 
02557     \param tmInstance_t Instance \n
02558            Instance identifier. \n
02559            
02560     \param UInt8  *pVendorSpecificRcCode \n
02561            Pointer to the Vendor Specific remote control code.
02562            its recommended t keep this to a minimum size.
02563            The maximum length shall not exceed 14 data blocks to avoid saturating bus
02564            
02565     \param UInt8    VendorSpecificRcCodeLength \n
02566            Length of VendorSpecificRcCode. \n
02567            
02568     \return The call result:
02569             - TM_OK: the call was successful
02570             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02571               out of range
02572             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02573               the resource
02574 
02575 */
02576 //==========================================================================
02577 tmErrorCode_t tmdlHdmiCecVendorRemoteButtonDown
02578 (
02579    tmInstance_t  Instance,
02580    UInt8         ReceiverLogicalAddress,
02581    UInt8         *pVendorSpecificRcCode,
02582    UInt8         VendorSpecificRcCodeLength
02583 );
02584 
02585 //==========================================================================
02586 /*!
02587     \brief This message indicates that a remote control button (the last button
02588            pressed indicated by the <Vendor remote button down > message) has 
02589            been released.
02590 
02591     \param tmInstance_t Instance \n
02592            Instance identifier. \n
02593            
02594     \return The call result:
02595             - TM_OK: the call was successful
02596             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02597               out of range
02598             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02599               the resource
02600 
02601 */
02602 //==========================================================================
02603 tmErrorCode_t tmdlHdmiCecVendorRemoteButtonUp
02604 (
02605    tmInstance_t  Instance,
02606    UInt8         ReceiverLogicalAddress
02607 );
02608 
02609 //==========================================================================
02610 /*!
02611     \brief Get the software version of the driver.
02612            This function is synchronous.
02613            This function is ISR friendly.
02614 
02615     \param pSWVersion Pointer to the version structure
02616 
02617     \return The call result:
02618             - TM_OK: the call was successful
02619             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02620               inconsistent
02621 */
02622 //==========================================================================
02623 tmErrorCode_t tmdlHdmiCecGetSWVersion
02624 (
02625     tmSWVersion_t  *pSWVersion
02626 );
02627 
02628 //==========================================================================
02629 /*!
02630     \brief Get the number of available CEC devices in the system.
02631            A unit directly represents a physical device.
02632            This function is synchronous.
02633            This function is ISR friendly.
02634 
02635     \param pUnitCount Pointer to the number of available units.
02636 
02637     \return The call result:
02638             - TM_OK: the call was successful
02639             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02640               inconsistent
02641 */
02642 //==========================================================================
02643 tmErrorCode_t tmdlHdmiCecGetNumberOfUnits
02644 (
02645     UInt32  *pUnitCount
02646 );
02647 
02648 //==========================================================================
02649 /*!
02650     \brief Get the capabilities of unit 0. Capabilities are stored into a
02651            dedicated structure.
02652            This function is synchronous.
02653            This function is not ISR friendly.
02654 
02655     \param pCapabilities Pointer to the capabilities structure.
02656 
02657     \return The call result:
02658             - TM_OK: the call was successful
02659             - TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or
02660               the receiver instance is not initialised
02661             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02662               inconsistent
02663             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02664               of range
02665 */
02666 //==========================================================================
02667 tmErrorCode_t tmdlHdmiCecGetCapabilities
02668 (
02669     tmdlHdmiCecCapabilities_t *pCapabilities
02670 );
02671 
02672 //==========================================================================
02673 /*!
02674     \brief Get the capabilities of a specific unit. Capabilities are stored
02675            into a dedicated structure 
02676            This function is synchronous.
02677            This function is not ISR friendly.
02678 
02679     \param unit          Unit to be probed.
02680     \param pCapabilities Pointer to the capabilities structure.
02681 
02682     \return The call result:
02683             - TM_OK: the call was successful
02684             - TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or
02685               the receiver instance is not initialised
02686             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02687               inconsistent
02688             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02689               of range
02690 */
02691 //==========================================================================
02692 tmErrorCode_t tmdlHdmiCecGetCapabilitiesM
02693 (
02694     tmUnitSelect_t            unit,
02695     tmdlHdmiCecCapabilities_t *pCapabilities
02696 );
02697 
02698 //==========================================================================
02699 /*!
02700     \brief Open unit 0 of CEC driver and provides the instance number to
02701            the caller. Note that one unit of CEC represents one physical
02702            CEC device and that only one instance per unit can be opened.
02703            This function is synchronous.
02704            This function is not ISR friendly.
02705 
02706     \param pInstance Pointer to the variable that will receive the instance
02707                      identifier.
02708 
02709     \return The call result:
02710             - TM_OK: the call was successful
02711             - TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or
02712               the receiver instance is not initialised
02713             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02714               of range
02715             - TMDL_ERR_DLHDMICEC_RESOURCE_OWNED: the resource is already in use
02716             - TMDL_ERR_DLHDMICEC_INIT_FAILED: the unit instance is already
02717               initialised or something wrong happened at lower level.
02718             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02719               inconsistent
02720             - TMDL_ERR_DLHDMICEC_NO_RESOURCES: the resource is not available
02721 */
02722 //==========================================================================
02723 tmErrorCode_t tmdlHdmiCecOpen
02724 (
02725     tmInstance_t   *pInstance
02726 );
02727 
02728 //==========================================================================
02729 /*!
02730     \brief Open a specific unit of CEC driver and provides the instance
02731            number to the caller. Note that one unit of CEC represents one
02732            physical CEC device and that only one instance per unit can be
02733            opened.
02734            This function is synchronous.
02735            This function is not ISR friendly.
02736 
02737     \param pInstance Pointer to the structure that will receive the instance
02738                      identifier.
02739     \param unit      Unit number to be opened.
02740 
02741     \return The call result:
02742             - TM_OK: the call was successful
02743             - TMDL_ERR_DLHDMICEC_BAD_UNIT_NUMBER: the unit number is wrong or
02744               the receiver instance is not initialised
02745             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02746               of range
02747             - TMDL_ERR_DLHDMICEC_RESOURCE_OWNED: the resource is already in use
02748             - TMDL_ERR_DLHDMICEC_INIT_FAILED: the unit instance is already
02749               initialised or something wrong happened at lower level.
02750             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02751               inconsistent
02752             - TMDL_ERR_DLHDMICEC_NO_RESOURCES: the resource is not available
02753 */
02754 //==========================================================================
02755 tmErrorCode_t tmdlHdmiCecOpenM
02756 (
02757     tmInstance_t   *pInstance,
02758     tmUnitSelect_t  unit
02759 );
02760 
02761 //==========================================================================
02762 /*!
02763     \brief Close an instance of CEC driver.
02764            This function is synchronous.
02765            This function is not ISR friendly.
02766 
02767     \param instance Instance identifier.
02768 
02769     \return The call result:
02770             - TM_OK: the call was successful
02771             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02772               out of range
02773             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02774               the resource
02775 */
02776 //==========================================================================
02777 tmErrorCode_t tmdlHdmiCecClose
02778 (
02779     tmInstance_t   instance
02780 );
02781 
02782 //==========================================================================
02783 /*!
02784     \brief Set the power state of an instance of the CEC device. ON
02785            state corresponds to a fully supplied, up and running device. Other
02786            modes correspond to the powerdown state of the device.
02787            This function is synchronous.
02788            This function is not ISR friendly.
02789 
02790 
02791     \param instance   Instance identifier.
02792     \param powerState Power state to set.
02793 
02794     \return The call result:
02795             - TM_OK: the call was successful
02796             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02797               out of range
02798             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02799               of range
02800 */
02801 //==========================================================================
02802 tmErrorCode_t tmdlHdmiCecSetPowerState
02803 (
02804     tmInstance_t   instance,
02805     tmPowerState_t powerState
02806 );
02807 
02808 //==========================================================================
02809 /*!
02810     \brief Get the power state of an instance of the CEC device. ON
02811            state corresponds to a fully supplied, up and running device. Other
02812            modes correspond to the powerdown state of the device.
02813            This function is synchronous.
02814            This function is not ISR friendly.
02815 
02816     \param instance    Instance identifier.
02817     \param pPowerState Pointer to the power state.
02818 
02819     \return The call result:
02820             - TM_OK: the call was successful
02821             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02822               out of range
02823             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02824               of range
02825             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02826               inconsistent
02827 */
02828 //==========================================================================
02829 tmErrorCode_t tmdlHdmiCecGetPowerState
02830 (
02831     tmInstance_t    instance,
02832     tmPowerState_t *pPowerState
02833 );
02834 
02835 //==========================================================================
02836 /*!
02837     \brief Set the configuration of instance attributes. This function is
02838            required by DVP architecture rules but actually does nothing in this
02839            driver
02840            This function is synchronous.
02841            This function is ISR friendly.
02842 
02843     \param instance    Instance identifier.
02844 
02845     \return The call result:
02846             - TM_OK: the call was successful
02847             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02848               out of range
02849             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02850               of range
02851 */
02852 //==========================================================================
02853 tmErrorCode_t tmdlHdmiCecInstanceConfig
02854 (
02855     tmInstance_t    instance
02856 );
02857 
02858 //==========================================================================
02859 /*!
02860     \brief Setup the instance with its configuration parameters. This function
02861            allows basic instance configuration like Logical Address or device
02862            state.
02863            This function is synchronous.
02864            This function is not ISR friendly.
02865 
02866     \param instance   Instance identifier.
02867     \param pSetupInfo Pointer to the structure containing all setup parameters
02868 
02869     \return The call result:
02870             - TM_OK: the call was successful
02871             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
02872               of range
02873             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02874               inconsistent
02875             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02876               out of range
02877             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02878               the resource
02879 */
02880 //==========================================================================
02881 tmErrorCode_t tmdlHdmiCecInstanceSetup
02882 (
02883     tmInstance_t                instance,
02884     ptmdlHdmiCecInstanceSetup_t pSetupInfo
02885 );
02886 
02887 //==========================================================================
02888 /*!
02889     \brief Get instance setup parameters.
02890 
02891     \param instance   Instance identifier.
02892     \param pSetupInfo Pointer to the structure that will receive setup
02893                       parameters
02894                       This function is synchronous.
02895                       This function is not ISR friendly.
02896 
02897 
02898     \return The call result:
02899             - TM_OK: the call was successful
02900             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02901               the resource
02902             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02903               out of range
02904             - TMDL_ERR_DLHDMICEC_INCONSISTENT_PARAMS: an input parameter is
02905               inconsistent
02906 */
02907 //==========================================================================
02908 tmErrorCode_t tmdlHdmiCecGetInstanceSetup
02909 (
02910     tmInstance_t                instance,
02911     ptmdlHdmiCecInstanceSetup_t pSetupInfo
02912 );
02913 
02914 //==========================================================================
02915 /*!
02916     \brief Make device library handle an incoming interrupt. This function is
02917            used by application to tell the device library that the hardware
02918            sent an interrupt. It can also be used to poll the interrupt status
02919            of the device if the interrupt line is not physically connected to
02920            the CPU.
02921            This function is synchronous.
02922            This function is ISR friendly.
02923 
02924 
02925     \param instance   Instance identifier.
02926 
02927     \return The call result:
02928             - TM_OK: the call was successful
02929             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02930               out of range
02931             - TMDL_ERR_DLHDMICEC_BAD_HANDLE: the handle number is wrong
02932             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02933               the resource
02934             - TMDL_ERR_DLHDMICEC_FULL: the queue is full
02935 */
02936 //==========================================================================
02937 tmErrorCode_t tmdlHdmiCecHandleInterrupt
02938 (
02939     tmInstance_t    instance
02940 );
02941 
02942 //==========================================================================
02943 /*!
02944     \brief Register event callbacks. Only one callback is registered through
02945            this API. This callback will received the type of event that
02946            occured throug a dedicated parameter and will be called as many
02947            times as there is pending events.
02948            This function is synchronous.
02949            This function is ISR friendly.
02950 
02951     \param instance   Instance identifier.
02952     \param pCallback  Pointer to the callback function that will handle events
02953                       from the devlib.
02954 
02955     \return The call result:
02956             - TM_OK: the call was successful
02957             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02958               out of range
02959             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02960               the resource
02961             - TMDL_ERR_DLHDMICEC_INVALID_STATE: the state is invalid for
02962               the function
02963 */
02964 //==========================================================================
02965 tmErrorCode_t tmdlHdmiCecRegisterCallbacks
02966 (
02967     tmInstance_t                instance,
02968     ptmdlHdmiCecCallbackFunc_t  pkCallback
02969 );
02970 
02971 //==========================================================================
02972 /*!
02973     \fn tmErrorCode_t tmdlHdmiCecSetLogicalAddress( )
02974     \brief Set Device Logical Address
02975 
02976     \param instance Instance identifier.
02977     \param LogicalAddress Logical Address value.
02978 
02979     \return The call result:
02980             - TM_OK: the call was successful
02981             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
02982               out of range
02983             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
02984               the resource
02985 
02986 */
02987 //==========================================================================
02988 tmErrorCode_t tmdlHdmiCecSetLogicalAddress
02989 (
02990     tmInstance_t   instance,
02991     tmdlHdmiCECLogicalAddress_t   LogicalAddress
02992 );
02993 
02994 //==========================================================================
02995 /*!
02996     \fn tmErrorCode_t tmdlHdmiCecSetRetry( )
02997     \brief Change the number of retransmission
02998 
02999     \param instance Instance identifier.
03000     \param NbRetry Number of retry.
03001 
03002     \return The call result:
03003             - TM_OK: the call was successful
03004             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03005               out of range
03006             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
03007               the resource
03008 
03009 */
03010 //==========================================================================
03011 tmErrorCode_t tmdlHdmiCecSetRetry
03012 (
03013     tmInstance_t   instance,
03014     UInt8   NbRetry
03015 );
03016 
03017 
03018 //==========================================================================
03019 /*!
03020     \fn tmErrorCode_t getCecLastMessage( )
03021     \brief Return the Addresses and the Opcode of the last CEC
03022            transmitted message
03023 
03024     \param pSaveMessage   Pointer to the CEC Save Message
03025 
03026     \return The call result:
03027             - TM_OK: the call was successful
03028             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03029               out of range
03030             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
03031               the resource
03032 
03033 */
03034 //==========================================================================
03035 tmErrorCode_t getCecLastMessage
03036 (
03037     tmdlHdmiCecSaveMessage_t  *pSaveMessage
03038 );
03039 
03040 
03041 //==========================================================================
03042 /*!
03043     \brief This function allows enabling a specific event of devlib.
03044            This function is synchronous.
03045            This function is not ISR friendly.
03046 
03047     \param instance Instance identifier.
03048     \param event    Event to enable
03049 
03050     \return The call result:
03051             - TM_OK: the call was successful
03052             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03053               out of range
03054             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
03055               of range
03056 */
03057 //==========================================================================
03058 tmErrorCode_t tmdlHdmiCecEnableEvent
03059 (
03060     tmInstance_t      instance,
03061     tmdlHdmiCecEvent_t event
03062 );
03063 
03064 //==========================================================================
03065 /*!
03066     \brief This function allows disabling a specific event of devlib.
03067            This function is synchronous.
03068            This function is not ISR friendly.
03069 
03070     \param instance Instance identifier.
03071     \param event    Event to disable
03072 
03073     \return The call result:
03074             - TM_OK: the call was successful
03075             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03076               out of range
03077             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
03078               of range
03079 */
03080 //==========================================================================
03081 tmErrorCode_t tmdlHdmiCecDisableEvent
03082 (
03083     tmInstance_t      instance,
03084     tmdlHdmiCecEvent_t event
03085 );
03086 
03087 
03088 //==========================================================================
03089 /*!
03090     \brief This function enables calibration depending on CEC clock source
03091            This function is synchronous.
03092            This function is not ISR friendly.
03093 
03094     \param instance          Instance identifier.
03095     \param cecClockSource    CEC clock source
03096 
03097     \return The call result:
03098             - TM_OK: the call was successful
03099             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03100               out of range
03101             - TMDL_ERR_DLHDMICEC_BAD_PARAMETER: a parameter is invalid or out
03102               of range
03103 */
03104 //==========================================================================
03105 tmErrorCode_t tmdlHdmiCecEnableCalibration
03106 (
03107    tmInstance_t instance,
03108    tmdlHdmiCecClockSource_t cecClockSource
03109 );
03110 
03111 
03112 //==========================================================================
03113 /*!
03114     \brief This function disable calibration depending on CEC clock source
03115            This function is synchronous.
03116            This function is not ISR friendly.
03117 
03118     \param instance          Instance identifier.
03119 */
03120 //==========================================================================
03121 tmErrorCode_t tmdlHdmiCecDisableCalibration(
03122    tmInstance_t instance
03123 );
03124 
03125 //==========================================================================
03126 /*!
03127     \brief This function allow to send a generic CEC message
03128            This function has to be used when CEC messages are construct in 
03129        the middleware
03130 
03131     \param instance  Instance identifier.
03132     
03133     \param *pData    Pointer to the CEC data buffer 
03134     
03135     \param lenData   Lenght of I2C data buffer
03136     
03137     \return The call result:
03138             - TM_OK: the call was successful
03139             - TMDL_ERR_DLHDMICEC_BAD_INSTANCE: the instance number is wrong or
03140               out of range
03141             - TMDL_ERR_DLHDMICEC_RESOURCE_NOT_OWNED: the caller does not own
03142               the resource
03143 */
03144 //==========================================================================
03145 tmErrorCode_t tmdlHdmiCecSendMessage(
03146 
03147    tmInstance_t instance,
03148    UInt8        *pData,
03149    UInt16       lenData
03150 );
03151 
03152 unsigned char tmdlHdmiCecGetRegister(tmInstance_t   instance, UInt32 offset);
03153 tmErrorCode_t tmdlHdmiCecSetRegister(tmInstance_t  instance,UInt32 offset,UInt32 value);
03154 
03155 
03156 
03157 #ifdef __cplusplus
03158 }
03159 #endif
03160 
03161 #endif /* TMDLHDMICEC_FUNCTIONS_H */
03162 
03163 /*============================================================================*/
03164 /*                            END OF FILE                                     */
03165 /*============================================================================*/
03166 

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