xref: /utopia/UTPA2-700.0.x/modules/dscmb/hal/kano/nsk2/halNSK2.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) 2008-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.
////////////////////////////////////////////////////////////////////////////////

#ifndef _HAL_NSK2_H_
#define _HAL_NSK2_H_

////////////////////////////////////////////////////////////////////////////////
/// @file halNSK2.h
/// @author MStar Semiconductor Inc.
/// @brief
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
// Header Files
////////////////////////////////////////////////////////////////////////////////
#include "regNSK2.h"

////////////////////////////////////////////////////////////////////////////////
// Define & data type
////////////////////////////////////////////////////////////////////////////////
#define OpenAllConfigs   0
#define MaximumXConnection      2


typedef struct _cmchannel_group_capability_descriptor {
    MS_U8 descriptor_tag;
    MS_U8 descriptor_length;
    MS_U8 number_of_channels[4];
    MS_U8 switch_combination_bitmap[32];
    MS_U8 user_context[8];
} cmchannel_group_capability_descriptor_t;


typedef struct _cmchannel_group_algorithm_record_descriptor {
    MS_U8 descriptor_tag;
    MS_U8 descriptor_length;
    MS_U8 algorithm_type;
    MS_U8 algorithm;
    MS_U8 parity_combination_bitmap;
    MS_U8 capability;
} cmchannel_group_algorithm_record_descriptor_t;

typedef struct _DMA_Capabability_Descriptor{
    MS_U8 descriptor_tag;
    MS_U8 descriptor_length;
    MS_U8 maximum_data_size[4];
    MS_U8 minimum_data_size[4];
    MS_U8 data_size_granularity[4];
    MS_U8 data_alignment[4];
    MS_U8 capability[4];
} DMA_Capa_Desc_t;


typedef struct _M2MChannelGroup_Capabability_Descriptor{
    MS_U8 descriptor_tag;
    MS_U8 descriptor_length;
    MS_U8 number_of_channels[4];
    MS_U8 user_context[8];
} M2MChGr_Capa_Desc_t;

typedef struct _M2MChannelGroup_AlgoRecord_Descriptor{
    MS_U8 descriptor_tag;
    MS_U8 descriptor_length;
    MS_U8 algorithm;
    MS_U8 capability[4];
} M2MChGr_AlgoRecord_Desc_t;

typedef struct _NVCounter_Descriptor{
    MS_U8  descriptor_tag;
    MS_U8  descriptor_length;
    MS_U8  max_nvcounter[4];
    MS_U8  left_nvcounter[4];
} NVCounter_Desc_t;

////////////////////////////////////////////////////////////////////////////////
// Extern function
////////////////////////////////////////////////////////////////////////////////
MS_U32 HAL_NSK2_Init(void);
MS_U32 HAL_NSK2_Exit(void);
void   HAL_NSK2_SetBase(MS_U32 u32Base);
MS_U32 HAL_NSK2_ColdReset(void);

MS_U32 HAL_NSK2_CompareMem(MS_U32 reserved, MS_U32 StartAddr, MS_U32 CompareLens,
                           MS_U32 CompareSim, MS_U32 ExpectResult, void *pGolden);
MS_U32 HAL_NSK2_Compare(MS_U32 StartAddr, MS_U32 CompareLens, MS_U32 CompareSim,
                        MS_U32 Mask, MS_U32 ExpectResult);
MS_U32 HAL_NSK2_CompareKTE(MS_U32 reserved_1, MS_U32 reserved_2, void *pLabel);
MS_U32 HAL_NSK2_CompareOut(MS_U32 reserved_1, MS_U32 reserved_2, MS_U32 HighDWord, MS_U32 LowDWord);

MS_U32 HAL_NSK2_WriteControl(MS_U32 control);
MS_U32 HAL_NSK2_WriteCommand(MS_U32 command);
MS_U32 HAL_NSK2_WriteESA(MS_U8 ESASelect, MS_U8 ESASubSelect, MS_U8 pid_no);
MS_U32 HAL_NSK2_WriteMem(MS_U32 reserved, MS_U32 StartAddr, MS_U32 WriteLens, void *pWriteData);
MS_U32 HAL_NSK2_WriteM2MKey(void *pIV, MS_U8 SubAlgo);
MS_U32 HAL_NSK2_WriteSFR(MS_U32 StartAddr, MS_U32 Data);
MS_U32 HAL_NSK2_WriteSCPUKey(void);
MS_U32 HAL_NSK2_WriteTransportKey(MS_U8 SCB, MS_U8 ForceSCB, void *pLabel, MS_U8 pid_no);

MS_U32 HAL_NSK2_NSKBasicInitializationComplete(void);
MS_U32 HAL_NSK2_SetRNG(MS_U32 reserved_1,MS_U32 RNG_Value);
MS_U32 HAL_NSK2_DriveKteAck(void);
MS_U32 HAL_NSK2_SetJTagPswd(void);
MS_U32 HAL_NSK2_PushSlowClock ( MS_BOOL HaltClk, MS_U32 NumOfMs);
void   HAL_NSK2_RunFree(MS_BOOL bRunFree);


