cbfs: Add an enum and comment for the magic number
authorSimon Glass <sjg@chromium.org>
Mon, 8 Jul 2019 19:18:21 +0000 (13:18 -0600)
committerSimon Glass <sjg@chromium.org>
Wed, 24 Jul 2019 03:27:57 +0000 (20:27 -0700)
This field is not commented in the original file. Add a comment.

Signed-off-by: Simon Glass <sjg@chromium.org>
include/cbfs.h

index bd1bf75bbfcf9b121e7fdfb0af3a29420013d63a..f2ede25f517b8a12f564e3f844af563c1ac01be6 100644 (file)
@@ -40,6 +40,17 @@ enum cbfs_filetype {
        CBFS_TYPE_CMOS_LAYOUT = 0x01aa
 };
 
+enum {
+       CBFS_HEADER_MAGIC       = 0x4f524243,
+};
+
+/**
+ * struct cbfs_header - header at the start of a CBFS region
+ *
+ * All fields use big-endian format.
+ *
+ * @magic: Magic number (CBFS_HEADER_MAGIC)
+ */
 struct cbfs_header {
        u32 magic;
        u32 version;