me.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-only */
 
#ifndef _INTEL_ME_H
#define _INTEL_ME_H
 
#include <device/device.h>
#include <types.h>
 
#define ME_RETRY                100000  /* 1 second */
#define ME_DELAY                10      /* 10 us */
 
/*
 * Management Engine PCI registers
 */
 
#define PCI_CPU_DEVICE          PCI_DEV(0,0,0)
#define PCI_CPU_MEBASE_L        0x70    /* Set by MRC */
#define PCI_CPU_MEBASE_H        0x74    /* Set by MRC */
 
#define PCI_ME_HFS              0x40
#define  ME_HFS_CWS_RESET       0
#define  ME_HFS_CWS_INIT        1
#define  ME_HFS_CWS_REC         2
#define  ME_HFS_CWS_NORMAL      5
#define  ME_HFS_CWS_WAIT        6
#define  ME_HFS_CWS_TRANS       7
#define  ME_HFS_CWS_INVALID     8
#define  ME_HFS_STATE_PREBOOT   0
#define  ME_HFS_STATE_M0_UMA    1
#define  ME_HFS_STATE_M3        4
#define  ME_HFS_STATE_M0        5
#define  ME_HFS_STATE_BRINGUP   6
#define  ME_HFS_STATE_ERROR     7
#define  ME_HFS_ERROR_NONE      0
#define  ME_HFS_ERROR_UNCAT     1
#define  ME_HFS_ERROR_IMAGE     3
#define  ME_HFS_ERROR_DEBUG     4
#define  ME_HFS_MODE_NORMAL     0
#define  ME_HFS_MODE_DEBUG      2
#define  ME_HFS_MODE_DIS        3
#define  ME_HFS_MODE_OVER_JMPR  4
#define  ME_HFS_MODE_OVER_MEI   5
#define  ME_HFS_BIOS_DRAM_ACK   1
#define  ME_HFS_ACK_NO_DID      0
#define  ME_HFS_ACK_RESET       1
#define  ME_HFS_ACK_PWR_CYCLE   2
#define  ME_HFS_ACK_S3          3
#define  ME_HFS_ACK_S4          4
#define  ME_HFS_ACK_S5          5
#define  ME_HFS_ACK_GBL_RESET   6
#define  ME_HFS_ACK_CONTINUE    7
 
union me_hfs {
        struct {
                u32 working_state: 4;
                u32 mfg_mode: 1;
                u32 fpt_bad: 1;
                u32 operation_state: 3;
                u32 fw_init_complete: 1;
                u32 ft_bup_ld_flr: 1;
                u32 update_in_progress: 1;
                u32 error_code: 4;
                u32 operation_mode: 4;
                u32 reserved: 4;
                u32 boot_options_present: 1;
                u32 ack_data: 3;
                u32 bios_msg_ack: 4;
        };
        u32 raw;
} __packed;
 
#define PCI_ME_UMA              0x44
 
union me_uma {
        struct {
                u32 size: 6;
                u32 reserved_1: 10;
                u32 valid: 1;
                u32 reserved_0: 14;
                u32 set_to_one: 1;
        };
        u32 raw;
} __packed;
 
#define PCI_ME_H_GS             0x4c
#define  ME_INIT_DONE           1
#define  ME_INIT_STATUS_SUCCESS 0
#define  ME_INIT_STATUS_NOMEM   1
#define  ME_INIT_STATUS_ERROR   2
 
union me_did {
        struct {
                u32 uma_base: 16;
                u32 reserved: 8;
                u32 status: 4;
                u32 init_done: 4;
        };
        u32 raw;
} __packed;
 
#define PCI_ME_GMES             0x48
#define  ME_GMES_PHASE_ROM      0
#define  ME_GMES_PHASE_BUP      1
#define  ME_GMES_PHASE_UKERNEL  2
#define  ME_GMES_PHASE_POLICY   3
#define  ME_GMES_PHASE_MODULE   4
#define  ME_GMES_PHASE_UNKNOWN  5
#define  ME_GMES_PHASE_HOST     6
 
union me_gmes {
        struct {
                u32 bist_in_prog : 1;
                u32 icc_prog_sts : 2;
                u32 invoke_mebx : 1;
                u32 cpu_replaced_sts : 1;
                u32 mbp_rdy : 1;
                u32 mfs_failure : 1;
                u32 warm_rst_req_for_df : 1;
                u32 cpu_replaced_valid : 1;
                u32 reserved_1 : 2;
                u32 fw_upd_ipu : 1;
                u32 reserved_2 : 4;
                u32 current_state: 8;
                u32 current_pmevent: 4;
                u32 progress_code: 4;
        };
        u32 raw;
} __packed;
 
