1f517f792SVaibhav Jain /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2f517f792SVaibhav Jain /* 3f517f792SVaibhav Jain * PAPR nvDimm Specific Methods (PDSM) and structs for libndctl 4f517f792SVaibhav Jain * 5f517f792SVaibhav Jain * (C) Copyright IBM 2020 6f517f792SVaibhav Jain * 7f517f792SVaibhav Jain * Author: Vaibhav Jain <vaibhav at linux.ibm.com> 8f517f792SVaibhav Jain */ 9f517f792SVaibhav Jain 10f517f792SVaibhav Jain #ifndef _UAPI_ASM_POWERPC_PAPR_PDSM_H_ 11f517f792SVaibhav Jain #define _UAPI_ASM_POWERPC_PAPR_PDSM_H_ 12f517f792SVaibhav Jain 13f517f792SVaibhav Jain #include <linux/types.h> 14f517f792SVaibhav Jain #include <linux/ndctl.h> 15f517f792SVaibhav Jain 16f517f792SVaibhav Jain /* 17f517f792SVaibhav Jain * PDSM Envelope: 18f517f792SVaibhav Jain * 19f517f792SVaibhav Jain * The ioctl ND_CMD_CALL exchange data between user-space and kernel via 20f517f792SVaibhav Jain * envelope which consists of 2 headers sections and payload sections as 21f517f792SVaibhav Jain * illustrated below: 22f517f792SVaibhav Jain * +-----------------+---------------+---------------------------+ 23f517f792SVaibhav Jain * | 64-Bytes | 8-Bytes | Max 184-Bytes | 24f517f792SVaibhav Jain * +-----------------+---------------+---------------------------+ 25f517f792SVaibhav Jain * | ND-HEADER | PDSM-HEADER | PDSM-PAYLOAD | 26f517f792SVaibhav Jain * +-----------------+---------------+---------------------------+ 27f517f792SVaibhav Jain * | nd_family | | | 28f517f792SVaibhav Jain * | nd_size_out | cmd_status | | 29f517f792SVaibhav Jain * | nd_size_in | reserved | nd_pdsm_payload | 30f517f792SVaibhav Jain * | nd_command | payload --> | | 31f517f792SVaibhav Jain * | nd_fw_size | | | 32f517f792SVaibhav Jain * | nd_payload ---> | | | 33f517f792SVaibhav Jain * +---------------+-----------------+---------------------------+ 34f517f792SVaibhav Jain * 35f517f792SVaibhav Jain * ND Header: 36f517f792SVaibhav Jain * This is the generic libnvdimm header described as 'struct nd_cmd_pkg' 37f517f792SVaibhav Jain * which is interpreted by libnvdimm before passed on to papr_scm. Important 38f517f792SVaibhav Jain * member fields used are: 39f517f792SVaibhav Jain * 'nd_family' : (In) NVDIMM_FAMILY_PAPR_SCM 40f517f792SVaibhav Jain * 'nd_size_in' : (In) PDSM-HEADER + PDSM-IN-PAYLOAD (usually 0) 41f517f792SVaibhav Jain * 'nd_size_out' : (In) PDSM-HEADER + PDSM-RETURN-PAYLOAD 42f517f792SVaibhav Jain * 'nd_command' : (In) One of PAPR_PDSM_XXX 43f517f792SVaibhav Jain * 'nd_fw_size' : (Out) PDSM-HEADER + size of actual payload returned 44f517f792SVaibhav Jain * 45f517f792SVaibhav Jain * PDSM Header: 46f517f792SVaibhav Jain * This is papr-scm specific header that precedes the payload. This is defined 47f517f792SVaibhav Jain * as nd_cmd_pdsm_pkg. Following fields aare available in this header: 48f517f792SVaibhav Jain * 49f517f792SVaibhav Jain * 'cmd_status' : (Out) Errors if any encountered while servicing PDSM. 50f517f792SVaibhav Jain * 'reserved' : Not used, reserved for future and should be set to 0. 51f517f792SVaibhav Jain * 'payload' : A union of all the possible payload structs 52f517f792SVaibhav Jain * 53f517f792SVaibhav Jain * PDSM Payload: 54f517f792SVaibhav Jain * 55f517f792SVaibhav Jain * The layout of the PDSM Payload is defined by various structs shared between 56f517f792SVaibhav Jain * papr_scm and libndctl so that contents of payload can be interpreted. As such 57f517f792SVaibhav Jain * its defined as a union of all possible payload structs as 58f517f792SVaibhav Jain * 'union nd_pdsm_payload'. Based on the value of 'nd_cmd_pkg.nd_command' 59f517f792SVaibhav Jain * appropriate member of the union is accessed. 60f517f792SVaibhav Jain */ 61f517f792SVaibhav Jain 62f517f792SVaibhav Jain /* Max payload size that we can handle */ 63f517f792SVaibhav Jain #define ND_PDSM_PAYLOAD_MAX_SIZE 184 64f517f792SVaibhav Jain 65f517f792SVaibhav Jain /* Max payload size that we can handle */ 66f517f792SVaibhav Jain #define ND_PDSM_HDR_SIZE \ 67f517f792SVaibhav Jain (sizeof(struct nd_pkg_pdsm) - ND_PDSM_PAYLOAD_MAX_SIZE) 68f517f792SVaibhav Jain 69d35f18b5SVaibhav Jain /* Various nvdimm health indicators */ 70d35f18b5SVaibhav Jain #define PAPR_PDSM_DIMM_HEALTHY 0 71d35f18b5SVaibhav Jain #define PAPR_PDSM_DIMM_UNHEALTHY 1 72d35f18b5SVaibhav Jain #define PAPR_PDSM_DIMM_CRITICAL 2 73d35f18b5SVaibhav Jain #define PAPR_PDSM_DIMM_FATAL 3 74d35f18b5SVaibhav Jain 75af0870c4SVaibhav Jain /* struct nd_papr_pdsm_health.extension_flags field flags */ 76af0870c4SVaibhav Jain 77af0870c4SVaibhav Jain /* Indicate that the 'dimm_fuel_gauge' field is valid */ 78af0870c4SVaibhav Jain #define PDSM_DIMM_HEALTH_RUN_GAUGE_VALID 1 79af0870c4SVaibhav Jain 80d35f18b5SVaibhav Jain /* 81d35f18b5SVaibhav Jain * Struct exchanged between kernel & ndctl in for PAPR_PDSM_HEALTH 82d35f18b5SVaibhav Jain * Various flags indicate the health status of the dimm. 83d35f18b5SVaibhav Jain * 84d35f18b5SVaibhav Jain * extension_flags : Any extension fields present in the struct. 85d35f18b5SVaibhav Jain * dimm_unarmed : Dimm not armed. So contents wont persist. 86d35f18b5SVaibhav Jain * dimm_bad_shutdown : Previous shutdown did not persist contents. 87d35f18b5SVaibhav Jain * dimm_bad_restore : Contents from previous shutdown werent restored. 88d35f18b5SVaibhav Jain * dimm_scrubbed : Contents of the dimm have been scrubbed. 89d35f18b5SVaibhav Jain * dimm_locked : Contents of the dimm cant be modified until CEC reboot 90d35f18b5SVaibhav Jain * dimm_encrypted : Contents of dimm are encrypted. 91d35f18b5SVaibhav Jain * dimm_health : Dimm health indicator. One of PAPR_PDSM_DIMM_XXXX 92af0870c4SVaibhav Jain * dimm_fuel_gauge : Life remaining of DIMM as a percentage from 0-100 93d35f18b5SVaibhav Jain */ 94d35f18b5SVaibhav Jain struct nd_papr_pdsm_health { 95d35f18b5SVaibhav Jain union { 96d35f18b5SVaibhav Jain struct { 97d35f18b5SVaibhav Jain __u32 extension_flags; 98d35f18b5SVaibhav Jain __u8 dimm_unarmed; 99d35f18b5SVaibhav Jain __u8 dimm_bad_shutdown; 100d35f18b5SVaibhav Jain __u8 dimm_bad_restore; 101d35f18b5SVaibhav Jain __u8 dimm_scrubbed; 102d35f18b5SVaibhav Jain __u8 dimm_locked; 103d35f18b5SVaibhav Jain __u8 dimm_encrypted; 104d35f18b5SVaibhav Jain __u16 dimm_health; 105af0870c4SVaibhav Jain 106af0870c4SVaibhav Jain /* Extension flag PDSM_DIMM_HEALTH_RUN_GAUGE_VALID */ 107af0870c4SVaibhav Jain __u16 dimm_fuel_gauge; 108d35f18b5SVaibhav Jain }; 109d35f18b5SVaibhav Jain __u8 buf[ND_PDSM_PAYLOAD_MAX_SIZE]; 110d35f18b5SVaibhav Jain }; 111d35f18b5SVaibhav Jain }; 112d35f18b5SVaibhav Jain 113f517f792SVaibhav Jain /* 114f517f792SVaibhav Jain * Methods to be embedded in ND_CMD_CALL request. These are sent to the kernel 115f517f792SVaibhav Jain * via 'nd_cmd_pkg.nd_command' member of the ioctl struct 116f517f792SVaibhav Jain */ 117f517f792SVaibhav Jain enum papr_pdsm { 118f517f792SVaibhav Jain PAPR_PDSM_MIN = 0x0, 119d35f18b5SVaibhav Jain PAPR_PDSM_HEALTH, 120f517f792SVaibhav Jain PAPR_PDSM_MAX, 121f517f792SVaibhav Jain }; 122f517f792SVaibhav Jain 123f517f792SVaibhav Jain /* Maximal union that can hold all possible payload types */ 124f517f792SVaibhav Jain union nd_pdsm_payload { 125d35f18b5SVaibhav Jain struct nd_papr_pdsm_health health; 126f517f792SVaibhav Jain __u8 buf[ND_PDSM_PAYLOAD_MAX_SIZE]; 127f517f792SVaibhav Jain } __packed; 128f517f792SVaibhav Jain 129f517f792SVaibhav Jain /* 130f517f792SVaibhav Jain * PDSM-header + payload expected with ND_CMD_CALL ioctl from libnvdimm 131f517f792SVaibhav Jain * Valid member of union 'payload' is identified via 'nd_cmd_pkg.nd_command' 132f517f792SVaibhav Jain * that should always precede this struct when sent to papr_scm via CMD_CALL 133f517f792SVaibhav Jain * interface. 134f517f792SVaibhav Jain */ 135f517f792SVaibhav Jain struct nd_pkg_pdsm { 136f517f792SVaibhav Jain __s32 cmd_status; /* Out: Sub-cmd status returned back */ 137f517f792SVaibhav Jain __u16 reserved[2]; /* Ignored and to be set as '0' */ 138f517f792SVaibhav Jain union nd_pdsm_payload payload; 139f517f792SVaibhav Jain } __packed; 140f517f792SVaibhav Jain 141f517f792SVaibhav Jain #endif /* _UAPI_ASM_POWERPC_PAPR_PDSM_H_ */ 142