xref: /utopia/UTPA2-700.0.x/mxlib/include/drvNSK2.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 ////////////////////////////////////////////////////////////////////////////////
93 
94 #ifndef _DRVNSK2_H_
95 #define _DRVNSK2_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvNSK2.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 //#include "ndstypes.h"
113 ////////////////////////////////////////////////////////////////////////////////
114 // Define & data type
115 ////////////////////////////////////////////////////////////////////////////////
116 
117 
118 typedef void (*NSK2_IntNotify)(MS_U32 reason, MS_U32 acpuError);
119 
120 
121 ////////////////////////////////////////////////////////////////////////////////
122 // Extern Function
123 ////////////////////////////////////////////////////////////////////////////////
124 MS_U32 MDrv_NSK2_Init(void);
125 MS_U32 MDrv_NSK2_ColdReset(void);
126 MS_U32 MDrv_NSK2_EndSubtest(void);
127 MS_U32 MDrv_NSK2_Compare(MS_U32 StartAddr, MS_U32 CompareLens, MS_U32 CompareSim,
128                          MS_U32 Mask, MS_U32 ExpectResult);
129 MS_U32 MDrv_NSK2_CompareMem(MS_U32 reserved, MS_U32 StartAddr, MS_U32 CompareLens,
130                             MS_U32 CompareSim, MS_U32 ExpectResult, void *pGolden);
131 
132 MS_U32 MDrv_NSK2_CompareKTE(MS_U32 reserved_1, MS_U32 reserved_2, void *pLabel);
133 MS_U32 MDrv_NSK2_CompareOut(MS_U32 reserved_1, MS_U32 reserved_2, MS_U32 HighDWord, MS_U32 LowDWord);
134 
135 MS_U32 MDrv_NSK2_WriteMem(MS_U32 reserved, MS_U32 StartAddr, MS_U32 WriteLens, void *pWriteData);
136 MS_U32 MDrv_NSK2_WriteSFR(MS_U32 StartAddr, MS_U32 Data);
137 MS_U32 MDrv_NSK2_WriteESA(MS_U8 ESASelect, MS_U8 ESASubSelect, MS_U8 pid_no);
138 
139 MS_U32 MDrv_NSK2_WriteTransportKey( MS_U8 SCB, MS_U8 ForceSCB, void *pLabel, MS_U8 pid_no );
140 MS_U32 MDrv_NSK2_WriteM2MKey(void *pIV, MS_U8 SubAlgo);
141 MS_U32 MDrv_NSK2_WriteSCPUKey(void);
142 MS_U32 MDrv_NSK2_WriteReservedKey(void);
143 MS_U32 MDrv_NSK2_GetReserveKeyNum(void);
144 
145 MS_U32 MDrv_NSK2_SetRNG(MS_U32 reserved_1, MS_U16 RNG_Value);
146 MS_U32 MDrv_NSK2_BasicInitializationComplete(void);
147 MS_U32 MDrv_NSK2_DriveKteAck(void);
148 MS_U32 MDrv_NSK2_FillJTagPswd(void);
149 MS_U32 MDrv_NSK2_CheckPubOTPConfig(void *pCheck);
150 MS_U32 MDrv_NSK2_UnlockOTPCtrl(void);
151 
152 MS_U32 MDrv_NSK2_ReadData(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
153 MS_U32 MDrv_NSK2_WriteData(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
154 MS_U32 MDrv_NSK2_ReadData8(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
155 MS_U32 MDrv_NSK2_WriteData8(MS_U32 addr_offset, MS_U32 data_size, MS_U8 *data);
156 MS_U32 MDrv_NSK2_ReadData32(MS_U32 addr_offset, MS_U32 data_size, MS_U32 *data);
157 MS_U32 MDrv_NSK2_WriteData32(MS_U32 addr_offset, MS_U32 data_size, MS_U32 *data);
158 
159 MS_U32 MDrv_NSK2_SetIntNotify(NSK2_IntNotify IntNotify);
160 MS_U32 MDrv_NSK2_ExcuteCmd(MS_U32 command, MS_U32 control,
161                            MS_U32 register_offset, MS_U32 data_size,
162                            const MS_U8    *data);
163 
164 MS_U32 MDrv_NSK2_GetOTPProperties(MS_U32 *desc_size, MS_U8 *desc);
165 MS_U32 MDrv_NSK2_GetCMProperties(MS_U32 *desc_size, MS_U8 *desc);
166 MS_U32 MDrv_NSK2_GetM2MProperties(MS_U32 *desc_size, MS_U8 *desc);
167 MS_U32 MDrv_NSK2_GetDMAProperties(MS_U32 *desc_size, MS_U8 *desc);
168 
169 
170 MS_U32 MDrv_NSK2_GetMaxXConn(void);
171 MS_U32 MDrv_NSK2_GetOTPValue(MS_U32 u32Offset);
172 MS_U32 MDrv_NSK2_CMChannelNum(void);
173 MS_U32 MDrv_NSK2_GetOTPFieldValue(MS_U8 u8Tag, MS_U8 *pLength, MS_U32 *pRetValue);
174 void   MDrv_NSK2_SetDbgLevel(MS_U32 u32Level);
175 void   MDrv_NSK2_SetPollingCnt(MS_U32 u32Cnt);
176 void   MDrv_NSK2_GetRNGThroughPut(void *pRngData, MS_U32 u32DataSize, MS_BOOL bDump);
177 void   MDrv_NSK2_RunFree(MS_BOOL bRunFree);
178 void   MDrv_NSK2_PushSlowClock ( MS_BOOL HaltClk, MS_U32 TenSecond);
179 MS_U32 MDrv_NSK2_BasicInitializationComplete(void);
180 
181 MS_U32 MDrv_NSK21_InvalidCmChannel(MS_U16 PidSlot);
182 MS_U32 MDrv_NSK21_CfgCmChannel(MS_U16 PidSlot, MS_U16 LocalDAlgo, MS_U16  ESAAlgo, MS_U16 LocalSAlgo, MS_U16 SysKeyIndex);
183 MS_U32 MDrv_NSK21_WriteTransportKey(MS_U8 SCB, MS_U8 ForceSCB, void *pLocalDIV1, void *pLocalDIV2,
184                                     void *pESAIV1, void *pESAIV2, void *pLocalSIV1, void *pLocalSIV2, MS_U16 PidSlot );
185 
186 
187 //void   MDrv_NSK2_BurstLen(MS_U32 u32PVREng, MS_U32 u32BurstMode);
188 MS_U32 MDrv_NSK21_WriteM2MKey(MS_U32 M2MAlgo);
189 MS_U32 MDrv_NSK21_ModifyGenIn(MS_U32 MaskVal,MS_U32 XorVal);
190 MS_U32 MDrv_NSK21_WriteJTagKey(MS_U32 OverrideOid, MS_U32 Select);
191 MS_U32 MDrv_NSK2_CompareIRQ(MS_U32 reserved_1, MS_U32 reserved_2, MS_U32 ExpectedValue);
192 MS_U32 MDrv_NSK21_IncrementNvCounter(void);
193 MS_U32 MDrv_NSK2_WriteOtpKey(void);
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 #endif//_DRVNSK2_H_
199 
200