/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * tboot.h: shared data structure with tboot and kernel and functions
 *          used by kernel for runtime support of Intel(R) Trusted
 *          Execution Technology
 *
 * Copyright (c) 2006-2009, Intel Corporation
 */

#ifndef _LINUX_TBOOT_H
#define _LINUX_TBOOT_H

/* these must have the values from 0-5 in this order */
enum {
 TB_SHUTDOWN_REBOOT = 0,
 TB_SHUTDOWN_S5,
 TB_SHUTDOWN_S4,
 TB_SHUTDOWN_S3,
 TB_SHUTDOWN_HALT,
 TB_SHUTDOWN_WFS
};

#ifdef CONFIG_INTEL_TXT
#include <linux/acpi.h>
/* used to communicate between tboot and the launched kernel */

#define TB_KEY_SIZE             64   /* 512 bits */

#define MAX_TB_MAC_REGIONS      32

struct tboot_mac_region {
 u64  start;         /* must be 64 byte -aligned */
 u32  size;          /* must be 64 byte -granular */
} __packed;

/* GAS - Generic Address Structure (ACPI 2.0+) */
struct tboot_acpi_generic_address {
 u8  space_id;
 u8  bit_width;
 u8  bit_offset;
 u8  access_width;
 u64 address;
} __packed;

/*
 * combines Sx info from FADT and FACS tables per ACPI 2.0+ spec
 * (https://uefi.org/specifications)
 */
struct tboot_acpi_sleep_info {
 struct tboot_acpi_generic_address pm1a_cnt_blk;
 struct tboot_acpi_generic_address pm1b_cnt_blk;
 struct tboot_acpi_generic_address pm1a_evt_blk;
 struct tboot_acpi_generic_address pm1b_evt_blk;
 u16 pm1a_cnt_val;
 u16 pm1b_cnt_val;
 u64 wakeup_vector;
 u32 vector_width;
 u64 kernel_s3_resume_vector;
} __packed;

/*
 * shared memory page used for communication between tboot and kernel
 */
struct tboot {
 /*
  * version 3+ fields:
 */

 /* TBOOT_UUID */
 u8 uuid[16];

 /* version number: 5 is current */
 u32 version;

 /* physical addr of tb_log_t log */
 u32 log_addr;

 /*
  * physical addr of entry point for tboot shutdown and
  * type of shutdown (TB_SHUTDOWN_*) being requested
 */
 u32 shutdown_entry;
 u32 shutdown_type;

 /* kernel-specified ACPI info for Sx shutdown */
 struct tboot_acpi_sleep_info acpi_sinfo;

 /* tboot location in memory (physical) */
 u32 tboot_base;
 u32 tboot_size;

 /* memory regions (phys addrs) for tboot to MAC on S3 */
 u8 num_mac_regions;
 struct tboot_mac_region mac_regions[MAX_TB_MAC_REGIONS];


 /*
  * version 4+ fields:
 */

 /* symmetric key for use by kernel; will be encrypted on S3 */
 u8 s3_key[TB_KEY_SIZE];


 /*
  * version 5+ fields:
 */

 /* used to 4byte-align num_in_wfs */
 u8 reserved_align[3];

 /* number of processors in wait-for-SIPI */
 u32 num_in_wfs;
} __packed;

/*
 * UUID for tboot data struct to facilitate matching
 * defined as {663C8DFF-E8B3-4b82-AABF-19EA4D057A08} by tboot, which is
 * represented as {} in the char array used here
 */
#define TBOOT_UUID {0xff, 0x8d, 0x3c, 0x66, 0xb3, 0xe8, 0x82, 0x4b, 0xbf,\
    0xaa, 0x19, 0xea, 0x4d, 0x5, 0x7a, 0x8}

bool tboot_enabled(void);
extern void tboot_probe(void);
extern void tboot_shutdown(u32 shutdown_type);
extern struct acpi_table_header *tboot_get_dmar_table(
          struct acpi_table_header *dmar_tbl);

#else

#define tboot_enabled()   0
#define tboot_probe()   do { } while (0)
#define tboot_shutdown(shutdown_type) do { } while (0)
#define tboot_sleep(sleep_state, pm1a_control, pm1b_control) \
     do { } while (0)
#define tboot_get_dmar_table(dmar_tbl) (dmar_tbl)

#endif /* !CONFIG_INTEL_TXT */

#endif /* _LINUX_TBOOT_H */