#define PCI_ME_HERES            0xbc
#define  PCI_ME_EXT_SHA1        0x00
#define  PCI_ME_EXT_SHA256      0x02
#define PCI_ME_HER(x)           (0xc0+(4*(x)))
 
union me_heres {
        struct {
                u32 extend_reg_algorithm: 4;
                u32 reserved: 26;
                u32 extend_feature_present: 1;
                u32 extend_reg_valid: 1;
        };
        u32 raw;
} __packed;
 
/*
 * Management Engine MEI registers
 */
 
#define MEI_H_CB_WW             0x00
#define MEI_H_CSR               0x04
#define MEI_ME_CB_RW            0x08
#define MEI_ME_CSR_HA           0x0c
 
struct mei_csr {
        u32 interrupt_enable: 1;
        u32 interrupt_status: 1;
        u32 interrupt_generate: 1;
        u32 ready: 1;
        u32 reset: 1;
        u32 reserved: 3;
        u32 buffer_read_ptr: 8;
        u32 buffer_write_ptr: 8;
        u32 buffer_depth: 8;
} __packed;
 
#define MEI_ADDRESS_CORE        0x01
#define MEI_ADDRESS_AMT         0x02
#define MEI_ADDRESS_RESERVED    0x03
#define MEI_ADDRESS_WDT         0x04
#define MEI_ADDRESS_MKHI        0x07
#define MEI_ADDRESS_ICC         0x08
#define MEI_ADDRESS_THERMAL     0x09
 
#define MEI_HOST_ADDRESS        0
 
struct mei_header {
        u32 client_address: 8;
        u32 host_address: 8;
        u32 length: 9;
        u32 reserved: 6;
        u32 is_complete: 1;
} __packed;
 
#define MKHI_GROUP_ID_CBM       0x00
#define MKHI_GROUP_ID_FWCAPS    0x03
#define MKHI_GROUP_ID_MDES      0x08
#define MKHI_GROUP_ID_GEN       0xff
 
#define MKHI_GLOBAL_RESET       0x0b
 
#define MKHI_FWCAPS_GET_RULE    0x02
#define MKHI_FWCAPS_SET_RULE    0x03
 
#define MKHI_DISABLE_RULE_ID    0x06
 
#define CMOS_ME_STATE(state)    ((state) & 0x1)
#define CMOS_ME_CHANGED(state)  (((state) & 0x2) >> 1)
#define CMOS_ME_STATE_NORMAL    0
#define CMOS_ME_STATE_DISABLED  1
#define CMOS_ME_STATE_CHANGED   2
 
#define ME_ENABLE_TIMEOUT       20000
 
struct me_disable {
        u32 rule_id;
        u16 data;
} __packed;
 
#define MKHI_MDES_ENABLE        0x09
 
#define MKHI_GET_FW_VERSION     0x02
#define MKHI_END_OF_POST        0x0c
#define MKHI_FEATURE_OVERRIDE   0x14
 
struct mkhi_header {
        u32 group_id: 8;
        u32 command: 7;
        u32 is_response: 1;
        u32 reserved: 8;
        u32 result: 8;
} __packed;
 
struct me_fw_version {
        u16 code_minor;
        u16 code_major;
        u16 code_build_number;
        u16 code_hot_fix;
        u16 recovery_minor;
        u16 recovery_major;
        u16 recovery_build_number;
        u16 recovery_hot_fix;
} __packed;
 
#define HECI_EOP_STATUS_SUCCESS       0x0
#define HECI_EOP_PERFORM_GLOBAL_RESET 0x1
 
#define CBM_RR_GLOBAL_RESET     0x01
 
#define GLOBAL_RESET_BIOS_MRC   0x01
#define GLOBAL_RESET_BIOS_POST  0x02
#define GLOBAL_RESET_MEBX       0x03
 
struct me_global_reset {
        u8 request_origin;
        u8 reset_type;
} __packed;
 
typedef enum {
        ME_NORMAL_BIOS_PATH,
        ME_S3WAKE_BIOS_PATH,
        ME_ERROR_BIOS_PATH,
        ME_RECOVERY_BIOS_PATH,
        ME_DISABLE_BIOS_PATH,
        ME_FIRMWARE_UPDATE_BIOS_PATH,
} me_bios_path;
 
/* Defined in me_common.c for both ramstage and smm */
const char *const me_get_bios_path_string(int path);
 
void mei_read_dword_ptr(void *ptr, int offset);
void mei_write_dword_ptr(void *ptr, int offset);
 
