update OCF framework to version 20100325
[openwrt/openwrt.git] / target / linux / generic-2.6 / files / crypto / ocf / kirkwood / mvHal / mv_hal / ddr1_2 / mvDramIf.h
1 /*******************************************************************************
2 Copyright (C) Marvell International Ltd. and its affiliates
3
4 This software file (the "File") is owned and distributed by Marvell
5 International Ltd. and/or its affiliates ("Marvell") under the following
6 alternative licensing terms. Once you have made an election to distribute the
7 File under one of the following license alternatives, please (i) delete this
8 introductory statement regarding license alternatives, (ii) delete the two
9 license alternatives that you have not elected to use and (iii) preserve the
10 Marvell copyright notice above.
11
12 ********************************************************************************
13 Marvell Commercial License Option
14
15 If you received this File from Marvell and you have entered into a commercial
16 license agreement (a "Commercial License") with Marvell, the File is licensed
17 to you under the terms of the applicable Commercial License.
18
19 ********************************************************************************
20 Marvell GPL License Option
21
22 If you received this File from Marvell, you may opt to use, redistribute and/or
23 modify this File in accordance with the terms and conditions of the General
24 Public License Version 2, June 1991 (the "GPL License"), a copy of which is
25 available along with the File in the license.txt file or by writing to the Free
26 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
27 on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
28
29 THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
30 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
31 DISCLAIMED. The GPL License provides additional details about this warranty
32 disclaimer.
33 ********************************************************************************
34 Marvell BSD License Option
35
36 If you received this File from Marvell, you may opt to use, redistribute and/or
37 modify this File under the following licensing terms.
38 Redistribution and use in source and binary forms, with or without modification,
39 are permitted provided that the following conditions are met:
40
41 * Redistributions of source code must retain the above copyright notice,
42 this list of conditions and the following disclaimer.
43
44 * Redistributions in binary form must reproduce the above copyright
45 notice, this list of conditions and the following disclaimer in the
46 documentation and/or other materials provided with the distribution.
47
48 * Neither the name of Marvell nor the names of its contributors may be
49 used to endorse or promote products derived from this software without
50 specific prior written permission.
51
52 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
53 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
54 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
55 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
56 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
57 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
58 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
59 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
61 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
63 *******************************************************************************/
64
65
66 #ifndef __INCmvDramIfh
67 #define __INCmvDramIfh
68
69 /* includes */
70 #include "ddr1_2/mvDramIfRegs.h"
71 #include "ddr1_2/mvDramIfConfig.h"
72 #include "ctrlEnv/mvCtrlEnvLib.h"
73
74 /* defines */
75 /* DRAM Timing parameters */
76 #define SDRAM_TWR 15 /* ns tWr */
77 #define SDRAM_TRFC_64_512M_AT_200MHZ 70 /* ns tRfc for dens 64-512 @ 200MHz */
78 #define SDRAM_TRFC_64_512M 75 /* ns tRfc for dens 64-512 */
79 #define SDRAM_TRFC_1G 120 /* ns tRfc for dens 1GB */
80 #define SDRAM_TR2R_CYC 1 /* cycle for tR2r */
81 #define SDRAM_TR2WW2R_CYC 1 /* cycle for tR2wW2r */
82
83 /* typedefs */
84
85 /* enumeration for memory types */
86 typedef enum _mvMemoryType
87 {
88 MEM_TYPE_SDRAM,
89 MEM_TYPE_DDR1,
90 MEM_TYPE_DDR2
91 }MV_MEMORY_TYPE;
92
93 /* enumeration for DDR1 supported CAS Latencies */
94 typedef enum _mvDimmDdr1Cas
95 {
96 DDR1_CL_1_5 = 0x02,
97 DDR1_CL_2 = 0x04,
98 DDR1_CL_2_5 = 0x08,
99 DDR1_CL_3 = 0x10,
100 DDR1_CL_4 = 0x40,
101 DDR1_CL_FAULT
102 } MV_DIMM_DDR1_CAS;
103
104 /* enumeration for DDR2 supported CAS Latencies */
105 typedef enum _mvDimmDdr2Cas
106 {
107 DDR2_CL_3 = 0x08,
108 DDR2_CL_4 = 0x10,
109 DDR2_CL_5 = 0x20,
110 DDR2_CL_FAULT
111 } MV_DIMM_DDR2_CAS;
112
113
114 typedef struct _mvDramBankInfo
115 {
116 MV_MEMORY_TYPE memoryType; /* DDR1, DDR2 or SDRAM */
117
118 /* DIMM dimensions */
119 MV_U32 numOfRowAddr;
120 MV_U32 numOfColAddr;
121 MV_U32 dataWidth;
122 MV_U32 errorCheckType; /* ECC , PARITY..*/
123 MV_U32 sdramWidth; /* 4,8,16 or 32 */
124 MV_U32 errorCheckDataWidth; /* 0 - no, 1 - Yes */
125 MV_U32 burstLengthSupported;
126 MV_U32 numOfBanksOnEachDevice;
127 MV_U32 suportedCasLatencies;
128 MV_U32 refreshInterval;
129
130 /* DIMM timing parameters */
131 MV_U32 minCycleTimeAtMaxCasLatPs;
132 MV_U32 minCycleTimeAtMaxCasLatMinus1Ps;
133 MV_U32 minCycleTimeAtMaxCasLatMinus2Ps;
134 MV_U32 minRowPrechargeTime;
135 MV_U32 minRowActiveToRowActive;
136 MV_U32 minRasToCasDelay;
137 MV_U32 minRasPulseWidth;
138 MV_U32 minWriteRecoveryTime; /* DDR2 only */
139 MV_U32 minWriteToReadCmdDelay; /* DDR2 only */
140 MV_U32 minReadToPrechCmdDelay; /* DDR2 only */
141 MV_U32 minRefreshToActiveCmd; /* DDR2 only */
142
143 /* Parameters calculated from the extracted DIMM information */
144 MV_U32 size;
145 MV_U32 deviceDensity; /* 16,64,128,256 or 512 Mbit */
146 MV_U32 numberOfDevices;
147
148 /* DIMM attributes (MV_TRUE for yes) */
149 MV_BOOL registeredAddrAndControlInputs;
150
151 }MV_DRAM_BANK_INFO;
152
153 /* This structure describes CPU interface address decode window */
154 typedef struct _mvDramIfDecWin
155 {
156 MV_ADDR_WIN addrWin; /* An address window*/
157 MV_BOOL enable; /* Address decode window is enabled/disabled */
158 }MV_DRAM_DEC_WIN;
159
160 #include "ddr1_2/mvDram.h"
161
162 /* mvDramIf.h API list */
163 MV_VOID mvDramIfBasicAsmInit(MV_VOID);
164 MV_STATUS mvDramIfDetect(MV_U32 forcedCl);
165 MV_VOID _mvDramIfConfig(MV_VOID);
166
167 MV_STATUS mvDramIfWinSet(MV_TARGET target, MV_DRAM_DEC_WIN *pAddrDecWin);
168 MV_STATUS mvDramIfWinGet(MV_TARGET target, MV_DRAM_DEC_WIN *pAddrDecWin);
169 MV_STATUS mvDramIfWinEnable(MV_TARGET target,MV_BOOL enable);
170 MV_32 mvDramIfBankSizeGet(MV_U32 bankNum);
171 MV_32 mvDramIfBankBaseGet(MV_U32 bankNum);
172 MV_32 mvDramIfSizeGet(MV_VOID);
173
174 #if 0
175 MV_STATUS mvDramIfMbusCtrlSet(MV_XBAR_TARGET *pPizzaArbArray);
176 MV_STATUS mvDramIfMbusToutSet(MV_U32 timeout, MV_BOOL enable);
177 #endif
178
179 #endif /* __INCmvDramIfh */