1 /*
2  * Copyright (c) 2016 Toradex, Inc.
3  *
4  * SPDX-License-Identifier:	GPL-2.0+
5  */
6 
7 #include <common.h>
8 #include "tdx-cfg-block.h"
9 
10 #if defined(CONFIG_TARGET_APALIS_IMX6) || defined(CONFIG_TARGET_COLIBRI_IMX6)
11 #include <asm/arch/sys_proto.h>
12 #else
13 #define is_cpu_type(cpu) (0)
14 #endif
15 #if defined(CONFIG_CPU_PXA27X)
16 #include <asm/arch-pxa/pxa.h>
17 #else
18 #define cpu_is_pxa27x(cpu) (0)
19 #endif
20 #include <cli.h>
21 #include <console.h>
22 #include <flash.h>
23 #include <malloc.h>
24 #include <mmc.h>
25 #include <nand.h>
26 #include <asm/mach-types.h>
27 
28 DECLARE_GLOBAL_DATA_PTR;
29 
30 #define TAG_VALID	0xcf01
31 #define TAG_MAC		0x0000
32 #define TAG_HW		0x0008
33 #define TAG_INVALID	0xffff
34 
35 #define TAG_FLAG_VALID	0x1
36 
37 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_MMC)
38 #define TDX_CFG_BLOCK_MAX_SIZE 512
39 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
40 #define TDX_CFG_BLOCK_MAX_SIZE 64
41 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
42 #define TDX_CFG_BLOCK_MAX_SIZE 64
43 #else
44 #error Toradex config block location not set
45 #endif
46 
47 struct toradex_tag {
48 	u32 len:14;
49 	u32 flags:2;
50 	u32 id:16;
51 };
52 
53 bool valid_cfgblock;
54 struct toradex_hw tdx_hw_tag;
55 struct toradex_eth_addr tdx_eth_addr;
56 u32 tdx_serial;
57 
58 const char * const toradex_modules[] = {
59 	 [0] = "UNKNOWN MODULE",
60 	 [1] = "Colibri PXA270 312MHz",
61 	 [2] = "Colibri PXA270 520MHz",
62 	 [3] = "Colibri PXA320 806MHz",
63 	 [4] = "Colibri PXA300 208MHz",
64 	 [5] = "Colibri PXA310 624MHz",
65 	 [6] = "Colibri PXA320 806MHz IT",
66 	 [7] = "Colibri PXA300 208MHz XT",
67 	 [8] = "Colibri PXA270 312MHz",
68 	 [9] = "Colibri PXA270 520MHz",
69 	[10] = "Colibri VF50 128MB", /* not currently on sale */
70 	[11] = "Colibri VF61 256MB",
71 	[12] = "Colibri VF61 256MB IT",
72 	[13] = "Colibri VF50 128MB IT",
73 	[14] = "Colibri iMX6 Solo 256MB",
74 	[15] = "Colibri iMX6 DualLite 512MB",
75 	[16] = "Colibri iMX6 Solo 256MB IT",
76 	[17] = "Colibri iMX6 DualLite 512MB IT",
77 	[18] = "UNKNOWN MODULE",
78 	[19] = "UNKNOWN MODULE",
79 	[20] = "Colibri T20 256MB",
80 	[21] = "Colibri T20 512MB",
81 	[22] = "Colibri T20 512MB IT",
82 	[23] = "Colibri T30 1GB",
83 	[24] = "Colibri T20 256MB IT",
84 	[25] = "Apalis T30 2GB",
85 	[26] = "Apalis T30 1GB",
86 	[27] = "Apalis iMX6 Quad 1GB",
87 	[28] = "Apalis iMX6 Quad 2GB IT",
88 	[29] = "Apalis iMX6 Dual 512MB",
89 	[30] = "Colibri T30 1GB IT",
90 	[31] = "Apalis T30 1GB IT",
91 	[32] = "Colibri iMX7 Solo 256MB",
92 	[33] = "Colibri iMX7 Dual 512MB",
93 	[34] = "Apalis TK1 2GB",
94 	[35] = "Apalis iMX6 Dual 1GB IT",
95 };
96 
97 #ifdef CONFIG_TDX_CFG_BLOCK_IS_IN_MMC
98 static int tdx_cfg_block_mmc_storage(u8 *config_block, int write)
99 {
100 	struct mmc *mmc;
101 	int dev = CONFIG_TDX_CFG_BLOCK_DEV;
102 	int offset = CONFIG_TDX_CFG_BLOCK_OFFSET;
103 	uint part = CONFIG_TDX_CFG_BLOCK_PART;
104 	uint blk_start;
105 	int ret = 0;
106 
107 	/* Read production parameter config block from eMMC */
108 	mmc = find_mmc_device(dev);
109 	if (!mmc) {
110 		puts("No MMC card found\n");
111 		ret = -ENODEV;
112 		goto out;
113 	}
114 	if (part != mmc_get_blk_desc(mmc)->hwpart) {
115 		if (blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part)) {
116 			puts("MMC partition switch failed\n");
117 			ret = -ENODEV;
118 			goto out;
119 		}
120 	}
121 	if (offset < 0)
122 		offset += mmc->capacity;
123 	blk_start = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
124 
125 	if (!write) {
126 		/* Careful reads a whole block of 512 bytes into config_block */
127 		if (blk_dread(mmc_get_blk_desc(mmc), blk_start, 1,
128 			      (unsigned char *)config_block) != 1) {
129 			ret = -EIO;
130 			goto out;
131 		}
132 		/* Flush cache after read */
133 		flush_cache((ulong)(unsigned char *)config_block, 512);
134 	} else {
135 		/* Just writing one 512 byte block */
136 		if (blk_dwrite(mmc_get_blk_desc(mmc), blk_start, 1,
137 			       (unsigned char *)config_block) != 1) {
138 			ret = -EIO;
139 			goto out;
140 		}
141 	}
142 
143 out:
144 	/* Switch back to regular eMMC user partition */
145 	blk_select_hwpart_devnum(IF_TYPE_MMC, 0, 0);
146 
147 	return ret;
148 }
149 #endif
150 
151 #ifdef CONFIG_TDX_CFG_BLOCK_IS_IN_NAND
152 static int read_tdx_cfg_block_from_nand(unsigned char *config_block)
153 {
154 	size_t size = TDX_CFG_BLOCK_MAX_SIZE;
155 
156 	/* Read production parameter config block from NAND page */
157 	return nand_read_skip_bad(nand_info[0], CONFIG_TDX_CFG_BLOCK_OFFSET,
158 			 &size, NULL, TDX_CFG_BLOCK_MAX_SIZE, config_block);
159 }
160 
161 static int write_tdx_cfg_block_to_nand(unsigned char *config_block)
162 {
163 	size_t size = TDX_CFG_BLOCK_MAX_SIZE;
164 
165 	/* Write production parameter config block to NAND page */
166 	return nand_write_skip_bad(nand_info[0], CONFIG_TDX_CFG_BLOCK_OFFSET,
167 				   &size, NULL, TDX_CFG_BLOCK_MAX_SIZE,
168 				   config_block, WITH_WR_VERIFY);
169 }
170 #endif
171 
172 #ifdef CONFIG_TDX_CFG_BLOCK_IS_IN_NOR
173 static int read_tdx_cfg_block_from_nor(unsigned char *config_block)
174 {
175 	/* Read production parameter config block from NOR flash */
176 	memcpy(config_block, (void *)CONFIG_TDX_CFG_BLOCK_OFFSET,
177 	       TDX_CFG_BLOCK_MAX_SIZE);
178 	return 0;
179 }
180 
181 static int write_tdx_cfg_block_to_nor(unsigned char *config_block)
182 {
183 	/* Write production parameter config block to NOR flash */
184 	return flash_write((void *)config_block, CONFIG_TDX_CFG_BLOCK_OFFSET,
185 			   TDX_CFG_BLOCK_MAX_SIZE);
186 }
187 #endif
188 
189 int read_tdx_cfg_block(void)
190 {
191 	int ret = 0;
192 	u8 *config_block = NULL;
193 	struct toradex_tag *tag;
194 	size_t size = TDX_CFG_BLOCK_MAX_SIZE;
195 	int offset;
196 
197 	/* Allocate RAM area for config block */
198 	config_block = memalign(ARCH_DMA_MINALIGN, size);
199 	if (!config_block) {
200 		printf("Not enough malloc space available!\n");
201 		return -ENOMEM;
202 	}
203 
204 	memset(config_block, 0, size);
205 
206 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_MMC)
207 	ret = tdx_cfg_block_mmc_storage(config_block, 0);
208 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
209 	ret = read_tdx_cfg_block_from_nand(config_block);
210 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
211 	ret = read_tdx_cfg_block_from_nor(config_block);
212 #else
213 	ret = -EINVAL;
214 #endif
215 	if (ret)
216 		goto out;
217 
218 	/* Expect a valid tag first */
219 	tag = (struct toradex_tag *)config_block;
220 	if (tag->flags != TAG_FLAG_VALID || tag->id != TAG_VALID) {
221 		valid_cfgblock = false;
222 		ret = -EINVAL;
223 		goto out;
224 	}
225 	valid_cfgblock = true;
226 	offset = 4;
227 
228 	while (offset < TDX_CFG_BLOCK_MAX_SIZE) {
229 		tag = (struct toradex_tag *)(config_block + offset);
230 		offset += 4;
231 		if (tag->id == TAG_INVALID)
232 			break;
233 
234 		if (tag->flags == TAG_FLAG_VALID) {
235 			switch (tag->id) {
236 			case TAG_MAC:
237 				memcpy(&tdx_eth_addr, config_block + offset,
238 				       6);
239 
240 				/* NIC part of MAC address is serial number */
241 				tdx_serial = ntohl(tdx_eth_addr.nic) >> 8;
242 				break;
243 			case TAG_HW:
244 				memcpy(&tdx_hw_tag, config_block + offset, 8);
245 				break;
246 			}
247 		}
248 
249 		/* Get to next tag according to current tags length */
250 		offset += tag->len * 4;
251 	}
252 
253 	/* Cap product id to avoid issues with a yet unknown one */
254 	if (tdx_hw_tag.prodid > (sizeof(toradex_modules) /
255 				  sizeof(toradex_modules[0])))
256 		tdx_hw_tag.prodid = 0;
257 
258 out:
259 	free(config_block);
260 	return ret;
261 }
262 
263 static int get_cfgblock_interactive(void)
264 {
265 	char message[CONFIG_SYS_CBSIZE];
266 	char *soc;
267 	char it = 'n';
268 	int len;
269 
270 	if (cpu_is_pxa27x())
271 		sprintf(message, "Is the module the 312 MHz version? [y/N] ");
272 	else
273 		sprintf(message, "Is the module an IT version? [y/N] ");
274 
275 	len = cli_readline(message);
276 	it = console_buffer[0];
277 
278 	soc = getenv("soc");
279 	if (!strcmp("mx6", soc)) {
280 #ifdef CONFIG_MACH_TYPE
281 		if (it == 'y' || it == 'Y')
282 			if (is_cpu_type(MXC_CPU_MX6Q))
283 				tdx_hw_tag.prodid = APALIS_IMX6Q_IT;
284 			else
285 				tdx_hw_tag.prodid = APALIS_IMX6D_IT;
286 		else
287 			if (is_cpu_type(MXC_CPU_MX6Q))
288 				tdx_hw_tag.prodid = APALIS_IMX6Q;
289 			else
290 				tdx_hw_tag.prodid = APALIS_IMX6D;
291 #else
292 		if (it == 'y' || it == 'Y')
293 			if (is_cpu_type(MXC_CPU_MX6DL))
294 				tdx_hw_tag.prodid = COLIBRI_IMX6DL_IT;
295 			else
296 				tdx_hw_tag.prodid = COLIBRI_IMX6S_IT;
297 		else
298 			if (is_cpu_type(MXC_CPU_MX6DL))
299 				tdx_hw_tag.prodid = COLIBRI_IMX6DL;
300 			else
301 				tdx_hw_tag.prodid = COLIBRI_IMX6S;
302 #endif /* CONFIG_MACH_TYPE */
303 	} else if (!strcmp("imx7d", soc)) {
304 		tdx_hw_tag.prodid = COLIBRI_IMX7D;
305 	} else if (!strcmp("imx7s", soc)) {
306 		tdx_hw_tag.prodid = COLIBRI_IMX7S;
307 	} else if (!strcmp("tegra20", soc)) {
308 		if (it == 'y' || it == 'Y')
309 			if (gd->ram_size == 0x10000000)
310 				tdx_hw_tag.prodid = COLIBRI_T20_256MB_IT;
311 			else
312 				tdx_hw_tag.prodid = COLIBRI_T20_512MB_IT;
313 		else
314 			if (gd->ram_size == 0x10000000)
315 				tdx_hw_tag.prodid = COLIBRI_T20_256MB;
316 			else
317 				tdx_hw_tag.prodid = COLIBRI_T20_512MB;
318 	} else if (cpu_is_pxa27x()) {
319 		if (it == 'y' || it == 'Y')
320 			tdx_hw_tag.prodid = COLIBRI_PXA270_312MHZ;
321 		else
322 			tdx_hw_tag.prodid = COLIBRI_PXA270_520MHZ;
323 #ifdef CONFIG_MACH_TYPE
324 	} else if (!strcmp("tegra30", soc)) {
325 		if (CONFIG_MACH_TYPE == MACH_TYPE_APALIS_T30) {
326 			if (it == 'y' || it == 'Y')
327 				tdx_hw_tag.prodid = APALIS_T30_IT;
328 			else
329 				if (gd->ram_size == 0x40000000)
330 					tdx_hw_tag.prodid = APALIS_T30_1GB;
331 				else
332 					tdx_hw_tag.prodid = APALIS_T30_2GB;
333 		} else {
334 			if (it == 'y' || it == 'Y')
335 				tdx_hw_tag.prodid = COLIBRI_T30_IT;
336 			else
337 				tdx_hw_tag.prodid = COLIBRI_T30;
338 		}
339 #endif /* CONFIG_MACH_TYPE */
340 	} else if (!strcmp("tegra124", soc)) {
341 		tdx_hw_tag.prodid = APALIS_TK1_2GB;
342 	} else if (!strcmp("vf500", soc)) {
343 		if (it == 'y' || it == 'Y')
344 			tdx_hw_tag.prodid = COLIBRI_VF50_IT;
345 		else
346 			tdx_hw_tag.prodid = COLIBRI_VF50;
347 	} else if (!strcmp("vf610", soc)) {
348 		if (it == 'y' || it == 'Y')
349 			tdx_hw_tag.prodid = COLIBRI_VF61_IT;
350 		else
351 			tdx_hw_tag.prodid = COLIBRI_VF61;
352 	} else {
353 		printf("Module type not detectable due to unknown SoC\n");
354 		return -1;
355 	}
356 
357 	while (len < 4) {
358 		sprintf(message, "Enter the module version (e.g. V1.1B): V");
359 		len = cli_readline(message);
360 	}
361 
362 	tdx_hw_tag.ver_major = console_buffer[0] - '0';
363 	tdx_hw_tag.ver_minor = console_buffer[2] - '0';
364 	tdx_hw_tag.ver_assembly = console_buffer[3] - 'A';
365 
366 	if (cpu_is_pxa27x() && (tdx_hw_tag.ver_major == 1))
367 		tdx_hw_tag.prodid -= (COLIBRI_PXA270_312MHZ -
368 				       COLIBRI_PXA270_V1_312MHZ);
369 
370 	while (len < 8) {
371 		sprintf(message, "Enter module serial number: ");
372 		len = cli_readline(message);
373 	}
374 
375 	tdx_serial = simple_strtoul(console_buffer, NULL, 10);
376 
377 	return 0;
378 }
379 
380 static int get_cfgblock_barcode(char *barcode)
381 {
382 	if (strlen(barcode) < 16) {
383 		printf("Argument too short, barcode is 16 chars long\n");
384 		return -1;
385 	}
386 
387 	/* Get hardware information from the first 8 digits */
388 	tdx_hw_tag.ver_major = barcode[4] - '0';
389 	tdx_hw_tag.ver_minor = barcode[5] - '0';
390 	tdx_hw_tag.ver_assembly = barcode[7] - '0';
391 
392 	barcode[4] = '\0';
393 	tdx_hw_tag.prodid = simple_strtoul(barcode, NULL, 10);
394 
395 	/* Parse second part of the barcode (serial number */
396 	barcode += 8;
397 	tdx_serial = simple_strtoul(barcode, NULL, 10);
398 
399 	return 0;
400 }
401 
402 static int do_cfgblock_create(cmd_tbl_t *cmdtp, int flag, int argc,
403 			      char * const argv[])
404 {
405 	u8 *config_block;
406 	struct toradex_tag *tag;
407 	size_t size = TDX_CFG_BLOCK_MAX_SIZE;
408 	int offset = 0;
409 	int ret = CMD_RET_SUCCESS;
410 	int err;
411 
412 	/* Allocate RAM area for config block */
413 	config_block = memalign(ARCH_DMA_MINALIGN, size);
414 	if (!config_block) {
415 		printf("Not enough malloc space available!\n");
416 		return CMD_RET_FAILURE;
417 	}
418 
419 	memset(config_block, 0xff, size);
420 
421 	read_tdx_cfg_block();
422 	if (valid_cfgblock) {
423 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
424 		/*
425 		 * On NAND devices, recreation is only allowed if the page is
426 		 * empty (config block invalid...)
427 		 */
428 		printf("NAND erase block %d need to be erased before creating a Toradex config block\n",
429 		       CONFIG_TDX_CFG_BLOCK_OFFSET / nand_info[0]->erasesize);
430 		goto out;
431 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
432 		/*
433 		 * On NOR devices, recreation is only allowed if the sector is
434 		 * empty and write protection is off (config block invalid...)
435 		 */
436 		printf("NOR sector at offset 0x%02x need to be erased and unprotected before creating a Toradex config block\n",
437 		       CONFIG_TDX_CFG_BLOCK_OFFSET);
438 		goto out;
439 #else
440 		char message[CONFIG_SYS_CBSIZE];
441 		sprintf(message,
442 			"A valid Toradex config block is present, still recreate? [y/N] ");
443 
444 		if (!cli_readline(message))
445 			goto out;
446 
447 		if (console_buffer[0] != 'y' && console_buffer[0] != 'Y')
448 			goto out;
449 #endif
450 	}
451 
452 	/* Parse new Toradex config block data... */
453 	if (argc < 3)
454 		err = get_cfgblock_interactive();
455 	else
456 		err = get_cfgblock_barcode(argv[2]);
457 
458 	if (err) {
459 		ret = CMD_RET_FAILURE;
460 		goto out;
461 	}
462 
463 	/* Convert serial number to MAC address (the storage format) */
464 	tdx_eth_addr.oui = htonl(0x00142dUL << 8);
465 	tdx_eth_addr.nic = htonl(tdx_serial << 8);
466 
467 	/* Valid Tag */
468 	tag = (struct toradex_tag *)config_block;
469 	tag->id = TAG_VALID;
470 	tag->flags = TAG_FLAG_VALID;
471 	tag->len = 0;
472 	offset += 4;
473 
474 	/* Product Tag */
475 	tag = (struct toradex_tag *)(config_block + offset);
476 	tag->id = TAG_HW;
477 	tag->flags = TAG_FLAG_VALID;
478 	tag->len = 2;
479 	offset += 4;
480 
481 	memcpy(config_block + offset, &tdx_hw_tag, 8);
482 	offset += 8;
483 
484 	/* MAC Tag */
485 	tag = (struct toradex_tag *)(config_block + offset);
486 	tag->id = TAG_MAC;
487 	tag->flags = TAG_FLAG_VALID;
488 	tag->len = 2;
489 	offset += 4;
490 
491 	memcpy(config_block + offset, &tdx_eth_addr, 6);
492 	offset += 6;
493 	memset(config_block + offset, 0, 32 - offset);
494 
495 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_MMC)
496 	err = tdx_cfg_block_mmc_storage(config_block, 1);
497 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
498 	err = write_tdx_cfg_block_to_nand(config_block);
499 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
500 	err = write_tdx_cfg_block_to_nor(config_block);
501 #else
502 	err = -EINVAL;
503 #endif
504 	if (err) {
505 		printf("Failed to write Toradex config block: %d\n", ret);
506 		ret = CMD_RET_FAILURE;
507 		goto out;
508 	}
509 
510 	printf("Toradex config block successfully written\n");
511 
512 out:
513 	free(config_block);
514 	return ret;
515 }
516 
517 static int do_cfgblock(cmd_tbl_t *cmdtp, int flag, int argc,
518 		       char * const argv[])
519 {
520 	int ret;
521 
522 	if (argc < 2)
523 		return CMD_RET_USAGE;
524 
525 	if (!strcmp(argv[1], "create")) {
526 		return do_cfgblock_create(cmdtp, flag, argc, argv);
527 	} else if (!strcmp(argv[1], "reload")) {
528 		ret = read_tdx_cfg_block();
529 		if (ret) {
530 			printf("Failed to reload Toradex config block: %d\n",
531 			       ret);
532 			return CMD_RET_FAILURE;
533 		}
534 		return CMD_RET_SUCCESS;
535 	}
536 
537 	return CMD_RET_USAGE;
538 }
539 
540 U_BOOT_CMD(
541 	cfgblock, 3, 0, do_cfgblock,
542 	"Toradex config block handling commands",
543 	"create [barcode] - (Re-)create Toradex config block\n"
544 	"cfgblock reload - Reload Toradex config block from flash"
545 );
546