source: svn/trunk/newcon3bcm2_21bu/magnum/portinginterface/cec/7552/bcec_priv.h

/***************************************************************************
*          (c)2007-2011 Broadcom Corporation
*
* This program is the proprietary software of Broadcom Corporation and/or its licensors,
* and may only be used, duplicated, modified or distributed pursuant to the terms and
* conditions of a separate, written license agreement executed between you and Broadcom
* (an "Authorized License").    Except as set forth in an Authorized License, Broadcom grants
* no license (express or implied), right to use, or waiver of any kind with respect to the
* Software, and Broadcom expressly reserves all rights in and to the Software and all
* intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
* HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
* NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.
*
* Except as expressly set forth in the Authorized License,
*
* 1.       This program, including its structure, sequence and organization, constitutes the valuable trade
* secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
* and to use this information only in connection with your use of Broadcom integrated circuit products.
*
*       2.         TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
* THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
* LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
* OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
* USE OR PERFORMANCE OF THE SOFTWARE.
*
* 3.       TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
* LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
* EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
* USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
* ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
* LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
* ANY LIMITED REMEDY.
*
* $brcm_Workfile: bcec_priv.h $
* $brcm_Revision: Hydra_Software_Devel/5 $
* $brcm_Date: 2/28/12 10:57a $
*
* Module Description:
*
* Revision History:
*
* $brcm_Log: /magnum/portinginterface/cec/7425/bcec_priv.h $
* 
* Hydra_Software_Devel/5   2/28/12 10:57a vle
* SW7425-2289, SW7420-2256: Add more debug messages, fix compiler
* warnings for 65nm platforms
* 
* Hydra_Software_Devel/4   2/24/12 4:06p vle
* SW7425-2289: Merge to mainline
* 
* Hydra_Software_Devel/SW7425-2289/1   2/22/12 6:11p vle
* SW7425-2289: Add support for CEC AutoOn
* 
* Hydra_Software_Devel/3   2/17/12 3:44p vle
* SW7425-2279: Merge to mainline
* 
* Hydra_Software_Devel/SW7425-2279/4   2/16/12 4:55p vle
* SW7425-2279: Additional updates after 2nd review. Still need to rework
* Standby/Resume function to use CEC autoOn feature.
* 
* Hydra_Software_Devel/SW7425-2279/3   2/13/12 3:33p vle
* SW7420-682: Merge to SW7425-2279 branch
* 
* Hydra_Software_Devel/SW7425-2279/2   2/9/12 3:35p vle
* SW7425-2279: Update BCEC PI implementations. Use separate events for
* transmit and receive.
* 
* Hydra_Software_Devel/SW7425-2279/1   1/30/12 7:14p vle
* SW7425-2279: Fix incorrect return of received CEC message
* 
* Hydra_Software_Devel/SW7420-682/1   2/3/12 6:42p vle
* SW7420-682: First attempt at enable Auto-on CEC. Code hasn't gone
* through testing.
* 
* Hydra_Software_Devel/2   1/17/12 6:46p vle
* SW7125-1214: Fix crash issue duing initialization in proxy mode.
* 
* Hydra_Software_Devel/1   11/22/11 6:23p vle
* SW7425-1140: Add BCEC PI support
* 
* Hydra_Software_Devel/SW7425-1140/1   11/16/11 12:14p vle
* SW7425-1140: Add CEC PI support for 7425
* 
***************************************************************************/
#ifndef BCEC_PRIV_H__
#define BCEC_PRIV_H__

#include "bcec.h"

#ifdef __cplusplus
extern "C" {
#endif


#define BCEC_MAKE_INTR_ENUM(IntName) BCEC_INTR_e##IntName
#define BCEC_MAKE_INTR_NAME(IntName) "BCEC_" #IntName


#define BCEC_MAX_OPCODES 62
typedef struct 
{
        uint8_t opCode ;
        const char *opText ;
} BCEC_OpcodeTextTable ;

                                                          
/******************************************************************************
Summary:
Enumeration of BCEC_Interrupts 
*******************************************************************************/
typedef enum
{
#if BCEC_CONFIG_DUAL_INTERRUPT
        /* 00 */ BCEC_MAKE_INTR_ENUM(RECEIVED),
        /* 01 */ BCEC_MAKE_INTR_ENUM(SENT),     
#else
        /* 00 */ BCEC_MAKE_INTR_ENUM(CEC),
#endif  
        /* 01 */ BCEC_MAKE_INTR_ENUM(LAST)
} BCEC_P_InterruptMask ;


typedef struct BCEC_P_ReceivedMessageInfo
{
        BAVC_HDMI_CEC_MessageData data; 
        BCEC_MessageStatus status;
} BCEC_P_ReceivedMessageInfo ;


/*******************************************************************************
Private CEC Handle Declaration 
*******************************************************************************/
BDBG_OBJECT_ID_DECLARE(BCEC_P_Handle);

typedef struct BCEC_P_Handle
{
        BDBG_OBJECT(BCEC_P_Handle)
        BCEC_Dependencies stDependencies;
        BCEC_Settings stSettings;
        BINT_CallbackHandle hCallback[BCEC_MAKE_INTR_ENUM(LAST)] ;

        BKNI_EventHandle BCEC_EventCec_Transmitted ;
        BKNI_EventHandle BCEC_EventCec_Received;
        BCEC_MessageStatus lastTransmitMessageStatus ;
        BCEC_MessageStatus lastReceivedMessageStatus ;
        bool firstCecMessage ;
        
        bool standby; /* true if in standby */
        bool enableAutoOn;
} BCEC_P_Handle ;


void BCEC_P_HandleInterrupt_isr(
        void *pParam1,                                          /* [in] Device handle */
        int parm2                                                       /* [in] not used */
);


#if BCEC_CONFIG_AUTO_ON_SUPPORT
void BCEC_P_EnableAutoOn(
        BCEC_Handle hCEC, 
        bool enable
);
#endif


#ifdef __cplusplus
 }
#endif
  
#endif /* BCEC_PRIV_H__ */