[J-u-boot.git] / cmd / bcb.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2019 Eugeniu Rosca <[email protected]>
 *
 * Command to read/modify/write Android BCB fields
 */

#include <android_bootloader_message.h>
#include <command.h>
#include <common.h>
#include <log.h>
#include <part.h>

enum bcb_cmd {
	BCB_CMD_LOAD,
	BCB_CMD_FIELD_SET,
	BCB_CMD_FIELD_CLEAR,
	BCB_CMD_FIELD_TEST,
	BCB_CMD_FIELD_DUMP,
	BCB_CMD_STORE,
};

static int bcb_dev = -1;
static int bcb_part = -1;
static struct bootloader_message bcb = { { 0 } };

static int bcb_cmd_get(char *cmd)
{
	if (!strcmp(cmd, "load"))
		return BCB_CMD_LOAD;
	if (!strcmp(cmd, "set"))
		return BCB_CMD_FIELD_SET;
	if (!strcmp(cmd, "clear"))
		return BCB_CMD_FIELD_CLEAR;
	if (!strcmp(cmd, "test"))
		return BCB_CMD_FIELD_TEST;
	if (!strcmp(cmd, "store"))
		return BCB_CMD_STORE;
	if (!strcmp(cmd, "dump"))
		return BCB_CMD_FIELD_DUMP;
	else
		return -1;
}

static int bcb_is_misused(int argc, char *const argv[])
{
	int cmd = bcb_cmd_get(argv[0]);

	switch (cmd) {
	case BCB_CMD_LOAD:
	case BCB_CMD_FIELD_SET:
		if (argc != 3)
			goto err;
		break;
	case BCB_CMD_FIELD_TEST:
		if (argc != 4)
			goto err;
		break;
	case BCB_CMD_FIELD_CLEAR:
		if (argc != 1 && argc != 2)
			goto err;
		break;
	case BCB_CMD_STORE:
		if (argc != 1)
			goto err;
		break;
	case BCB_CMD_FIELD_DUMP:
		if (argc != 2)
			goto err;
		break;
	default:
		printf("Error: 'bcb %s' not supported\n", argv[0]);
		return -1;
	}

	if (cmd != BCB_CMD_LOAD && (bcb_dev < 0 || bcb_part < 0)) {
		printf("Error: Please, load BCB first!\n");
		return -1;
	}

	return 0;
err:
	printf("Error: Bad usage of 'bcb %s'\n", argv[0]);

	return -1;
}

static int bcb_field_get(char *name, char **fieldp, int *sizep)
{
	if (!strcmp(name, "command")) {
		*fieldp = bcb.command;
		*sizep = sizeof(bcb.command);
	} else if (!strcmp(name, "status")) {
		*fieldp = bcb.status;
		*sizep = sizeof(bcb.status);
	} else if (!strcmp(name, "recovery")) {
		*fieldp = bcb.recovery;
		*sizep = sizeof(bcb.recovery);
	} else if (!strcmp(name, "stage")) {
		*fieldp = bcb.stage;
		*sizep = sizeof(bcb.stage);
	} else if (!strcmp(name, "reserved")) {
		*fieldp = bcb.reserved;
		*sizep = sizeof(bcb.reserved);
	} else {
		printf("Error: Unknown bcb field '%s'\n", name);
		return -1;
	}

	return 0;
}

static int do_bcb_load(struct cmd_tbl *cmdtp, int flag, int argc,
		       char *const argv[])
{
	struct blk_desc *desc;
	struct disk_partition info;
	u64 cnt;
	char *endp;
	int part, ret;

	ret = blk_get_device_by_str("mmc", argv[1], &desc);
	if (ret < 0)
		goto err_read_fail;

	part = simple_strtoul(argv[2], &endp, 0);
	if (*endp == '\0') {
		ret = part_get_info(desc, part, &info);
		if (ret)
			goto err_read_fail;
	} else {
		part = part_get_info_by_name(desc, argv[2], &info);
		if (part < 0) {
			ret = part;
			goto err_read_fail;
		}
	}

	cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz);
	if (cnt > info.size)
		goto err_too_small;

	if (blk_dread(desc, info.start, cnt, &bcb) != cnt) {
		ret = -EIO;
		goto err_read_fail;
	}

	bcb_dev = desc->devnum;
	bcb_part = part;
	debug("%s: Loaded from mmc %d:%d\n", __func__, bcb_dev, bcb_part);

	return CMD_RET_SUCCESS;
