xref: /rk3399_rockchip-uboot/drivers/mtd/mtd_uboot.c (revision 7a13c786fea0ce3e6b583d8e3eefc15875abe2b1)
1 /*
2  * (C) Copyright 2014
3  * Heiko Schocher, DENX Software Engineering, hs@denx.de.
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 #include <common.h>
8 #include <dm/device.h>
9 #include <dm/uclass-internal.h>
10 #include <jffs2/jffs2.h> /* LEGACY */
11 #include <linux/mtd/mtd.h>
12 #include <linux/mtd/partitions.h>
13 #include <mtd.h>
14 
15 #define MTD_NAME_MAX_LEN 20
16 
17 void board_mtdparts_default(const char **mtdids, const char **mtdparts);
18 
19 static const char *get_mtdids(void)
20 {
21 	__maybe_unused const char *mtdparts = NULL;
22 	const char *mtdids = env_get("mtdids");
23 
24 	if (mtdids)
25 		return mtdids;
26 
27 #if defined(CONFIG_SYS_MTDPARTS_RUNTIME)
28 	board_mtdparts_default(&mtdids, &mtdparts);
29 #elif defined(MTDIDS_DEFAULT)
30 	mtdids = MTDIDS_DEFAULT;
31 #elif defined(CONFIG_MTDIDS_DEFAULT)
32 	mtdids = CONFIG_MTDIDS_DEFAULT;
33 #endif
34 
35 	if (mtdids)
36 		env_set("mtdids", mtdids);
37 
38 	return mtdids;
39 }
40 
41 /**
42  * mtd_search_alternate_name - Search an alternate name for @mtdname thanks to
43  *                             the mtdids legacy environment variable.
44  *
45  * The mtdids string is a list of comma-separated 'dev_id=mtd_id' tupples.
46  * Check if one of the mtd_id matches mtdname, in this case save dev_id in
47  * altname.
48  *
49  * @mtdname: Current MTD device name
50  * @altname: Alternate name to return
51  * @max_len: Length of the alternate name buffer
52  *
53  * @return 0 on success, an error otherwise.
54  */
55 int mtd_search_alternate_name(const char *mtdname, char *altname,
56 			      unsigned int max_len)
57 {
58 	const char *mtdids, *equal, *comma, *dev_id, *mtd_id;
59 	int dev_id_len, mtd_id_len;
60 
61 	mtdids = get_mtdids();
62 	if (!mtdids)
63 		return -EINVAL;
64 
65 	do {
66 		/* Find the '=' sign */
67 		dev_id = mtdids;
68 		equal = strchr(dev_id, '=');
69 		if (!equal)
70 			break;
71 		dev_id_len = equal - mtdids;
72 		mtd_id = equal + 1;
73 
74 		/* Find the end of the tupple */
75 		comma = strchr(mtdids, ',');
76 		if (comma)
77 			mtd_id_len = comma - mtd_id;
78 		else
79 			mtd_id_len = &mtdids[strlen(mtdids)] - mtd_id + 1;
80 
81 		if (!dev_id_len || !mtd_id_len)
82 			return -EINVAL;
83 
84 		if (dev_id_len + 1 > max_len)
85 			continue;
86 
87 		/* Compare the name we search with the current mtd_id */
88 		if (!strncmp(mtdname, mtd_id, mtd_id_len)) {
89 			strncpy(altname, dev_id, dev_id_len);
90 			altname[dev_id_len] = 0;
91 
92 			return 0;
93 		}
94 
95 		/* Go to the next tupple */
96 		mtdids = comma + 1;
97 	} while (comma);
98 
99 	return -EINVAL;
100 }
101 
102 #if IS_ENABLED(CONFIG_MTD)
103 static void mtd_probe_uclass_mtd_devs(void)
104 {
105 	struct udevice *dev;
106 	int idx = 0;
107 
108 	/* Probe devices with DM compliant drivers */
109 	while (!uclass_find_device(UCLASS_MTD, idx, &dev) && dev) {
110 		mtd_probe(dev);
111 		idx++;
112 	}
113 }
114 #else
115 static void mtd_probe_uclass_mtd_devs(void) { }
116 #endif
117 
118 #if defined(CONFIG_MTD_PARTITIONS)
119 
120 #define MTDPARTS_MAXLEN         512
121 
122 static const char *get_mtdparts(void)
123 {
124 	__maybe_unused const char *mtdids = NULL;
125 	static char tmp_parts[MTDPARTS_MAXLEN];
126 	static bool use_defaults = true;
127 	const char *mtdparts = NULL;
128 
129 	if (gd->flags & GD_FLG_ENV_READY)
130 		mtdparts = env_get("mtdparts");
131 	else if (env_get_f("mtdparts", tmp_parts, sizeof(tmp_parts)) != -1)
132 		mtdparts = tmp_parts;
133 
134 	if (mtdparts || !use_defaults)
135 		return mtdparts;
136 
137 #if defined(CONFIG_SYS_MTDPARTS_RUNTIME)
138 	board_mtdparts_default(&mtdids, &mtdparts);
139 #elif defined(MTDPARTS_DEFAULT)
140 	mtdparts = MTDPARTS_DEFAULT;
141 #elif defined(CONFIG_MTDPARTS_DEFAULT)
142 	mtdparts = CONFIG_MTDPARTS_DEFAULT;
143 #endif
144 
145 	if (mtdparts)
146 		env_set("mtdparts", mtdparts);
147 
148 	use_defaults = false;
149 
150 	return mtdparts;
151 }
152 
153 int mtd_probe_devices(void)
154 {
155 	static char *old_mtdparts;
156 	static char *old_mtdids;
157 	const char *mtdparts = get_mtdparts();
158 	const char *mtdids = get_mtdids();
159 	bool remaining_partitions = true;
160 	struct mtd_info *mtd;
161 
162 	mtd_probe_uclass_mtd_devs();
163 
164 	/*
165 	 * Check if mtdparts/mtdids changed or if the MTD dev list was updated
166 	 * since last call, otherwise: exit
167 	 */
168 	if ((!mtdparts && !old_mtdparts && !mtdids && !old_mtdids) ||
169 	    (mtdparts && old_mtdparts && mtdids && old_mtdids &&
170 	     !mtd_dev_list_updated() &&
171 	     !strcmp(mtdparts, old_mtdparts) &&
172 	     !strcmp(mtdids, old_mtdids)))
173 		return 0;
174 
175 	/* Update the local copy of mtdparts */
176 	free(old_mtdparts);
177 	free(old_mtdids);
178 	old_mtdparts = strdup(mtdparts);
179 	old_mtdids = strdup(mtdids);
180 
181 	/* If at least one partition is still in use, do not delete anything */
182 	mtd_for_each_device(mtd) {
183 		if (mtd->usecount) {
184 			printf("Partition \"%s\" already in use, aborting\n",
185 			       mtd->name);
186 			return -EACCES;
187 		}
188 	}
189 
190 	/*
191 	 * Everything looks clear, remove all partitions. It is not safe to
192 	 * remove entries from the mtd_for_each_device loop as it uses idr
193 	 * indexes and the partitions removal is done in bulk (all partitions of
194 	 * one device at the same time), so break and iterate from start each
195 	 * time a new partition is found and deleted.
196 	 */
197 	while (remaining_partitions) {
198 		remaining_partitions = false;
199 		mtd_for_each_device(mtd) {
200 			if (!mtd_is_partition(mtd) && mtd_has_partitions(mtd)) {
201 				del_mtd_partitions(mtd);
202 				remaining_partitions = true;
203 				break;
204 			}
205 		}
206 	}
207 
208 	/*
209 	 * Call mtd_dev_list_updated() to clear updates generated by our own
210 	 * parts removal loop.
211 	 */
212 	mtd_dev_list_updated();
213 
214 	/* If either mtdparts or mtdids is empty, then exit */
215 	if (!mtdparts || !mtdids)
216 		return 0;
217 
218 	/* Start the parsing by ignoring the extra 'mtdparts=' prefix, if any */
219 	if (!strncmp(mtdparts, "mtdparts=", sizeof("mtdparts=") - 1))
220 		mtdparts += 9;
221 
222 	/* For each MTD device in mtdparts */
223 	while (mtdparts[0] != '\0') {
224 		char mtd_name[MTD_NAME_MAX_LEN], *colon;
225 		struct mtd_partition *parts;
226 		unsigned int mtd_name_len;
227 		int nparts, ret;
228 
229 		colon = strchr(mtdparts, ':');
230 		if (!colon) {
231 			printf("Wrong mtdparts: %s\n", mtdparts);
232 			return -EINVAL;
233 		}
234 
235 		mtd_name_len = (unsigned int)(colon - mtdparts);
236 		if (mtd_name_len + 1 > sizeof(mtd_name)) {
237 			printf("MTD name too long: %s\n", mtdparts);
238 			return -EINVAL;
239 		}
240 
241 		strncpy(mtd_name, mtdparts, mtd_name_len);
242 		mtd_name[mtd_name_len] = '\0';
243 		/* Move the pointer forward (including the ':') */
244 		mtdparts += mtd_name_len + 1;
245 		mtd = get_mtd_device_nm(mtd_name);
246 		if (IS_ERR_OR_NULL(mtd)) {
247 			char linux_name[MTD_NAME_MAX_LEN];
248 
249 			/*
250 			 * The MTD device named "mtd_name" does not exist. Try
251 			 * to find a correspondance with an MTD device having
252 			 * the same type and number as defined in the mtdids.
253 			 */
254 			debug("No device named %s\n", mtd_name);
255 			ret = mtd_search_alternate_name(mtd_name, linux_name,
256 							MTD_NAME_MAX_LEN);
257 			if (!ret)
258 				mtd = get_mtd_device_nm(linux_name);
259 
260 			/*
261 			 * If no device could be found, move the mtdparts
262 			 * pointer forward until the next set of partitions.
263 			 */
264 			if (ret || IS_ERR_OR_NULL(mtd)) {
265 				printf("Could not find a valid device for %s\n",
266 				       mtd_name);
267 				mtdparts = strchr(mtdparts, ';');
268 				if (mtdparts)
269 					mtdparts++;
270 
271 				continue;
272 			}
273 		}
274 
275 		/*
276 		 * Parse the MTD device partitions. It will update the mtdparts
277 		 * pointer, create an array of parts (that must be freed), and
278 		 * return the number of partition structures in the array.
279 		 */
280 		ret = mtd_parse_partitions(mtd, &mtdparts, &parts, &nparts);
281 		if (ret) {
282 			printf("Could not parse device %s\n", mtd->name);
283 			put_mtd_device(mtd);
284 			return -EINVAL;
285 		}
286 
287 		if (!nparts)
288 			continue;
289 
290 		/* Create the new MTD partitions */
291 		add_mtd_partitions(mtd, parts, nparts);
292 
293 		/* Free the structures allocated during the parsing */
294 		mtd_free_parsed_partitions(parts, nparts);
295 
296 		put_mtd_device(mtd);
297 	}
298 
299 	/*
300 	 * Call mtd_dev_list_updated() to clear updates generated by our own
301 	 * parts registration loop.
302 	 */
303 	mtd_dev_list_updated();
304 
305 	return 0;
306 }
307 #else
308 int mtd_probe_devices(void)
309 {
310 	mtd_probe_uclass_mtd_devs();
311 
312 	return 0;
313 }
314 #endif /* defined(CONFIG_MTD_PARTITIONS) */
315 
316 /* Legacy */
317 
318 static int get_part(const char *partname, int *idx, loff_t *off, loff_t *size,
319 		loff_t *maxsize, int devtype)
320 {
321 #ifdef CONFIG_CMD_MTDPARTS
322 	struct mtd_device *dev;
323 	struct part_info *part;
324 	u8 pnum;
325 	int ret;
326 
327 	ret = mtdparts_init();
328 	if (ret)
329 		return ret;
330 
331 	ret = find_dev_and_part(partname, &dev, &pnum, &part);
332 	if (ret)
333 		return ret;
334 
335 	if (dev->id->type != devtype) {
336 		printf("not same typ %d != %d\n", dev->id->type, devtype);
337 		return -1;
338 	}
339 
340 	*off = part->offset;
341 	*size = part->size;
342 	*maxsize = part->size;
343 	*idx = dev->id->num;
344 
345 	return 0;
346 #else
347 	puts("mtdparts support missing.\n");
348 	return -1;
349 #endif
350 }
351 
352 int mtd_arg_off(const char *arg, int *idx, loff_t *off, loff_t *size,
353 		loff_t *maxsize, int devtype, uint64_t chipsize)
354 {
355 	if (!str2off(arg, off))
356 		return get_part(arg, idx, off, size, maxsize, devtype);
357 
358 	if (*off >= chipsize) {
359 		puts("Offset exceeds device limit\n");
360 		return -1;
361 	}
362 
363 	*maxsize = chipsize - *off;
364 	*size = *maxsize;
365 	return 0;
366 }
367 
368 int mtd_arg_off_size(int argc, char *const argv[], int *idx, loff_t *off,
369 		     loff_t *size, loff_t *maxsize, int devtype,
370 		     uint64_t chipsize)
371 {
372 	int ret;
373 
374 	if (argc == 0) {
375 		*off = 0;
376 		*size = chipsize;
377 		*maxsize = *size;
378 		goto print;
379 	}
380 
381 	ret = mtd_arg_off(argv[0], idx, off, size, maxsize, devtype,
382 			  chipsize);
383 	if (ret)
384 		return ret;
385 
386 	if (argc == 1)
387 		goto print;
388 
389 	if (!str2off(argv[1], size)) {
390 		printf("'%s' is not a number\n", argv[1]);
391 		return -1;
392 	}
393 
394 	if (*size > *maxsize) {
395 		puts("Size exceeds partition or device limit\n");
396 		return -1;
397 	}
398 
399 print:
400 	printf("device %d ", *idx);
401 	if (*size == chipsize)
402 		puts("whole chip\n");
403 	else
404 		printf("offset 0x%llx, size 0x%llx\n",
405 		       (unsigned long long)*off, (unsigned long long)*size);
406 	return 0;
407 }
408