xref: /utopia/UTPA2-700.0.x/modules/security/hal/k6lite/rsa/halRSA.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) 2006-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 
95 ////////////////////////////////////////////////////////////////////////////////////////////////////
96 // file   halAESDMA.h
97 // @brief  AESDMA HAL
98 // @author MStar Semiconductor,Inc.
99 ////////////////////////////////////////////////////////////////////////////////////////////////////
100 #ifndef __HAL_RSA_H__
101 #define __HAL_RSA_H__
102 
103 
104 //--------------------------------------------------------------------------------------------------
105 //  Driver Compiler Option
106 //--------------------------------------------------------------------------------------------------
107 
108 //--------------------------------------------------------------------------------------------------
109 //  AESDMA Hardware Abstraction Layer
110 //--------------------------------------------------------------------------------------------------
111 
112 // TSP Register
113 #define _TspPid                     ((REG_Pid*)(REG_PIDFLT_BASE))
114 #define _TspSec                     ((REG_Sec*)(REG_SECFLT_BASE))
115 
116 #define DIGEST_SIZE_SHA1   5          //160-bit
117 #define DIGEST_SIZE_SHA256 8          //256-bit
118 #define SHA_MIU1_ENABLE    0x80000000 //Enable  access MIU1
119 #define SHA_UNIT_SIZE      8          //64-bits
120 
121 //--------------------------------------------------------------------------------------------------
122 //  Macro of bit operations
123 //--------------------------------------------------------------------------------------------------
124 #define HAS_FLAG(flag, bit)        ((flag) & (bit))
125 #define SET_FLAG(flag, bit)        ((flag)|= (bit))
126 #define RESET_FLAG(flag, bit)      ((flag)&= (~(bit)))
127 #define SET_FLAG1(flag, bit)       ((flag)|  (bit))
128 #define RESET_FLAG1(flag, bit)     ((flag)&  (~(bit)))
129 
130 
131 typedef enum {
132     RAM_READ = 0x0,
133     RAM_WRITE = 0x1
134 } RAM_DIR_t;
135 
136 
137 typedef enum {
138     E_RSA_SW_RESET_OFF = 0x0,
139     E_RSA_SW_RESET_ON = 0x1
140 } RSA_SW_RESET_t;
141 
142 typedef enum {
143     E_RSA_USE_SW_KEY = 0x0,
144     E_RSA_USE_HW_KEY = 0x1
145 } RSA_HW_KEY_t;
146 
147 typedef enum {
148     E_RSA_USE_PRIV_KEY = 0x0,
149     E_RSA_USE_PUB_KEY = 0x1
150 } RSA_PUB_KEY_t;
151 
152 typedef enum {
153     E_RSA_HW_PRI_KEY  = 0x0,
154     E_RSA_HW_PUB_KEY1 = 0x1,
155     E_RSA_HW_PUB_KEY2 = 0x2
156 } RSA_PUB_KEY_SEL_t;
157 
158 
159 /// HW PARSER Mode
160 
161 
162 typedef enum
163 {
164     E_RSA_ADDRESS_E = 0,
165     E_RSA_ADDRESS_N,
166     E_RSA_ADDRESS_A,
167     E_RSA_ADDRESS_Z,
168 } RSA_IND32Address;
169 
170 
171 
172 
173 
174 ////////////////////////////////////////////////
175 // HAL API
176 ////////////////////////////////////////////////
177 void HAL_RSA_ClearInt(void);
178 void HAL_RSA_Reset(void);
179 void HAL_RSA_Ind32Ctrl(MS_U8 u8dirction);
180 void HAL_RSA_LoadSram(MS_U32 *u32Buf, RSA_IND32Address eMode);
181 void HAL_RSA_SetKeyLength(MS_U32 u32keylen);
182 void HAL_RSA_SetKeyType(MS_U8 u8hwkey, MS_U8 u8pubkey);
183 void HAL_RSA_Rootkey_Sel(MS_U8 u8KeySrc);
184 void HAL_RSA_ExponetialStart(void);
185 MS_U32 HAL_RSA_GetStatus(void);
186 void HAL_RSA_FileOutStart(void);
187 void HAL_RSA_SetFileOutAddr(MS_U32 u32offset);
188 MS_U32 HAL_RSA_FileOut(void);
189 MS_U32 HAL_RSA_Get_RSA_IsFinished(void);
190 void HAL_RSA_SetBank(MS_VIRT u32NonPmBankAddr);
191 
192 MS_BOOL HAL_RSA_SetSecureRange(MS_U32 u32addr, MS_U32 u32size);
193 
194 void HAL_RSA_Hwkey_Switch(void);
195 MS_U32 HAL_RSA_Read_Hwkey_Switch(void);
196 
197 #endif // #ifndef __HAL_TSP_H__
198