1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* Copyright(c) 2024-2025 Intel Corporation. */ 3 #ifndef __CXL_FEATURES_H__ 4 #define __CXL_FEATURES_H__ 5 6 #include <linux/uuid.h> 7 8 /* Feature UUIDs used by the kernel */ 9 #define CXL_FEAT_PATROL_SCRUB_UUID \ 10 UUID_INIT(0x96dad7d6, 0xfde8, 0x482b, 0xa7, 0x33, 0x75, 0x77, 0x4e, \ 11 0x06, 0xdb, 0x8a) 12 13 #define CXL_FEAT_ECS_UUID \ 14 UUID_INIT(0xe5b13f22, 0x2328, 0x4a14, 0xb8, 0xba, 0xb9, 0x69, 0x1e, \ 15 0x89, 0x33, 0x86) 16 17 #define CXL_FEAT_SPPR_UUID \ 18 UUID_INIT(0x892ba475, 0xfad8, 0x474e, 0x9d, 0x3e, 0x69, 0x2c, 0x91, \ 19 0x75, 0x68, 0xbb) 20 21 #define CXL_FEAT_HPPR_UUID \ 22 UUID_INIT(0x80ea4521, 0x786f, 0x4127, 0xaf, 0xb1, 0xec, 0x74, 0x59, \ 23 0xfb, 0x0e, 0x24) 24 25 #define CXL_FEAT_CACHELINE_SPARING_UUID \ 26 UUID_INIT(0x96C33386, 0x91dd, 0x44c7, 0x9e, 0xcb, 0xfd, 0xaf, 0x65, \ 27 0x03, 0xba, 0xc4) 28 29 #define CXL_FEAT_ROW_SPARING_UUID \ 30 UUID_INIT(0x450ebf67, 0xb135, 0x4f97, 0xa4, 0x98, 0xc2, 0xd5, 0x7f, \ 31 0x27, 0x9b, 0xed) 32 33 #define CXL_FEAT_BANK_SPARING_UUID \ 34 UUID_INIT(0x78b79636, 0x90ac, 0x4b64, 0xa4, 0xef, 0xfa, 0xac, 0x5d, \ 35 0x18, 0xa8, 0x63) 36 37 #define CXL_FEAT_RANK_SPARING_UUID \ 38 UUID_INIT(0x34dbaff5, 0x0552, 0x4281, 0x8f, 0x76, 0xda, 0x0b, 0x5e, \ 39 0x7a, 0x76, 0xa7) 40 41 /* Feature commands capability supported by a device */ 42 enum cxl_features_capability { 43 CXL_FEATURES_NONE = 0, 44 CXL_FEATURES_RO, 45 CXL_FEATURES_RW, 46 }; 47 48 /* Get Supported Features (0x500h) CXL r3.2 8.2.9.6.1 */ 49 struct cxl_mbox_get_sup_feats_in { 50 __le32 count; 51 __le16 start_idx; 52 u8 reserved[2]; 53 } __packed; 54 55 /* CXL spec r3.2 Table 8-87 command effects */ 56 #define CXL_CMD_CONFIG_CHANGE_COLD_RESET BIT(0) 57 #define CXL_CMD_CONFIG_CHANGE_IMMEDIATE BIT(1) 58 #define CXL_CMD_DATA_CHANGE_IMMEDIATE BIT(2) 59 #define CXL_CMD_POLICY_CHANGE_IMMEDIATE BIT(3) 60 #define CXL_CMD_LOG_CHANGE_IMMEDIATE BIT(4) 61 #define CXL_CMD_SECURITY_STATE_CHANGE BIT(5) 62 #define CXL_CMD_BACKGROUND BIT(6) 63 #define CXL_CMD_BGCMD_ABORT_SUPPORTED BIT(7) 64 #define CXL_CMD_EFFECTS_VALID BIT(9) 65 #define CXL_CMD_CONFIG_CHANGE_CONV_RESET BIT(10) 66 #define CXL_CMD_CONFIG_CHANGE_CXL_RESET BIT(11) 67 68 /* 69 * CXL spec r3.2 Table 8-109 70 * Get Supported Features Supported Feature Entry 71 */ 72 struct cxl_feat_entry { 73 uuid_t uuid; 74 __le16 id; 75 __le16 get_feat_size; 76 __le16 set_feat_size; 77 __le32 flags; 78 u8 get_feat_ver; 79 u8 set_feat_ver; 80 __le16 effects; 81 u8 reserved[18]; 82 } __packed; 83 84 /* @flags field for 'struct cxl_feat_entry' */ 85 #define CXL_FEATURE_F_CHANGEABLE BIT(0) 86 #define CXL_FEATURE_F_PERSIST_FW_UPDATE BIT(4) 87 #define CXL_FEATURE_F_DEFAULT_SEL BIT(5) 88 #define CXL_FEATURE_F_SAVED_SEL BIT(6) 89 90 /* 91 * CXL spec r3.2 Table 8-108 92 * Get supported Features Output Payload 93 */ 94 struct cxl_mbox_get_sup_feats_out { 95 __struct_group(cxl_mbox_get_sup_feats_out_hdr, hdr, /* no attrs */, 96 __le16 num_entries; 97 __le16 supported_feats; 98 __u8 reserved[4]; 99 ); 100 struct cxl_feat_entry ents[] __counted_by_le(num_entries); 101 } __packed; 102 103 /* 104 * Get Feature CXL spec r3.2 Spec 8.2.9.6.2 105 */ 106 107 /* 108 * Get Feature input payload 109 * CXL spec r3.2 section 8.2.9.6.2 Table 8-99 110 */ 111 struct cxl_mbox_get_feat_in { 112 uuid_t uuid; 113 __le16 offset; 114 __le16 count; 115 u8 selection; 116 } __packed; 117 118 /* Selection field for 'struct cxl_mbox_get_feat_in' */ 119 enum cxl_get_feat_selection { 120 CXL_GET_FEAT_SEL_CURRENT_VALUE, 121 CXL_GET_FEAT_SEL_DEFAULT_VALUE, 122 CXL_GET_FEAT_SEL_SAVED_VALUE, 123 CXL_GET_FEAT_SEL_MAX 124 }; 125 126 /* 127 * Set Feature CXL spec r3.2 8.2.9.6.3 128 */ 129 130 /* 131 * Set Feature input payload 132 * CXL spec r3.2 section 8.2.9.6.3 Table 8-101 133 */ 134 struct cxl_mbox_set_feat_in { 135 __struct_group(cxl_mbox_set_feat_hdr, hdr, /* no attrs */, 136 uuid_t uuid; 137 __le32 flags; 138 __le16 offset; 139 u8 version; 140 u8 rsvd[9]; 141 ); 142 __u8 feat_data[]; 143 } __packed; 144 145 /* Set Feature flags field */ 146 enum cxl_set_feat_flag_data_transfer { 147 CXL_SET_FEAT_FLAG_FULL_DATA_TRANSFER = 0, 148 CXL_SET_FEAT_FLAG_INITIATE_DATA_TRANSFER, 149 CXL_SET_FEAT_FLAG_CONTINUE_DATA_TRANSFER, 150 CXL_SET_FEAT_FLAG_FINISH_DATA_TRANSFER, 151 CXL_SET_FEAT_FLAG_ABORT_DATA_TRANSFER, 152 CXL_SET_FEAT_FLAG_DATA_TRANSFER_MAX 153 }; 154 155 #define CXL_SET_FEAT_FLAG_DATA_TRANSFER_MASK GENMASK(2, 0) 156 157 #define CXL_SET_FEAT_FLAG_DATA_SAVED_ACROSS_RESET BIT(3) 158 159 /** 160 * struct cxl_features_state - The Features state for the device 161 * @cxlds: Pointer to CXL device state 162 * @entries: CXl feature entry context 163 * @num_features: total Features supported by the device 164 * @ent: Flex array of Feature detail entries from the device 165 */ 166 struct cxl_features_state { 167 struct cxl_dev_state *cxlds; 168 struct cxl_feat_entries { 169 int num_features; 170 int num_user_features; 171 struct cxl_feat_entry ent[] __counted_by(num_features); 172 } *entries; 173 }; 174 175 struct cxl_mailbox; 176 #ifdef CONFIG_CXL_FEATURES 177 inline struct cxl_features_state *to_cxlfs(struct cxl_dev_state *cxlds); 178 int devm_cxl_setup_features(struct cxl_dev_state *cxlds); 179 #else 180 static inline struct cxl_features_state *to_cxlfs(struct cxl_dev_state *cxlds) 181 { 182 return NULL; 183 } 184 185 static inline int devm_cxl_setup_features(struct cxl_dev_state *cxlds) 186 { 187 return -EOPNOTSUPP; 188 } 189 #endif 190 191 #endif 192