err_read_fail:
	printf("Error: mmc %s:%s read failed (%d)\n", argv[1], argv[2], ret);
	goto err;
err_too_small:
	printf("Error: mmc %s:%s too small!", argv[1], argv[2]);
	goto err;
err:
	bcb_dev = -1;
	bcb_part = -1;

	return CMD_RET_FAILURE;
}

static int do_bcb_set(struct cmd_tbl *cmdtp, int flag, int argc,
		      char *const argv[])
{
	int size, len;
	char *field, *str, *found;

	if (bcb_field_get(argv[1], &field, &size))
		return CMD_RET_FAILURE;

	len = strlen(argv[2]);
	if (len >= size) {
		printf("Error: sizeof('%s') = %d >= %d = sizeof(bcb.%s)\n",
		       argv[2], len, size, argv[1]);
		return CMD_RET_FAILURE;
	}
	str = argv[2];

	field[0] = '\0';
	while ((found = strsep(&str, ":"))) {
		if (field[0] != '\0')
			strcat(field, "\n");
		strcat(field, found);
	}

	return CMD_RET_SUCCESS;
}

static int do_bcb_clear(struct cmd_tbl *cmdtp, int flag, int argc,
			char *const argv[])
{
	int size;
	char *field;

	if (argc == 1) {
		memset(&bcb, 0, sizeof(bcb));
		return CMD_RET_SUCCESS;
	}

	if (bcb_field_get(argv[1], &field, &size))
		return CMD_RET_FAILURE;

	memset(field, 0, size);

	return CMD_RET_SUCCESS;
}

static int do_bcb_test(struct cmd_tbl *cmdtp, int flag, int argc,
		       char *const argv[])
{
	int size;
	char *field;
	char *op = argv[2];

	if (bcb_field_get(argv[1], &field, &size))
		return CMD_RET_FAILURE;

	if (*op == '=' && *(op + 1) == '\0') {
		if (!strncmp(argv[3], field, size))
			return CMD_RET_SUCCESS;
		else
			return CMD_RET_FAILURE;
	} else if (*op == '~' && *(op + 1) == '\0') {
		if (!strstr(field, argv[3]))
			return CMD_RET_FAILURE;
		else
			return CMD_RET_SUCCESS;
	} else {
		printf("Error: Unknown operator '%s'\n", op);
	}

	return CMD_RET_FAILURE;
}

static int do_bcb_dump(struct cmd_tbl *cmdtp, int flag, int argc,
		       char *const argv[])
{
	int size;
	char *field;

	if (bcb_field_get(argv[1], &field, &size))
		return CMD_RET_FAILURE;

	print_buffer((ulong)field - (ulong)&bcb, (void *)field, 1, size, 16);

	return CMD_RET_SUCCESS;
}

static int do_bcb_store(struct cmd_tbl *cmdtp, int flag, int argc,
			char *const argv[])
{
	struct blk_desc *desc;
	struct disk_partition info;
	u64 cnt;
	int ret;

	desc = blk_get_devnum_by_type(IF_TYPE_MMC, bcb_dev);
	if (!desc) {
		ret = -ENODEV;
		goto err;
	}

	ret = part_get_info(desc, bcb_part, &info);
	if (ret)
		goto err;

	cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz);

	if (blk_dwrite(desc, info.start, cnt, &bcb) != cnt) {
		ret = -EIO;
		goto err;
	}

	return CMD_RET_SUCCESS;
err:
	printf("Error: mmc %d:%d write failed (%d)\n", bcb_dev, bcb_part, ret);

	return CMD_RET_FAILURE;
}

