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 #include <linux/fwctl.h>
8 #include <uapi/cxl/features.h>
9 
10 /* Feature UUIDs used by the kernel */
11 #define CXL_FEAT_PATROL_SCRUB_UUID						\
12 	UUID_INIT(0x96dad7d6, 0xfde8, 0x482b, 0xa7, 0x33, 0x75, 0x77, 0x4e,	\
13 		  0x06, 0xdb, 0x8a)
14 
15 #define CXL_FEAT_ECS_UUID							\
16 	UUID_INIT(0xe5b13f22, 0x2328, 0x4a14, 0xb8, 0xba, 0xb9, 0x69, 0x1e,	\
17 		  0x89, 0x33, 0x86)
18 
19 #define CXL_FEAT_SPPR_UUID							\
20 	UUID_INIT(0x892ba475, 0xfad8, 0x474e, 0x9d, 0x3e, 0x69, 0x2c, 0x91,	\
21 		  0x75, 0x68, 0xbb)
22 
23 #define CXL_FEAT_HPPR_UUID							\
24 	UUID_INIT(0x80ea4521, 0x786f, 0x4127, 0xaf, 0xb1, 0xec, 0x74, 0x59,	\
25 		  0xfb, 0x0e, 0x24)
26 
27 #define CXL_FEAT_CACHELINE_SPARING_UUID						\
28 	UUID_INIT(0x96C33386, 0x91dd, 0x44c7, 0x9e, 0xcb, 0xfd, 0xaf, 0x65,	\
29 		  0x03, 0xba, 0xc4)
30 
31 #define CXL_FEAT_ROW_SPARING_UUID						\
32 	UUID_INIT(0x450ebf67, 0xb135, 0x4f97, 0xa4, 0x98, 0xc2, 0xd5, 0x7f,	\
33 		  0x27, 0x9b, 0xed)
34 
35 #define CXL_FEAT_BANK_SPARING_UUID						\
36 	UUID_INIT(0x78b79636, 0x90ac, 0x4b64, 0xa4, 0xef, 0xfa, 0xac, 0x5d,	\
37 		  0x18, 0xa8, 0x63)
38 
39 #define CXL_FEAT_RANK_SPARING_UUID						\
40 	UUID_INIT(0x34dbaff5, 0x0552, 0x4281, 0x8f, 0x76, 0xda, 0x0b, 0x5e,	\
41 		  0x7a, 0x76, 0xa7)
42 
43 /* Feature commands capability supported by a device */
44 enum cxl_features_capability {
45 	CXL_FEATURES_NONE = 0,
46 	CXL_FEATURES_RO,
47 	CXL_FEATURES_RW,
48 };
49 
50 /**
51  * struct cxl_features_state - The Features state for the device
52  * @cxlds: Pointer to CXL device state
53  * @entries: CXl feature entry context
54  */
55 struct cxl_features_state {
56 	struct cxl_dev_state *cxlds;
57 	struct cxl_feat_entries {
58 		int num_features;
59 		int num_user_features;
60 		struct cxl_feat_entry ent[] __counted_by(num_features);
61 	} *entries;
62 };
63 
64 struct cxl_mailbox;
65 struct cxl_memdev;
66 #ifdef CONFIG_CXL_FEATURES
67 struct cxl_features_state *to_cxlfs(struct cxl_dev_state *cxlds);
68 int devm_cxl_setup_features(struct cxl_dev_state *cxlds);
69 int devm_cxl_setup_fwctl(struct device *host, struct cxl_memdev *cxlmd);
70 #else
71 static inline struct cxl_features_state *to_cxlfs(struct cxl_dev_state *cxlds)
72 {
73 	return NULL;
74 }
75 
76 static inline int devm_cxl_setup_features(struct cxl_dev_state *cxlds)
77 {
78 	return -EOPNOTSUPP;
79 }
80 
81 static inline int devm_cxl_setup_fwctl(struct device *host,
82 				       struct cxl_memdev *cxlmd)
83 {
84 	return -EOPNOTSUPP;
85 }
86 #endif
87 
88 #endif
89