MS_U32 HAL_NSK2_UnlockOTPCtrl(void);
MS_BOOL HAL_NSK2_CheckPubOTPConfig(void *pCheck);

MS_U32 HAL_NSK2_ReadData(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
MS_U32 HAL_NSK2_WriteData(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
MS_U32 HAL_NSK2_ReadData8(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
MS_U32 HAL_NSK2_WriteData8(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
MS_U32 HAL_NSK2_ReadData32(MS_U32 addr_offset, MS_U32 data_size, MS_U32 *data);
MS_U32 HAL_NSK2_WriteData32(MS_U32 addr_offset, MS_U32 data_size, MS_U32 *data);
MS_U32 HAL_NSK2_EnableInt(void);
MS_U32 HAL_NSK2_GetIntStatus(void);
MS_U32 HAL_NSK2_ClearInt(MS_U32 u32IntValue);
MS_U32 HAL_NSK2_GetMaxXConn(void);
MS_U32 HAL_NSK2_CMChannelNum(void);
MS_U32 HAL_NSK2_ReadSwitchFromNSK2(void);
void   HAL_NSK2_ReadTSPInfo(MS_U32 pid_no);
void   HAL_NSK2_AllTSPPidFilter(void);
void   HAL_NSK2_ChangePidFilter(MS_U32 pid_no, MS_U32 Data);
void   HAL_NSK2_SetDbgLevel(MS_U32 u32Level);
void   HAL_NSK2_SetPollingCnt(MS_U32 u32Cnt);
void   HAL_NSK2_ClockTest(MS_U32 testnum);
void   HAL_NSK2_GetRNGThroughPut(void *pRngData, MS_U32 u32DataSize, MS_BOOL bDump);
void   HAL_NSK2_BurstLen(MS_U32 u32PVREng, MS_U32 u32BurstMode);
MS_U32 HAL_NSK2_GetCMProperties(MS_U32 *desc_size, MS_U8 *desc);
MS_U32 HAL_NSK2_GetM2MProperties(MS_U32 *desc_size, MS_U8 *desc);
MS_U32 HAL_NSK2_GetDMAProperties(MS_U32 *desc_size, MS_U8 *desc);
MS_U32 HAL_NSK2_GetOTPProperties(MS_U32 *desc_size, MS_U8 *desc);
MS_U32 HAL_NSK2_GetFullChipSize(void);
MS_U32 HAL_NSK2_GetFullChipConfig(MS_U32 *desc_size, MS_U8 *desc);
MS_U32 HAL_NSK2_GetNVCounterConfig(MS_U32 *desc_size, MS_U8 *desc);

void HAL_NSK2_ReadAllOTP(void);

MS_U32 HAL_NSK2_ReadKTEResp(void);
MS_U32 HAL_NSK21_InvalidCmChannel(MS_U16 PidSlot);
MS_U32 HAL_NSK21_CfgCmChannel(MS_U16 PidSlot, MS_U16 LocalDAlgo, MS_U16  ESAAlgo, MS_U16 LocalSAlgo, MS_U16 SysKeyIndex);
MS_U32 HAL_NSK21_WriteTransportKey(MS_U8 SCB, MS_U8 ForceSCB, void *pLocalDIV1, void *pLocalDIV2,
                                   void *pESAIV1, void *pESAIV2, void *pLocalSIV1, void *pLocalSIV2, MS_U16 PidSlot );
MS_U32 HAL_NSK21_WriteM2MKey(MS_U32 M2MAlgo);
MS_U32 HAL_NSK21_ModifyGenIn(MS_U32 MaskVal,MS_U32 XorVal);
MS_U32 HAL_NSK21_WriteJTagKey(MS_U32 OverrideOid, MS_U32 Select);
MS_U32 HAL_NSK21_IncrementNvCounter(void);
MS_U32 HAL_NSK2_WriteOtpKey(void);
MS_U32 HAL_NSK2_EndSubtest(void);
MS_U32 HAL_NSK2_DisableInt(void);
MS_U32 HAL_NSK2_WriteReservedKey(void);
MS_U32 HAL_NSK2_GetReserveKeyNum(void);
MS_U32 HAL_NSK2_ReadPWD_Status(void);
MS_U32 HAL_NSK2_CtrlClk(MS_BOOL Enable);
MS_U32 HAL_NSK2_ReadClkStatus(void);
MS_U32 HAL_NSK2_GetSRAlignBit(void);
MS_BOOL HAL_NSK2_RSA_SetSecureRange(MS_U32 u32SecSet, MS_U32 u32SecStart, MS_U32 u32SecEnd, MS_BOOL bEnable);
void HAL_NSK2_RSA_SetSR_Mask(MS_U32 u32DramSize);

#endif  //_HAL_NSK2_H_