1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * OpenFirmware helpers for memory drivers 4 * 5 * Copyright (C) 2012 Texas Instruments, Inc. 6 * Copyright (C) 2019 Samsung Electronics Co., Ltd. 7 * Copyright (C) 2020 Krzysztof Kozlowski <[email protected]> 8 */ 9 10 #include <linux/device.h> 11 #include <linux/of.h> 12 #include <linux/gfp.h> 13 #include <linux/export.h> 14 15 #include "jedec_ddr.h" 16 #include "of_memory.h" 17 18 /** 19 * of_get_min_tck() - extract min timing values for ddr 20 * @np: pointer to ddr device tree node 21 * @device: device requesting for min timing values 22 * 23 * Populates the lpddr2_min_tck structure by extracting data 24 * from device tree node. Returns a pointer to the populated 25 * structure. If any error in populating the structure, returns 26 * default min timings provided by JEDEC. 27 */ 28 const struct lpddr2_min_tck *of_get_min_tck(struct device_node *np, 29 struct device *dev) 30 { 31 int ret = 0; 32 struct lpddr2_min_tck *min; 33 34 min = devm_kzalloc(dev, sizeof(*min), GFP_KERNEL); 35 if (!min) 36 goto default_min_tck; 37 38 ret |= of_property_read_u32(np, "tRPab-min-tck", &min->tRPab); 39 ret |= of_property_read_u32(np, "tRCD-min-tck", &min->tRCD); 40 ret |= of_property_read_u32(np, "tWR-min-tck", &min->tWR); 41 ret |= of_property_read_u32(np, "tRASmin-min-tck", &min->tRASmin); 42 ret |= of_property_read_u32(np, "tRRD-min-tck", &min->tRRD); 43 ret |= of_property_read_u32(np, "tWTR-min-tck", &min->tWTR); 44 ret |= of_property_read_u32(np, "tXP-min-tck", &min->tXP); 45 ret |= of_property_read_u32(np, "tRTP-min-tck", &min->tRTP); 46 ret |= of_property_read_u32(np, "tCKE-min-tck", &min->tCKE); 47 ret |= of_property_read_u32(np, "tCKESR-min-tck", &min->tCKESR); 48 ret |= of_property_read_u32(np, "tFAW-min-tck", &min->tFAW); 49 50 if (ret) { 51 devm_kfree(dev, min); 52 goto default_min_tck; 53 } 54 55 return min; 56 57 default_min_tck: 58 dev_warn(dev, "Using default min-tck values\n"); 59 return &lpddr2_jedec_min_tck; 60 } 61 EXPORT_SYMBOL(of_get_min_tck); 62 63 static int of_do_get_timings(struct device_node *np, 64 struct lpddr2_timings *tim) 65 { 66 int ret; 67 68 ret = of_property_read_u32(np, "max-freq", &tim->max_freq); 69 ret |= of_property_read_u32(np, "min-freq", &tim->min_freq); 70 ret |= of_property_read_u32(np, "tRPab", &tim->tRPab); 71 ret |= of_property_read_u32(np, "tRCD", &tim->tRCD); 72 ret |= of_property_read_u32(np, "tWR", &tim->tWR); 73 ret |= of_property_read_u32(np, "tRAS-min", &tim->tRAS_min); 74 ret |= of_property_read_u32(np, "tRRD", &tim->tRRD); 75 ret |= of_property_read_u32(np, "tWTR", &tim->tWTR); 76 ret |= of_property_read_u32(np, "tXP", &tim->tXP); 77 ret |= of_property_read_u32(np, "tRTP", &tim->tRTP); 78 ret |= of_property_read_u32(np, "tCKESR", &tim->tCKESR); 79 ret |= of_property_read_u32(np, "tDQSCK-max", &tim->tDQSCK_max); 80 ret |= of_property_read_u32(np, "tFAW", &tim->tFAW); 81 ret |= of_property_read_u32(np, "tZQCS", &tim->tZQCS); 82 ret |= of_property_read_u32(np, "tZQCL", &tim->tZQCL); 83 ret |= of_property_read_u32(np, "tZQinit", &tim->tZQinit); 84 ret |= of_property_read_u32(np, "tRAS-max-ns", &tim->tRAS_max_ns); 85 ret |= of_property_read_u32(np, "tDQSCK-max-derated", 86 &tim->tDQSCK_max_derated); 87 88 return ret; 89 } 90 91 /** 92 * of_get_ddr_timings() - extracts the ddr timings and updates no of 93 * frequencies available. 94 * @np_ddr: Pointer to ddr device tree node 95 * @dev: Device requesting for ddr timings 96 * @device_type: Type of ddr(LPDDR2 S2/S4) 97 * @nr_frequencies: No of frequencies available for ddr 98 * (updated by this function) 99 * 100 * Populates lpddr2_timings structure by extracting data from device 101 * tree node. Returns pointer to populated structure. If any error 102 * while populating, returns default timings provided by JEDEC. 103 */ 104 const struct lpddr2_timings *of_get_ddr_timings(struct device_node *np_ddr, 105 struct device *dev, u32 device_type, u32 *nr_frequencies) 106 { 107 struct lpddr2_timings *timings = NULL; 108 u32 arr_sz = 0, i = 0; 109 struct device_node *np_tim; 110 char *tim_compat = NULL; 111 112 switch (device_type) { 113 case DDR_TYPE_LPDDR2_S2: 114 case DDR_TYPE_LPDDR2_S4: 115 tim_compat = "jedec,lpddr2-timings"; 116 break; 117 default: 118 dev_warn(dev, "Unsupported memory type\n"); 119 } 120 121 for_each_child_of_node(np_ddr, np_tim) 122 if (of_device_is_compatible(np_tim, tim_compat)) 123 arr_sz++; 124 125 if (arr_sz) 126 timings = devm_kcalloc(dev, arr_sz, sizeof(*timings), 127 GFP_KERNEL); 128 129 if (!timings) 130 goto default_timings; 131 132 for_each_child_of_node(np_ddr, np_tim) { 133 if (of_device_is_compatible(np_tim, tim_compat)) { 134 if (of_do_get_timings(np_tim, &timings[i])) { 135 devm_kfree(dev, timings); 136 goto default_timings; 137 } 138 i++; 139 } 140 } 141 142 *nr_frequencies = arr_sz; 143 144 return timings; 145 146 default_timings: 147 dev_warn(dev, "Using default memory timings\n"); 148 *nr_frequencies = ARRAY_SIZE(lpddr2_jedec_timings); 149 return lpddr2_jedec_timings; 150 } 151 EXPORT_SYMBOL(of_get_ddr_timings); 152 153 /** 154 * of_lpddr3_get_min_tck() - extract min timing values for lpddr3 155 * @np: pointer to ddr device tree node 156 * @device: device requesting for min timing values 157 * 158 * Populates the lpddr3_min_tck structure by extracting data 159 * from device tree node. Returns a pointer to the populated 160 * structure. If any error in populating the structure, returns NULL. 161 */ 162 const struct lpddr3_min_tck *of_lpddr3_get_min_tck(struct device_node *np, 163 struct device *dev) 164 { 165 int ret = 0; 166 struct lpddr3_min_tck *min; 167 168 min = devm_kzalloc(dev, sizeof(*min), GFP_KERNEL); 169 if (!min) 170 goto default_min_tck; 171 172 ret |= of_property_read_u32(np, "tRFC-min-tck", &min->tRFC); 173 ret |= of_property_read_u32(np, "tRRD-min-tck", &min->tRRD); 174 ret |= of_property_read_u32(np, "tRPab-min-tck", &min->tRPab); 175 ret |= of_property_read_u32(np, "tRPpb-min-tck", &min->tRPpb); 176 ret |= of_property_read_u32(np, "tRCD-min-tck", &min->tRCD); 177 ret |= of_property_read_u32(np, "tRC-min-tck", &min->tRC); 178 ret |= of_property_read_u32(np, "tRAS-min-tck", &min->tRAS); 179 ret |= of_property_read_u32(np, "tWTR-min-tck", &min->tWTR); 180 ret |= of_property_read_u32(np, "tWR-min-tck", &min->tWR); 181 ret |= of_property_read_u32(np, "tRTP-min-tck", &min->tRTP); 182 ret |= of_property_read_u32(np, "tW2W-C2C-min-tck", &min->tW2W_C2C); 183 ret |= of_property_read_u32(np, "tR2R-C2C-min-tck", &min->tR2R_C2C); 184 ret |= of_property_read_u32(np, "tWL-min-tck", &min->tWL); 185 ret |= of_property_read_u32(np, "tDQSCK-min-tck", &min->tDQSCK); 186 ret |= of_property_read_u32(np, "tRL-min-tck", &min->tRL); 187 ret |= of_property_read_u32(np, "tFAW-min-tck", &min->tFAW); 188 ret |= of_property_read_u32(np, "tXSR-min-tck", &min->tXSR); 189 ret |= of_property_read_u32(np, "tXP-min-tck", &min->tXP); 190 ret |= of_property_read_u32(np, "tCKE-min-tck", &min->tCKE); 191 ret |= of_property_read_u32(np, "tCKESR-min-tck", &min->tCKESR); 192 ret |= of_property_read_u32(np, "tMRD-min-tck", &min->tMRD); 193 194 if (ret) { 195 dev_warn(dev, "Errors while parsing min-tck values\n"); 196 devm_kfree(dev, min); 197 goto default_min_tck; 198 } 199 200 return min; 201 202 default_min_tck: 203 dev_warn(dev, "Using default min-tck values\n"); 204 return NULL; 205 } 206 EXPORT_SYMBOL(of_lpddr3_get_min_tck); 207 208 static int of_lpddr3_do_get_timings(struct device_node *np, 209 struct lpddr3_timings *tim) 210 { 211 int ret; 212 213 /* The 'reg' param required since DT has changed, used as 'max-freq' */ 214 ret = of_property_read_u32(np, "reg", &tim->max_freq); 215 ret |= of_property_read_u32(np, "min-freq", &tim->min_freq); 216 ret |= of_property_read_u32(np, "tRFC", &tim->tRFC); 217 ret |= of_property_read_u32(np, "tRRD", &tim->tRRD); 218 ret |= of_property_read_u32(np, "tRPab", &tim->tRPab); 219 ret |= of_property_read_u32(np, "tRPpb", &tim->tRPpb); 220 ret |= of_property_read_u32(np, "tRCD", &tim->tRCD); 221 ret |= of_property_read_u32(np, "tRC", &tim->tRC); 222 ret |= of_property_read_u32(np, "tRAS", &tim->tRAS); 223 ret |= of_property_read_u32(np, "tWTR", &tim->tWTR); 224 ret |= of_property_read_u32(np, "tWR", &tim->tWR); 225 ret |= of_property_read_u32(np, "tRTP", &tim->tRTP); 226 ret |= of_property_read_u32(np, "tW2W-C2C", &tim->tW2W_C2C); 227 ret |= of_property_read_u32(np, "tR2R-C2C", &tim->tR2R_C2C); 228 ret |= of_property_read_u32(np, "tFAW", &tim->tFAW); 229 ret |= of_property_read_u32(np, "tXSR", &tim->tXSR); 230 ret |= of_property_read_u32(np, "tXP", &tim->tXP); 231 ret |= of_property_read_u32(np, "tCKE", &tim->tCKE); 232 ret |= of_property_read_u32(np, "tCKESR", &tim->tCKESR); 233 ret |= of_property_read_u32(np, "tMRD", &tim->tMRD); 234 235 return ret; 236 } 237 238 /** 239 * of_lpddr3_get_ddr_timings() - extracts the lpddr3 timings and updates no of 240 * frequencies available. 241 * @np_ddr: Pointer to ddr device tree node 242 * @dev: Device requesting for ddr timings 243 * @device_type: Type of ddr 244 * @nr_frequencies: No of frequencies available for ddr 245 * (updated by this function) 246 * 247 * Populates lpddr3_timings structure by extracting data from device 248 * tree node. Returns pointer to populated structure. If any error 249 * while populating, returns NULL. 250 */ 251 const struct lpddr3_timings 252 *of_lpddr3_get_ddr_timings(struct device_node *np_ddr, struct device *dev, 253 u32 device_type, u32 *nr_frequencies) 254 { 255 struct lpddr3_timings *timings = NULL; 256 u32 arr_sz = 0, i = 0; 257 struct device_node *np_tim; 258 char *tim_compat = NULL; 259 260 switch (device_type) { 261 case DDR_TYPE_LPDDR3: 262 tim_compat = "jedec,lpddr3-timings"; 263 break; 264 default: 265 dev_warn(dev, "Unsupported memory type\n"); 266 } 267 268 for_each_child_of_node(np_ddr, np_tim) 269 if (of_device_is_compatible(np_tim, tim_compat)) 270 arr_sz++; 271 272 if (arr_sz) 273 timings = devm_kcalloc(dev, arr_sz, sizeof(*timings), 274 GFP_KERNEL); 275 276 if (!timings) 277 goto default_timings; 278 279 for_each_child_of_node(np_ddr, np_tim) { 280 if (of_device_is_compatible(np_tim, tim_compat)) { 281 if (of_lpddr3_do_get_timings(np_tim, &timings[i])) { 282 devm_kfree(dev, timings); 283 goto default_timings; 284 } 285 i++; 286 } 287 } 288 289 *nr_frequencies = arr_sz; 290 291 return timings; 292 293 default_timings: 294 dev_warn(dev, "Failed to get timings\n"); 295 *nr_frequencies = 0; 296 return NULL; 297 } 298 EXPORT_SYMBOL(of_lpddr3_get_ddr_timings); 299