1 // SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
3 * Copyright (C) 2019, STMicroelectronics - All Rights Reserved
5 * the st command stboard supports the STMicroelectronics board identification
8 * The ST product codification have several element
9 * - "Commercial Product Name" (CPN): type of product board (DKX, EVX)
10 * associated to the board ID "MBxxxx"
11 * - "Finished Good" or "Finish Good" (FG):
12 * effective content of the product without chip STM32MP1xx (LCD, Wifi,…)
13 * - BOM: cost variant for same FG (for example, several provider of the same
17 * - commercial product = STM32MP157C-EV1 for board MB1263
18 * - Finished Good = EVA32MP157A1$AU1
20 * Both information are written on board and these information are also saved
22 * bit [31:16] (hex) => Board id, MBxxxx
23 * bit [15:12] (dec) => Variant CPN (1....15)
24 * bit [11:8] (dec) => Revision board (index with A = 1, Z = 26)
25 * bit [7:4] (dec) => Variant FG : finished good index
26 * bit [3:0] (dec) => BOM (01, .... 255)
28 * and displayed with the format:
29 * Board: MB<Board> Var<VarCPN>.<VarFG> Rev.<Revision>-<BOM>
32 #ifndef CONFIG_SPL_BUILD
37 #include <dm/device.h>
38 #include <dm/uclass.h>
40 static bool check_stboard(u16 board)
43 /* list of supported ST boards */
44 const u16 st_board_id[] = {
53 for (i = 0; i < ARRAY_SIZE(st_board_id); i++)
54 if (board == st_board_id[i])
60 static void display_stboard(u32 otp)
62 /* display board indentification with OPT coding */
63 printf("Board: MB%04x Var%d.%d Rev.%c-%02d\n",
67 ((otp >> 8) & 0xF) - 1 + 'A',
71 static int do_stboard(struct cmd_tbl *cmdtp, int flag, int argc,
77 unsigned long board, var_cpn, var_fg, bom;
79 int confirmed = argc == 7 && !strcmp(argv[1], "-y");
81 argc -= 1 + confirmed;
82 argv += 1 + confirmed;
84 if (argc != 0 && argc != 5)
87 ret = uclass_get_device_by_driver(UCLASS_MISC,
88 DM_GET_DRIVER(stm32mp_bsec),
91 ret = misc_read(dev, STM32_BSEC_OTP(BSEC_OTP_BOARD),
95 puts("OTP read error");
96 return CMD_RET_FAILURE;
99 ret = misc_read(dev, STM32_BSEC_LOCK(BSEC_OTP_BOARD),
100 &lock, sizeof(lock));
102 puts("LOCK read error");
103 return CMD_RET_FAILURE;
108 puts("Board : OTP board FREE\n");
110 display_stboard(otp);
111 printf(" OTP %d %s locked !\n", BSEC_OTP_BOARD,
112 lock == 1 ? "" : "NOT");
113 return CMD_RET_SUCCESS;
117 display_stboard(otp);
118 printf("ERROR: OTP board not FREE\n");
119 return CMD_RET_FAILURE;
122 if (strict_strtoul(argv[0], 16, &board) < 0 ||
123 board == 0 || board > 0xFFFF) {
124 printf("argument %d invalid: %s\n", 1, argv[0]);
125 return CMD_RET_USAGE;
128 if (strict_strtoul(argv[1], 10, &var_cpn) < 0 ||
129 var_cpn == 0 || var_cpn > 15) {
130 printf("argument %d invalid: %s\n", 2, argv[1]);
131 return CMD_RET_USAGE;
134 revision = argv[2][0] - 'A' + 1;
135 if (strlen(argv[2]) > 1 || revision == 0 || revision > 15) {
136 printf("argument %d invalid: %s\n", 3, argv[2]);
137 return CMD_RET_USAGE;
140 if (strict_strtoul(argv[3], 10, &var_fg) < 0 ||
142 printf("argument %d invalid: %s\n", 4, argv[3]);
143 return CMD_RET_USAGE;
146 if (strict_strtoul(argv[4], 10, &bom) < 0 ||
147 bom == 0 || bom > 15) {
148 printf("argument %d invalid: %s\n", 4, argv[3]);
149 return CMD_RET_USAGE;
152 /* st board indentification value */
153 otp = (board << 16) | (var_cpn << 12) | (revision << 8) |
155 display_stboard(otp);
156 printf("=> OTP[%d] = %08X\n", BSEC_OTP_BOARD, otp);
158 if (!check_stboard((u16)board)) {
159 printf("Unknown board MB%04x\n", (u16)board);
160 return CMD_RET_FAILURE;
163 printf("Warning: Programming BOARD in OTP is irreversible!\n");
164 printf("Really perform this OTP programming? <y/N>\n");
166 if (!confirm_yesno()) {
167 puts("BOARD programming aborted\n");
168 return CMD_RET_FAILURE;
172 ret = misc_write(dev, STM32_BSEC_OTP(BSEC_OTP_BOARD),
176 puts("BOARD programming error\n");
177 return CMD_RET_FAILURE;
180 /* write persistent lock */
182 ret = misc_write(dev, STM32_BSEC_LOCK(BSEC_OTP_BOARD),
185 puts("BOARD lock error\n");
186 return CMD_RET_FAILURE;
189 puts("BOARD programming done\n");
191 return CMD_RET_SUCCESS;
194 U_BOOT_CMD(stboard, 7, 0, do_stboard,
195 "read/write board reference in OTP",
197 " Print current board information\n"
198 "stboard [-y] <Board> <VarCPN> <Revision> <VarFG> <BOM>\n"
199 " Write board information\n"
200 " - Board: xxxx, example 1264 for MB1264\n"
201 " - VarCPN: 1...15\n"
202 " - Revision: A...O\n"