xref: /rk3399_rockchip-uboot/drivers/mtd/mtd_blk.c (revision 913fb045d4ccfcd85b701ffd83bde08719f5f901)
1 /*
2  * (C) Copyright 2019 Rockchip Electronics Co., Ltd
3  *
4  * SPDX-License-Identifier:	GPL-2.0+
5  */
6 
7 #include <common.h>
8 #include <blk.h>
9 #include <boot_rkimg.h>
10 #include <dm.h>
11 #include <errno.h>
12 #include <malloc.h>
13 #include <nand.h>
14 #include <part.h>
15 #include <dm/device-internal.h>
16 
17 #define MTD_PART_NAND_HEAD		"mtdparts="
18 #define MTD_PART_INFO_MAX_SIZE		512
19 #define MTD_SINGLE_PART_INFO_MAX_SIZE	40
20 
21 #define MTD_BLK_TABLE_BLOCK_UNKNOWN	(-2)
22 #define MTD_BLK_TABLE_BLOCK_SHIFT	(-1)
23 
24 static int *mtd_map_blk_table;
25 
26 int mtd_blk_map_table_init(struct blk_desc *desc,
27 			   loff_t offset,
28 			   size_t length)
29 {
30 	u32 blk_total, blk_begin, blk_cnt;
31 	struct mtd_info *mtd = NULL;
32 	int i, j;
33 
34 	if (!desc)
35 		return -ENODEV;
36 
37 	if (desc->devnum == BLK_MTD_NAND) {
38 #if defined(CONFIG_NAND) && !defined(CONFIG_SPL_BUILD)
39 		mtd = dev_get_priv(desc->bdev->parent);
40 #endif
41 	} else if (desc->devnum == BLK_MTD_SPI_NAND) {
42 #if defined(CONFIG_MTD_SPI_NAND) && !defined(CONFIG_SPL_BUILD)
43 		mtd = desc->bdev->priv;
44 #endif
45 	}
46 
47 	if (!mtd) {
48 		return -ENODEV;
49 	} else {
50 		blk_total = (mtd->size + mtd->erasesize - 1) >> mtd->erasesize_shift;
51 		if (!mtd_map_blk_table) {
52 			mtd_map_blk_table = (int *)malloc(blk_total * 4);
53 			memset(mtd_map_blk_table, MTD_BLK_TABLE_BLOCK_UNKNOWN,
54 			       blk_total * 4);
55 		}
56 
57 		blk_begin = (u32)offset >> mtd->erasesize_shift;
58 		blk_cnt = ((u32)((offset & mtd->erasesize_mask) + length) >> mtd->erasesize_shift);
59 		if ((blk_begin + blk_cnt) > blk_total)
60 			blk_cnt = blk_total - blk_begin;
61 
62 		if (mtd_map_blk_table[blk_begin] != MTD_BLK_TABLE_BLOCK_UNKNOWN)
63 			return 0;
64 
65 		j = 0;
66 		 /* should not across blk_cnt */
67 		for (i = 0; i < blk_cnt; i++) {
68 			if (j >= blk_cnt)
69 				mtd_map_blk_table[blk_begin + i] = MTD_BLK_TABLE_BLOCK_SHIFT;
70 			for (; j < blk_cnt; j++) {
71 				if (!mtd_block_isbad(mtd, (blk_begin + j) << mtd->erasesize_shift)) {
72 					mtd_map_blk_table[blk_begin + i] = blk_begin + j;
73 					j++;
74 					if (j == blk_cnt)
75 						j++;
76 					break;
77 				}
78 			}
79 		}
80 
81 		return 0;
82 	}
83 }
84 
85 static bool get_mtd_blk_map_address(struct mtd_info *mtd, loff_t *off)
86 {
87 	bool mapped;
88 	loff_t offset = *off;
89 	size_t block_offset = offset & (mtd->erasesize - 1);
90 
91 	mapped = false;
92 	if (!mtd_map_blk_table ||
93 	    mtd_map_blk_table[(u64)offset >> mtd->erasesize_shift] ==
94 	    MTD_BLK_TABLE_BLOCK_UNKNOWN ||
95 	    mtd_map_blk_table[(u64)offset >> mtd->erasesize_shift] ==
96 	    0xffffffff)
97 		return mapped;
98 
99 	mapped = true;
100 	*off = (loff_t)(((u32)mtd_map_blk_table[(u64)offset >>
101 		mtd->erasesize_shift] << mtd->erasesize_shift) + block_offset);
102 
103 	return mapped;
104 }
105 
106 void mtd_blk_map_partitions(struct blk_desc *desc)
107 {
108 	disk_partition_t info;
109 	int i, ret;
110 
111 	if (!desc)
112 		return;
113 
114 	if (desc->if_type != IF_TYPE_MTD)
115 		return;
116 
117 	for (i = 1; i < MAX_SEARCH_PARTITIONS; i++) {
118 		ret = part_get_info(desc, i, &info);
119 		if (ret != 0)
120 			continue;
121 
122 		if (mtd_blk_map_table_init(desc,
123 					   info.start << 9,
124 					   info.size << 9)) {
125 			printf("mtd block map table fail\n");
126 		}
127 	}
128 }
129 
130 static __maybe_unused int mtd_map_read(struct mtd_info *mtd, loff_t offset,
131 				       size_t *length, size_t *actual,
132 				       loff_t lim, u_char *buffer)
133 {
134 	size_t left_to_read = *length;
135 	u_char *p_buffer = buffer;
136 	int rval;
137 
138 	while (left_to_read > 0) {
139 		size_t block_offset = offset & (mtd->erasesize - 1);
140 		size_t read_length;
141 		loff_t mapped_offset;
142 
143 		if (offset >= mtd->size)
144 			return 0;
145 
146 		mapped_offset = offset;
147 		if (!get_mtd_blk_map_address(mtd, &mapped_offset)) {
148 			if (mtd_block_isbad(mtd, mapped_offset &
149 					    ~(mtd->erasesize - 1))) {
150 				printf("Skipping bad block 0x%08llx\n",
151 				       offset & ~(mtd->erasesize - 1));
152 				offset += mtd->erasesize - block_offset;
153 				continue;
154 			}
155 		}
156 
157 		if (left_to_read < (mtd->erasesize - block_offset))
158 			read_length = left_to_read;
159 		else
160 			read_length = mtd->erasesize - block_offset;
161 
162 		rval = mtd_read(mtd, mapped_offset, read_length, &read_length,
163 				p_buffer);
164 		if (rval && rval != -EUCLEAN) {
165 			printf("NAND read from offset %llx failed %d\n",
166 			       offset, rval);
167 			*length -= left_to_read;
168 			return rval;
169 		}
170 
171 		left_to_read -= read_length;
172 		offset       += read_length;
173 		p_buffer     += read_length;
174 	}
175 
176 	return 0;
177 }
178 
179 char *mtd_part_parse(void)
180 {
181 	char mtd_part_info_temp[MTD_SINGLE_PART_INFO_MAX_SIZE] = {0};
182 	u32 length, data_len = MTD_PART_INFO_MAX_SIZE;
183 	struct blk_desc *dev_desc;
184 	disk_partition_t info;
185 	char *mtd_part_info_p;
186 	struct mtd_info *mtd;
187 	char *mtd_part_info;
188 	int ret;
189 	int p;
190 
191 	dev_desc = rockchip_get_bootdev();
192 	if (!dev_desc)
193 		return NULL;
194 
195 	mtd = (struct mtd_info *)dev_desc->bdev->priv;
196 	if (!mtd)
197 		return NULL;
198 
199 	mtd_part_info = (char *)calloc(MTD_PART_INFO_MAX_SIZE, sizeof(char));
200 	if (!mtd_part_info) {
201 		printf("%s: Fail to malloc!", __func__);
202 		return NULL;
203 	}
204 
205 	mtd_part_info_p = mtd_part_info;
206 	snprintf(mtd_part_info_p, data_len - 1, "%s%s:",
207 		 MTD_PART_NAND_HEAD,
208 		 dev_desc->product);
209 	data_len -= strlen(mtd_part_info_p);
210 	mtd_part_info_p = mtd_part_info_p + strlen(mtd_part_info_p);
211 
212 	for (p = 1; p < MAX_SEARCH_PARTITIONS; p++) {
213 		ret = part_get_info(dev_desc, p, &info);
214 		if (ret)
215 			break;
216 
217 		debug("name is %s, start addr is %x\n", info.name,
218 		      (int)(size_t)info.start);
219 
220 		snprintf(mtd_part_info_p, data_len - 1, "0x%x@0x%x(%s)",
221 			 (int)(size_t)info.size << 9,
222 			 (int)(size_t)info.start << 9,
223 			 info.name);
224 		snprintf(mtd_part_info_temp, MTD_SINGLE_PART_INFO_MAX_SIZE - 1,
225 			 "0x%x@0x%x(%s)",
226 			 (int)(size_t)info.size << 9,
227 			 (int)(size_t)info.start << 9,
228 			 info.name);
229 		strcat(mtd_part_info, ",");
230 		if (part_get_info(dev_desc, p + 1, &info)) {
231 			/* Nand flash is erased by block and gpt table just
232 			 * resserve 33 sectors for the last partition. This
233 			 * will erase the backup gpt table by user program,
234 			 * so reserve one block.
235 			 */
236 			snprintf(mtd_part_info_p, data_len - 1, "0x%x@0x%x(%s)",
237 				 (int)(size_t)(info.size -
238 				 (info.size - 1) %
239 				 (mtd->erasesize >> 9) - 1) << 9,
240 				 (int)(size_t)info.start << 9,
241 				 info.name);
242 			break;
243 		}
244 		length = strlen(mtd_part_info_temp);
245 		data_len -= length;
246 		mtd_part_info_p = mtd_part_info_p + length + 1;
247 		memset(mtd_part_info_temp, 0, MTD_SINGLE_PART_INFO_MAX_SIZE);
248 	}
249 
250 	return mtd_part_info;
251 }
252 
253 ulong mtd_dread(struct udevice *udev, lbaint_t start,
254 		lbaint_t blkcnt, void *dst)
255 {
256 	struct blk_desc *desc = dev_get_uclass_platdata(udev);
257 #if defined(CONFIG_NAND) || defined(CONFIG_MTD_SPI_NAND) || defined(CONFIG_SPI_FLASH_MTD)
258 	loff_t off = (loff_t)(start * 512);
259 	size_t rwsize = blkcnt * 512;
260 #endif
261 	struct mtd_info *mtd;
262 	int ret = 0;
263 
264 	if (!desc)
265 		return ret;
266 
267 	mtd = desc->bdev->priv;
268 	if (!mtd)
269 		return 0;
270 
271 	if (blkcnt == 0)
272 		return 0;
273 
274 	if (desc->devnum == BLK_MTD_NAND) {
275 #if defined(CONFIG_NAND) && !defined(CONFIG_SPL_BUILD)
276 		mtd = dev_get_priv(udev->parent);
277 		if (!mtd)
278 			return 0;
279 
280 		ret = nand_read_skip_bad(mtd, off, &rwsize,
281 					 NULL, mtd->size,
282 					 (u_char *)(dst));
283 #else
284 		ret = mtd_map_read(mtd, off, &rwsize,
285 				   NULL, mtd->size,
286 				   (u_char *)(dst));
287 #endif
288 		if (!ret)
289 			return blkcnt;
290 		else
291 			return 0;
292 	} else if (desc->devnum == BLK_MTD_SPI_NAND) {
293 		ret = mtd_map_read(mtd, off, &rwsize,
294 				   NULL, mtd->size,
295 				   (u_char *)(dst));
296 		if (!ret)
297 			return blkcnt;
298 		else
299 			return 0;
300 	} else if (desc->devnum == BLK_MTD_SPI_NOR) {
301 #if defined(CONFIG_SPI_FLASH_MTD) || defined(CONFIG_SPL_BUILD)
302 		size_t retlen_nor;
303 
304 		mtd_read(mtd, off, rwsize, &retlen_nor, dst);
305 		if (retlen_nor == rwsize)
306 			return blkcnt;
307 		else
308 #endif
309 			return 0;
310 	} else {
311 		return 0;
312 	}
313 }
314 
315 ulong mtd_dwrite(struct udevice *udev, lbaint_t start,
316 		 lbaint_t blkcnt, const void *src)
317 {
318 	/* Not implemented */
319 	return 0;
320 }
321 
322 ulong mtd_derase(struct udevice *udev, lbaint_t start,
323 		 lbaint_t blkcnt)
324 {
325 	/* Not implemented */
326 	return 0;
327 }
328 
329 static int mtd_blk_probe(struct udevice *udev)
330 {
331 	struct mtd_info *mtd = dev_get_uclass_priv(udev->parent);
332 	struct blk_desc *desc = dev_get_uclass_platdata(udev);
333 	int ret, i;
334 
335 	desc->bdev->priv = mtd;
336 	sprintf(desc->vendor, "0x%.4x", 0x2207);
337 	memcpy(desc->product, mtd->name, strlen(mtd->name));
338 	memcpy(desc->revision, "V1.00", sizeof("V1.00"));
339 	if (mtd->type == MTD_NANDFLASH) {
340 		if (desc->devnum == BLK_MTD_NAND)
341 			mtd = dev_get_priv(udev->parent);
342 		/*
343 		 * Find the first useful block in the end,
344 		 * and it is the end lba of the nand storage.
345 		 */
346 		for (i = 0; i < (mtd->size / mtd->erasesize); i++) {
347 			ret =  mtd_block_isbad(mtd,
348 					       mtd->size - mtd->erasesize * (i + 1));
349 			if (!ret) {
350 				desc->lba = (mtd->size >> 9) -
351 					(mtd->erasesize >> 9) * i;
352 				break;
353 			}
354 		}
355 	} else {
356 		desc->lba = mtd->size >> 9;
357 	}
358 
359 	debug("MTD: desc->lba is %lx\n", desc->lba);
360 
361 	return 0;
362 }
363 
364 static const struct blk_ops mtd_blk_ops = {
365 	.read	= mtd_dread,
366 #ifndef CONFIG_SPL_BUILD
367 	.write	= mtd_dwrite,
368 	.erase	= mtd_derase,
369 #endif
370 };
371 
372 U_BOOT_DRIVER(mtd_blk) = {
373 	.name		= "mtd_blk",
374 	.id		= UCLASS_BLK,
375 	.ops		= &mtd_blk_ops,
376 	.probe		= mtd_blk_probe,
377 };
378