source: svn/newcon3bcm2_21bu/magnum/portinginterface/hdm/7552/bhdm_cec.c

/***************************************************************************
 *     Copyright (c) 2003-2011, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: bhdm_cec.c $
 * $brcm_Revision: Hydra_Software_Devel/20 $
 * $brcm_Date: 11/22/11 6:02p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/portinginterface/hdm/7038/bhdm_cec.c $
 * 
 * Hydra_Software_Devel/20   11/22/11 6:02p vle
 * SW7425-1140: Merge to mainline.  Remove all CEC functionality out of
 * HDM PI.
 * 
 * Hydra_Software_Devel/SW7425-1140/2   11/22/11 5:47p vle
 * SW7425-1140: Add BHDM_CONFIG_CEC_LEGACY_SUPPORT for backward compatible
 * for CEC legacy platforms.
 * 
 * Hydra_Software_Devel/SW7425-1140/1   11/16/11 12:16p vle
 * SW7425-1140: Remove all CEC functionalities out of HDM PI
 * 
 * Hydra_Software_Devel/19   1/4/10 2:22p rgreen
 * SW3548-2670: Fix bdbg leave trace message for BHDM_CEC_GetMsgInfo
 * 
 * Hydra_Software_Devel/18   10/30/08 5:51p vle
 * PR47447: Merge to main branch.
 * Add new GetReceivedMessage API. Use same CEC configuration for
 * transmitter and receiver.
 * 
 * Hydra_Software_Devel/PR47447/1   9/30/08 7:03p vle
 * PR47447: Add new GetReceivedMessage API. Use same CEC configuration for
 * transmitter and receiver.
 * 
 * Hydra_Software_Devel/17   4/28/08 6:02p vle
 * PR42271: Move HDMI CEC implementations to bhdm_cec_priv to allow ease
 * of code sharing between HDMI transmitter and receiver platforms.
 * 
 * Hydra_Software_Devel/16   4/24/08 9:30p vle
 * PR42168: Add implementation of CEC message queue allowing CEC bus to be
 * re-enabled faster to process next message.
 * 
 * Hydra_Software_Devel/15   3/28/08 8:20p vle
 * PR 39341: Stop/start transmitting CEC message when reset/dereset CEC
 * core.
 * 
 * Hydra_Software_Devel/14   3/11/08 3:30p rgreen
 * PR40264: Add HDMI CEC Support for 3563
 * 
 * Hydra_Software_Devel/13   2/14/08 5:21p vle
 * PR 39069: Add BHDM_CEC_PingLogicalAddr() API for polling logical
 * address.
 * 
 * Hydra_Software_Devel/12   2/5/08 3:41p vle
 * PR 39341: Fix debug message in BHDM_CEC_ReportPhysicalAddress
 * 
 * Hydra_Software_Devel/11   2/4/08 10:36p vle
 * PR 39341: Add API allowing application to enable/disable CEC core.
 * Fix compiler warning in BHDM_CEC_ReportPhysicalAddress()
 * 
 * Hydra_Software_Devel/10   1/28/08 11:39a vle
 * PR 39069: Add implementation of BHDM_CEC_ReportPhysicalAddress
 * function.
 * 
 * Hydra_Software_Devel/9   12/3/07 6:07p rgreen
 * PR37814:Prevent transmission of 2nd CEC message when another is active
 * 
 * Hydra_Software_Devel/8   4/11/07 2:11p vle
 * PR 26746: Fix debug message.
 * 
 * Hydra_Software_Devel/7   1/11/07 5:07p rgreen
 * PR27069: Adjust CEC default timings
 * 
 * Hydra_Software_Devel/6   12/21/06 2:59p rgreen
 * PR26531: Should use #if instead of #ifdef for compile flag
 * BDBG_DEBUG_BUILD
 * 
 * Hydra_Software_Devel/5   2/1/06 6:56p rgreen
 * PR14359,PR19283: HDMI CEC Support
 * Move BHDM_CEC_xxx definitions to bavc_hdmi.h (BAVC_HDMI_CEC_xxx for
 * shared use with both Rx and Tx devices
 * Update CEC code for getting CEC logical/physical addresses
 * 
 * Hydra_Software_Devel/4   9/28/05 3:11p rgreen
 * PR8896: Add standard documentation file header
 * 
 ***************************************************************************/



/****************************** Include Files ********************************/
#include "bstd.h"

#include "bavc_hdmi.h"
#include "bhdm_config.h"

#include "bhdm_cec.h"
#include "bhdm_cec_priv.h"
#include "bhdm_priv.h"


BDBG_MODULE(BHDM_CEC) ;

#define BHDM_CHECK_RC( rc, func )                     \
do                                                \
{                                                                                         \
        if( (rc = BERR_TRACE(func)) != BERR_SUCCESS ) \
        {                                                                                     \
                goto done;                                                            \
        }                                                                                     \
} while(0)



/*=************************ Module Overview ********************************
  The CEC (Consumer Electronic Control) functions provide support for sending
  and receving messages used for the control of HDMI devices connected 
  together.

  These functions do not interpret CEC messages, but buffers them for access
  by application software.  Support is also provided to send messages to 
  other HDMI connected devices.
***************************************************************************/

#if BHDM_CONFIG_CEC_LEGACY_SUPPORT

/******************************************************************************
 * Public API
 ******************************************************************************/

