Commit | Line | Data |
---|---|---|
8adaf747 BW |
1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* Copyright(c) 2020 Intel Corporation. */ | |
3 | ||
4 | #ifndef __CXL_H__ | |
5 | #define __CXL_H__ | |
6 | ||
8fdcb170 | 7 | #include <linux/libnvdimm.h> |
8adaf747 BW |
8 | #include <linux/bitfield.h> |
9 | #include <linux/bitops.h> | |
80d10a6c | 10 | #include <linux/log2.h> |
8adaf747 BW |
11 | #include <linux/io.h> |
12 | ||
4812be97 DW |
13 | /** |
14 | * DOC: cxl objects | |
15 | * | |
16 | * The CXL core objects like ports, decoders, and regions are shared | |
17 | * between the subsystem drivers cxl_acpi, cxl_pci, and core drivers | |
18 | * (port-driver, region-driver, nvdimm object-drivers... etc). | |
19 | */ | |
20 | ||
d17d0540 DW |
21 | /* CXL 2.0 8.2.4 CXL Component Register Layout and Definition */ |
22 | #define CXL_COMPONENT_REG_BLOCK_SIZE SZ_64K | |
23 | ||
08422378 BW |
24 | /* CXL 2.0 8.2.5 CXL.cache and CXL.mem Registers*/ |
25 | #define CXL_CM_OFFSET 0x1000 | |
26 | #define CXL_CM_CAP_HDR_OFFSET 0x0 | |
27 | #define CXL_CM_CAP_HDR_ID_MASK GENMASK(15, 0) | |
28 | #define CM_CAP_HDR_CAP_ID 1 | |
29 | #define CXL_CM_CAP_HDR_VERSION_MASK GENMASK(19, 16) | |
30 | #define CM_CAP_HDR_CAP_VERSION 1 | |
31 | #define CXL_CM_CAP_HDR_CACHE_MEM_VERSION_MASK GENMASK(23, 20) | |
32 | #define CM_CAP_HDR_CACHE_MEM_VERSION 1 | |
33 | #define CXL_CM_CAP_HDR_ARRAY_SIZE_MASK GENMASK(31, 24) | |
34 | #define CXL_CM_CAP_PTR_MASK GENMASK(31, 20) | |
35 | ||
36 | #define CXL_CM_CAP_CAP_ID_HDM 0x5 | |
37 | #define CXL_CM_CAP_CAP_HDM_VERSION 1 | |
38 | ||
39 | /* HDM decoders CXL 2.0 8.2.5.12 CXL HDM Decoder Capability Structure */ | |
40 | #define CXL_HDM_DECODER_CAP_OFFSET 0x0 | |
41 | #define CXL_HDM_DECODER_COUNT_MASK GENMASK(3, 0) | |
42 | #define CXL_HDM_DECODER_TARGET_COUNT_MASK GENMASK(7, 4) | |
d17d0540 DW |
43 | #define CXL_HDM_DECODER_INTERLEAVE_11_8 BIT(8) |
44 | #define CXL_HDM_DECODER_INTERLEAVE_14_12 BIT(9) | |
45 | #define CXL_HDM_DECODER_CTRL_OFFSET 0x4 | |
46 | #define CXL_HDM_DECODER_ENABLE BIT(1) | |
47 | #define CXL_HDM_DECODER0_BASE_LOW_OFFSET(i) (0x20 * (i) + 0x10) | |
48 | #define CXL_HDM_DECODER0_BASE_HIGH_OFFSET(i) (0x20 * (i) + 0x14) | |
49 | #define CXL_HDM_DECODER0_SIZE_LOW_OFFSET(i) (0x20 * (i) + 0x18) | |
50 | #define CXL_HDM_DECODER0_SIZE_HIGH_OFFSET(i) (0x20 * (i) + 0x1c) | |
51 | #define CXL_HDM_DECODER0_CTRL_OFFSET(i) (0x20 * (i) + 0x20) | |
52 | #define CXL_HDM_DECODER0_CTRL_IG_MASK GENMASK(3, 0) | |
53 | #define CXL_HDM_DECODER0_CTRL_IW_MASK GENMASK(7, 4) | |
54 | #define CXL_HDM_DECODER0_CTRL_LOCK BIT(8) | |
55 | #define CXL_HDM_DECODER0_CTRL_COMMIT BIT(9) | |
56 | #define CXL_HDM_DECODER0_CTRL_COMMITTED BIT(10) | |
176baefb | 57 | #define CXL_HDM_DECODER0_CTRL_COMMIT_ERROR BIT(11) |
d17d0540 DW |
58 | #define CXL_HDM_DECODER0_CTRL_TYPE BIT(12) |
59 | #define CXL_HDM_DECODER0_TL_LOW(i) (0x20 * (i) + 0x24) | |
60 | #define CXL_HDM_DECODER0_TL_HIGH(i) (0x20 * (i) + 0x28) | |
9c57cde0 DW |
61 | #define CXL_HDM_DECODER0_SKIP_LOW(i) CXL_HDM_DECODER0_TL_LOW(i) |
62 | #define CXL_HDM_DECODER0_SKIP_HIGH(i) CXL_HDM_DECODER0_TL_HIGH(i) | |
08422378 | 63 | |
6423035f BW |
64 | static inline int cxl_hdm_decoder_count(u32 cap_hdr) |
65 | { | |
66 | int val = FIELD_GET(CXL_HDM_DECODER_COUNT_MASK, cap_hdr); | |
67 | ||
68 | return val ? val * 2 : 1; | |
69 | } | |
70 | ||
419af595 DW |
71 | /* Encode defined in CXL 2.0 8.2.5.12.7 HDM Decoder Control Register */ |
72 | static inline int cxl_to_granularity(u16 ig, unsigned int *val) | |
73 | { | |
74 | if (ig > 6) | |
75 | return -EINVAL; | |
76 | *val = 256 << ig; | |
77 | return 0; | |
78 | } | |
79 | ||
80 | /* Encode defined in CXL ECN "3, 6, 12 and 16-way memory Interleaving" */ | |
81 | static inline int cxl_to_ways(u8 eniw, unsigned int *val) | |
82 | { | |
83 | switch (eniw) { | |
84 | case 0 ... 4: | |
85 | *val = 1 << eniw; | |
86 | break; | |
87 | case 8 ... 10: | |
88 | *val = 3 << (eniw - 8); | |
89 | break; | |
90 | default: | |
91 | return -EINVAL; | |
92 | } | |
93 | ||
94 | return 0; | |
95 | } | |
96 | ||
80d10a6c BW |
97 | static inline int granularity_to_cxl(int g, u16 *ig) |
98 | { | |
99 | if (g > SZ_16K || g < 256 || !is_power_of_2(g)) | |
100 | return -EINVAL; | |
101 | *ig = ilog2(g) - 8; | |
102 | return 0; | |
103 | } | |
104 | ||
105 | static inline int ways_to_cxl(int ways, u8 *iw) | |
106 | { | |
107 | if (ways > 16) | |
108 | return -EINVAL; | |
109 | if (is_power_of_2(ways)) { | |
110 | *iw = ilog2(ways); | |
111 | return 0; | |
112 | } | |
113 | if (ways % 3) | |
114 | return -EINVAL; | |
115 | ways /= 3; | |
116 | if (!is_power_of_2(ways)) | |
117 | return -EINVAL; | |
118 | *iw = ilog2(ways) + 8; | |
119 | return 0; | |
120 | } | |
121 | ||
8adaf747 BW |
122 | /* CXL 2.0 8.2.8.1 Device Capabilities Array Register */ |
123 | #define CXLDEV_CAP_ARRAY_OFFSET 0x0 | |
124 | #define CXLDEV_CAP_ARRAY_CAP_ID 0 | |
125 | #define CXLDEV_CAP_ARRAY_ID_MASK GENMASK_ULL(15, 0) | |
126 | #define CXLDEV_CAP_ARRAY_COUNT_MASK GENMASK_ULL(47, 32) | |
127 | /* CXL 2.0 8.2.8.2 CXL Device Capability Header Register */ | |
128 | #define CXLDEV_CAP_HDR_CAP_ID_MASK GENMASK(15, 0) | |
129 | /* CXL 2.0 8.2.8.2.1 CXL Device Capabilities */ | |
130 | #define CXLDEV_CAP_CAP_ID_DEVICE_STATUS 0x1 | |
131 | #define CXLDEV_CAP_CAP_ID_PRIMARY_MAILBOX 0x2 | |
132 | #define CXLDEV_CAP_CAP_ID_SECONDARY_MAILBOX 0x3 | |
133 | #define CXLDEV_CAP_CAP_ID_MEMDEV 0x4000 | |
134 | ||
135 | /* CXL 2.0 8.2.8.4 Mailbox Registers */ | |
136 | #define CXLDEV_MBOX_CAPS_OFFSET 0x00 | |
137 | #define CXLDEV_MBOX_CAP_PAYLOAD_SIZE_MASK GENMASK(4, 0) | |
138 | #define CXLDEV_MBOX_CTRL_OFFSET 0x04 | |
139 | #define CXLDEV_MBOX_CTRL_DOORBELL BIT(0) | |
140 | #define CXLDEV_MBOX_CMD_OFFSET 0x08 | |
141 | #define CXLDEV_MBOX_CMD_COMMAND_OPCODE_MASK GENMASK_ULL(15, 0) | |
142 | #define CXLDEV_MBOX_CMD_PAYLOAD_LENGTH_MASK GENMASK_ULL(36, 16) | |
143 | #define CXLDEV_MBOX_STATUS_OFFSET 0x10 | |
144 | #define CXLDEV_MBOX_STATUS_RET_CODE_MASK GENMASK_ULL(47, 32) | |
145 | #define CXLDEV_MBOX_BG_CMD_STATUS_OFFSET 0x18 | |
146 | #define CXLDEV_MBOX_PAYLOAD_OFFSET 0x20 | |
147 | ||
8ac75dd6 | 148 | /* |
301e68dd KC |
149 | * Using struct_group() allows for per register-block-type helper routines, |
150 | * without requiring block-type agnostic code to include the prefix. | |
8ac75dd6 DW |
151 | */ |
152 | struct cxl_regs { | |
301e68dd KC |
153 | /* |
154 | * Common set of CXL Component register block base pointers | |
155 | * @hdm_decoder: CXL 2.0 8.2.5.12 CXL HDM Decoder Capability Structure | |
156 | */ | |
157 | struct_group_tagged(cxl_component_regs, component, | |
158 | void __iomem *hdm_decoder; | |
159 | ); | |
160 | /* | |
161 | * Common set of CXL Device register block base pointers | |
162 | * @status: CXL 2.0 8.2.8.3 Device Status Registers | |
163 | * @mbox: CXL 2.0 8.2.8.4 Mailbox Registers | |
164 | * @memdev: CXL 2.0 8.2.8.5 Memory Device Registers | |
165 | */ | |
166 | struct_group_tagged(cxl_device_regs, device_regs, | |
167 | void __iomem *status, *mbox, *memdev; | |
168 | ); | |
8ac75dd6 DW |
169 | }; |
170 | ||
30af9729 IW |
171 | struct cxl_reg_map { |
172 | bool valid; | |
173 | unsigned long offset; | |
174 | unsigned long size; | |
175 | }; | |
176 | ||
08422378 BW |
177 | struct cxl_component_reg_map { |
178 | struct cxl_reg_map hdm_decoder; | |
179 | }; | |
180 | ||
30af9729 IW |
181 | struct cxl_device_reg_map { |
182 | struct cxl_reg_map status; | |
183 | struct cxl_reg_map mbox; | |
184 | struct cxl_reg_map memdev; | |
185 | }; | |
186 | ||
a261e9a1 DW |
187 | /** |
188 | * struct cxl_register_map - DVSEC harvested register block mapping parameters | |
189 | * @base: virtual base of the register-block-BAR + @block_offset | |
190 | * @block_offset: offset to start of register block in @barno | |
191 | * @reg_type: see enum cxl_regloc_type | |
192 | * @barno: PCI BAR number containing the register block | |
193 | * @component_map: cxl_reg_map for component registers | |
194 | * @device_map: cxl_reg_maps for device registers | |
195 | */ | |
30af9729 | 196 | struct cxl_register_map { |
a261e9a1 | 197 | void __iomem *base; |
30af9729 IW |
198 | u64 block_offset; |
199 | u8 reg_type; | |
200 | u8 barno; | |
201 | union { | |
08422378 | 202 | struct cxl_component_reg_map component_map; |
30af9729 IW |
203 | struct cxl_device_reg_map device_map; |
204 | }; | |
205 | }; | |
206 | ||
08422378 BW |
207 | void cxl_probe_component_regs(struct device *dev, void __iomem *base, |
208 | struct cxl_component_reg_map *map); | |
30af9729 IW |
209 | void cxl_probe_device_regs(struct device *dev, void __iomem *base, |
210 | struct cxl_device_reg_map *map); | |
08422378 BW |
211 | int cxl_map_component_regs(struct pci_dev *pdev, |
212 | struct cxl_component_regs *regs, | |
213 | struct cxl_register_map *map); | |
30af9729 IW |
214 | int cxl_map_device_regs(struct pci_dev *pdev, |
215 | struct cxl_device_regs *regs, | |
216 | struct cxl_register_map *map); | |
399d34eb | 217 | |
303ebc1b BW |
218 | enum cxl_regloc_type; |
219 | int cxl_find_regblock(struct pci_dev *pdev, enum cxl_regloc_type type, | |
220 | struct cxl_register_map *map); | |
54cdbf84 BW |
221 | void __iomem *devm_cxl_iomap_block(struct device *dev, resource_size_t addr, |
222 | resource_size_t length); | |
303ebc1b | 223 | |
4812be97 | 224 | #define CXL_RESOURCE_NONE ((resource_size_t) -1) |
7d4b5ca2 | 225 | #define CXL_TARGET_STRLEN 20 |
4812be97 | 226 | |
40ba17af DW |
227 | /* |
228 | * cxl_decoder flags that define the type of memory / devices this | |
229 | * decoder supports as well as configuration lock status See "CXL 2.0 | |
230 | * 8.2.5.12.7 CXL HDM Decoder 0 Control Register" for details. | |
231 | */ | |
232 | #define CXL_DECODER_F_RAM BIT(0) | |
233 | #define CXL_DECODER_F_PMEM BIT(1) | |
234 | #define CXL_DECODER_F_TYPE2 BIT(2) | |
235 | #define CXL_DECODER_F_TYPE3 BIT(3) | |
236 | #define CXL_DECODER_F_LOCK BIT(4) | |
d17d0540 DW |
237 | #define CXL_DECODER_F_ENABLE BIT(5) |
238 | #define CXL_DECODER_F_MASK GENMASK(5, 0) | |
40ba17af DW |
239 | |
240 | enum cxl_decoder_type { | |
241 | CXL_DECODER_ACCELERATOR = 2, | |
242 | CXL_DECODER_EXPANDER = 3, | |
243 | }; | |
244 | ||
a5c25802 DW |
245 | /* |
246 | * Current specification goes up to 8, double that seems a reasonable | |
247 | * software max for the foreseeable future | |
248 | */ | |
249 | #define CXL_DECODER_MAX_INTERLEAVE 16 | |
250 | ||
40ba17af | 251 | /** |
e636479e | 252 | * struct cxl_decoder - Common CXL HDM Decoder Attributes |
40ba17af DW |
253 | * @dev: this decoder's device |
254 | * @id: kernel device name id | |
e8b7ea58 | 255 | * @hpa_range: Host physical address range mapped by this decoder |
40ba17af DW |
256 | * @interleave_ways: number of cxl_dports in this decode |
257 | * @interleave_granularity: data stride per dport | |
258 | * @target_type: accelerator vs expander (type2 vs type3) selector | |
b9686e8c | 259 | * @region: currently assigned region for this decoder |
40ba17af | 260 | * @flags: memory type capabilities and locking |
176baefb DW |
261 | * @commit: device/decoder-type specific callback to commit settings to hw |
262 | * @reset: device/decoder-type specific callback to reset hw settings | |
263 | */ | |
40ba17af DW |
264 | struct cxl_decoder { |
265 | struct device dev; | |
266 | int id; | |
e50fe01e | 267 | struct range hpa_range; |
40ba17af DW |
268 | int interleave_ways; |
269 | int interleave_granularity; | |
270 | enum cxl_decoder_type target_type; | |
b9686e8c | 271 | struct cxl_region *region; |
40ba17af | 272 | unsigned long flags; |
176baefb DW |
273 | int (*commit)(struct cxl_decoder *cxld); |
274 | int (*reset)(struct cxl_decoder *cxld); | |
e636479e DW |
275 | }; |
276 | ||
b9686e8c DW |
277 | /* |
278 | * CXL_DECODER_DEAD prevents endpoints from being reattached to regions | |
279 | * while cxld_unregister() is running | |
280 | */ | |
2c866903 DW |
281 | enum cxl_decoder_mode { |
282 | CXL_DECODER_NONE, | |
283 | CXL_DECODER_RAM, | |
284 | CXL_DECODER_PMEM, | |
285 | CXL_DECODER_MIXED, | |
b9686e8c | 286 | CXL_DECODER_DEAD, |
2c866903 DW |
287 | }; |
288 | ||
3bf65915 DW |
289 | /** |
290 | * struct cxl_endpoint_decoder - Endpoint / SPA to DPA decoder | |
291 | * @cxld: base cxl_decoder_object | |
292 | * @dpa_res: actively claimed DPA span of this decoder | |
293 | * @skip: offset into @dpa_res where @cxld.hpa_range maps | |
2c866903 | 294 | * @mode: which memory type / access-mode-partition this decoder targets |
b9686e8c | 295 | * @pos: interleave position in @cxld.region |
3bf65915 DW |
296 | */ |
297 | struct cxl_endpoint_decoder { | |
298 | struct cxl_decoder cxld; | |
299 | struct resource *dpa_res; | |
300 | resource_size_t skip; | |
2c866903 | 301 | enum cxl_decoder_mode mode; |
b9686e8c | 302 | int pos; |
3bf65915 DW |
303 | }; |
304 | ||
e636479e DW |
305 | /** |
306 | * struct cxl_switch_decoder - Switch specific CXL HDM Decoder | |
307 | * @cxld: base cxl_decoder object | |
308 | * @target_lock: coordinate coherent reads of the target list | |
309 | * @nr_targets: number of elements in @target | |
310 | * @target: active ordered target list in current decoder configuration | |
311 | * | |
312 | * The 'switch' decoder type represents the decoder instances of cxl_port's that | |
313 | * route from the root of a CXL memory decode topology to the endpoints. They | |
314 | * come in two flavors, root-level decoders, statically defined by platform | |
315 | * firmware, and mid-level decoders, where interleave-granularity, | |
316 | * interleave-width, and the target list are mutable. | |
317 | */ | |
318 | struct cxl_switch_decoder { | |
319 | struct cxl_decoder cxld; | |
86c8ea0f | 320 | seqlock_t target_lock; |
be185c29 | 321 | int nr_targets; |
40ba17af DW |
322 | struct cxl_dport *target[]; |
323 | }; | |
324 | ||
8fdcb170 | 325 | |
0f157c7f DW |
326 | /** |
327 | * struct cxl_root_decoder - Static platform CXL address decoder | |
328 | * @res: host / parent resource for region allocations | |
779dd20c | 329 | * @region_id: region id for next region provisioning event |
6aa41144 | 330 | * @calc_hb: which host bridge covers the n'th position by granularity |
0f157c7f DW |
331 | * @cxlsd: base cxl switch decoder |
332 | */ | |
333 | struct cxl_root_decoder { | |
334 | struct resource *res; | |
779dd20c | 335 | atomic_t region_id; |
6aa41144 | 336 | struct cxl_dport *(*calc_hb)(struct cxl_root_decoder *cxlrd, int pos); |
0f157c7f DW |
337 | struct cxl_switch_decoder cxlsd; |
338 | }; | |
339 | ||
dd5ba0eb BW |
340 | /* |
341 | * enum cxl_config_state - State machine for region configuration | |
342 | * @CXL_CONFIG_IDLE: Any sysfs attribute can be written freely | |
80d10a6c BW |
343 | * @CXL_CONFIG_INTERLEAVE_ACTIVE: region size has been set, no more |
344 | * changes to interleave_ways or interleave_granularity | |
dd5ba0eb BW |
345 | * @CXL_CONFIG_ACTIVE: All targets have been added the region is now |
346 | * active | |
176baefb DW |
347 | * @CXL_CONFIG_RESET_PENDING: see commit_store() |
348 | * @CXL_CONFIG_COMMIT: Soft-config has been committed to hardware | |
dd5ba0eb BW |
349 | */ |
350 | enum cxl_config_state { | |
351 | CXL_CONFIG_IDLE, | |
80d10a6c | 352 | CXL_CONFIG_INTERLEAVE_ACTIVE, |
dd5ba0eb | 353 | CXL_CONFIG_ACTIVE, |
176baefb DW |
354 | CXL_CONFIG_RESET_PENDING, |
355 | CXL_CONFIG_COMMIT, | |
dd5ba0eb BW |
356 | }; |
357 | ||
358 | /** | |
359 | * struct cxl_region_params - region settings | |
360 | * @state: allow the driver to lockdown further parameter changes | |
361 | * @uuid: unique id for persistent regions | |
80d10a6c BW |
362 | * @interleave_ways: number of endpoints in the region |
363 | * @interleave_granularity: capacity each endpoint contributes to a stripe | |
23a22cd1 | 364 | * @res: allocated iomem capacity for this region |
dd5ba0eb BW |
365 | * |
366 | * State transitions are protected by the cxl_region_rwsem | |
367 | */ | |
368 | struct cxl_region_params { | |
369 | enum cxl_config_state state; | |
370 | uuid_t uuid; | |
80d10a6c BW |
371 | int interleave_ways; |
372 | int interleave_granularity; | |
23a22cd1 | 373 | struct resource *res; |
b9686e8c DW |
374 | struct cxl_endpoint_decoder *targets[CXL_DECODER_MAX_INTERLEAVE]; |
375 | int nr_targets; | |
dd5ba0eb BW |
376 | }; |
377 | ||
779dd20c BW |
378 | /** |
379 | * struct cxl_region - CXL region | |
380 | * @dev: This region's device | |
381 | * @id: This region's id. Id is globally unique across all regions | |
382 | * @mode: Endpoint decoder allocation / access mode | |
383 | * @type: Endpoint decoder target type | |
dd5ba0eb | 384 | * @params: active + config params for the region |
779dd20c BW |
385 | */ |
386 | struct cxl_region { | |
387 | struct device dev; | |
388 | int id; | |
389 | enum cxl_decoder_mode mode; | |
390 | enum cxl_decoder_type type; | |
dd5ba0eb | 391 | struct cxl_region_params params; |
779dd20c BW |
392 | }; |
393 | ||
53989fad DW |
394 | /** |
395 | * enum cxl_nvdimm_brige_state - state machine for managing bus rescans | |
396 | * @CXL_NVB_NEW: Set at bridge create and after cxl_pmem_wq is destroyed | |
397 | * @CXL_NVB_DEAD: Set at brige unregistration to preclude async probing | |
398 | * @CXL_NVB_ONLINE: Target state after successful ->probe() | |
399 | * @CXL_NVB_OFFLINE: Target state after ->remove() or failed ->probe() | |
400 | */ | |
8fdcb170 DW |
401 | enum cxl_nvdimm_brige_state { |
402 | CXL_NVB_NEW, | |
403 | CXL_NVB_DEAD, | |
404 | CXL_NVB_ONLINE, | |
405 | CXL_NVB_OFFLINE, | |
406 | }; | |
407 | ||
408 | struct cxl_nvdimm_bridge { | |
2e52b625 | 409 | int id; |
8fdcb170 DW |
410 | struct device dev; |
411 | struct cxl_port *port; | |
412 | struct nvdimm_bus *nvdimm_bus; | |
413 | struct nvdimm_bus_descriptor nd_desc; | |
414 | struct work_struct state_work; | |
415 | enum cxl_nvdimm_brige_state state; | |
416 | }; | |
417 | ||
21083f51 DW |
418 | struct cxl_nvdimm { |
419 | struct device dev; | |
420 | struct cxl_memdev *cxlmd; | |
21083f51 DW |
421 | }; |
422 | ||
4812be97 DW |
423 | /** |
424 | * struct cxl_port - logical collection of upstream port devices and | |
425 | * downstream port devices to construct a CXL memory | |
426 | * decode hierarchy. | |
427 | * @dev: this port's device | |
428 | * @uport: PCI or platform device implementing the upstream port capability | |
ee800010 | 429 | * @host_bridge: Shortcut to the platform attach point for this port |
4812be97 | 430 | * @id: id for port device-name |
7d4b5ca2 | 431 | * @dports: cxl_dport instances referenced by decoders |
2703c16c | 432 | * @endpoints: cxl_ep instances, endpoints that are a descendant of this port |
384e624b | 433 | * @regions: cxl_region_ref instances, regions mapped by this port |
1b58b4ca | 434 | * @parent_dport: dport that points to this port in the parent |
40ba17af | 435 | * @decoder_ida: allocator for decoder ids |
0c33b393 | 436 | * @hdm_end: track last allocated HDM decoder instance for allocation ordering |
176baefb | 437 | * @commit_end: cursor to track highest committed decoder for commit ordering |
4812be97 | 438 | * @component_reg_phys: component register capability base address (optional) |
2703c16c | 439 | * @dead: last ep has been removed, force port re-creation |
53fa1bff | 440 | * @depth: How deep this port is relative to the root. depth 0 is the root. |
c9700604 IW |
441 | * @cdat: Cached CDAT data |
442 | * @cdat_available: Should a CDAT attribute be available in sysfs | |
4812be97 DW |
443 | */ |
444 | struct cxl_port { | |
445 | struct device dev; | |
446 | struct device *uport; | |
ee800010 | 447 | struct device *host_bridge; |
4812be97 | 448 | int id; |
39178585 | 449 | struct xarray dports; |
256d0e9e | 450 | struct xarray endpoints; |
384e624b | 451 | struct xarray regions; |
1b58b4ca | 452 | struct cxl_dport *parent_dport; |
40ba17af | 453 | struct ida decoder_ida; |
0c33b393 | 454 | int hdm_end; |
176baefb | 455 | int commit_end; |
4812be97 | 456 | resource_size_t component_reg_phys; |
2703c16c | 457 | bool dead; |
53fa1bff | 458 | unsigned int depth; |
c9700604 IW |
459 | struct cxl_cdat { |
460 | void *table; | |
461 | size_t length; | |
462 | } cdat; | |
463 | bool cdat_available; | |
4812be97 DW |
464 | }; |
465 | ||
39178585 DW |
466 | static inline struct cxl_dport * |
467 | cxl_find_dport_by_dev(struct cxl_port *port, const struct device *dport_dev) | |
468 | { | |
469 | return xa_load(&port->dports, (unsigned long)dport_dev); | |
470 | } | |
471 | ||
7d4b5ca2 DW |
472 | /** |
473 | * struct cxl_dport - CXL downstream port | |
474 | * @dport: PCI bridge or firmware device representing the downstream link | |
475 | * @port_id: unique hardware identifier for dport in decoder target list | |
476 | * @component_reg_phys: downstream port component registers | |
477 | * @port: reference to cxl_port that contains this downstream port | |
7d4b5ca2 DW |
478 | */ |
479 | struct cxl_dport { | |
480 | struct device *dport; | |
481 | int port_id; | |
482 | resource_size_t component_reg_phys; | |
483 | struct cxl_port *port; | |
7d4b5ca2 DW |
484 | }; |
485 | ||
2703c16c DW |
486 | /** |
487 | * struct cxl_ep - track an endpoint's interest in a port | |
488 | * @ep: device that hosts a generic CXL endpoint (expander or accelerator) | |
de516b40 | 489 | * @dport: which dport routes to this endpoint on @port |
7f8faf96 DW |
490 | * @next: cxl switch port across the link attached to @dport NULL if |
491 | * attached to an endpoint | |
2703c16c DW |
492 | */ |
493 | struct cxl_ep { | |
494 | struct device *ep; | |
de516b40 | 495 | struct cxl_dport *dport; |
7f8faf96 | 496 | struct cxl_port *next; |
2703c16c DW |
497 | }; |
498 | ||
384e624b DW |
499 | /** |
500 | * struct cxl_region_ref - track a region's interest in a port | |
501 | * @port: point in topology to install this reference | |
502 | * @decoder: decoder assigned for @region in @port | |
503 | * @region: region for this reference | |
504 | * @endpoints: cxl_ep references for region members beneath @port | |
27b3f8d1 | 505 | * @nr_targets_set: track how many targets have been programmed during setup |
384e624b DW |
506 | * @nr_eps: number of endpoints beneath @port |
507 | * @nr_targets: number of distinct targets needed to reach @nr_eps | |
508 | */ | |
509 | struct cxl_region_ref { | |
510 | struct cxl_port *port; | |
511 | struct cxl_decoder *decoder; | |
512 | struct cxl_region *region; | |
513 | struct xarray endpoints; | |
27b3f8d1 | 514 | int nr_targets_set; |
384e624b DW |
515 | int nr_eps; |
516 | int nr_targets; | |
517 | }; | |
518 | ||
d54c1bbe BW |
519 | /* |
520 | * The platform firmware device hosting the root is also the top of the | |
521 | * CXL port topology. All other CXL ports have another CXL port as their | |
522 | * parent and their ->uport / host device is out-of-line of the port | |
523 | * ancestry. | |
524 | */ | |
525 | static inline bool is_cxl_root(struct cxl_port *port) | |
526 | { | |
527 | return port->uport == port->dev.parent; | |
528 | } | |
529 | ||
3c5b9039 | 530 | bool is_cxl_port(struct device *dev); |
4812be97 | 531 | struct cxl_port *to_cxl_port(struct device *dev); |
98d2d3a2 | 532 | struct pci_bus; |
5ff7316f DW |
533 | int devm_cxl_register_pci_bus(struct device *host, struct device *uport, |
534 | struct pci_bus *bus); | |
535 | struct pci_bus *cxl_port_to_pci_bus(struct cxl_port *port); | |
4812be97 DW |
536 | struct cxl_port *devm_cxl_add_port(struct device *host, struct device *uport, |
537 | resource_size_t component_reg_phys, | |
1b58b4ca | 538 | struct cxl_dport *parent_dport); |
7f8faf96 DW |
539 | int devm_cxl_add_endpoint(struct cxl_memdev *cxlmd, |
540 | struct cxl_dport *parent_dport); | |
a46cfc0f | 541 | struct cxl_port *find_cxl_root(struct device *dev); |
2703c16c | 542 | int devm_cxl_enumerate_ports(struct cxl_memdev *cxlmd); |
8dd2bc0f | 543 | int cxl_bus_rescan(void); |
1b58b4ca DW |
544 | struct cxl_port *cxl_mem_find_port(struct cxl_memdev *cxlmd, |
545 | struct cxl_dport **dport); | |
8dd2bc0f | 546 | bool schedule_cxl_memdev_detach(struct cxl_memdev *cxlmd); |
2703c16c | 547 | |
664bf115 | 548 | struct cxl_dport *devm_cxl_add_dport(struct cxl_port *port, |
98d2d3a2 DW |
549 | struct device *dport, int port_id, |
550 | resource_size_t component_reg_phys); | |
2703c16c | 551 | |
40ba17af | 552 | struct cxl_decoder *to_cxl_decoder(struct device *dev); |
0f157c7f | 553 | struct cxl_root_decoder *to_cxl_root_decoder(struct device *dev); |
3bf65915 | 554 | struct cxl_endpoint_decoder *to_cxl_endpoint_decoder(struct device *dev); |
8fdcb170 | 555 | bool is_root_decoder(struct device *dev); |
8ae3cebc | 556 | bool is_endpoint_decoder(struct device *dev); |
0f157c7f DW |
557 | struct cxl_root_decoder *cxl_root_decoder_alloc(struct cxl_port *port, |
558 | unsigned int nr_targets); | |
e636479e DW |
559 | struct cxl_switch_decoder *cxl_switch_decoder_alloc(struct cxl_port *port, |
560 | unsigned int nr_targets); | |
48667f67 | 561 | int cxl_decoder_add(struct cxl_decoder *cxld, int *target_map); |
3bf65915 | 562 | struct cxl_endpoint_decoder *cxl_endpoint_decoder_alloc(struct cxl_port *port); |
d17d0540 | 563 | int cxl_decoder_add_locked(struct cxl_decoder *cxld, int *target_map); |
48667f67 | 564 | int cxl_decoder_autoremove(struct device *host, struct cxl_decoder *cxld); |
8dd2bc0f BW |
565 | int cxl_endpoint_autoremove(struct cxl_memdev *cxlmd, struct cxl_port *endpoint); |
566 | ||
d17d0540 | 567 | struct cxl_hdm; |
664bf115 DW |
568 | struct cxl_hdm *devm_cxl_setup_hdm(struct cxl_port *port); |
569 | int devm_cxl_enumerate_decoders(struct cxl_hdm *cxlhdm); | |
570 | int devm_cxl_add_passthrough_decoder(struct cxl_port *port); | |
40ba17af | 571 | |
779dd20c BW |
572 | bool is_cxl_region(struct device *dev); |
573 | ||
b39cb105 | 574 | extern struct bus_type cxl_bus_type; |
6af7139c DW |
575 | |
576 | struct cxl_driver { | |
577 | const char *name; | |
578 | int (*probe)(struct device *dev); | |
579 | void (*remove)(struct device *dev); | |
580 | struct device_driver drv; | |
581 | int id; | |
582 | }; | |
583 | ||
584 | static inline struct cxl_driver *to_cxl_drv(struct device_driver *drv) | |
585 | { | |
586 | return container_of(drv, struct cxl_driver, drv); | |
587 | } | |
588 | ||
589 | int __cxl_driver_register(struct cxl_driver *cxl_drv, struct module *owner, | |
590 | const char *modname); | |
591 | #define cxl_driver_register(x) __cxl_driver_register(x, THIS_MODULE, KBUILD_MODNAME) | |
592 | void cxl_driver_unregister(struct cxl_driver *cxl_drv); | |
593 | ||
c57cae78 BW |
594 | #define module_cxl_driver(__cxl_driver) \ |
595 | module_driver(__cxl_driver, cxl_driver_register, cxl_driver_unregister) | |
596 | ||
21083f51 DW |
597 | #define CXL_DEVICE_NVDIMM_BRIDGE 1 |
598 | #define CXL_DEVICE_NVDIMM 2 | |
54cdbf84 BW |
599 | #define CXL_DEVICE_PORT 3 |
600 | #define CXL_DEVICE_ROOT 4 | |
8dd2bc0f | 601 | #define CXL_DEVICE_MEMORY_EXPANDER 5 |
8fdcb170 | 602 | |
6af7139c DW |
603 | #define MODULE_ALIAS_CXL(type) MODULE_ALIAS("cxl:t" __stringify(type) "*") |
604 | #define CXL_MODALIAS_FMT "cxl:t%d" | |
605 | ||
8fdcb170 DW |
606 | struct cxl_nvdimm_bridge *to_cxl_nvdimm_bridge(struct device *dev); |
607 | struct cxl_nvdimm_bridge *devm_cxl_add_nvdimm_bridge(struct device *host, | |
608 | struct cxl_port *port); | |
21083f51 DW |
609 | struct cxl_nvdimm *to_cxl_nvdimm(struct device *dev); |
610 | bool is_cxl_nvdimm(struct device *dev); | |
53989fad | 611 | bool is_cxl_nvdimm_bridge(struct device *dev); |
21083f51 | 612 | int devm_cxl_add_nvdimm(struct device *host, struct cxl_memdev *cxlmd); |
7d3eb23c | 613 | struct cxl_nvdimm_bridge *cxl_find_nvdimm_bridge(struct cxl_nvdimm *cxl_nvd); |
67dcdd4d DW |
614 | |
615 | /* | |
616 | * Unit test builds overrides this to __weak, find the 'strong' version | |
617 | * of these symbols in tools/testing/cxl/. | |
618 | */ | |
619 | #ifndef __mock | |
620 | #define __mock static | |
621 | #endif | |
3c5b9039 | 622 | |
8adaf747 | 623 | #endif /* __CXL_H__ */ |