xref: /utopia/UTPA2-700.0.x/modules/security/hal/k6lite/rsa/regRSA.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 //
97 //  File name: regAESDMA.h
98 //  Description: AESDMA Register Definition
99 //
100 ////////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _RSA_REG_MCU_H_
103 #define _RSA_REG_MCU_H_
104 
105 
106 //--------------------------------------------------------------------------------------------------
107 //  Abbreviation
108 //--------------------------------------------------------------------------------------------------
109 // Addr                             Address
110 // Buf                              Buffer
111 // Clr                              Clear
112 // CmdQ                             Command queue
113 // Cnt                              Count
114 // Ctrl                             Control
115 // Flt                              Filter
116 // Hw                               Hardware
117 // Int                              Interrupt
118 // Len                              Length
119 // Ovfw                             Overflow
120 // Pkt                              Packet
121 // Rec                              Record
122 // Recv                             Receive
123 // Rmn                              Remain
124 // Reg                              Register
125 // Req                              Request
126 // Rst                              Reset
127 // Scmb                             Scramble
128 // Sec                              Section
129 // Stat                             Status
130 // Sw                               Software
131 // Ts                               Transport Stream
132 
133 
134 //--------------------------------------------------------------------------------------------------
135 //  Global Definition
136 //--------------------------------------------------------------------------------------------------
137 
138 
139 //--------------------------------------------------------------------------------------------------
140 //  Compliation Option
141 //--------------------------------------------------------------------------------------------------
142 
143 
144 //-------------------------------------------------------------------------------------------------
145 //  Harware Capability
146 //-------------------------------------------------------------------------------------------------
147 
148 
149 //-------------------------------------------------------------------------------------------------
150 //  Type and Structure
151 //-------------------------------------------------------------------------------------------------
152 #define REG_RSACTRL_BASE            (0xA1200 * 2)
153 
154 #define RSA_E_BASE_ADDR             (0x00)
155 #define RSA_N_BASE_ADDR             (0x40)
156 #define RSA_A_BASE_ADDR             (0x80)
157 #define RSA_Z_BASE_ADDR             (0xC0)  /// 256-64
158 
159 #define RSA_MAX_SECURE_RANGE_SIZE   (0x6)
160 
161 typedef struct _REG32
162 {
163     volatile MS_U32                u32Reg;
164 } REG32;
165 
166 typedef struct _REG_SecureRange
167 {
168 	REG32 Rsa_Sec_Range_Start;
169 	REG32 Rsa_Sec_Range_End;
170 
171 }REG_SecureRange;
172 
173 
174 typedef struct _REG_RSACtrl
175 {
176     REG32               Rsa_Ind32_Start;                        //(REG_X32_RSA_BASE + 4 * 0)
177         #define RSA_EXP_START                       0x00000001  ///exp_start
178         #define RSA_INDIRECT_START                  0x00000002  /// ram start
179         #define RSA_IND32_CTRL_DIRECTION_WRITE      0x00000004  /// ram_wdata
180         #define RSA_INT_CLR                         0x00000008  /// int_clr
181         #define RSA_BLOCK_RSA_KEY                   0x00000010  /// block_rsa_key
182         #define RSA_ROOTKEY_SEL_PUB_NO              0x00000020  /// if public key, 0: select 1st key; 1 select 2nd key
183         #define RSA_ROOTKEY_SEL_TYPE                0x00000040  /// 1: OTP RSA key is public; 0: OTP RSA is private
184         //#define RSA_ROOTKEY_SEL_MASK                0x00000060 /// rootkey_sel:2
185     REG32               Rsa_Dummy;
186     REG32               Rsa_Ctrl;                               //(REG_X32_RSA_BASE + 4 * 2)
187         #define RSA_CTRL_RSA_RST                    0x00000001  //RSA_SW_RESET_t sw_reset:1;
188         #define RSA_CTRL_SEL_HW_KEY                 0x00000002  //RSA_HW_KEY_t hw_key:1;
189         #define RSA_CTRL_SEL_PUBLIC_KEY             0x00000004  //RSA_PUB_KEY_t pub_key:1;
190         #define RSA_CTRL_NMI                        0x00000010  ///nmi:1;
191         #define RSA_CTRL_NLEN_ADJ                   0x00000020  ///nlen_adj:1
192         #define RSA_CTRL_SRAM_EN                    0x00000080  ///sram_en:1
193         #define RSA_CTRL_KEY_LENGTH_MASK            0x00003F00  ///nlen:6
194         #define RSA_RAM_DIR                         0x00020000  ///RAM_DIR_t
195         #define RSA_IND32_CTRL_ADDR_AUTO_INC        0x00040000
196         #define RSA_IND32_CTRL_ACCESS_AUTO_START    0x00080000
197         #define RSA_RAM_MSB_FIRST                   0x00100000
198     REG32               Rsa_Ind32_Addr;                         //(REG_X32_RSA_BASE + 4 * 3)  REG_RSA_RAM_ADDR, REG_RSA_STATUS
199         #define RSA_STATUS_RSA_BUSY                 0x01000000
200         #define RSA_STATUS_MASK                     0x01000000
201     REG32               Rsa_Ind32_Data;                         //(REG_X32_RSA_BASE + 4 * 4)          REG_RSA_RAM_DATA
202 
203 	REG_SecureRange Rsa_Sec_Range[RSA_MAX_SECURE_RANGE_SIZE];
204    	    #define REG_RSA_SEC_RANGE_MASK              0xFFFF0000
205         #define REG_RSA_SEC_RANGE_SHIFT              16
206 
207    REG32               Rsa_CA_Spare_Oneway0;                   //(REG_X32_RSA_BASE + 4 * 11)
208    REG32               Rsa_CA_Spare_Oneway1;                   //(REG_X32_RSA_BASE + 4 * 12)
209    REG32               Rsa_Miu_Address_Mask;                   //(REG_X32_RSA_BASE + 4 * 13)
210    REG32               Rsa_Xiu_Id;                             //(REG_X32_RSA_BASE + 4 * 14)
211    REG32               Rsa_Release_Access;                     //(REG_X32_RSA_BASE + 4 * 15)
212    REG32               Rsa_Hwkey_Switch;                       //(REG_X32_RSA_BASE + 4 * 16)
213        #define RSA_READ_HWKEY_SWITCH               0x00000001
214        #define RSA_HWKEY_SWITCH                    0x00000100
215 
216 }REG_RSACtrl;
217 
218 
219 #endif // #ifndef _RSA_REG_MCU_H_
220