static struct cmd_tbl cmd_bcb_sub[] = {
	U_BOOT_CMD_MKENT(load, CONFIG_SYS_MAXARGS, 1, do_bcb_load, "", ""),
	U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 1, do_bcb_set, "", ""),
	U_BOOT_CMD_MKENT(clear, CONFIG_SYS_MAXARGS, 1, do_bcb_clear, "", ""),
	U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_bcb_test, "", ""),
	U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_bcb_dump, "", ""),
	U_BOOT_CMD_MKENT(store, CONFIG_SYS_MAXARGS, 1, do_bcb_store, "", ""),
};

static int do_bcb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
	struct cmd_tbl *c;

	if (argc < 2)
		return CMD_RET_USAGE;

	argc--;
	argv++;

	c = find_cmd_tbl(argv[0], cmd_bcb_sub, ARRAY_SIZE(cmd_bcb_sub));
	if (!c)
		return CMD_RET_USAGE;

	if (bcb_is_misused(argc, argv)) {
		/*
		 * We try to improve the user experience by reporting the
		 * root-cause of misusage, so don't return CMD_RET_USAGE,
		 * since the latter prints out the full-blown help text
		 */
		return CMD_RET_FAILURE;
	}

	return c->cmd(cmdtp, flag, argc, argv);
}

U_BOOT_CMD(
	bcb, CONFIG_SYS_MAXARGS, 1, do_bcb,
	"Load/set/clear/test/dump/store Android BCB fields",
	"load  <dev> <part>       - load  BCB from mmc <dev>:<part>\n"
	"bcb set   <field> <val>      - set   BCB <field> to <val>\n"
	"bcb clear [<field>]          - clear BCB <field> or all fields\n"
	"bcb test  <field> <op> <val> - test  BCB <field> against <val>\n"
	"bcb dump  <field>            - dump  BCB <field>\n"
	"bcb store                    - store BCB back to mmc\n"
	"\n"
	"Legend:\n"
	"<dev>   - MMC device index containing the BCB partition\n"
	"<part>  - MMC partition index or name containing the BCB\n"
	"<field> - one of {command,status,recovery,stage,reserved}\n"
	"<op>    - the binary operator used in 'bcb test':\n"
	"          '=' returns true if <val> matches the string stored in <field>\n"
	"          '~' returns true if <val> matches a subset of <field>'s string\n"
	"<val>   - string/text provided as input to bcb {set,test}\n"
	"          NOTE: any ':' character in <val> will be replaced by line feed\n"
	"          during 'bcb set' and used as separator by upper layers\n"
);
Commit	Line	Data
db7b7a05 ER	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* Copyright (C) 2019 Eugeniu Rosca <[email protected]>
	4	*
	5	* Command to read/modify/write Android BCB fields
	6	*/
	7
	8	#include <android_bootloader_message.h>
	9	#include <command.h>
	10	#include <common.h>