BERR_Code BHDM_CEC_GetMyAddrs(
   BHDM_Handle hHDMI,        /* [in] HDMI handle */
   uint8_t *pMyPhysicalAddr, /* [out] ptr to uint8 to hold my Physical Addr */
   uint8_t *pMyLogicalAddr   /* [out] ptr to uint8 to hold my Logical Addr */
)  
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_GetMyAddrs);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_GetMyAddrs(hHDMI, pMyPhysicalAddr, pMyLogicalAddr);


        BDBG_LEAVE(BHDM_CEC_GetMyAddrs);
        return rc ;
}


BERR_Code BHDM_CEC_SetMyAddr(
   BHDM_Handle hHDMI,
   uint8_t MyLogicalAddr
)
{
        BERR_Code rc = BERR_SUCCESS;

        BDBG_ENTER(BHDM_CEC_SetMyAddr);
        BDBG_ASSERT(hHDMI);
        
        rc = BHDM_CEC_P_SetMyAddr(hHDMI, MyLogicalAddr);


        BDBG_LEAVE(BHDM_CEC_SetMyAddr);
        return rc;
}


BERR_Code BHDM_CEC_GetMsgInfo(
        BHDM_Handle hHDMI,     
        BAVC_HDMI_CEC_IntMessageType *CECMsgType, /* Interrupt Message Type (Rx or) Tx */
        uint8_t *CECMsgStatus,
        uint8_t *CECMsgLength,
        uint8_t *EOM
)
{
        BERR_Code rc = BERR_SUCCESS ;
        BDBG_ENTER(BHDM_CEC_GetMsgInfo);
        BDBG_ASSERT(hHDMI);
        
        rc = BHDM_CEC_P_GetMsgInfo(hHDMI, CECMsgType, CECMsgStatus, CECMsgLength, EOM);
        

        BDBG_LEAVE(BHDM_CEC_GetMsgInfo);
        return rc ;
}


BERR_Code BHDM_CEC_PingLogicalAddr(
   BHDM_Handle hHDMI,     /* [in] HDMI handle */
   uint8_t LogicalAddr  /* [in] device logical address */
) 
{
        BERR_Code rc = BERR_SUCCESS ;
        BDBG_ENTER(BHDM_CEC_PingLogicalAddr);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_PingLogicalAddr(hHDMI, LogicalAddr);
        
        
        BDBG_LEAVE(BHDM_CEC_PingLogicalAddr);
        return rc ;     
}


   
BERR_Code BHDM_CEC_XmitMsg(
   BHDM_Handle hHDMI,     /* [in] HDMI handle */
   uint8_t DestinationAddr, 
   const uint8_t *pCecTxMsgBuf, /* [in] ptr to buffer containing CEC msg to send */
   uint8_t uiPayLoadLength       /* [in] size (bytes) of buffer to send */
) 
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_XmitMsg);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_XmitMsg(hHDMI, DestinationAddr, pCecTxMsgBuf, uiPayLoadLength);

        
        BDBG_LEAVE(BHDM_CEC_XmitMsg);
        return rc ;     
}


BERR_Code BHDM_CEC_EnableReceive(
   BHDM_Handle hHDMI     /* [in] HDMI handle */
) 
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_EnableReceive);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_EnableReceive(hHDMI);
        
        
        BDBG_LEAVE(BHDM_CEC_EnableReceive);
        return rc ;
}


BERR_Code BHDM_CEC_GetReceivedMessage(
        BHDM_Handle hHDMI,     /* [in] HDMI handle */
        BAVC_HDMI_CEC_MessageData *pRecvMessageData /* [out] ptr to storage for received CEC msg */
) 
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_GetReceivedMessage);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_GetReceivedMessage(hHDMI, pRecvMessageData);


        BDBG_LEAVE(BHDM_CEC_GetReceivedMessage);
        return rc ;
}


BERR_Code BHDM_CEC_RecvMsg(
   BHDM_Handle hHDMI,     /* [in] HDMI handle */
   uint8_t *pCECRxMsgBuf, /* [out] ptr to storage for received CEC msg */
   uint8_t *iByteLength       /* [in ] size of memory in Received CEC Msg */
) 
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_RecvMsg);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_RecvMsg(hHDMI, pCECRxMsgBuf, iByteLength);


        BDBG_LEAVE(BHDM_CEC_RecvMsg);
        return rc ;
}



BERR_Code BHDM_CEC_ReportPhysicalAddress(
   BHDM_Handle hHDMI     /* [in] HDMI handle */
) 
{
        BERR_Code rc = BERR_SUCCESS ;

        BDBG_ENTER(BHDM_CEC_ReportPhysicalAddress);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_ReportPhysicalAddress(hHDMI);
        

        BDBG_LEAVE(BHDM_CEC_ReportPhysicalAddress);
        return rc ;
}


BERR_Code BHDM_CEC_Enable(
        BHDM_Handle hHDMI,              /* [in] HDMI handle */
        bool bEnableCec         /* [in] boolean to enable/disable CEC core      */
)
{
        BERR_Code rc = BERR_SUCCESS;

        BDBG_ENTER(BHDM_CEC_Enable);
        BDBG_ASSERT(hHDMI);

        rc = BHDM_CEC_P_Enable(hHDMI, bEnableCec);


        BDBG_LEAVE(BHDM_CEC_Enable);
        return rc;
}

#endif /* end BHDM_CONFIG_CEC_LEGACY_SUPPORT */