boot_log.h

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
 
#ifndef OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_BOOT_LOG_H_
#define OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_BOOT_LOG_H_
 
#include <stdint.h>
 
#include "sw/device/lib/base/macros.h"
#include "sw/device/silicon_creator/lib/boot_data.h"
#include "sw/device/silicon_creator/lib/chip_info.h"
#include "sw/device/silicon_creator/lib/drivers/hmac.h"
#include "sw/device/silicon_creator/lib/error.h"
#include "sw/device/silicon_creator/lib/nonce.h"
#include "sw/device/silicon_creator/lib/ownership/datatypes.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**
 * The boot_log encodes information about how the chip booted.
 */
typedef struct boot_log {
  /** Digest to indicate validity of the boot_log. */
  hmac_digest_t digest;
  /** Identifier (`BLOG`). */
  uint32_t identifier;
  /** Chip version (from the ROM). */
  chip_info_scm_revision_t chip_version;
  /** Which ROM_EXT slot booted (boot_slot_t). */
  uint32_t rom_ext_slot;
  /** ROM_EXT major version number. */
  uint32_t rom_ext_major;
  /** ROM_EXT minor version number. */
  uint32_t rom_ext_minor;
  /** ROM_EXT size in flash. */
  uint32_t rom_ext_size;
  /** ROM_EXT nonce for challenge/response boot_svc commands. */
  nonce_t rom_ext_nonce;
  /** Which BL0 slot booted (boot_slot_t). */
  uint32_t bl0_slot;
  /** Chip ownership state. */
  uint32_t ownership_state;
  /** Number of ownership transfers this chip has had. */
  uint32_t ownership_transfers;
  /** Minimum security version permitted for ROM_EXT payloads. */
  uint32_t rom_ext_min_sec_ver;
  /** Minimum security version permitted for application payloads. */
  uint32_t bl0_min_sec_ver;
  /** Primary BL0 slot. */
  uint32_t primary_bl0_slot;
  /** Whether the RET-RAM was initialized on this boot (hardened_bool_t). */
  uint32_t retention_ram_initialized;
  /** Pad to 128 bytes. */
  uint32_t reserved[8];
} boot_log_t;
 
OT_ASSERT_MEMBER_OFFSET(boot_log_t, digest, 0);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, identifier, 32);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, chip_version, 36);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_slot, 44);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_major, 48);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_minor, 52);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_size, 56);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_nonce, 60);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, bl0_slot, 68);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, ownership_state, 72);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, ownership_transfers, 76);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, rom_ext_min_sec_ver, 80);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, bl0_min_sec_ver, 84);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, primary_bl0_slot, 88);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, retention_ram_initialized, 92);
OT_ASSERT_MEMBER_OFFSET(boot_log_t, reserved, 96);
 
enum {
  /**
   * Boot log identifier value (ASCII "BLOG").
   */
  kBootLogIdentifier = 0x474f4c42,
};
 
/**
 * Updates the digest of the boot_log.
 *
 * This function computes the digest over all fields of the boot_log_t struct
 * (except digest) and updates the digest field. The digest must be the first
 * member of the struct.
 *
 * @param boot_log A buffer that holds the boot_log.
 */
void boot_log_digest_update(boot_log_t *boot_log);
 
/**
 * Checks whether a boot_log entry is valid.
 *
 * This function checks the `identifier` and `digest` fields of the given
 * `boot_log`.
 *
 * @param boot_log A buffer that holds the boot_log.
 * @return Whether the digest and identifier of the `boot_log` are valid.
 */
OT_WARN_UNUSED_RESULT
rom_error_t boot_log_check(const boot_log_t *boot_log);
 
/**
 * Check the boot_log and initialize it if not yet initialized.
 *
 * @param boot_log A buffer that holds the boot_log.
 * @param rom_ext_slot The current ROM_EXT slot.
 * @param info A pointer to the chip_info_t structure in ROM.
 */
void boot_log_check_or_init(boot_log_t *boot_log, uint32_t rom_ext_slot,
                            const chip_info_t *info);
 
#ifdef __cplusplus
}
#endif
 
#endif  // OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_BOOT_LOG_H_