xref: /utopia/UTPA2-700.0.x/modules/hdmi/drv/hdmitx/include/halHDCPTx.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all
// or part of MStar Software is expressly prohibited, unless prior written
// permission has been granted by MStar.
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software.
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s
//    confidential information in strictest confidence and not disclose to any
//    third party.
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2006-2009 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// (��MStar Confidential Information��) by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
////////////////////////////////////////////////////////////////////////////////

/////////////////////////////////////////////////////////////////////////////////////////////////////
///
/// file    halHDCPTx.h
/// @author MStar Semiconductor,Inc.
/// @brief  HDMITx HDCP HAL
/////////////////////////////////////////////////////////////////////////////////////////////////////

#ifndef _HAL_HDCPTX_H_
#define _HAL_HDCPTX_H_


#ifdef __cplusplus
extern "C"
{
#endif

//-------------------------------------------------------------------------------------------------
//  Hardware Capability
//-------------------------------------------------------------------------------------------------


//-------------------------------------------------------------------------------------------------
//  Macro and Define
//-------------------------------------------------------------------------------------------------

#define SHA160LENGTH            5UL
#define BLOCKSIZE               64UL
#define BLOCKSIZE2              BLOCKSIZE << 1

//-------------------------------------------------------------------------------------------------
//  Type and Structure
//-------------------------------------------------------------------------------------------------

typedef struct
{
    MS_U32   m_auiBuf[SHA160LENGTH]; //Maximum for SHA256
    MS_U32   m_auiBits[2];
    MS_U8   m_aucIn[BLOCKSIZE2];    //128 bytes for SHA384, SHA512
}SHA1_DATA;

//-------------------------------------------------------------------------------------------------
//  Function and Variable
//-------------------------------------------------------------------------------------------------
extern void MHal_HDMITx_HdcpDebugEnable(MS_BOOL benable);
extern void MHal_HDMITx_GetHdcpKey(MS_BOOL useinternalkey, MS_U8 *data);
extern void MHal_HDMITx_HdcpKeyInit(MS_BOOL useinternalkey);
extern void MHal_HDMITx_HdcpInit(void);
extern MS_BOOL MHal_HDMITx_HdcpRxActive(void);
extern void MHal_HDMITx_HdcpSetEncrypt(MS_BOOL enable);
extern MS_BOOL MHal_HDMITx_HdcpCheckBksvLn(void);
extern MS_BOOL MHal_HDMITx_HdcpWriteAn(MS_U8 internal);
extern MS_BOOL MHal_HDMITx_HdcpWriteAksv(void);
extern void MHal_HDMITx_GET74(MS_U8 udata, MS_U8 *pdata);
extern void MHal_HDMITx_HdcpStartCipher(void);
extern void MHal_HDMITx_HdcpAuthPass(void);
extern MS_BOOL MHal_HDMITx_HdcpCheckRi(MS_U16 *ptx_ri, MS_U16 *prx_ri);
extern void MHal_HDMITx_HdcpSha1Init(SHA1_DATA *dig);
extern void MHal_HDMITx_HdcpSha1AddData(SHA1_DATA *dig, MS_U8 const * pcData, MS_U16  iDataLength);
extern void MHal_HDMITx_HdcpSha1FinalDigest(SHA1_DATA *dig, MS_U8* pcDigest);
extern void MHal_HDMITx_DdcRam_WriteEdidData(MS_U8 HDMI_Port, MS_U8 * HDMI_Data, MS_U32 u32Size, MS_BOOL bDDCheck);
extern void MHal_HDMITx_DDCRam_Access(void);

// *************  For customer NDS **************//
extern MS_BOOL MHal_HDMITx_HDCP_Get_BCaps(MS_U8 *u8bcaps);
extern MS_BOOL MHal_HDMITx_HDCP_Get_BStatus(MS_U16 *u16bstatus);
extern MS_BOOL MHal_HDMITx_HDCP_Get_BKSV(MS_U8 *u8bksv);
extern void MHal_HDMITx_HDCP_SHA1_Transform(unsigned int *sha1, const MS_U8 *s);
#ifdef __cplusplus
}
#endif


#endif // _HAL_HDCPTX_H_