bcb.c 7.7 KB

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