Linux-libre 5.4.49-gnu
[librecmc/linux-libre.git] / drivers / memory / jedec_ddr.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Definitions for DDR memories based on JEDEC specs
4  *
5  * Copyright (C) 2012 Texas Instruments, Inc.
6  *
7  * Aneesh V <aneesh@ti.com>
8  */
9 #ifndef __JEDEC_DDR_H
10 #define __JEDEC_DDR_H
11
12 #include <linux/types.h>
13
14 /* DDR Densities */
15 #define DDR_DENSITY_64Mb        1
16 #define DDR_DENSITY_128Mb       2
17 #define DDR_DENSITY_256Mb       3
18 #define DDR_DENSITY_512Mb       4
19 #define DDR_DENSITY_1Gb         5
20 #define DDR_DENSITY_2Gb         6
21 #define DDR_DENSITY_4Gb         7
22 #define DDR_DENSITY_8Gb         8
23 #define DDR_DENSITY_16Gb        9
24 #define DDR_DENSITY_32Gb        10
25
26 /* DDR type */
27 #define DDR_TYPE_DDR2           1
28 #define DDR_TYPE_DDR3           2
29 #define DDR_TYPE_LPDDR2_S4      3
30 #define DDR_TYPE_LPDDR2_S2      4
31 #define DDR_TYPE_LPDDR2_NVM     5
32
33 /* DDR IO width */
34 #define DDR_IO_WIDTH_4          1
35 #define DDR_IO_WIDTH_8          2
36 #define DDR_IO_WIDTH_16         3
37 #define DDR_IO_WIDTH_32         4
38
39 /* Number of Row bits */
40 #define R9                      9
41 #define R10                     10
42 #define R11                     11
43 #define R12                     12
44 #define R13                     13
45 #define R14                     14
46 #define R15                     15
47 #define R16                     16
48
49 /* Number of Column bits */
50 #define C7                      7
51 #define C8                      8
52 #define C9                      9
53 #define C10                     10
54 #define C11                     11
55 #define C12                     12
56
57 /* Number of Banks */
58 #define B1                      0
59 #define B2                      1
60 #define B4                      2
61 #define B8                      3
62
63 /* Refresh rate in nano-seconds */
64 #define T_REFI_15_6             15600
65 #define T_REFI_7_8              7800
66 #define T_REFI_3_9              3900
67
68 /* tRFC values */
69 #define T_RFC_90                90000
70 #define T_RFC_110               110000
71 #define T_RFC_130               130000
72 #define T_RFC_160               160000
73 #define T_RFC_210               210000
74 #define T_RFC_300               300000
75 #define T_RFC_350               350000
76
77 /* Mode register numbers */
78 #define DDR_MR0                 0
79 #define DDR_MR1                 1
80 #define DDR_MR2                 2
81 #define DDR_MR3                 3
82 #define DDR_MR4                 4
83 #define DDR_MR5                 5
84 #define DDR_MR6                 6
85 #define DDR_MR7                 7
86 #define DDR_MR8                 8
87 #define DDR_MR9                 9
88 #define DDR_MR10                10
89 #define DDR_MR11                11
90 #define DDR_MR16                16
91 #define DDR_MR17                17
92 #define DDR_MR18                18
93
94 /*
95  * LPDDR2 related defines
96  */
97
98 /* MR4 register fields */
99 #define MR4_SDRAM_REF_RATE_SHIFT                        0
100 #define MR4_SDRAM_REF_RATE_MASK                         7
101 #define MR4_TUF_SHIFT                                   7
102 #define MR4_TUF_MASK                                    (1 << 7)
103
104 /* MR4 SDRAM Refresh Rate field values */
105 #define SDRAM_TEMP_NOMINAL                              0x3
106 #define SDRAM_TEMP_RESERVED_4                           0x4
107 #define SDRAM_TEMP_HIGH_DERATE_REFRESH                  0x5
108 #define SDRAM_TEMP_HIGH_DERATE_REFRESH_AND_TIMINGS      0x6
109 #define SDRAM_TEMP_VERY_HIGH_SHUTDOWN                   0x7
110
111 #define NUM_DDR_ADDR_TABLE_ENTRIES                      11
112 #define NUM_DDR_TIMING_TABLE_ENTRIES                    4
113
114 /* Structure for DDR addressing info from the JEDEC spec */
115 struct lpddr2_addressing {
116         u32 num_banks;
117         u32 tREFI_ns;
118         u32 tRFCab_ps;
119 };
120
121 /*
122  * Structure for timings from the LPDDR2 datasheet
123  * All parameters are in pico seconds(ps) unless explicitly indicated
124  * with a suffix like tRAS_max_ns below
125  */
126 struct lpddr2_timings {
127         u32 max_freq;
128         u32 min_freq;
129         u32 tRPab;
130         u32 tRCD;
131         u32 tWR;
132         u32 tRAS_min;
133         u32 tRRD;
134         u32 tWTR;
135         u32 tXP;
136         u32 tRTP;
137         u32 tCKESR;
138         u32 tDQSCK_max;
139         u32 tDQSCK_max_derated;
140         u32 tFAW;
141         u32 tZQCS;
142         u32 tZQCL;
143         u32 tZQinit;
144         u32 tRAS_max_ns;
145 };
146
147 /*
148  * Min value for some parameters in terms of number of tCK cycles(nCK)
149  * Please set to zero parameters that are not valid for a given memory
150  * type
151  */
152 struct lpddr2_min_tck {
153         u32 tRPab;
154         u32 tRCD;
155         u32 tWR;
156         u32 tRASmin;
157         u32 tRRD;
158         u32 tWTR;
159         u32 tXP;
160         u32 tRTP;
161         u32 tCKE;
162         u32 tCKESR;
163         u32 tFAW;
164 };
165
166 extern const struct lpddr2_addressing
167         lpddr2_jedec_addressing_table[NUM_DDR_ADDR_TABLE_ENTRIES];
168 extern const struct lpddr2_timings
169         lpddr2_jedec_timings[NUM_DDR_TIMING_TABLE_ENTRIES];
170 extern const struct lpddr2_min_tck lpddr2_jedec_min_tck;
171
172 #endif /* __JEDEC_DDR_H */