f7ae49fc	11	#include <log.h>
e6f6f9e6	12	#include <part.h>
db7b7a05 ER	13
	14	enum bcb_cmd {
	15	BCB_CMD_LOAD,
	16	BCB_CMD_FIELD_SET,
	17	BCB_CMD_FIELD_CLEAR,
	18	BCB_CMD_FIELD_TEST,
	19	BCB_CMD_FIELD_DUMP,
	20	BCB_CMD_STORE,
	21	};
	22
	23	static int bcb_dev = -1;
	24	static int bcb_part = -1;
	25	static struct bootloader_message bcb = { { 0 } };
	26
	27	static int bcb_cmd_get(char *cmd)
	28	{
739168cf	29	if (!strcmp(cmd, "load"))
db7b7a05	30	return BCB_CMD_LOAD;
739168cf	31	if (!strcmp(cmd, "set"))
db7b7a05	32	return BCB_CMD_FIELD_SET;
739168cf	33	if (!strcmp(cmd, "clear"))
db7b7a05	34	return BCB_CMD_FIELD_CLEAR;
739168cf	35	if (!strcmp(cmd, "test"))
db7b7a05	36	return BCB_CMD_FIELD_TEST;
739168cf	37	if (!strcmp(cmd, "store"))
db7b7a05	38	return BCB_CMD_STORE;
739168cf	39	if (!strcmp(cmd, "dump"))
db7b7a05 ER	40	return BCB_CMD_FIELD_DUMP;
	41	else
	42	return -1;
	43	}
	44
	45	static int bcb_is_misused(int argc, char *const argv[])
	46	{
	47	int cmd = bcb_cmd_get(argv[0]);
	48
	49	switch (cmd) {
	50	case BCB_CMD_LOAD:
db7b7a05 ER	51	case BCB_CMD_FIELD_SET:
	52	if (argc != 3)
	53	goto err;
	54	break;
	55	case BCB_CMD_FIELD_TEST:
	56	if (argc != 4)
	57	goto err;
	58	break;
	59	case BCB_CMD_FIELD_CLEAR:
	60	if (argc != 1 && argc != 2)
	61	goto err;
	62	break;
	63	case BCB_CMD_STORE:
	64	if (argc != 1)
	65	goto err;
	66	break;
	67	case BCB_CMD_FIELD_DUMP:
	68	if (argc != 2)
	69	goto err;
	70	break;
	71	default:
	72	printf("Error: 'bcb %s' not supported\n", argv[0]);
	73	return -1;
	74	}
	75
	76	if (cmd != BCB_CMD_LOAD && (bcb_dev < 0 \|\| bcb_part < 0)) {
	77	printf("Error: Please, load BCB first!\n");
	78	return -1;
	79	}
	80
	81	return 0;
	82	err:
	83	printf("Error: Bad usage of 'bcb %s'\n", argv[0]);
	84
	85	return -1;
	86	}
	87
37f1811a	88	static int bcb_field_get(char name, char fieldp, int sizep)
db7b7a05	89	{
739168cf	90	if (!strcmp(name, "command")) {
37f1811a ER	91	*fieldp = bcb.command;
37f1811a ER	92	*sizep = sizeof(bcb.command);
739168cf	93	} else if (!strcmp(name, "status")) {
37f1811a ER	94	*fieldp = bcb.status;
37f1811a ER	95	*sizep = sizeof(bcb.status);
739168cf	96	} else if (!strcmp(name, "recovery")) {
37f1811a ER	97	*fieldp = bcb.recovery;
37f1811a ER	98	*sizep = sizeof(bcb.recovery);
739168cf	99	} else if (!strcmp(name, "stage")) {
37f1811a ER	100	*fieldp = bcb.stage;
37f1811a ER	101	*sizep = sizeof(bcb.stage);
739168cf	102	} else if (!strcmp(name, "reserved")) {
37f1811a ER	103	*fieldp = bcb.reserved;
37f1811a ER	104	*sizep = sizeof(bcb.reserved);
db7b7a05 ER	105	} else {
	106	printf("Error: Unknown bcb field '%s'\n", name);
	107	return -1;
	108	}
	109
	110	return 0;
	111	}
	112
09140113 SG	113	static int do_bcb_load(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	114	char *const argv[])
db7b7a05 ER	115	{
db7b7a05 ER	116	struct blk_desc *desc;
0528979f	117	struct disk_partition info;
db7b7a05 ER	118	u64 cnt;
	119	char *endp;
	120	int part, ret;
	121
	122	ret = blk_get_device_by_str("mmc", argv[1], &desc);
	123	if (ret < 0)
37f1811a	124	goto err_read_fail;
db7b7a05 ER	125
	126	part = simple_strtoul(argv[2], &endp, 0);
	127	if (*endp == '\0') {
	128	ret = part_get_info(desc, part, &info);
	129	if (ret)
37f1811a	130	goto err_read_fail;
db7b7a05 ER	131	} else {
	132	part = part_get_info_by_name(desc, argv[2], &info);
	133	if (part < 0) {
	134	ret = part;
37f1811a	135	goto err_read_fail;
db7b7a05 ER	136	}
	137	}
	138
	139	cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz);
	140	if (cnt > info.size)
