xref: /utopia/UTPA2-700.0.x/modules/mspi/hal/k6/mspi/regMSPI.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 
95 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// file    regMSPI.h
98 /// @brief  Master SPI Register Definition
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _REG_MSPI_H_
103 #define _REG_MSPI_H_
104 
105 //-------------------------------------------------------------------------------------------------
106 // Include File
107 //-------------------------------------------------------------------------------------------------
108 
109 //-------------------------------------------------------------------------------------------------
110 //  Hardware Capability
111 //-------------------------------------------------------------------------------------------------
112 
113 //-------------------------------------------------------------------------------------------------
114 //  Macro and Define
115 //-------------------------------------------------------------------------------------------------
116 // BASEADDR & BK
117 #define BASEADDR_RIU                   0xBF000000
118 
119 // BASEADDR & BK
120 #define BK_MSP                         0x1300*2
121 #define BK_MSP1                        0x0C00*2
122 #define BK_CLK0                        0xB00*2
123 
124 #define MSPI_REG_BASE                  0x200
125 #define MSPI_WRITE_BUF_OFFSET          0x40
126 #define MSPI_READ_BUF_OFFSET           0x44
127 #define MSPI_WBF_SIZE_OFFSET           0x48
128 #define MSPI_RBF_SIZE_OFFSET           0x48
129     // read/ write buffer size
130     #define MSPI_RWSIZE_MASK               0xFF
131     #define MSPI_RSIZE_BIT_OFFSET          0x8
132     #define MAX_READ_BUF_SIZE              0x7
133     #define MAX_WRITE_BUF_SIZE             0x7
134 // CLK config
135 #define MSPI_CTRL_OFFSET               0x49
136 #define MSPI_CLK_CLOCK_OFFSET          0x49
137     #define MSPI_CLK_CLOCK_BIT_OFFSET      0x08
138     #define MSPI_CLK_CLOCK_MASK            0xFF
139     #define MSPI_CLK_PHASE_MASK            0x40
140     #define MSPI_CLK_PHASE_BIT_OFFSET      0x06
141     #define MSPI_CLK_POLARITY_MASK         0x80
142 	#define MSPI_CLK_POLARITY_BIT_OFFSET   0x07
143     #define MSPI_CLK_PHASE_MAX             0x1
144     #define MSPI_CLK_POLARITY_MAX          0x1
145     #define MSPI_CLK_CLOCK_MAX             0x7
146 // DC config
147 #define MSPI_DC_MASK                   0xFF
148 #define MSPI_DC_BIT_OFFSET             0x08
149 #define MSPI_DC_TR_START_OFFSET        0x4A
150     #define MSPI_DC_TRSTART_MAX            0xFF
151 #define MSPI_DC_TR_END_OFFSET          0x4A
152     #define MSPI_DC_TREND_MAX              0xFF
153 #define MSPI_DC_TB_OFFSET              0x4B
154     #define MSPI_DC_TB_MAX                 0xFF
155 #define MSPI_DC_TRW_OFFSET             0x4B
156     #define MSPI_DC_TRW_MAX                0xFF
157 // Frame Config
158 #define MSPI_FRAME_WBIT_OFFSET         0x4C
159 #define MSPI_FRAME_RBIT_OFFSET         0x4E
160     #define MSPI_FRAME_BIT_MAX             0x07
161     #define MSPI_FRAME_BIT_MASK            0x07
162     #define MSPI_FRAME_BIT_FIELD           0x03
163 #define MSPI_LSB_FIRST_OFFSET          0x50
164 #define MSPI_TRIGGER_OFFSET            0x5A
165 #define MSPI_DONE_OFFSET               0x5B
166 #define MSPI_DONE_CLEAR_OFFSET         0x5C
167 #define MSPI_CHIP_SELECT_OFFSET        0x5F
168 //chip select bit map
169     #define MSPI_CHIP_SELECT_MAX           0x07
170 // control bit
171 #define MSPI_DONE_FLAG                 0x01
172 #define MSPI_TRIGGER                   0x01
173 #define MSPI_CLEAR_DONE                0x01
174 #define MSPI_INT_ENABLE                0x04
175 #define MSPI_RESET                     0x02
176 #define MSPI_ENABLE                    0x01
177 
178 // CLKGEN0
179 #define MSPI_CLK_CFG                   0x16
180     #define  MSPI_CLK_CFG_OFFSET           0x0A
181     #define  MSPI_CLK_MASK                 0x1FFF
182     #define  MSPI_MAXCLKLEVEL			   0x03
183 #endif // _REG_MSPI_H_
184 
185