From b835c2feb06e72b48ef82845e114bb8af5d7145e Mon Sep 17 00:00:00 2001 From: "Thejaswani Puta thejaswani.putta@intel.com" Date: Wed, 20 Jan 2021 15:22:01 -0800 Subject: CBI: Add rework_id field This field will be used to describe all the reworks performed on a board which includes the mandatory, optional and feature reworks. Also modified existing command handlers under ectool and cbi-util tool to support 64 bit length data. Includes build fix for targets where long int is not 64 bits. BUG: b:170385859 BUILD TEST: make BOARD= -j; make runfuzztests make runhosttests setup_board, cros_workon & emerge-<32-bit target> ec-utils TEST: ./cbi-util create --file ~/cbi_image --board_version 1 --oem_id 2 --sku_id 255 --dram_part_num "01654329efghac" --model_id 15 --rework_id 123456789123456712 --size 256 CBI image is created successfully TEST: ./cbi-util show --file ~/cbi_image CBI image: /home/thejaswani/cbi_image TOTAL_SIZE: 47 Data Field: name: value (hex, tag, size) BOARD_VERSION: 1 (0x1, 0, 1) OEM_ID: 2 (0x2, 1, 1) SKU_ID: 255 (0xff, 2, 1) MODEL_ID: 15 (0xf, 5, 1) REWORK_ID: 123456789123456712 (0x1b69b4bacd05ec8, 9, 8) DRAM_PART_NUM: 01654329efghac (3, 15) Data validated successfully TEST: hexdump -C ~/cbi_image 00000000 43 42 49 1e 00 00 2f 00 00 01 01 01 01 02 02 01 |CBI.../.........| 00000010 ff 05 01 0f 09 08 c8 5e d0 ac 4b 9b b6 01 03 0f |.......^..K.....| 00000020 30 31 36 35 34 33 32 39 65 66 67 68 61 63 00 ff |01654329efghac..| 00000030 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| * 00000100 TEST: localhost ~ # ectool cbi set 9 98765432 8 localhost ~ # ectool cbi get 9 As uint: 98765432 (0x5e30a78) As binary: 78 0a e3 05 00 00 00 00 localhost ~ # ectool cbi set 9 123456789123456712 8 localhost ~ # ectool cbi get 9 As uint: 123456789123456712 (0x1b69b4bacd05ec8) As binary: c8 5e d0 ac 4b 9b b6 01 localhost ~ # ectool cbi set 9 1234 2 localhost ~ # ectool cbi get 9 As uint: 1234 (0x4d2) As binary: d2 04 TEST: > cbi(from EC Console) 2021-01-19 20:59:56 [80.979692 CBI Reading board info] 2021-01-19 20:59:56 CBI_VERSION: 0x0000 2021-01-19 20:59:56 TOTAL_SIZE: 54 2021-01-19 20:59:56 BOARD_VERSION: 1 (0x1) 2021-01-19 20:59:56 OEM_ID: (Error 1) 2021-01-19 20:59:56 MODEL_ID: (Error 1) 2021-01-19 20:59:56 SKU_ID: 655361 (0xa0001) 2021-01-19 20:59:56 FW_CONFIG: 199683 (0x30c03) 2021-01-19 20:59:56 PCB_SUPPLIER: (Error 1) 2021-01-19 20:59:56 SSFC: (Error 1) 2021-01-19 20:59:56 REWORK_ID: 1234 (0x4d2) 2021-01-19 20:59:56 43 42 49 8c 00 00 36 00 00 01 01 02 04 01 00 0a |CBI...6.........| 2021-01-19 20:59:56 00 06 04 03 0c 03 00 03 19 4d 54 35 33 45 35 31 |.........MT53E51| 2021-01-19 20:59:56 32 4d 36 34 44 34 4e 57 2d 30 34 36 20 57 54 3a |2M64D4NW-046 WT:| 2021-01-19 20:59:56 45 00 09 02 d2 04 ff ff ff ff ff 7f ff ff ff ff |E...............| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2020-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| 2021-01-19 20:59:56 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff |................| Signed-off-by: Thejaswani Puta Change-Id: I073a119d43c94cd266503a0fc972a62134b3385f Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2693746 Tested-by: Thejaswani Putta Commit-Queue: Thejaswani Putta Reviewed-by: Peter Marheine Reviewed-by: Daisuke Nojiri --- common/cbi.c | 18 ++++++++++++ include/cros_board_info.h | 5 ++-- include/ec_commands.h | 1 + test/cbi.c | 6 ++++ util/cbi-util.c | 72 ++++++++++++++++++++++++++++++++++++++++++++--- util/ectool.c | 41 ++++++++++++++++++--------- 6 files changed, 123 insertions(+), 20 deletions(-) diff --git a/common/cbi.c b/common/cbi.c index 6c98e610ec..97bdbf5a2f 100644 --- a/common/cbi.c +++ b/common/cbi.c @@ -343,6 +343,12 @@ int cbi_get_pcb_supplier(uint32_t *pcb_supplier) &size); } +int cbi_get_rework_id(uint64_t *id) +{ + uint8_t size = sizeof(*id); + return cbi_get_board_info(CBI_TAG_REWORK_ID, (uint8_t *)id, &size); +} + static enum ec_status hc_cbi_get(struct host_cmd_handler_args *args) { const struct __ec_align4 ec_params_get_cbi *p = args->params; @@ -441,9 +447,20 @@ static void print_tag(const char * const tag, int rv, const uint32_t *val) ccprintf(": (Error %d)\n", rv); } +static void print_uint64_tag(const char * const tag, int rv, const uint64_t *lval) +{ + ccprintf("%s", tag); + if(rv == EC_SUCCESS && lval) + ccprintf(": %llu (0x%llx)\n", *(unsigned long long*)lval, + *(unsigned long long*)lval); + else + ccprintf(": (Error %d)\n", rv); +} + static void dump_cbi(void) { uint32_t val; + uint64_t lval; /* Ensure we read the latest data from flash. */ cached_read_result = EC_ERROR_CBI_CACHE_INVALID; @@ -464,6 +481,7 @@ static void dump_cbi(void) print_tag("FW_CONFIG", cbi_get_fw_config(&val), &val); print_tag("PCB_SUPPLIER", cbi_get_pcb_supplier(&val), &val); print_tag("SSFC", cbi_get_ssfc(&val), &val); + print_uint64_tag("REWORK_ID", cbi_get_rework_id(&lval), &lval); } static int cc_cbi(int argc, char **argv) diff --git a/include/cros_board_info.h b/include/cros_board_info.h index ed5967b0d6..266e66c5af 100644 --- a/include/cros_board_info.h +++ b/include/cros_board_info.h @@ -44,8 +44,8 @@ struct cbi_data { /** * Board info accessors * - * @param version/sku_id/oem_id/id/fw_config/pcb_supplier/ssfc [OUT] Data read - * from EEPROM + * @param version/sku_id/oem_id/id/fw_config/pcb_supplier/ssfc/rework_id [OUT] + * Data_read from EEPROM. * @return EC_SUCCESS on success or EC_ERROR_* otherwise. * EC_ERROR_BUSY to indicate data is not ready. */ @@ -56,6 +56,7 @@ int cbi_get_model_id(uint32_t *id); int cbi_get_fw_config(uint32_t *fw_config); int cbi_get_pcb_supplier(uint32_t *pcb_supplier); int cbi_get_ssfc(uint32_t *ssfc); +int cbi_get_rework_id(uint64_t *id); /** * Get data from CBI store diff --git a/include/ec_commands.h b/include/ec_commands.h index d1f03e516a..96f7fbc547 100644 --- a/include/ec_commands.h +++ b/include/ec_commands.h @@ -5892,6 +5892,7 @@ enum cbi_data_tag { CBI_TAG_PCB_SUPPLIER = 7, /* uint32_t or smaller */ /* Second Source Factory Cache */ CBI_TAG_SSFC = 8, /* uint32_t bit field */ + CBI_TAG_REWORK_ID = 9, /* uint64_t or smaller */ CBI_TAG_COUNT, }; diff --git a/test/cbi.c b/test/cbi.c index f0fe68f162..eb2321a649 100644 --- a/test/cbi.c +++ b/test/cbi.c @@ -126,6 +126,7 @@ static int test_all_tags(void) { uint8_t d8; uint32_t d32; + uint64_t d64; const char string[] = "abc"; uint8_t buf[32]; uint8_t size; @@ -162,6 +163,9 @@ static int test_all_tags(void) TEST_ASSERT(cbi_set_board_info(CBI_TAG_SSFC, &d8, sizeof(d8)) == EC_SUCCESS); count++; + TEST_ASSERT(cbi_set_board_info(CBI_TAG_REWORK_ID, &d8, sizeof(d8)) + == EC_SUCCESS); + count++; /* Read out all */ TEST_ASSERT(cbi_get_board_version(&d32) == EC_SUCCESS); @@ -188,6 +192,8 @@ static int test_all_tags(void) TEST_EQ(d32, d8, "0x%x"); TEST_ASSERT(cbi_get_ssfc(&d32) == EC_SUCCESS); TEST_EQ(d32, d8, "0x%x"); + TEST_ASSERT(cbi_get_rework_id(&d64) == EC_SUCCESS); + TEST_EQ((unsigned long long)d64, (unsigned long long)d8, "0x%llx"); /* Fail if a (new) tag is missing from the unit test. */ TEST_EQ(count, CBI_TAG_COUNT, "%d"); diff --git a/util/cbi-util.c b/util/cbi-util.c index 54782f8bad..fe0c4c2bce 100644 --- a/util/cbi-util.c +++ b/util/cbi-util.c @@ -40,6 +40,7 @@ enum { OPT_FW_CONFIG, OPT_PCB_SUPPLIER, OPT_SSFC, + OPT_REWORK_ID, OPT_SIZE, OPT_ERASE_BYTE, OPT_SHOW_ALL, @@ -57,6 +58,7 @@ static const struct option opts_create[] = { {"fw_config", 1, 0, OPT_FW_CONFIG}, {"pcb_supplier", 1, 0, OPT_PCB_SUPPLIER}, {"ssfc", 1, 0, OPT_SSFC}, + {"rework_id", 1, 0, OPT_REWORK_ID}, {"size", 1, 0, OPT_SIZE}, {"erase_byte", 1, 0, OPT_ERASE_BYTE}, {NULL, 0, 0, 0} @@ -79,6 +81,7 @@ static const char *field_name[] = { "FW_CONFIG", "PCB_SUPPLIER", "SSFC", + "REWORK_ID", }; BUILD_ASSERT(ARRAY_SIZE(field_name) == CBI_TAG_COUNT); @@ -101,9 +104,11 @@ const char help_create[] = " --fw_config Firmware configuration bit-field\n" " --pcb_supplier PCB supplier\n" " --ssfc Second Source Factory Cache bit-field\n" + " --rework_id REWORK_ID\n" "\n" - " must be a positive integer <= 0XFFFFFFFF and field size can\n" - " be optionally specified by notation: e.g. 0xabcd:4.\n" + " must be a positive integer <= 0XFFFFFFFF, must be a\n" + " positive integer <= 0xFFFFFFFFFFFFFFFF and field size can be\n" + " optionally specified by notation: e.g. 0xabcd:4.\n" " must be a positive integer <= 0XFFFF.\n" " is a string\n" "\n"; @@ -124,6 +129,11 @@ struct integer_field { int size; }; +struct long_integer_field { + uint64_t val; + int size; +}; + static void print_help_create(void) { printf(help_create, cmd_name); @@ -250,6 +260,48 @@ static int parse_integer_field(const char *arg, struct integer_field *f) return 0; } +static int parse_uint64_field(const char *arg, struct long_integer_field *f) +{ + uint64_t val; + char *e; + char *ch; + + val = strtoul(arg, &e, 0); + /* strtoul sets an errno for invalid input. If the value read is out of + * range of representable values by an unsigned long int, the function + * returns ULONG_MAX or ULONG_MIN and the errno is set to ERANGE. + */ + if (errno == ERANGE || !*arg || (e && *e && *e != ':')) { + fprintf(stderr, "Invalid integer value\n"); + return -1; + } + f->val = val; + + ch = strchr(arg, ':'); + if (ch) { + ch++; + val = strtoul(ch, &e, 0); + if (val < 1 || 8 < val || !*ch || (e && *e)) { + fprintf(stderr, "Invalid size suffix\n"); + return -1; + } + f->size = val; + } else { + if (f->val < UINT32_MAX) + f->size = estimate_field_size(f->val); + else + f->size = 8; /* assign default long int size */ + } + + if (f->size < 8 && (f->val > (1ull << f->size * 8))) { + fprintf(stderr, "Value (0x%llx) exceeds field size (%d)\n", + (unsigned long long)f->val, f->size); + return -1; + } + + return 0; +} + static int cmd_create(int argc, char **argv) { uint8_t *cbi; @@ -261,6 +313,7 @@ static int cmd_create(int argc, char **argv) struct integer_field fw_config; struct integer_field pcb_supplier; struct integer_field ssfc; + struct long_integer_field rework; const char *dram_part_num; const char *oem_name; } bi; @@ -341,6 +394,10 @@ static int cmd_create(int argc, char **argv) if (parse_integer_field(optarg, &bi.ssfc)) return -1; break; + case OPT_REWORK_ID: + if (parse_uint64_field(optarg, &bi.rework)) + return -1; + break; } } @@ -372,6 +429,7 @@ static int cmd_create(int argc, char **argv) p = cbi_set_data(p, CBI_TAG_PCB_SUPPLIER, &bi.pcb_supplier.val, bi.pcb_supplier.size); p = cbi_set_data(p, CBI_TAG_SSFC, &bi.ssfc.val, bi.ssfc.size); + p = cbi_set_data(p, CBI_TAG_REWORK_ID, &bi.rework.val, bi.rework.size); p = cbi_set_string(p, CBI_TAG_DRAM_PART_NUM, bi.dram_part_num); p = cbi_set_string(p, CBI_TAG_OEM_NAME, bi.oem_name); @@ -407,7 +465,8 @@ static void print_string(const uint8_t *buf, enum cbi_data_tag tag) static void print_integer(const uint8_t *buf, enum cbi_data_tag tag) { - uint32_t v; + uint64_t v; + struct cbi_data *d = cbi_find_tag(buf, tag); const char *name; @@ -426,12 +485,16 @@ static void print_integer(const uint8_t *buf, enum cbi_data_tag tag) case 4: v = *(uint32_t *)d->value; break; + case 8: + v = *(uint64_t *)d->value; + break; default: printf(" %s: Integer of size %d not supported\n", name, d->size); return; } - printf(" %s: %u (0x%x, %u, %u)\n", name, v, v, d->tag, d->size); + printf(" %s: %llu (0x%llx, %u, %u)\n", name, (unsigned long long)v, + (unsigned long long)v, d->tag, d->size); } static int cmd_show(int argc, char **argv) @@ -500,6 +563,7 @@ static int cmd_show(int argc, char **argv) print_integer(buf, CBI_TAG_FW_CONFIG); print_integer(buf, CBI_TAG_PCB_SUPPLIER); print_integer(buf, CBI_TAG_SSFC); + print_integer(buf, CBI_TAG_REWORK_ID); print_string(buf, CBI_TAG_DRAM_PART_NUM); print_string(buf, CBI_TAG_OEM_NAME); diff --git a/util/ectool.c b/util/ectool.c index a5d156129d..a85166ebe7 100644 --- a/util/ectool.c +++ b/util/ectool.c @@ -8106,6 +8106,7 @@ static void cmd_cbi_help(char *cmd) " 6: FW_CONFIG\n" " 7: PCB_VENDOR\n" " 8: SSFC\n" + " 9: REWORK_ID\n" " is the size of the data in byte. It should be zero for\n" " string types.\n" " is an integer or a string to be set\n" @@ -8171,16 +8172,13 @@ static int cmd_cbi(int argc, char *argv[]) printf("%.*s", rv, (const char *)ec_inbuf); } else { const uint8_t * const buffer = ec_inbuf; + uint64_t int_value = 0; + for(i = 0; i < rv; i++) + int_value |= (uint64_t)buffer[i] << (i * 8); - if (rv <= sizeof(uint32_t)) { - uint32_t int_value = 0; - - for (i = 0; i < rv; i++) - int_value |= buffer[i] << (i * 8); - - printf("As uint: %u (0x%x)\n", int_value, - int_value); - } + printf("As uint: %llu (0x%llx)\n", + (unsigned long long)int_value, + (unsigned long long)int_value); printf("As binary:"); for (i = 0; i < rv; i++) { if (i % 32 == 31) @@ -8194,8 +8192,9 @@ static int cmd_cbi(int argc, char *argv[]) struct ec_params_set_cbi *p = (struct ec_params_set_cbi *)ec_outbuf; void *val_ptr; - uint32_t val; + uint64_t val = 0; uint8_t size; + uint8_t bad_size = 0; if (argc < 5) { fprintf(stderr, "Invalid number of params\n"); cmd_cbi_help(argv[0]); @@ -8208,17 +8207,31 @@ static int cmd_cbi(int argc, char *argv[]) val_ptr = argv[3]; size = strlen(val_ptr) + 1; } else { - val = strtol(argv[3], &e, 0); - if (e && *e) { + val = strtoul(argv[3], &e, 0); + /* strtoul sets an errno for invalid input. If the value + * read is out of range of representable values by an + * unsigned long int, the function returns ULONG_MAX + * or ULONG_MIN and the errno is set to ERANGE. + */ + if ((e && *e) || errno == ERANGE) { fprintf(stderr, "Bad value\n"); return -1; } size = strtol(argv[4], &e, 0); - if ((e && *e) || size < 1 || 4 < size || - val >= (1ull << size*8)) { + if (tag == CBI_TAG_REWORK_ID) { + if ((e && *e) || size < 1 || size > 8 || + (size < 8 && val >= (1ull << size*8))) + bad_size = 1; + } else { + if ((e && *e) || size < 1 || 4 < size || + val >= (1ull << size*8)) + bad_size = 1; + } + if (bad_size == 1) { fprintf(stderr, "Bad size: %d\n", size); return -1; } + val_ptr = &val; } -- cgit v1.2.1