tmbslhdmitx_app.h

HDMI NXP9983 chipset controller driver

    tmbslHdmiTxafs_t        audioRate,
    UInt8                   i2sQualifier
);

/*============================================================================*/
/**
    \brief      Set audio channel allocation

    \param[in]  ChannelAllocation     audio channel allocation

    \return     The call result:
                - void
 */
void
appHdmiTx_setAudioChannelAllocation
(
	UInt8					ChannelAllocation
);

/*============================================================================*/
/**
    \brief      Switch on HDCP

    \param[in]  txUnit       Transmitter unit number
    \param[in]  voutFmt      Current CEA output format
    \param[in]  options      HDCP options (HDMITX_HDCP_OPTION_FORCE_ values)

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_Hdcp_On
(
    tmUnitSelect_t           txUnit,
    tmbslHdmiTxVidFmt_t      voutFmt,
    tmbslHdmiTxHdcpOptions_t options
);

/*============================================================================*/
/**
    \brief      Switch off HDCP

    \param[in]  txUnit       Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_Hdcp_Off
(
    tmUnitSelect_t      txUnit
);

/*============================================================================*/
/**
    \brief      Handle HDCP BCAPS interrupt as a callback

    \param[in]  txUnit       Transmitter unit number
    \param[out] pbBksvSecure BKSV check result

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleBCAPS
(
    tmUnitSelect_t txUnit,
    Bool *pbBksvSecure
);

/*============================================================================*/
/**
    \brief      Handle HDCP BSTATUS interrupt as a callback

    \param[in]  txUnit       Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleBSTATUS
(
    tmUnitSelect_t  txUnit
);

/*============================================================================*/
/**
    \brief      Handle HDCP ENCRYPT interrupt as a callback

    \param[in]  txUnit       Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleENCRYPT
(
    tmUnitSelect_t  txUnit
);

/*============================================================================*/
/**
    \brief      Handle HDCP PJ interrupt as a callback

    \param[in]  txUnit       Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handlePJ
(
    tmUnitSelect_t  txUnit
);

/*============================================================================*/
/**
    \brief      Handle HDCP SHA_1 interrupt as a callback

    \param[in]  txUnit       Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleSHA_1
(
    tmUnitSelect_t  txUnit
);

/*============================================================================*/
/**
    \brief      Handle HDCP T0 interrupt as a callback

    \param[in]  txUnit      Transmitter unit number

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleT0
(
    tmUnitSelect_t  txUnit
);

/*============================================================================*/
/**
    \brief      Handle Hot Plug Detect interrupt as a callback

    \param[in]  txUnit          Transmitter unit number
    \param[out] pHotPlugStatus  Pointer to hot plug status
    \param[out] pEdidStatus     Copy of pDis->EdidStatus
    \param[out] pEdidVidFlags   Ptr to video capability flags
                                See enum _tmbslHdmiTxVidCap_t

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t
appHdmiTx_handleHPD
(
    tmUnitSelect_t          txUnit,
    tmbslHdmiTxHotPlug_t    *pHotPlugStatus,
    UInt8                   *pEdidStatus,
    UInt8                   *pEdidVidFlags
);

/*============================================================================*/
/**
    \brief      Get the pointer to the KSV list used by the App unit

    \param[in]  ppKsvList      Pointer to pointer to KSV list
    \param[in]  pKsvDevices    Pointer to device count 0 to 128

    \return     None
 */
void 
appHdmiTx_getKsvList
(
    UInt8          **ppKsvList,
    UInt8          *pKsvDevices
);

/*============================================================================*/
/**
    \brief      Get the pointer to the BKSV used by the App unit

    \param[in]  ppBksv      Pointer to pointer to BKSV

    \return     None
 */
void 
appHdmiTx_getBksv
(
    UInt8          **ppBksv
);

/*============================================================================*/
/**
    \brief      Check a video format against the Short Video
                Descriptors last read from EDID

    \param[in]  vidFmt  Video format to check

    \return     The call result:
                - True:  vidFmt is in SVD list
                - False: not in list
 */
Bool
appHdmiTx_checkVidFmt
(
    tmbslHdmiTxVidFmt_t     vidFmt
);

/*============================================================================*/
/**
    \brief      Find the next video format in the Short Video Descriptors list
                last read from the EDID

    \param[in]  vidFmtOld      Video format whose successor must be found
    \param[in]  *pVidFmtNew    Ptr to a variable to receive the next higher
                               video format or the first format in SVD list

    \return     The call result:
                - True:  a format was found
                - False: no format was found because the list was empty
 */
Bool
appHdmiTx_nextEdidVidFmt
(
    tmbslHdmiTxVidFmt_t     vidFmtOld,
    tmbslHdmiTxVidFmt_t     *pVidFmtNew
);

/*============================================================================*/
/**
    \brief      Read Edid after PowerOn

    \param[in]  txUnit          Transmitter unit number
    \param[out] pEdidStatus     Copy of pDis->EdidStatus
    \param[out] pEdidVidFlags   Ptr to video capability flags
                                See enum _tmbslHdmiTxVidCap_t

    \return     The call result:
                - TM_OK: the call was successful
                - Else a problem has been detected
 */
tmErrorCode_t 
appHdmiTx_ReadEdidAtPowerOn
(
    tmUnitSelect_t          txUnit,
    UInt8                   *pEdidStatus,
    UInt8                   *pEdidVidFlags
);


#ifdef __cplusplus
}
#endif

#endif /* TMBSLHDMITX_APP_H */
/*============================================================================*/
/*                            END OF FILE                                     */
/*============================================================================*/