system: Add CrOS FWID to version output

EC version does not follow the the AP and OS version. This causes
confusion during development. This change augments the EC version output
to include the CrOS FWID when available. The CrOS FWID will be missing
when the CrOS EC is built outside of cros_sdk. When CrOS FWID is missing
'CROS_FWID_MISSING' will be used.

Zephyr/zmake support will be added later, CROS_FWID32 is set to
'CROS_FWID_MISSING' in zephyr builds until then.

BUG=b:188073399
TEST=version
21-05-20 16:43:18.627 Chip:	Nuvoton NPCX993F A.00160101
21-05-20 16:43:18.631 Board:	1
21-05-20 16:43:18.631 RO:	guybrush_v2.0.8770+f47439f75
21-05-20 16:43:18.634 		guybrush_13983.0.21_05_20
21-05-20 16:43:18.639 RW_A:	* guybrush_v2.0.8770+f47439f75
21-05-20 16:43:18.641 		* guybrush_13983.0.21_05_20
21-05-20 16:43:18.644 RW_B:	guybrush_v2.0.8770+f47439f75
21-05-20 16:43:18.644 		guybrush_13983.0.21_05_20
21-05-20 16:43:18.647 Build:	guybrush_v2.0.8770+f47439f75
21-05-20 16:43:18.651 		guybrush_13983.0.21_05_20 2021-05-20
21-05-20 16:43:18.657 		16:31:19 robbarnes@robbarnes0
ectool version
RO version:    guybrush_v2.0.8770+f47439f75
RO cros fwid:  guybrush_13983.0.21_05_20
RW version:    guybrush_v2.0.8770+f47439f75
RW cros fwid:  guybrush_13983.0.21_05_20
Firmware copy: RO
Build info:    guybrush_v2.0.8770+f47439f75
guybrush_13983.0.21_05_20 2021-05-20 16:31:19 robbarnes@robbarnes0
Tool version:  1.1.9999-f47439f  @robbarnes0
BRANCH=None

Signed-off-by: Rob Barnes <robbarnes@google.com>
Change-Id: Ief0a0c6e9d35edc72ac2d4780ee203be41d7305f
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2894145
Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>

5 files changed, 26 insertions, 2 deletions

diff --git a/include/config.h b/include/config.h
index 63dc4beb62..e555b8a78e 100644
--- a/include/config.h
+++ b/include/config.h
@@ -5208,6 +5208,11 @@
 #undef CONFIG_EXTENDED_VERSION_INFO
 
 /*
+ * Include CROS_FWID in version output.
+ */
+#define CONFIG_CROS_FWID_VERSION
+
+/*
  * Define this to support Cros Board Info from EEPROM. I2C_PORT_EEPROM
  * and I2C_ADDR_EEPROM_FLAGS must be defined as well.
  */
diff --git a/include/cros_version.h b/include/cros_version.h
index 0d3e777dc5..585c2c1013 100644
--- a/include/cros_version.h
+++ b/include/cros_version.h
@@ -13,6 +13,9 @@
 
 #define CROS_EC_IMAGE_DATA_COOKIE1 0xce778899
 #define CROS_EC_IMAGE_DATA_COOKIE2 0xceaabbdd
+#define CROS_EC_IMAGE_DATA_COOKIE3 0xceeeff00
+#define CROS_EC_IMAGE_DATA_COOKIE3_MASK		GENMASK(31, 8)
+#define CROS_EC_IMAGE_DATA_COOKIE3_VERSION	GENMASK(7, 0)
 
 struct image_data {
 	uint32_t cookie1;
@@ -20,6 +23,8 @@ struct image_data {
 	uint32_t size;
 	int32_t rollback_version;
 	uint32_t cookie2;
+	char cros_fwid[32];
+	uint32_t cookie3;
 } __packed;
 
 extern const struct image_data current_image_data;
diff --git a/include/ec_commands.h b/include/ec_commands.h
index 9395175e73..6e9c538e5e 100644
--- a/include/ec_commands.h
+++ b/include/ec_commands.h
@@ -1152,14 +1152,16 @@ enum ec_image {
  * struct ec_response_get_version - Response to the get version command.
  * @version_string_ro: Null-terminated RO firmware version string.
  * @version_string_rw: Null-terminated RW firmware version string.
- * @reserved: Unused bytes; was previously RW-B firmware version string.
+ * @cros_fwid_ro: Null-terminated RO CrOS FWID string.
  * @current_image: One of ec_image.
+ * @cros_fwid_rw: Null-terminated RW CrOS FWID string.
  */
 struct ec_response_get_version {
 	char version_string_ro[32];
 	char version_string_rw[32];
-	char reserved[32];
+	char cros_fwid_ro[32];  /* Added in version 1 (Used to be reserved) */
 	uint32_t current_image;
+	char cros_fwid_rw[32];  /* Added in version 1 */
 } __ec_align4;
 
 /* Read test */
diff --git a/include/system.h b/include/system.h
index 325d76f702..6d46392e38 100644
--- a/include/system.h
+++ b/include/system.h
@@ -286,6 +286,15 @@ const struct image_data *system_get_image_data(enum ec_image copy);
 const char *system_get_version(enum ec_image copy);
 
 /**
+ * Get the CrOS fwid string for an image
+ *
+ * @param copy		Image copy to get version from, or SYSTEM_IMAGE_UNKNOWN
+ *			to get the version for the currently running image.
+ * @return The fwid string for the image copy, or an empty string if error.
+ */
+const char *system_get_cros_fwid(enum ec_image copy);
+
+/**
  * Get the SKU ID for a device
  *
  * @return A value that identifies the SKU variant of a model. Its meaning and
diff --git a/include/util.h b/include/util.h
index 1b077d0f55..a1c1abb514 100644
--- a/include/util.h
+++ b/include/util.h
@@ -45,6 +45,9 @@ extern "C" {
 #define NULL ((void *)0)
 #endif
 
+/* Returns true if string is not null and not empty */
+#define IS_NONEMPTY_STRING(s) ((s) && (s)[0])
+
 /**
  * Ensure that value `v` is between `min` and `max`.
  *