boot_svc_enter_rescue.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_SVC_BOOT_SVC_ENTER_RESCUE_H_
#define OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_BOOT_SVC_BOOT_SVC_ENTER_RESCUE_H_
 
#include <stdint.h>
 
#include "sw/device/lib/base/macros.h"
#include "sw/device/silicon_creator/lib/boot_svc/boot_svc_header.h"
#include "sw/device/silicon_creator/lib/error.h"
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
enum {
  /** Enter rescue request: `ERSQ`. */
  kBootSvcEnterRescueReqType = 0x51535245,
  /** Enter rescue response: `QSRE`. */
  kBootSvcEnterRescueResType = 0x45525351,
};
 
/**
 * An Enter Rescue request.
 */
typedef struct boot_svc_enter_rescue_req {
  /**
   * Boot services message header.
   */
  boot_svc_header_t header;
  /**
   * Command rescue to ignore the rescue trigger one time.
   */
  uint32_t skip_once;
} boot_svc_enter_rescue_req_t;
 
OT_ASSERT_MEMBER_OFFSET(boot_svc_enter_rescue_req_t, header, 0);
OT_ASSERT_MEMBER_OFFSET(boot_svc_enter_rescue_req_t, skip_once,
                        CHIP_BOOT_SVC_MSG_HEADER_SIZE + 0);
OT_ASSERT_SIZE(boot_svc_enter_rescue_req_t, CHIP_BOOT_SVC_MSG_HEADER_SIZE + 4);
 
/**
 * An Enter Rescue response.
 */
typedef struct boot_svc_enter_rescue_res {
  /**
   * Boot services message header.
   */
  boot_svc_header_t header;
  /**
   * Response status from the ROM_EXT.
   */
  uint32_t status;
} boot_svc_enter_rescue_res_t;
 
OT_ASSERT_MEMBER_OFFSET(boot_svc_enter_rescue_res_t, header, 0);
OT_ASSERT_MEMBER_OFFSET(boot_svc_enter_rescue_res_t, status,
                        CHIP_BOOT_SVC_MSG_HEADER_SIZE);
OT_ASSERT_SIZE(boot_svc_enter_rescue_res_t, 48);
 
/**
 * Initialize an enter rescue request.
 *
 * @param skip_once Ignore the rescue trigger on the next boot.
 * @param[out] msg Output buffer for the message.
 */
void boot_svc_enter_rescue_req_init(uint32_t skip_once,
                                    boot_svc_enter_rescue_req_t *msg);
 
/**
 * Initialize an enter rescue response.
 *
 * @param status Reponse from the ROM_EXT after receiving the request.
 * @param[out] msg Output buffer for the message.
 */
void boot_svc_enter_rescue_res_init(rom_error_t status,
                                    boot_svc_enter_rescue_res_t *msg);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_SW_DEVICE_SILICON_CREATOR_LIB_BOOT_SVC_BOOT_SVC_ENTER_RESCUE_H_