10db89fa2SChen Yu /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 20db89fa2SChen Yu /* 30db89fa2SChen Yu * Platform Firmware Runtime Update header 40db89fa2SChen Yu * 50db89fa2SChen Yu * Copyright(c) 2021 Intel Corporation. All rights reserved. 60db89fa2SChen Yu */ 70db89fa2SChen Yu #ifndef __PFRUT_H__ 80db89fa2SChen Yu #define __PFRUT_H__ 90db89fa2SChen Yu 100db89fa2SChen Yu #include <linux/ioctl.h> 110db89fa2SChen Yu #include <linux/types.h> 120db89fa2SChen Yu 130db89fa2SChen Yu #define PFRUT_IOCTL_MAGIC 0xEE 140db89fa2SChen Yu 150db89fa2SChen Yu /** 160db89fa2SChen Yu * PFRU_IOC_SET_REV - _IOW(PFRUT_IOCTL_MAGIC, 0x01, unsigned int) 170db89fa2SChen Yu * 180db89fa2SChen Yu * Return: 190db89fa2SChen Yu * * 0 - success 200db89fa2SChen Yu * * -EFAULT - fail to read the revision id 210db89fa2SChen Yu * * -EINVAL - user provides an invalid revision id 220db89fa2SChen Yu * 230db89fa2SChen Yu * Set the Revision ID for Platform Firmware Runtime Update. 240db89fa2SChen Yu */ 250db89fa2SChen Yu #define PFRU_IOC_SET_REV _IOW(PFRUT_IOCTL_MAGIC, 0x01, unsigned int) 260db89fa2SChen Yu 270db89fa2SChen Yu /** 280db89fa2SChen Yu * PFRU_IOC_STAGE - _IOW(PFRUT_IOCTL_MAGIC, 0x02, unsigned int) 290db89fa2SChen Yu * 300db89fa2SChen Yu * Return: 310db89fa2SChen Yu * * 0 - success 320db89fa2SChen Yu * * -EINVAL - stage phase returns invalid result 330db89fa2SChen Yu * 340db89fa2SChen Yu * Stage a capsule image from communication buffer and perform authentication. 350db89fa2SChen Yu */ 360db89fa2SChen Yu #define PFRU_IOC_STAGE _IOW(PFRUT_IOCTL_MAGIC, 0x02, unsigned int) 370db89fa2SChen Yu 380db89fa2SChen Yu /** 390db89fa2SChen Yu * PFRU_IOC_ACTIVATE - _IOW(PFRUT_IOCTL_MAGIC, 0x03, unsigned int) 400db89fa2SChen Yu * 410db89fa2SChen Yu * Return: 420db89fa2SChen Yu * * 0 - success 430db89fa2SChen Yu * * -EINVAL - activate phase returns invalid result 440db89fa2SChen Yu * 450db89fa2SChen Yu * Activate a previously staged capsule image. 460db89fa2SChen Yu */ 470db89fa2SChen Yu #define PFRU_IOC_ACTIVATE _IOW(PFRUT_IOCTL_MAGIC, 0x03, unsigned int) 480db89fa2SChen Yu 490db89fa2SChen Yu /** 500db89fa2SChen Yu * PFRU_IOC_STAGE_ACTIVATE - _IOW(PFRUT_IOCTL_MAGIC, 0x04, unsigned int) 510db89fa2SChen Yu * 520db89fa2SChen Yu * Return: 530db89fa2SChen Yu * * 0 - success 540db89fa2SChen Yu * * -EINVAL - stage/activate phase returns invalid result. 550db89fa2SChen Yu * 560db89fa2SChen Yu * Perform both stage and activation action. 570db89fa2SChen Yu */ 580db89fa2SChen Yu #define PFRU_IOC_STAGE_ACTIVATE _IOW(PFRUT_IOCTL_MAGIC, 0x04, unsigned int) 590db89fa2SChen Yu 600db89fa2SChen Yu /** 610db89fa2SChen Yu * PFRU_IOC_QUERY_CAP - _IOR(PFRUT_IOCTL_MAGIC, 0x05, 620db89fa2SChen Yu * struct pfru_update_cap_info) 630db89fa2SChen Yu * 640db89fa2SChen Yu * Return: 650db89fa2SChen Yu * * 0 - success 660db89fa2SChen Yu * * -EINVAL - query phase returns invalid result 670db89fa2SChen Yu * * -EFAULT - the result fails to be copied to userspace 680db89fa2SChen Yu * 690db89fa2SChen Yu * Retrieve information on the Platform Firmware Runtime Update capability. 700db89fa2SChen Yu * The information is a struct pfru_update_cap_info. 710db89fa2SChen Yu */ 720db89fa2SChen Yu #define PFRU_IOC_QUERY_CAP _IOR(PFRUT_IOCTL_MAGIC, 0x05, struct pfru_update_cap_info) 730db89fa2SChen Yu 740db89fa2SChen Yu /** 750db89fa2SChen Yu * struct pfru_payload_hdr - Capsule file payload header. 760db89fa2SChen Yu * 770db89fa2SChen Yu * @sig: Signature of this capsule file. 780db89fa2SChen Yu * @hdr_version: Revision of this header structure. 790db89fa2SChen Yu * @hdr_size: Size of this header, including the OemHeader bytes. 800db89fa2SChen Yu * @hw_ver: The supported firmware version. 810db89fa2SChen Yu * @rt_ver: Version of the code injection image. 820db89fa2SChen Yu * @platform_id: A platform specific GUID to specify the platform what 830db89fa2SChen Yu * this capsule image support. 840db89fa2SChen Yu */ 850db89fa2SChen Yu struct pfru_payload_hdr { 860db89fa2SChen Yu __u32 sig; 870db89fa2SChen Yu __u32 hdr_version; 880db89fa2SChen Yu __u32 hdr_size; 890db89fa2SChen Yu __u32 hw_ver; 900db89fa2SChen Yu __u32 rt_ver; 910db89fa2SChen Yu __u8 platform_id[16]; 920db89fa2SChen Yu }; 930db89fa2SChen Yu 940db89fa2SChen Yu enum pfru_dsm_status { 950db89fa2SChen Yu DSM_SUCCEED = 0, 960db89fa2SChen Yu DSM_FUNC_NOT_SUPPORT = 1, 970db89fa2SChen Yu DSM_INVAL_INPUT = 2, 980db89fa2SChen Yu DSM_HARDWARE_ERR = 3, 990db89fa2SChen Yu DSM_RETRY_SUGGESTED = 4, 1000db89fa2SChen Yu DSM_UNKNOWN = 5, 1010db89fa2SChen Yu DSM_FUNC_SPEC_ERR = 6, 1020db89fa2SChen Yu }; 1030db89fa2SChen Yu 1040db89fa2SChen Yu /** 1050db89fa2SChen Yu * struct pfru_update_cap_info - Runtime update capability information. 1060db89fa2SChen Yu * 1070db89fa2SChen Yu * @status: Indicator of whether this query succeed. 1080db89fa2SChen Yu * @update_cap: Bitmap to indicate whether the feature is supported. 1090db89fa2SChen Yu * @code_type: A buffer containing an image type GUID. 1100db89fa2SChen Yu * @fw_version: Platform firmware version. 1110db89fa2SChen Yu * @code_rt_version: Code injection runtime version for anti-rollback. 1120db89fa2SChen Yu * @drv_type: A buffer containing an image type GUID. 1130db89fa2SChen Yu * @drv_rt_version: The version of the driver update runtime code. 1140db89fa2SChen Yu * @drv_svn: The secure version number(SVN) of the driver update runtime code. 1150db89fa2SChen Yu * @platform_id: A buffer containing a platform ID GUID. 1160db89fa2SChen Yu * @oem_id: A buffer containing an OEM ID GUID. 1170db89fa2SChen Yu * @oem_info_len: Length of the buffer containing the vendor specific information. 1180db89fa2SChen Yu */ 1190db89fa2SChen Yu struct pfru_update_cap_info { 1200db89fa2SChen Yu __u32 status; 1210db89fa2SChen Yu __u32 update_cap; 1220db89fa2SChen Yu 1230db89fa2SChen Yu __u8 code_type[16]; 1240db89fa2SChen Yu __u32 fw_version; 1250db89fa2SChen Yu __u32 code_rt_version; 1260db89fa2SChen Yu 1270db89fa2SChen Yu __u8 drv_type[16]; 1280db89fa2SChen Yu __u32 drv_rt_version; 1290db89fa2SChen Yu __u32 drv_svn; 1300db89fa2SChen Yu 1310db89fa2SChen Yu __u8 platform_id[16]; 1320db89fa2SChen Yu __u8 oem_id[16]; 1330db89fa2SChen Yu 1340db89fa2SChen Yu __u32 oem_info_len; 1350db89fa2SChen Yu }; 1360db89fa2SChen Yu 1370db89fa2SChen Yu /** 1380db89fa2SChen Yu * struct pfru_com_buf_info - Communication buffer information. 1390db89fa2SChen Yu * 1400db89fa2SChen Yu * @status: Indicator of whether this query succeed. 1410db89fa2SChen Yu * @ext_status: Implementation specific query result. 1420db89fa2SChen Yu * @addr_lo: Low 32bit physical address of the communication buffer to hold 1430db89fa2SChen Yu * a runtime update package. 1440db89fa2SChen Yu * @addr_hi: High 32bit physical address of the communication buffer to hold 1450db89fa2SChen Yu * a runtime update package. 1460db89fa2SChen Yu * @buf_size: Maximum size in bytes of the communication buffer. 1470db89fa2SChen Yu */ 1480db89fa2SChen Yu struct pfru_com_buf_info { 1490db89fa2SChen Yu __u32 status; 1500db89fa2SChen Yu __u32 ext_status; 1510db89fa2SChen Yu __u64 addr_lo; 1520db89fa2SChen Yu __u64 addr_hi; 1530db89fa2SChen Yu __u32 buf_size; 1540db89fa2SChen Yu }; 1550db89fa2SChen Yu 1560db89fa2SChen Yu /** 1570db89fa2SChen Yu * struct pfru_updated_result - Platform firmware runtime update result information. 1580db89fa2SChen Yu * @status: Indicator of whether this update succeed. 1590db89fa2SChen Yu * @ext_status: Implementation specific update result. 1600db89fa2SChen Yu * @low_auth_time: Low 32bit value of image authentication time in nanosecond. 1610db89fa2SChen Yu * @high_auth_time: High 32bit value of image authentication time in nanosecond. 1620db89fa2SChen Yu * @low_exec_time: Low 32bit value of image execution time in nanosecond. 1630db89fa2SChen Yu * @high_exec_time: High 32bit value of image execution time in nanosecond. 1640db89fa2SChen Yu */ 1650db89fa2SChen Yu struct pfru_updated_result { 1660db89fa2SChen Yu __u32 status; 1670db89fa2SChen Yu __u32 ext_status; 1680db89fa2SChen Yu __u64 low_auth_time; 1690db89fa2SChen Yu __u64 high_auth_time; 1700db89fa2SChen Yu __u64 low_exec_time; 1710db89fa2SChen Yu __u64 high_exec_time; 1720db89fa2SChen Yu }; 1730db89fa2SChen Yu 174*b0013e03SChen Yu /** 175*b0013e03SChen Yu * struct pfrt_log_data_info - Log Data from telemetry service. 176*b0013e03SChen Yu * @status: Indicator of whether this update succeed. 177*b0013e03SChen Yu * @ext_status: Implementation specific update result. 178*b0013e03SChen Yu * @chunk1_addr_lo: Low 32bit physical address of the telemetry data chunk1 179*b0013e03SChen Yu * starting address. 180*b0013e03SChen Yu * @chunk1_addr_hi: High 32bit physical address of the telemetry data chunk1 181*b0013e03SChen Yu * starting address. 182*b0013e03SChen Yu * @chunk2_addr_lo: Low 32bit physical address of the telemetry data chunk2 183*b0013e03SChen Yu * starting address. 184*b0013e03SChen Yu * @chunk2_addr_hi: High 32bit physical address of the telemetry data chunk2 185*b0013e03SChen Yu * starting address. 186*b0013e03SChen Yu * @max_data_size: Maximum supported size of data of all data chunks combined. 187*b0013e03SChen Yu * @chunk1_size: Data size in bytes of the telemetry data chunk1 buffer. 188*b0013e03SChen Yu * @chunk2_size: Data size in bytes of the telemetry data chunk2 buffer. 189*b0013e03SChen Yu * @rollover_cnt: Number of times telemetry data buffer is overwritten 190*b0013e03SChen Yu * since telemetry buffer reset. 191*b0013e03SChen Yu * @reset_cnt: Number of times telemetry services resets that results in 192*b0013e03SChen Yu * rollover count and data chunk buffers are reset. 193*b0013e03SChen Yu */ 194*b0013e03SChen Yu struct pfrt_log_data_info { 195*b0013e03SChen Yu __u32 status; 196*b0013e03SChen Yu __u32 ext_status; 197*b0013e03SChen Yu __u64 chunk1_addr_lo; 198*b0013e03SChen Yu __u64 chunk1_addr_hi; 199*b0013e03SChen Yu __u64 chunk2_addr_lo; 200*b0013e03SChen Yu __u64 chunk2_addr_hi; 201*b0013e03SChen Yu __u32 max_data_size; 202*b0013e03SChen Yu __u32 chunk1_size; 203*b0013e03SChen Yu __u32 chunk2_size; 204*b0013e03SChen Yu __u32 rollover_cnt; 205*b0013e03SChen Yu __u32 reset_cnt; 206*b0013e03SChen Yu }; 207*b0013e03SChen Yu 208*b0013e03SChen Yu /** 209*b0013e03SChen Yu * struct pfrt_log_info - Telemetry log information. 210*b0013e03SChen Yu * @log_level: The telemetry log level. 211*b0013e03SChen Yu * @log_type: The telemetry log type(history and execution). 212*b0013e03SChen Yu * @log_revid: The telemetry log revision id. 213*b0013e03SChen Yu */ 214*b0013e03SChen Yu struct pfrt_log_info { 215*b0013e03SChen Yu __u32 log_level; 216*b0013e03SChen Yu __u32 log_type; 217*b0013e03SChen Yu __u32 log_revid; 218*b0013e03SChen Yu }; 219*b0013e03SChen Yu 220*b0013e03SChen Yu /** 221*b0013e03SChen Yu * PFRT_LOG_IOC_SET_INFO - _IOW(PFRUT_IOCTL_MAGIC, 0x06, 222*b0013e03SChen Yu * struct pfrt_log_info) 223*b0013e03SChen Yu * 224*b0013e03SChen Yu * Return: 225*b0013e03SChen Yu * * 0 - success 226*b0013e03SChen Yu * * -EFAULT - fail to get the setting parameter 227*b0013e03SChen Yu * * -EINVAL - fail to set the log level 228*b0013e03SChen Yu * 229*b0013e03SChen Yu * Set the PFRT log level and log type. The input information is 230*b0013e03SChen Yu * a struct pfrt_log_info. 231*b0013e03SChen Yu */ 232*b0013e03SChen Yu #define PFRT_LOG_IOC_SET_INFO _IOW(PFRUT_IOCTL_MAGIC, 0x06, struct pfrt_log_info) 233*b0013e03SChen Yu 234*b0013e03SChen Yu /** 235*b0013e03SChen Yu * PFRT_LOG_IOC_GET_INFO - _IOR(PFRUT_IOCTL_MAGIC, 0x07, 236*b0013e03SChen Yu * struct pfrt_log_info) 237*b0013e03SChen Yu * 238*b0013e03SChen Yu * Return: 239*b0013e03SChen Yu * * 0 - success 240*b0013e03SChen Yu * * -EINVAL - fail to get the log level 241*b0013e03SChen Yu * * -EFAULT - fail to copy the result back to userspace 242*b0013e03SChen Yu * 243*b0013e03SChen Yu * Retrieve log level and log type of the telemetry. The information is 244*b0013e03SChen Yu * a struct pfrt_log_info. 245*b0013e03SChen Yu */ 246*b0013e03SChen Yu #define PFRT_LOG_IOC_GET_INFO _IOR(PFRUT_IOCTL_MAGIC, 0x07, struct pfrt_log_info) 247*b0013e03SChen Yu 248*b0013e03SChen Yu /** 249*b0013e03SChen Yu * PFRT_LOG_IOC_GET_DATA_INFO - _IOR(PFRUT_IOCTL_MAGIC, 0x08, 250*b0013e03SChen Yu * struct pfrt_log_data_info) 251*b0013e03SChen Yu * 252*b0013e03SChen Yu * Return: 253*b0013e03SChen Yu * * 0 - success 254*b0013e03SChen Yu * * -EINVAL - fail to get the log buffer information 255*b0013e03SChen Yu * * -EFAULT - fail to copy the log buffer information to userspace 256*b0013e03SChen Yu * 257*b0013e03SChen Yu * Retrieve data information about the telemetry. The information 258*b0013e03SChen Yu * is a struct pfrt_log_data_info. 259*b0013e03SChen Yu */ 260*b0013e03SChen Yu #define PFRT_LOG_IOC_GET_DATA_INFO _IOR(PFRUT_IOCTL_MAGIC, 0x08, struct pfrt_log_data_info) 261*b0013e03SChen Yu 2620db89fa2SChen Yu #endif /* __PFRUT_H__ */ 263