bcb.c 7.7 KB

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