1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * tboot.h: shared data structure with tboot and kernel and functions 4*4882a593Smuzhiyun * used by kernel for runtime support of Intel(R) Trusted 5*4882a593Smuzhiyun * Execution Technology 6*4882a593Smuzhiyun * 7*4882a593Smuzhiyun * Copyright (c) 2006-2009, Intel Corporation 8*4882a593Smuzhiyun */ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun #ifndef _LINUX_TBOOT_H 11*4882a593Smuzhiyun #define _LINUX_TBOOT_H 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun /* these must have the values from 0-5 in this order */ 14*4882a593Smuzhiyun enum { 15*4882a593Smuzhiyun TB_SHUTDOWN_REBOOT = 0, 16*4882a593Smuzhiyun TB_SHUTDOWN_S5, 17*4882a593Smuzhiyun TB_SHUTDOWN_S4, 18*4882a593Smuzhiyun TB_SHUTDOWN_S3, 19*4882a593Smuzhiyun TB_SHUTDOWN_HALT, 20*4882a593Smuzhiyun TB_SHUTDOWN_WFS 21*4882a593Smuzhiyun }; 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun #ifdef CONFIG_INTEL_TXT 24*4882a593Smuzhiyun #include <linux/acpi.h> 25*4882a593Smuzhiyun /* used to communicate between tboot and the launched kernel */ 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun #define TB_KEY_SIZE 64 /* 512 bits */ 28*4882a593Smuzhiyun 29*4882a593Smuzhiyun #define MAX_TB_MAC_REGIONS 32 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun struct tboot_mac_region { 32*4882a593Smuzhiyun u64 start; /* must be 64 byte -aligned */ 33*4882a593Smuzhiyun u32 size; /* must be 64 byte -granular */ 34*4882a593Smuzhiyun } __packed; 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun /* GAS - Generic Address Structure (ACPI 2.0+) */ 37*4882a593Smuzhiyun struct tboot_acpi_generic_address { 38*4882a593Smuzhiyun u8 space_id; 39*4882a593Smuzhiyun u8 bit_width; 40*4882a593Smuzhiyun u8 bit_offset; 41*4882a593Smuzhiyun u8 access_width; 42*4882a593Smuzhiyun u64 address; 43*4882a593Smuzhiyun } __packed; 44*4882a593Smuzhiyun 45*4882a593Smuzhiyun /* 46*4882a593Smuzhiyun * combines Sx info from FADT and FACS tables per ACPI 2.0+ spec 47*4882a593Smuzhiyun * (https://uefi.org/specifications) 48*4882a593Smuzhiyun */ 49*4882a593Smuzhiyun struct tboot_acpi_sleep_info { 50*4882a593Smuzhiyun struct tboot_acpi_generic_address pm1a_cnt_blk; 51*4882a593Smuzhiyun struct tboot_acpi_generic_address pm1b_cnt_blk; 52*4882a593Smuzhiyun struct tboot_acpi_generic_address pm1a_evt_blk; 53*4882a593Smuzhiyun struct tboot_acpi_generic_address pm1b_evt_blk; 54*4882a593Smuzhiyun u16 pm1a_cnt_val; 55*4882a593Smuzhiyun u16 pm1b_cnt_val; 56*4882a593Smuzhiyun u64 wakeup_vector; 57*4882a593Smuzhiyun u32 vector_width; 58*4882a593Smuzhiyun u64 kernel_s3_resume_vector; 59*4882a593Smuzhiyun } __packed; 60*4882a593Smuzhiyun 61*4882a593Smuzhiyun /* 62*4882a593Smuzhiyun * shared memory page used for communication between tboot and kernel 63*4882a593Smuzhiyun */ 64*4882a593Smuzhiyun struct tboot { 65*4882a593Smuzhiyun /* 66*4882a593Smuzhiyun * version 3+ fields: 67*4882a593Smuzhiyun */ 68*4882a593Smuzhiyun 69*4882a593Smuzhiyun /* TBOOT_UUID */ 70*4882a593Smuzhiyun u8 uuid[16]; 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun /* version number: 5 is current */ 73*4882a593Smuzhiyun u32 version; 74*4882a593Smuzhiyun 75*4882a593Smuzhiyun /* physical addr of tb_log_t log */ 76*4882a593Smuzhiyun u32 log_addr; 77*4882a593Smuzhiyun 78*4882a593Smuzhiyun /* 79*4882a593Smuzhiyun * physical addr of entry point for tboot shutdown and 80*4882a593Smuzhiyun * type of shutdown (TB_SHUTDOWN_*) being requested 81*4882a593Smuzhiyun */ 82*4882a593Smuzhiyun u32 shutdown_entry; 83*4882a593Smuzhiyun u32 shutdown_type; 84*4882a593Smuzhiyun 85*4882a593Smuzhiyun /* kernel-specified ACPI info for Sx shutdown */ 86*4882a593Smuzhiyun struct tboot_acpi_sleep_info acpi_sinfo; 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun /* tboot location in memory (physical) */ 89*4882a593Smuzhiyun u32 tboot_base; 90*4882a593Smuzhiyun u32 tboot_size; 91*4882a593Smuzhiyun 92*4882a593Smuzhiyun /* memory regions (phys addrs) for tboot to MAC on S3 */ 93*4882a593Smuzhiyun u8 num_mac_regions; 94*4882a593Smuzhiyun struct tboot_mac_region mac_regions[MAX_TB_MAC_REGIONS]; 95*4882a593Smuzhiyun 96*4882a593Smuzhiyun 97*4882a593Smuzhiyun /* 98*4882a593Smuzhiyun * version 4+ fields: 99*4882a593Smuzhiyun */ 100*4882a593Smuzhiyun 101*4882a593Smuzhiyun /* symmetric key for use by kernel; will be encrypted on S3 */ 102*4882a593Smuzhiyun u8 s3_key[TB_KEY_SIZE]; 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun 105*4882a593Smuzhiyun /* 106*4882a593Smuzhiyun * version 5+ fields: 107*4882a593Smuzhiyun */ 108*4882a593Smuzhiyun 109*4882a593Smuzhiyun /* used to 4byte-align num_in_wfs */ 110*4882a593Smuzhiyun u8 reserved_align[3]; 111*4882a593Smuzhiyun 112*4882a593Smuzhiyun /* number of processors in wait-for-SIPI */ 113*4882a593Smuzhiyun u32 num_in_wfs; 114*4882a593Smuzhiyun } __packed; 115*4882a593Smuzhiyun 116*4882a593Smuzhiyun /* 117*4882a593Smuzhiyun * UUID for tboot data struct to facilitate matching 118*4882a593Smuzhiyun * defined as {663C8DFF-E8B3-4b82-AABF-19EA4D057A08} by tboot, which is 119*4882a593Smuzhiyun * represented as {} in the char array used here 120*4882a593Smuzhiyun */ 121*4882a593Smuzhiyun #define TBOOT_UUID {0xff, 0x8d, 0x3c, 0x66, 0xb3, 0xe8, 0x82, 0x4b, 0xbf,\ 122*4882a593Smuzhiyun 0xaa, 0x19, 0xea, 0x4d, 0x5, 0x7a, 0x8} 123*4882a593Smuzhiyun 124*4882a593Smuzhiyun bool tboot_enabled(void); 125*4882a593Smuzhiyun extern void tboot_probe(void); 126*4882a593Smuzhiyun extern void tboot_shutdown(u32 shutdown_type); 127*4882a593Smuzhiyun extern struct acpi_table_header *tboot_get_dmar_table( 128*4882a593Smuzhiyun struct acpi_table_header *dmar_tbl); 129*4882a593Smuzhiyun extern int tboot_force_iommu(void); 130*4882a593Smuzhiyun 131*4882a593Smuzhiyun #else 132*4882a593Smuzhiyun 133*4882a593Smuzhiyun #define tboot_enabled() 0 134*4882a593Smuzhiyun #define tboot_probe() do { } while (0) 135*4882a593Smuzhiyun #define tboot_shutdown(shutdown_type) do { } while (0) 136*4882a593Smuzhiyun #define tboot_sleep(sleep_state, pm1a_control, pm1b_control) \ 137*4882a593Smuzhiyun do { } while (0) 138*4882a593Smuzhiyun #define tboot_get_dmar_table(dmar_tbl) (dmar_tbl) 139*4882a593Smuzhiyun #define tboot_force_iommu() 0 140*4882a593Smuzhiyun 141*4882a593Smuzhiyun #endif /* !CONFIG_INTEL_TXT */ 142*4882a593Smuzhiyun 143*4882a593Smuzhiyun #endif /* _LINUX_TBOOT_H */ 144