#ifndef __SIMPLE_DEVICE__
bool enter_soft_temp_disable(void);
void enter_soft_temp_disable_wait(void);
void exit_soft_temp_disable(struct device *dev);
void exit_soft_temp_disable_wait(struct device *dev);
#endif
 
void read_host_csr(struct mei_csr *csr);
void write_host_csr(struct mei_csr *csr);
 
void read_me_csr(struct mei_csr *csr);
 
void write_cb(u32 dword);
u32 read_cb(void);
 
int mei_sendrecv(struct mei_header *mei, struct mkhi_header *mkhi,
                 void *req_data, void *rsp_data, int rsp_bytes);
 
void update_mei_base_address(void);
bool is_mei_base_address_valid(void);
int intel_mei_setup(struct device *dev);
int intel_me_extend_valid(struct device *dev);
void intel_me_hide(struct device *dev);
 
/* Defined in me_status.c for both romstage and ramstage */
void intel_me_status(union me_hfs *hfs, union me_gmes *gmes);
 
void intel_early_me_status(void);
int intel_early_me_init(void);
int intel_early_me_uma_size(void);
int intel_early_me_init_done(u8 status);
 
void intel_me_finalize_smm(void);
 
typedef struct {
        u32       major_version  : 16;
        u32       minor_version  : 16;
        u32       hotfix_version : 16;
        u32       build_version  : 16;
} __packed mbp_fw_version_name;
 
typedef struct {
        u8        num_icc_profiles;
        u8        icc_profile_soft_strap;
        u8        icc_profile_index;
        u8        reserved;
        u32       register_lock_mask[3];
} __packed mbp_icc_profile;
 
typedef struct {
        u32  full_net           : 1;
        u32  std_net            : 1;
        u32  manageability      : 1;
        u32  small_business     : 1;
        u32  l3manageability    : 1;
        u32  intel_at           : 1;
        u32  intel_cls          : 1;
        u32  reserved           : 3;
        u32  intel_mpc          : 1;
        u32  icc_over_clocking  : 1;
        u32  pavp               : 1;
        u32  reserved_1         : 4;
        u32  ipv6               : 1;
        u32  kvm                : 1;
        u32  och                : 1;
        u32  vlan               : 1;
        u32  tls                : 1;
        u32  reserved_4         : 1;
        u32  wlan               : 1;
        u32  reserved_5         : 8;
} __packed mefwcaps_sku;
 
typedef struct {
        u16  lock_state              : 1;
        u16  authenticate_module     : 1;
        u16  s3authentication        : 1;
        u16  flash_wear_out          : 1;
        u16  flash_variable_security : 1;
        u16  wwan3gpresent           : 1;
        u16  wwan3goob               : 1;
        u16  reserved                : 9;
} __packed tdt_state_flag;
 
typedef struct {
        u8           state;
        u8           last_theft_trigger;
        tdt_state_flag  flags;
}  __packed tdt_state_info;
 
typedef struct {
        u32  platform_target_usage_type  : 4;
        u32  platform_target_market_type : 2;
        u32  super_sku                   : 1;
        u32  reserved                    : 1;
        u32  intel_me_fw_image_type      : 4;
        u32  platform_brand              : 4;
        u32  reserved_1                  : 16;
}  __packed platform_type_rule_data;
 
typedef struct {
        mefwcaps_sku fw_capabilities;
        u8      available;
} mbp_fw_caps;
 
typedef struct {
        u16        device_id;
        u16        fuse_test_flags;
        u32        umchid[4];
}  __packed mbp_rom_bist_data;
 
typedef struct {
        u32        key[8];
} mbp_platform_key;
 
typedef struct {
        platform_type_rule_data rule_data;
        u8                available;
} mbp_plat_type;
 
typedef struct {
        mbp_fw_version_name fw_version_name;
        mbp_fw_caps         fw_caps_sku;
        mbp_rom_bist_data   rom_bist_data;
        mbp_platform_key    platform_key;
        mbp_plat_type       fw_plat_type;
        mbp_icc_profile     icc_profile;
        tdt_state_info      at_state;
        u32                 mfsintegrity;
} me_bios_payload;
 
typedef  struct {
        u32  mbp_size    : 8;
        u32  num_entries : 8;
        u32  rsvd        : 16;
} __packed mbp_header;
 
typedef struct {
        u32  app_id  : 8;
        u32  item_id : 8;
        u32  length  : 8;
        u32  rsvd    : 8;
}  __packed mbp_item_header;
 
struct me_fwcaps {
        u32 id;
        u8 length;
        mefwcaps_sku caps_sku;
        u8 reserved[3];
} __packed;
 
#endif /* _INTEL_ME_H */