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 <krzk@kernel.org>
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 * @dev: 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 */
28const 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
57default_min_tck:
58	dev_warn(dev, "Using default min-tck values\n");
59	return &lpddr2_jedec_min_tck;
60}
61EXPORT_SYMBOL(of_get_min_tck);
62
63static 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 */
104const struct lpddr2_timings *of_get_ddr_timings(struct device_node *np_ddr,
105						struct device *dev,
106						u32 device_type,
107						u32 *nr_frequencies)
108{
109	struct lpddr2_timings	*timings = NULL;
110	u32			arr_sz = 0, i = 0;
111	struct device_node	*np_tim;
112	char			*tim_compat = NULL;
113
114	switch (device_type) {
115	case DDR_TYPE_LPDDR2_S2:
116	case DDR_TYPE_LPDDR2_S4:
117		tim_compat = "jedec,lpddr2-timings";
118		break;
119	default:
120		dev_warn(dev, "Unsupported memory type\n");
121	}
122
123	for_each_child_of_node(np_ddr, np_tim)
124		if (of_device_is_compatible(np_tim, tim_compat))
125			arr_sz++;
126
127	if (arr_sz)
128		timings = devm_kcalloc(dev, arr_sz, sizeof(*timings),
129				       GFP_KERNEL);
130
131	if (!timings)
132		goto default_timings;
133
134	for_each_child_of_node(np_ddr, np_tim) {
135		if (of_device_is_compatible(np_tim, tim_compat)) {
136			if (of_do_get_timings(np_tim, &timings[i])) {
137				of_node_put(np_tim);
138				devm_kfree(dev, timings);
139				goto default_timings;
140			}
141			i++;
142		}
143	}
144
145	*nr_frequencies = arr_sz;
146
147	return timings;
148
149default_timings:
150	dev_warn(dev, "Using default memory timings\n");
151	*nr_frequencies = ARRAY_SIZE(lpddr2_jedec_timings);
152	return lpddr2_jedec_timings;
153}
154EXPORT_SYMBOL(of_get_ddr_timings);
155
156/**
157 * of_lpddr3_get_min_tck() - extract min timing values for lpddr3
158 * @np: pointer to ddr device tree node
159 * @dev: device requesting for min timing values
160 *
161 * Populates the lpddr3_min_tck structure by extracting data
162 * from device tree node. Returns a pointer to the populated
163 * structure. If any error in populating the structure, returns NULL.
164 */
165const struct lpddr3_min_tck *of_lpddr3_get_min_tck(struct device_node *np,
166						   struct device *dev)
167{
168	int			ret = 0;
169	struct lpddr3_min_tck	*min;
170
171	min = devm_kzalloc(dev, sizeof(*min), GFP_KERNEL);
172	if (!min)
173		goto default_min_tck;
174
175	ret |= of_property_read_u32(np, "tRFC-min-tck", &min->tRFC);
176	ret |= of_property_read_u32(np, "tRRD-min-tck", &min->tRRD);
177	ret |= of_property_read_u32(np, "tRPab-min-tck", &min->tRPab);
178	ret |= of_property_read_u32(np, "tRPpb-min-tck", &min->tRPpb);
179	ret |= of_property_read_u32(np, "tRCD-min-tck", &min->tRCD);
180	ret |= of_property_read_u32(np, "tRC-min-tck", &min->tRC);
181	ret |= of_property_read_u32(np, "tRAS-min-tck", &min->tRAS);
182	ret |= of_property_read_u32(np, "tWTR-min-tck", &min->tWTR);
183	ret |= of_property_read_u32(np, "tWR-min-tck", &min->tWR);
184	ret |= of_property_read_u32(np, "tRTP-min-tck", &min->tRTP);
185	ret |= of_property_read_u32(np, "tW2W-C2C-min-tck", &min->tW2W_C2C);
186	ret |= of_property_read_u32(np, "tR2R-C2C-min-tck", &min->tR2R_C2C);
187	ret |= of_property_read_u32(np, "tWL-min-tck", &min->tWL);
188	ret |= of_property_read_u32(np, "tDQSCK-min-tck", &min->tDQSCK);
189	ret |= of_property_read_u32(np, "tRL-min-tck", &min->tRL);
190	ret |= of_property_read_u32(np, "tFAW-min-tck", &min->tFAW);
191	ret |= of_property_read_u32(np, "tXSR-min-tck", &min->tXSR);
192	ret |= of_property_read_u32(np, "tXP-min-tck", &min->tXP);
193	ret |= of_property_read_u32(np, "tCKE-min-tck", &min->tCKE);
194	ret |= of_property_read_u32(np, "tCKESR-min-tck", &min->tCKESR);
195	ret |= of_property_read_u32(np, "tMRD-min-tck", &min->tMRD);
196
197	if (ret) {
198		dev_warn(dev, "Errors while parsing min-tck values\n");
199		devm_kfree(dev, min);
200		goto default_min_tck;
201	}
202
203	return min;
204
205default_min_tck:
206	dev_warn(dev, "Using default min-tck values\n");
207	return NULL;
208}
209EXPORT_SYMBOL(of_lpddr3_get_min_tck);
210
211static int of_lpddr3_do_get_timings(struct device_node *np,
212				    struct lpddr3_timings *tim)
213{
214	int ret;
215
216	/* The 'reg' param required since DT has changed, used as 'max-freq' */
217	ret = of_property_read_u32(np, "reg", &tim->max_freq);
218	ret |= of_property_read_u32(np, "min-freq", &tim->min_freq);
219	ret |= of_property_read_u32(np, "tRFC", &tim->tRFC);
220	ret |= of_property_read_u32(np, "tRRD", &tim->tRRD);
221	ret |= of_property_read_u32(np, "tRPab", &tim->tRPab);
222	ret |= of_property_read_u32(np, "tRPpb", &tim->tRPpb);
223	ret |= of_property_read_u32(np, "tRCD", &tim->tRCD);
224	ret |= of_property_read_u32(np, "tRC", &tim->tRC);
225	ret |= of_property_read_u32(np, "tRAS", &tim->tRAS);
226	ret |= of_property_read_u32(np, "tWTR", &tim->tWTR);
227	ret |= of_property_read_u32(np, "tWR", &tim->tWR);
228	ret |= of_property_read_u32(np, "tRTP", &tim->tRTP);
229	ret |= of_property_read_u32(np, "tW2W-C2C", &tim->tW2W_C2C);
230	ret |= of_property_read_u32(np, "tR2R-C2C", &tim->tR2R_C2C);
231	ret |= of_property_read_u32(np, "tFAW", &tim->tFAW);
232	ret |= of_property_read_u32(np, "tXSR", &tim->tXSR);
233	ret |= of_property_read_u32(np, "tXP", &tim->tXP);
234	ret |= of_property_read_u32(np, "tCKE", &tim->tCKE);
235	ret |= of_property_read_u32(np, "tCKESR", &tim->tCKESR);
236	ret |= of_property_read_u32(np, "tMRD", &tim->tMRD);
237
238	return ret;
239}
240
241/**
242 * of_lpddr3_get_ddr_timings() - extracts the lpddr3 timings and updates no of
243 * frequencies available.
244 * @np_ddr: Pointer to ddr device tree node
245 * @dev: Device requesting for ddr timings
246 * @device_type: Type of ddr
247 * @nr_frequencies: No of frequencies available for ddr
248 * (updated by this function)
249 *
250 * Populates lpddr3_timings structure by extracting data from device
251 * tree node. Returns pointer to populated structure. If any error
252 * while populating, returns NULL.
253 */
254const struct lpddr3_timings
255*of_lpddr3_get_ddr_timings(struct device_node *np_ddr, struct device *dev,
256			   u32 device_type, u32 *nr_frequencies)
257{
258	struct lpddr3_timings	*timings = NULL;
259	u32			arr_sz = 0, i = 0;
260	struct device_node	*np_tim;
261	char			*tim_compat = NULL;
262
263	switch (device_type) {
264	case DDR_TYPE_LPDDR3:
265		tim_compat = "jedec,lpddr3-timings";
266		break;
267	default:
268		dev_warn(dev, "Unsupported memory type\n");
269	}
270
271	for_each_child_of_node(np_ddr, np_tim)
272		if (of_device_is_compatible(np_tim, tim_compat))
273			arr_sz++;
274
275	if (arr_sz)
276		timings = devm_kcalloc(dev, arr_sz, sizeof(*timings),
277				       GFP_KERNEL);
278
279	if (!timings)
280		goto default_timings;
281
282	for_each_child_of_node(np_ddr, np_tim) {
283		if (of_device_is_compatible(np_tim, tim_compat)) {
284			if (of_lpddr3_do_get_timings(np_tim, &timings[i])) {
285				devm_kfree(dev, timings);
286				of_node_put(np_tim);
287				goto default_timings;
288			}
289			i++;
290		}
291	}
292
293	*nr_frequencies = arr_sz;
294
295	return timings;
296
297default_timings:
298	dev_warn(dev, "Failed to get timings\n");
299	*nr_frequencies = 0;
300	return NULL;
301}
302EXPORT_SYMBOL(of_lpddr3_get_ddr_timings);
303