1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ 2*4882a593Smuzhiyun #ifndef _UAPI_LINUX_FSI_H 3*4882a593Smuzhiyun #define _UAPI_LINUX_FSI_H 4*4882a593Smuzhiyun 5*4882a593Smuzhiyun #include <linux/types.h> 6*4882a593Smuzhiyun #include <linux/ioctl.h> 7*4882a593Smuzhiyun 8*4882a593Smuzhiyun /* 9*4882a593Smuzhiyun * /dev/scom "raw" ioctl interface 10*4882a593Smuzhiyun * 11*4882a593Smuzhiyun * The driver supports a high level "read/write" interface which 12*4882a593Smuzhiyun * handles retries and converts the status to Linux error codes, 13*4882a593Smuzhiyun * however low level tools an debugger need to access the "raw" 14*4882a593Smuzhiyun * HW status information and interpret it themselves, so this 15*4882a593Smuzhiyun * ioctl interface is also provided for their use case. 16*4882a593Smuzhiyun */ 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun /* Structure for SCOM read/write */ 19*4882a593Smuzhiyun struct scom_access { 20*4882a593Smuzhiyun __u64 addr; /* SCOM address, supports indirect */ 21*4882a593Smuzhiyun __u64 data; /* SCOM data (in for write, out for read) */ 22*4882a593Smuzhiyun __u64 mask; /* Data mask for writes */ 23*4882a593Smuzhiyun __u32 intf_errors; /* Interface error flags */ 24*4882a593Smuzhiyun #define SCOM_INTF_ERR_PARITY 0x00000001 /* Parity error */ 25*4882a593Smuzhiyun #define SCOM_INTF_ERR_PROTECTION 0x00000002 /* Blocked by secure boot */ 26*4882a593Smuzhiyun #define SCOM_INTF_ERR_ABORT 0x00000004 /* PIB reset during access */ 27*4882a593Smuzhiyun #define SCOM_INTF_ERR_UNKNOWN 0x80000000 /* Unknown error */ 28*4882a593Smuzhiyun /* 29*4882a593Smuzhiyun * Note: Any other bit set in intf_errors need to be considered as an 30*4882a593Smuzhiyun * error. Future implementations may define new error conditions. The 31*4882a593Smuzhiyun * pib_status below is only valid if intf_errors is 0. 32*4882a593Smuzhiyun */ 33*4882a593Smuzhiyun __u8 pib_status; /* 3-bit PIB status */ 34*4882a593Smuzhiyun #define SCOM_PIB_SUCCESS 0 /* Access successful */ 35*4882a593Smuzhiyun #define SCOM_PIB_BLOCKED 1 /* PIB blocked, pls retry */ 36*4882a593Smuzhiyun #define SCOM_PIB_OFFLINE 2 /* Chiplet offline */ 37*4882a593Smuzhiyun #define SCOM_PIB_PARTIAL 3 /* Partial good */ 38*4882a593Smuzhiyun #define SCOM_PIB_BAD_ADDR 4 /* Invalid address */ 39*4882a593Smuzhiyun #define SCOM_PIB_CLK_ERR 5 /* Clock error */ 40*4882a593Smuzhiyun #define SCOM_PIB_PARITY_ERR 6 /* Parity error on the PIB bus */ 41*4882a593Smuzhiyun #define SCOM_PIB_TIMEOUT 7 /* Bus timeout */ 42*4882a593Smuzhiyun __u8 pad; 43*4882a593Smuzhiyun }; 44*4882a593Smuzhiyun 45*4882a593Smuzhiyun /* Flags for SCOM check */ 46*4882a593Smuzhiyun #define SCOM_CHECK_SUPPORTED 0x00000001 /* Interface supported */ 47*4882a593Smuzhiyun #define SCOM_CHECK_PROTECTED 0x00000002 /* Interface blocked by secure boot */ 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun /* Flags for SCOM reset */ 50*4882a593Smuzhiyun #define SCOM_RESET_INTF 0x00000001 /* Reset interface */ 51*4882a593Smuzhiyun #define SCOM_RESET_PIB 0x00000002 /* Reset PIB */ 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun #define FSI_SCOM_CHECK _IOR('s', 0x00, __u32) 54*4882a593Smuzhiyun #define FSI_SCOM_READ _IOWR('s', 0x01, struct scom_access) 55*4882a593Smuzhiyun #define FSI_SCOM_WRITE _IOWR('s', 0x02, struct scom_access) 56*4882a593Smuzhiyun #define FSI_SCOM_RESET _IOW('s', 0x03, __u32) 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun #endif /* _UAPI_LINUX_FSI_H */ 59