bcb.c 7.7 KB

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