37f1811a	141	goto err_too_small;
db7b7a05 ER	142
	143	if (blk_dread(desc, info.start, cnt, &bcb) != cnt) {
	144	ret = -EIO;
37f1811a	145	goto err_read_fail;
db7b7a05 ER	146	}
	147
	148	bcb_dev = desc->devnum;
	149	bcb_part = part;
	150	debug("%s: Loaded from mmc %d:%d\n", __func__, bcb_dev, bcb_part);
	151
	152	return CMD_RET_SUCCESS;
37f1811a	153	err_read_fail:
db7b7a05 ER	154	printf("Error: mmc %s:%s read failed (%d)\n", argv[1], argv[2], ret);
db7b7a05 ER	155	goto err;
37f1811a	156	err_too_small:
db7b7a05 ER	157	printf("Error: mmc %s:%s too small!", argv[1], argv[2]);
	158	goto err;
	159	err:
	160	bcb_dev = -1;
	161	bcb_part = -1;
	162
	163	return CMD_RET_FAILURE;
	164	}
	165
09140113 SG	166	static int do_bcb_set(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	167	char *const argv[])
db7b7a05 ER	168	{
	169	int size, len;
	170	char field, str, *found;
	171
	172	if (bcb_field_get(argv[1], &field, &size))
	173	return CMD_RET_FAILURE;
	174
	175	len = strlen(argv[2]);
	176	if (len >= size) {
	177	printf("Error: sizeof('%s') = %d >= %d = sizeof(bcb.%s)\n",
	178	argv[2], len, size, argv[1]);
	179	return CMD_RET_FAILURE;
	180	}
	181	str = argv[2];
	182
	183	field[0] = '\0';
	184	while ((found = strsep(&str, ":"))) {
	185	if (field[0] != '\0')
	186	strcat(field, "\n");
	187	strcat(field, found);
	188	}
	189
	190	return CMD_RET_SUCCESS;
	191	}
	192
09140113 SG	193	static int do_bcb_clear(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	194	char *const argv[])
db7b7a05 ER	195	{
	196	int size;
	197	char *field;
	198
	199	if (argc == 1) {
	200	memset(&bcb, 0, sizeof(bcb));
	201	return CMD_RET_SUCCESS;
	202	}
	203
	204	if (bcb_field_get(argv[1], &field, &size))
	205	return CMD_RET_FAILURE;
	206
	207	memset(field, 0, size);
	208
	209	return CMD_RET_SUCCESS;
	210	}
	211
09140113 SG	212	static int do_bcb_test(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	213	char *const argv[])
db7b7a05 ER	214	{
	215	int size;
	216	char *field;
	217	char *op = argv[2];
	218
	219	if (bcb_field_get(argv[1], &field, &size))
	220	return CMD_RET_FAILURE;
	221
	222	if (op == '=' && (op + 1) == '\0') {
	223	if (!strncmp(argv[3], field, size))
	224	return CMD_RET_SUCCESS;
	225	else
	226	return CMD_RET_FAILURE;
	227	} else if (op == '~' && (op + 1) == '\0') {
	228	if (!strstr(field, argv[3]))
	229	return CMD_RET_FAILURE;
	230	else
	231	return CMD_RET_SUCCESS;
	232	} else {
	233	printf("Error: Unknown operator '%s'\n", op);
	234	}
	235
	236	return CMD_RET_FAILURE;
	237	}
	238
09140113 SG	239	static int do_bcb_dump(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	240	char *const argv[])
db7b7a05 ER	241	{
	242	int size;
	243	char *field;
	244
	245	if (bcb_field_get(argv[1], &field, &size))
	246	return CMD_RET_FAILURE;
	247
	248	print_buffer((ulong)field - (ulong)&bcb, (void *)field, 1, size, 16);
	249
	250	return CMD_RET_SUCCESS;
	251	}
	252
09140113 SG	253	static int do_bcb_store(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	254	char *const argv[])
db7b7a05 ER	255	{
db7b7a05 ER	256	struct blk_desc *desc;
0528979f	257	struct disk_partition info;
db7b7a05 ER	258	u64 cnt;
	259	int ret;
	260
	261	desc = blk_get_devnum_by_type(IF_TYPE_MMC, bcb_dev);
	262	if (!desc) {
	263	ret = -ENODEV;
	264	goto err;
	265	}
	266
	267	ret = part_get_info(desc, bcb_part, &info);
	268	if (ret)
	269	goto err;
	270
	271	cnt = DIV_ROUND_UP(sizeof(struct bootloader_message), info.blksz);
	272
	273	if (blk_dwrite(desc, info.start, cnt, &bcb) != cnt) {
	274	ret = -EIO;
	275	goto err;
	276	}
	277
	278	return CMD_RET_SUCCESS;
	279	err:
	280	printf("Error: mmc %d:%d write failed (%d)\n", bcb_dev, bcb_part, ret);
	281
	282	return CMD_RET_FAILURE;
	283	}
	284
09140113	285	static struct cmd_tbl cmd_bcb_sub[] = {
db7b7a05 ER	286	U_BOOT_CMD_MKENT(load, CONFIG_SYS_MAXARGS, 1, do_bcb_load, "", ""),
	287	U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 1, do_bcb_set, "", ""),
	288	U_BOOT_CMD_MKENT(clear, CONFIG_SYS_MAXARGS, 1, do_bcb_clear, "", ""),
	289	U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_bcb_test, "", ""),
	290	U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_bcb_dump, "", ""),
	291	U_BOOT_CMD_MKENT(store, CONFIG_SYS_MAXARGS, 1, do_bcb_store, "", ""),
	292	};
	293
09140113	294	static int do_bcb(struct cmd_tbl cmdtp, int flag, int argc, char const argv[])
db7b7a05	295	{
09140113	296	struct cmd_tbl *c;
db7b7a05 ER	297
	298	if (argc < 2)
	299	return CMD_RET_USAGE;
	300
	301	argc--;
	302	argv++;
	303
	304	c = find_cmd_tbl(argv[0], cmd_bcb_sub, ARRAY_SIZE(cmd_bcb_sub));
	305	if (!c)
	306	return CMD_RET_USAGE;
	307
	308	if (bcb_is_misused(argc, argv)) {
37f1811a ER	309	/*
37f1811a ER	310	* We try to improve the user experience by reporting the
db7b7a05 ER	311	* root-cause of misusage, so don't return CMD_RET_USAGE,
	312	* since the latter prints out the full-blown help text
	313	*/
	314	return CMD_RET_FAILURE;
	315	}
	316
	317	return c->cmd(cmdtp, flag, argc, argv);
	318	}
	319
	320	U_BOOT_CMD(
	321	bcb, CONFIG_SYS_MAXARGS, 1, do_bcb,
	322	"Load/set/clear/test/dump/store Android BCB fields",
	323	"load <dev> <part> - load BCB from mmc <dev>:<part>\n"
	324	"bcb set <field> <val> - set BCB <field> to <val>\n"
	325	"bcb clear [<field>] - clear BCB <field> or all fields\n"
	326	"bcb test <field> <op> <val> - test BCB <field> against <val>\n"
	327	"bcb dump <field> - dump BCB <field>\n"
	328	"bcb store - store BCB back to mmc\n"
	329	"\n"
	330	"Legend:\n"
	331	"<dev> - MMC device index containing the BCB partition\n"
	332	"<part> - MMC partition index or name containing the BCB\n"
	333	"<field> - one of {command,status,recovery,stage,reserved}\n"
	334	"<op> - the binary operator used in 'bcb test':\n"
	335	" '=' returns true if <val> matches the string stored in <field>\n"
	336	" '~' returns true if <val> matches a subset of <field>'s string\n"
	337	"<val> - string/text provided as input to bcb {set,test}\n"
	338	" NOTE: any ':' character in <val> will be replaced by line feed\n"
	339	" during 'bcb set' and used as separator by upper layers\n"
	340	);