1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* Copyright(c) 2020 Intel Corporation. */ 3 4 #ifndef __CXL_H__ 5 #define __CXL_H__ 6 7 #include <linux/libnvdimm.h> 8 #include <linux/bitfield.h> 9 #include <linux/notifier.h> 10 #include <linux/bitops.h> 11 #include <linux/log2.h> 12 #include <linux/node.h> 13 #include <linux/io.h> 14 #include <linux/range.h> 15 16 extern const struct nvdimm_security_ops *cxl_security_ops; 17 18 /** 19 * DOC: cxl objects 20 * 21 * The CXL core objects like ports, decoders, and regions are shared 22 * between the subsystem drivers cxl_acpi, cxl_pci, and core drivers 23 * (port-driver, region-driver, nvdimm object-drivers... etc). 24 */ 25 26 /* CXL 2.0 8.2.4 CXL Component Register Layout and Definition */ 27 #define CXL_COMPONENT_REG_BLOCK_SIZE SZ_64K 28 29 /* CXL 2.0 8.2.5 CXL.cache and CXL.mem Registers*/ 30 #define CXL_CM_OFFSET 0x1000 31 #define CXL_CM_CAP_HDR_OFFSET 0x0 32 #define CXL_CM_CAP_HDR_ID_MASK GENMASK(15, 0) 33 #define CM_CAP_HDR_CAP_ID 1 34 #define CXL_CM_CAP_HDR_VERSION_MASK GENMASK(19, 16) 35 #define CM_CAP_HDR_CAP_VERSION 1 36 #define CXL_CM_CAP_HDR_CACHE_MEM_VERSION_MASK GENMASK(23, 20) 37 #define CM_CAP_HDR_CACHE_MEM_VERSION 1 38 #define CXL_CM_CAP_HDR_ARRAY_SIZE_MASK GENMASK(31, 24) 39 #define CXL_CM_CAP_PTR_MASK GENMASK(31, 20) 40 41 #define CXL_CM_CAP_CAP_ID_RAS 0x2 42 #define CXL_CM_CAP_CAP_ID_HDM 0x5 43 #define CXL_CM_CAP_CAP_HDM_VERSION 1 44 45 /* HDM decoders CXL 2.0 8.2.5.12 CXL HDM Decoder Capability Structure */ 46 #define CXL_HDM_DECODER_CAP_OFFSET 0x0 47 #define CXL_HDM_DECODER_COUNT_MASK GENMASK(3, 0) 48 #define CXL_HDM_DECODER_TARGET_COUNT_MASK GENMASK(7, 4) 49 #define CXL_HDM_DECODER_INTERLEAVE_11_8 BIT(8) 50 #define CXL_HDM_DECODER_INTERLEAVE_14_12 BIT(9) 51 #define CXL_HDM_DECODER_INTERLEAVE_3_6_12_WAY BIT(11) 52 #define CXL_HDM_DECODER_INTERLEAVE_16_WAY BIT(12) 53 #define CXL_HDM_DECODER_CTRL_OFFSET 0x4 54 #define CXL_HDM_DECODER_ENABLE BIT(1) 55 #define CXL_HDM_DECODER0_BASE_LOW_OFFSET(i) (0x20 * (i) + 0x10) 56 #define CXL_HDM_DECODER0_BASE_HIGH_OFFSET(i) (0x20 * (i) + 0x14) 57 #define CXL_HDM_DECODER0_SIZE_LOW_OFFSET(i) (0x20 * (i) + 0x18) 58 #define CXL_HDM_DECODER0_SIZE_HIGH_OFFSET(i) (0x20 * (i) + 0x1c) 59 #define CXL_HDM_DECODER0_CTRL_OFFSET(i) (0x20 * (i) + 0x20) 60 #define CXL_HDM_DECODER0_CTRL_IG_MASK GENMASK(3, 0) 61 #define CXL_HDM_DECODER0_CTRL_IW_MASK GENMASK(7, 4) 62 #define CXL_HDM_DECODER0_CTRL_LOCK BIT(8) 63 #define CXL_HDM_DECODER0_CTRL_COMMIT BIT(9) 64 #define CXL_HDM_DECODER0_CTRL_COMMITTED BIT(10) 65 #define CXL_HDM_DECODER0_CTRL_COMMIT_ERROR BIT(11) 66 #define CXL_HDM_DECODER0_CTRL_HOSTONLY BIT(12) 67 #define CXL_HDM_DECODER0_TL_LOW(i) (0x20 * (i) + 0x24) 68 #define CXL_HDM_DECODER0_TL_HIGH(i) (0x20 * (i) + 0x28) 69 #define CXL_HDM_DECODER0_SKIP_LOW(i) CXL_HDM_DECODER0_TL_LOW(i) 70 #define CXL_HDM_DECODER0_SKIP_HIGH(i) CXL_HDM_DECODER0_TL_HIGH(i) 71 72 /* HDM decoder control register constants CXL 3.0 8.2.5.19.7 */ 73 #define CXL_DECODER_MIN_GRANULARITY 256 74 #define CXL_DECODER_MAX_ENCODED_IG 6 75 76 static inline int cxl_hdm_decoder_count(u32 cap_hdr) 77 { 78 int val = FIELD_GET(CXL_HDM_DECODER_COUNT_MASK, cap_hdr); 79 80 return val ? val * 2 : 1; 81 } 82 83 /* Encode defined in CXL 2.0 8.2.5.12.7 HDM Decoder Control Register */ 84 static inline int eig_to_granularity(u16 eig, unsigned int *granularity) 85 { 86 if (eig > CXL_DECODER_MAX_ENCODED_IG) 87 return -EINVAL; 88 *granularity = CXL_DECODER_MIN_GRANULARITY << eig; 89 return 0; 90 } 91 92 /* Encode defined in CXL ECN "3, 6, 12 and 16-way memory Interleaving" */ 93 static inline int eiw_to_ways(u8 eiw, unsigned int *ways) 94 { 95 switch (eiw) { 96 case 0 ... 4: 97 *ways = 1 << eiw; 98 break; 99 case 8 ... 10: 100 *ways = 3 << (eiw - 8); 101 break; 102 default: 103 return -EINVAL; 104 } 105 106 return 0; 107 } 108 109 static inline int granularity_to_eig(int granularity, u16 *eig) 110 { 111 if (granularity > SZ_16K || granularity < CXL_DECODER_MIN_GRANULARITY || 112 !is_power_of_2(granularity)) 113 return -EINVAL; 114 *eig = ilog2(granularity) - 8; 115 return 0; 116 } 117 118 static inline int ways_to_eiw(unsigned int ways, u8 *eiw) 119 { 120 if (ways > 16) 121 return -EINVAL; 122 if (is_power_of_2(ways)) { 123 *eiw = ilog2(ways); 124 return 0; 125 } 126 if (ways % 3) 127 return -EINVAL; 128 ways /= 3; 129 if (!is_power_of_2(ways)) 130 return -EINVAL; 131 *eiw = ilog2(ways) + 8; 132 return 0; 133 } 134 135 /* RAS Registers CXL 2.0 8.2.5.9 CXL RAS Capability Structure */ 136 #define CXL_RAS_UNCORRECTABLE_STATUS_OFFSET 0x0 137 #define CXL_RAS_UNCORRECTABLE_STATUS_MASK (GENMASK(16, 14) | GENMASK(11, 0)) 138 #define CXL_RAS_UNCORRECTABLE_MASK_OFFSET 0x4 139 #define CXL_RAS_UNCORRECTABLE_MASK_MASK (GENMASK(16, 14) | GENMASK(11, 0)) 140 #define CXL_RAS_UNCORRECTABLE_MASK_F256B_MASK BIT(8) 141 #define CXL_RAS_UNCORRECTABLE_SEVERITY_OFFSET 0x8 142 #define CXL_RAS_UNCORRECTABLE_SEVERITY_MASK (GENMASK(16, 14) | GENMASK(11, 0)) 143 #define CXL_RAS_CORRECTABLE_STATUS_OFFSET 0xC 144 #define CXL_RAS_CORRECTABLE_STATUS_MASK GENMASK(6, 0) 145 #define CXL_RAS_CORRECTABLE_MASK_OFFSET 0x10 146 #define CXL_RAS_CORRECTABLE_MASK_MASK GENMASK(6, 0) 147 #define CXL_RAS_CAP_CONTROL_OFFSET 0x14 148 #define CXL_RAS_CAP_CONTROL_FE_MASK GENMASK(5, 0) 149 #define CXL_RAS_HEADER_LOG_OFFSET 0x18 150 #define CXL_RAS_CAPABILITY_LENGTH 0x58 151 #define CXL_HEADERLOG_SIZE SZ_512 152 #define CXL_HEADERLOG_SIZE_U32 SZ_512 / sizeof(u32) 153 154 /* CXL 2.0 8.2.8.1 Device Capabilities Array Register */ 155 #define CXLDEV_CAP_ARRAY_OFFSET 0x0 156 #define CXLDEV_CAP_ARRAY_CAP_ID 0 157 #define CXLDEV_CAP_ARRAY_ID_MASK GENMASK_ULL(15, 0) 158 #define CXLDEV_CAP_ARRAY_COUNT_MASK GENMASK_ULL(47, 32) 159 /* CXL 2.0 8.2.8.2 CXL Device Capability Header Register */ 160 #define CXLDEV_CAP_HDR_CAP_ID_MASK GENMASK(15, 0) 161 /* CXL 2.0 8.2.8.2.1 CXL Device Capabilities */ 162 #define CXLDEV_CAP_CAP_ID_DEVICE_STATUS 0x1 163 #define CXLDEV_CAP_CAP_ID_PRIMARY_MAILBOX 0x2 164 #define CXLDEV_CAP_CAP_ID_SECONDARY_MAILBOX 0x3 165 #define CXLDEV_CAP_CAP_ID_MEMDEV 0x4000 166 167 /* CXL 3.0 8.2.8.3.1 Event Status Register */ 168 #define CXLDEV_DEV_EVENT_STATUS_OFFSET 0x00 169 #define CXLDEV_EVENT_STATUS_INFO BIT(0) 170 #define CXLDEV_EVENT_STATUS_WARN BIT(1) 171 #define CXLDEV_EVENT_STATUS_FAIL BIT(2) 172 #define CXLDEV_EVENT_STATUS_FATAL BIT(3) 173 174 #define CXLDEV_EVENT_STATUS_ALL (CXLDEV_EVENT_STATUS_INFO | \ 175 CXLDEV_EVENT_STATUS_WARN | \ 176 CXLDEV_EVENT_STATUS_FAIL | \ 177 CXLDEV_EVENT_STATUS_FATAL) 178 179 /* CXL rev 3.0 section 8.2.9.2.4; Table 8-52 */ 180 #define CXLDEV_EVENT_INT_MODE_MASK GENMASK(1, 0) 181 #define CXLDEV_EVENT_INT_MSGNUM_MASK GENMASK(7, 4) 182 183 /* CXL 2.0 8.2.8.4 Mailbox Registers */ 184 #define CXLDEV_MBOX_CAPS_OFFSET 0x00 185 #define CXLDEV_MBOX_CAP_PAYLOAD_SIZE_MASK GENMASK(4, 0) 186 #define CXLDEV_MBOX_CAP_BG_CMD_IRQ BIT(6) 187 #define CXLDEV_MBOX_CAP_IRQ_MSGNUM_MASK GENMASK(10, 7) 188 #define CXLDEV_MBOX_CTRL_OFFSET 0x04 189 #define CXLDEV_MBOX_CTRL_DOORBELL BIT(0) 190 #define CXLDEV_MBOX_CTRL_BG_CMD_IRQ BIT(2) 191 #define CXLDEV_MBOX_CMD_OFFSET 0x08 192 #define CXLDEV_MBOX_CMD_COMMAND_OPCODE_MASK GENMASK_ULL(15, 0) 193 #define CXLDEV_MBOX_CMD_PAYLOAD_LENGTH_MASK GENMASK_ULL(36, 16) 194 #define CXLDEV_MBOX_STATUS_OFFSET 0x10 195 #define CXLDEV_MBOX_STATUS_BG_CMD BIT(0) 196 #define CXLDEV_MBOX_STATUS_RET_CODE_MASK GENMASK_ULL(47, 32) 197 #define CXLDEV_MBOX_BG_CMD_STATUS_OFFSET 0x18 198 #define CXLDEV_MBOX_BG_CMD_COMMAND_OPCODE_MASK GENMASK_ULL(15, 0) 199 #define CXLDEV_MBOX_BG_CMD_COMMAND_PCT_MASK GENMASK_ULL(22, 16) 200 #define CXLDEV_MBOX_BG_CMD_COMMAND_RC_MASK GENMASK_ULL(47, 32) 201 #define CXLDEV_MBOX_BG_CMD_COMMAND_VENDOR_MASK GENMASK_ULL(63, 48) 202 #define CXLDEV_MBOX_PAYLOAD_OFFSET 0x20 203 204 /* 205 * Using struct_group() allows for per register-block-type helper routines, 206 * without requiring block-type agnostic code to include the prefix. 207 */ 208 struct cxl_regs { 209 /* 210 * Common set of CXL Component register block base pointers 211 * @hdm_decoder: CXL 2.0 8.2.5.12 CXL HDM Decoder Capability Structure 212 * @ras: CXL 2.0 8.2.5.9 CXL RAS Capability Structure 213 */ 214 struct_group_tagged(cxl_component_regs, component, 215 void __iomem *hdm_decoder; 216 void __iomem *ras; 217 ); 218 /* 219 * Common set of CXL Device register block base pointers 220 * @status: CXL 2.0 8.2.8.3 Device Status Registers 221 * @mbox: CXL 2.0 8.2.8.4 Mailbox Registers 222 * @memdev: CXL 2.0 8.2.8.5 Memory Device Registers 223 */ 224 struct_group_tagged(cxl_device_regs, device_regs, 225 void __iomem *status, *mbox, *memdev; 226 ); 227 228 struct_group_tagged(cxl_pmu_regs, pmu_regs, 229 void __iomem *pmu; 230 ); 231 232 /* 233 * RCH downstream port specific RAS register 234 * @aer: CXL 3.0 8.2.1.1 RCH Downstream Port RCRB 235 */ 236 struct_group_tagged(cxl_rch_regs, rch_regs, 237 void __iomem *dport_aer; 238 ); 239 240 /* 241 * RCD upstream port specific PCIe cap register 242 * @pcie_cap: CXL 3.0 8.2.1.2 RCD Upstream Port RCRB 243 */ 244 struct_group_tagged(cxl_rcd_regs, rcd_regs, 245 void __iomem *rcd_pcie_cap; 246 ); 247 }; 248 249 struct cxl_reg_map { 250 bool valid; 251 int id; 252 unsigned long offset; 253 unsigned long size; 254 }; 255 256 struct cxl_component_reg_map { 257 struct cxl_reg_map hdm_decoder; 258 struct cxl_reg_map ras; 259 }; 260 261 struct cxl_device_reg_map { 262 struct cxl_reg_map status; 263 struct cxl_reg_map mbox; 264 struct cxl_reg_map memdev; 265 }; 266 267 struct cxl_pmu_reg_map { 268 struct cxl_reg_map pmu; 269 }; 270 271 /** 272 * struct cxl_register_map - DVSEC harvested register block mapping parameters 273 * @host: device for devm operations and logging 274 * @base: virtual base of the register-block-BAR + @block_offset 275 * @resource: physical resource base of the register block 276 * @max_size: maximum mapping size to perform register search 277 * @reg_type: see enum cxl_regloc_type 278 * @component_map: cxl_reg_map for component registers 279 * @device_map: cxl_reg_maps for device registers 280 * @pmu_map: cxl_reg_maps for CXL Performance Monitoring Units 281 */ 282 struct cxl_register_map { 283 struct device *host; 284 void __iomem *base; 285 resource_size_t resource; 286 resource_size_t max_size; 287 u8 reg_type; 288 union { 289 struct cxl_component_reg_map component_map; 290 struct cxl_device_reg_map device_map; 291 struct cxl_pmu_reg_map pmu_map; 292 }; 293 }; 294 295 void cxl_probe_component_regs(struct device *dev, void __iomem *base, 296 struct cxl_component_reg_map *map); 297 void cxl_probe_device_regs(struct device *dev, void __iomem *base, 298 struct cxl_device_reg_map *map); 299 int cxl_map_component_regs(const struct cxl_register_map *map, 300 struct cxl_component_regs *regs, 301 unsigned long map_mask); 302 int cxl_map_device_regs(const struct cxl_register_map *map, 303 struct cxl_device_regs *regs); 304 int cxl_map_pmu_regs(struct cxl_register_map *map, struct cxl_pmu_regs *regs); 305 306 #define CXL_INSTANCES_COUNT -1 307 enum cxl_regloc_type; 308 int cxl_count_regblock(struct pci_dev *pdev, enum cxl_regloc_type type); 309 int cxl_find_regblock_instance(struct pci_dev *pdev, enum cxl_regloc_type type, 310 struct cxl_register_map *map, unsigned int index); 311 int cxl_find_regblock(struct pci_dev *pdev, enum cxl_regloc_type type, 312 struct cxl_register_map *map); 313 int cxl_setup_regs(struct cxl_register_map *map); 314 struct cxl_dport; 315 resource_size_t cxl_rcd_component_reg_phys(struct device *dev, 316 struct cxl_dport *dport); 317 int cxl_dport_map_rcd_linkcap(struct pci_dev *pdev, struct cxl_dport *dport); 318 319 #define CXL_RESOURCE_NONE ((resource_size_t) -1) 320 #define CXL_TARGET_STRLEN 20 321 322 /* 323 * cxl_decoder flags that define the type of memory / devices this 324 * decoder supports as well as configuration lock status See "CXL 2.0 325 * 8.2.5.12.7 CXL HDM Decoder 0 Control Register" for details. 326 * Additionally indicate whether decoder settings were autodetected, 327 * user customized. 328 */ 329 #define CXL_DECODER_F_RAM BIT(0) 330 #define CXL_DECODER_F_PMEM BIT(1) 331 #define CXL_DECODER_F_TYPE2 BIT(2) 332 #define CXL_DECODER_F_TYPE3 BIT(3) 333 #define CXL_DECODER_F_LOCK BIT(4) 334 #define CXL_DECODER_F_ENABLE BIT(5) 335 #define CXL_DECODER_F_MASK GENMASK(5, 0) 336 337 enum cxl_decoder_type { 338 CXL_DECODER_DEVMEM = 2, 339 CXL_DECODER_HOSTONLYMEM = 3, 340 }; 341 342 /* 343 * Current specification goes up to 8, double that seems a reasonable 344 * software max for the foreseeable future 345 */ 346 #define CXL_DECODER_MAX_INTERLEAVE 16 347 348 #define CXL_QOS_CLASS_INVALID -1 349 350 /** 351 * struct cxl_decoder - Common CXL HDM Decoder Attributes 352 * @dev: this decoder's device 353 * @id: kernel device name id 354 * @hpa_range: Host physical address range mapped by this decoder 355 * @interleave_ways: number of cxl_dports in this decode 356 * @interleave_granularity: data stride per dport 357 * @target_type: accelerator vs expander (type2 vs type3) selector 358 * @region: currently assigned region for this decoder 359 * @flags: memory type capabilities and locking 360 * @commit: device/decoder-type specific callback to commit settings to hw 361 * @reset: device/decoder-type specific callback to reset hw settings 362 */ 363 struct cxl_decoder { 364 struct device dev; 365 int id; 366 struct range hpa_range; 367 int interleave_ways; 368 int interleave_granularity; 369 enum cxl_decoder_type target_type; 370 struct cxl_region *region; 371 unsigned long flags; 372 int (*commit)(struct cxl_decoder *cxld); 373 void (*reset)(struct cxl_decoder *cxld); 374 }; 375 376 /* 377 * Track whether this decoder is reserved for region autodiscovery, or 378 * free for userspace provisioning. 379 */ 380 enum cxl_decoder_state { 381 CXL_DECODER_STATE_MANUAL, 382 CXL_DECODER_STATE_AUTO, 383 }; 384 385 /** 386 * struct cxl_endpoint_decoder - Endpoint / SPA to DPA decoder 387 * @cxld: base cxl_decoder_object 388 * @dpa_res: actively claimed DPA span of this decoder 389 * @skip: offset into @dpa_res where @cxld.hpa_range maps 390 * @state: autodiscovery state 391 * @part: partition index this decoder maps 392 * @pos: interleave position in @cxld.region 393 */ 394 struct cxl_endpoint_decoder { 395 struct cxl_decoder cxld; 396 struct resource *dpa_res; 397 resource_size_t skip; 398 enum cxl_decoder_state state; 399 int part; 400 int pos; 401 }; 402 403 /** 404 * struct cxl_switch_decoder - Switch specific CXL HDM Decoder 405 * @cxld: base cxl_decoder object 406 * @nr_targets: number of elements in @target 407 * @target: active ordered target list in current decoder configuration 408 * 409 * The 'switch' decoder type represents the decoder instances of cxl_port's that 410 * route from the root of a CXL memory decode topology to the endpoints. They 411 * come in two flavors, root-level decoders, statically defined by platform 412 * firmware, and mid-level decoders, where interleave-granularity, 413 * interleave-width, and the target list are mutable. 414 */ 415 struct cxl_switch_decoder { 416 struct cxl_decoder cxld; 417 int nr_targets; 418 struct cxl_dport *target[]; 419 }; 420 421 struct cxl_root_decoder; 422 typedef u64 (*cxl_hpa_to_spa_fn)(struct cxl_root_decoder *cxlrd, u64 hpa); 423 424 /** 425 * struct cxl_root_decoder - Static platform CXL address decoder 426 * @res: host / parent resource for region allocations 427 * @region_id: region id for next region provisioning event 428 * @hpa_to_spa: translate CXL host-physical-address to Platform system-physical-address 429 * @platform_data: platform specific configuration data 430 * @range_lock: sync region autodiscovery by address range 431 * @qos_class: QoS performance class cookie 432 * @cxlsd: base cxl switch decoder 433 */ 434 struct cxl_root_decoder { 435 struct resource *res; 436 atomic_t region_id; 437 cxl_hpa_to_spa_fn hpa_to_spa; 438 void *platform_data; 439 struct mutex range_lock; 440 int qos_class; 441 struct cxl_switch_decoder cxlsd; 442 }; 443 444 /* 445 * enum cxl_config_state - State machine for region configuration 446 * @CXL_CONFIG_IDLE: Any sysfs attribute can be written freely 447 * @CXL_CONFIG_INTERLEAVE_ACTIVE: region size has been set, no more 448 * changes to interleave_ways or interleave_granularity 449 * @CXL_CONFIG_ACTIVE: All targets have been added the region is now 450 * active 451 * @CXL_CONFIG_RESET_PENDING: see commit_store() 452 * @CXL_CONFIG_COMMIT: Soft-config has been committed to hardware 453 */ 454 enum cxl_config_state { 455 CXL_CONFIG_IDLE, 456 CXL_CONFIG_INTERLEAVE_ACTIVE, 457 CXL_CONFIG_ACTIVE, 458 CXL_CONFIG_RESET_PENDING, 459 CXL_CONFIG_COMMIT, 460 }; 461 462 /** 463 * struct cxl_region_params - region settings 464 * @state: allow the driver to lockdown further parameter changes 465 * @uuid: unique id for persistent regions 466 * @interleave_ways: number of endpoints in the region 467 * @interleave_granularity: capacity each endpoint contributes to a stripe 468 * @res: allocated iomem capacity for this region 469 * @targets: active ordered targets in current decoder configuration 470 * @nr_targets: number of targets 471 * @cache_size: extended linear cache size if exists, otherwise zero. 472 * 473 * State transitions are protected by the cxl_region_rwsem 474 */ 475 struct cxl_region_params { 476 enum cxl_config_state state; 477 uuid_t uuid; 478 int interleave_ways; 479 int interleave_granularity; 480 struct resource *res; 481 struct cxl_endpoint_decoder *targets[CXL_DECODER_MAX_INTERLEAVE]; 482 int nr_targets; 483 resource_size_t cache_size; 484 }; 485 486 enum cxl_partition_mode { 487 CXL_PARTMODE_RAM, 488 CXL_PARTMODE_PMEM, 489 }; 490 491 /* 492 * Indicate whether this region has been assembled by autodetection or 493 * userspace assembly. Prevent endpoint decoders outside of automatic 494 * detection from being added to the region. 495 */ 496 #define CXL_REGION_F_AUTO 0 497 498 /* 499 * Require that a committed region successfully complete a teardown once 500 * any of its associated decoders have been torn down. This maintains 501 * the commit state for the region since there are committed decoders, 502 * but blocks cxl_region_probe(). 503 */ 504 #define CXL_REGION_F_NEEDS_RESET 1 505 506 /** 507 * struct cxl_region - CXL region 508 * @dev: This region's device 509 * @id: This region's id. Id is globally unique across all regions 510 * @mode: Operational mode of the mapped capacity 511 * @type: Endpoint decoder target type 512 * @cxl_nvb: nvdimm bridge for coordinating @cxlr_pmem setup / shutdown 513 * @cxlr_pmem: (for pmem regions) cached copy of the nvdimm bridge 514 * @flags: Region state flags 515 * @params: active + config params for the region 516 * @coord: QoS access coordinates for the region 517 * @node_notifier: notifier for setting the access coordinates to node 518 * @adist_notifier: notifier for calculating the abstract distance of node 519 */ 520 struct cxl_region { 521 struct device dev; 522 int id; 523 enum cxl_partition_mode mode; 524 enum cxl_decoder_type type; 525 struct cxl_nvdimm_bridge *cxl_nvb; 526 struct cxl_pmem_region *cxlr_pmem; 527 unsigned long flags; 528 struct cxl_region_params params; 529 struct access_coordinate coord[ACCESS_COORDINATE_MAX]; 530 struct notifier_block node_notifier; 531 struct notifier_block adist_notifier; 532 }; 533 534 struct cxl_nvdimm_bridge { 535 int id; 536 struct device dev; 537 struct cxl_port *port; 538 struct nvdimm_bus *nvdimm_bus; 539 struct nvdimm_bus_descriptor nd_desc; 540 }; 541 542 #define CXL_DEV_ID_LEN 19 543 544 struct cxl_nvdimm { 545 struct device dev; 546 struct cxl_memdev *cxlmd; 547 u8 dev_id[CXL_DEV_ID_LEN]; /* for nvdimm, string of 'serial' */ 548 u64 dirty_shutdowns; 549 }; 550 551 struct cxl_pmem_region_mapping { 552 struct cxl_memdev *cxlmd; 553 struct cxl_nvdimm *cxl_nvd; 554 u64 start; 555 u64 size; 556 int position; 557 }; 558 559 struct cxl_pmem_region { 560 struct device dev; 561 struct cxl_region *cxlr; 562 struct nd_region *nd_region; 563 struct range hpa_range; 564 int nr_mappings; 565 struct cxl_pmem_region_mapping mapping[]; 566 }; 567 568 struct cxl_dax_region { 569 struct device dev; 570 struct cxl_region *cxlr; 571 struct range hpa_range; 572 }; 573 574 /** 575 * struct cxl_port - logical collection of upstream port devices and 576 * downstream port devices to construct a CXL memory 577 * decode hierarchy. 578 * @dev: this port's device 579 * @uport_dev: PCI or platform device implementing the upstream port capability 580 * @host_bridge: Shortcut to the platform attach point for this port 581 * @id: id for port device-name 582 * @dports: cxl_dport instances referenced by decoders 583 * @endpoints: cxl_ep instances, endpoints that are a descendant of this port 584 * @regions: cxl_region_ref instances, regions mapped by this port 585 * @parent_dport: dport that points to this port in the parent 586 * @decoder_ida: allocator for decoder ids 587 * @reg_map: component and ras register mapping parameters 588 * @nr_dports: number of entries in @dports 589 * @hdm_end: track last allocated HDM decoder instance for allocation ordering 590 * @commit_end: cursor to track highest committed decoder for commit ordering 591 * @dead: last ep has been removed, force port re-creation 592 * @depth: How deep this port is relative to the root. depth 0 is the root. 593 * @cdat: Cached CDAT data 594 * @cdat_available: Should a CDAT attribute be available in sysfs 595 * @pci_latency: Upstream latency in picoseconds 596 */ 597 struct cxl_port { 598 struct device dev; 599 struct device *uport_dev; 600 struct device *host_bridge; 601 int id; 602 struct xarray dports; 603 struct xarray endpoints; 604 struct xarray regions; 605 struct cxl_dport *parent_dport; 606 struct ida decoder_ida; 607 struct cxl_register_map reg_map; 608 int nr_dports; 609 int hdm_end; 610 int commit_end; 611 bool dead; 612 unsigned int depth; 613 struct cxl_cdat { 614 void *table; 615 size_t length; 616 } cdat; 617 bool cdat_available; 618 long pci_latency; 619 }; 620 621 /** 622 * struct cxl_root - logical collection of root cxl_port items 623 * 624 * @port: cxl_port member 625 * @ops: cxl root operations 626 */ 627 struct cxl_root { 628 struct cxl_port port; 629 const struct cxl_root_ops *ops; 630 }; 631 632 static inline struct cxl_root * 633 to_cxl_root(const struct cxl_port *port) 634 { 635 return container_of(port, struct cxl_root, port); 636 } 637 638 struct cxl_root_ops { 639 int (*qos_class)(struct cxl_root *cxl_root, 640 struct access_coordinate *coord, int entries, 641 int *qos_class); 642 }; 643 644 static inline struct cxl_dport * 645 cxl_find_dport_by_dev(struct cxl_port *port, const struct device *dport_dev) 646 { 647 return xa_load(&port->dports, (unsigned long)dport_dev); 648 } 649 650 struct cxl_rcrb_info { 651 resource_size_t base; 652 u16 aer_cap; 653 }; 654 655 /** 656 * struct cxl_dport - CXL downstream port 657 * @dport_dev: PCI bridge or firmware device representing the downstream link 658 * @reg_map: component and ras register mapping parameters 659 * @port_id: unique hardware identifier for dport in decoder target list 660 * @rcrb: Data about the Root Complex Register Block layout 661 * @rch: Indicate whether this dport was enumerated in RCH or VH mode 662 * @port: reference to cxl_port that contains this downstream port 663 * @regs: Dport parsed register blocks 664 * @coord: access coordinates (bandwidth and latency performance attributes) 665 * @link_latency: calculated PCIe downstream latency 666 * @gpf_dvsec: Cached GPF port DVSEC 667 */ 668 struct cxl_dport { 669 struct device *dport_dev; 670 struct cxl_register_map reg_map; 671 int port_id; 672 struct cxl_rcrb_info rcrb; 673 bool rch; 674 struct cxl_port *port; 675 struct cxl_regs regs; 676 struct access_coordinate coord[ACCESS_COORDINATE_MAX]; 677 long link_latency; 678 int gpf_dvsec; 679 }; 680 681 /** 682 * struct cxl_ep - track an endpoint's interest in a port 683 * @ep: device that hosts a generic CXL endpoint (expander or accelerator) 684 * @dport: which dport routes to this endpoint on @port 685 * @next: cxl switch port across the link attached to @dport NULL if 686 * attached to an endpoint 687 */ 688 struct cxl_ep { 689 struct device *ep; 690 struct cxl_dport *dport; 691 struct cxl_port *next; 692 }; 693 694 /** 695 * struct cxl_region_ref - track a region's interest in a port 696 * @port: point in topology to install this reference 697 * @decoder: decoder assigned for @region in @port 698 * @region: region for this reference 699 * @endpoints: cxl_ep references for region members beneath @port 700 * @nr_targets_set: track how many targets have been programmed during setup 701 * @nr_eps: number of endpoints beneath @port 702 * @nr_targets: number of distinct targets needed to reach @nr_eps 703 */ 704 struct cxl_region_ref { 705 struct cxl_port *port; 706 struct cxl_decoder *decoder; 707 struct cxl_region *region; 708 struct xarray endpoints; 709 int nr_targets_set; 710 int nr_eps; 711 int nr_targets; 712 }; 713 714 /* 715 * The platform firmware device hosting the root is also the top of the 716 * CXL port topology. All other CXL ports have another CXL port as their 717 * parent and their ->uport_dev / host device is out-of-line of the port 718 * ancestry. 719 */ 720 static inline bool is_cxl_root(struct cxl_port *port) 721 { 722 return port->uport_dev == port->dev.parent; 723 } 724 725 int cxl_num_decoders_committed(struct cxl_port *port); 726 bool is_cxl_port(const struct device *dev); 727 struct cxl_port *to_cxl_port(const struct device *dev); 728 struct cxl_port *parent_port_of(struct cxl_port *port); 729 void cxl_port_commit_reap(struct cxl_decoder *cxld); 730 struct pci_bus; 731 int devm_cxl_register_pci_bus(struct device *host, struct device *uport_dev, 732 struct pci_bus *bus); 733 struct pci_bus *cxl_port_to_pci_bus(struct cxl_port *port); 734 struct cxl_port *devm_cxl_add_port(struct device *host, 735 struct device *uport_dev, 736 resource_size_t component_reg_phys, 737 struct cxl_dport *parent_dport); 738 struct cxl_root *devm_cxl_add_root(struct device *host, 739 const struct cxl_root_ops *ops); 740 struct cxl_root *find_cxl_root(struct cxl_port *port); 741 742 DEFINE_FREE(put_cxl_root, struct cxl_root *, if (_T) put_device(&_T->port.dev)) 743 DEFINE_FREE(put_cxl_port, struct cxl_port *, if (!IS_ERR_OR_NULL(_T)) put_device(&_T->dev)) 744 DEFINE_FREE(put_cxl_root_decoder, struct cxl_root_decoder *, if (!IS_ERR_OR_NULL(_T)) put_device(&_T->cxlsd.cxld.dev)) 745 DEFINE_FREE(put_cxl_region, struct cxl_region *, if (!IS_ERR_OR_NULL(_T)) put_device(&_T->dev)) 746 747 int devm_cxl_enumerate_ports(struct cxl_memdev *cxlmd); 748 void cxl_bus_rescan(void); 749 void cxl_bus_drain(void); 750 struct cxl_port *cxl_pci_find_port(struct pci_dev *pdev, 751 struct cxl_dport **dport); 752 struct cxl_port *cxl_mem_find_port(struct cxl_memdev *cxlmd, 753 struct cxl_dport **dport); 754 bool schedule_cxl_memdev_detach(struct cxl_memdev *cxlmd); 755 756 struct cxl_dport *devm_cxl_add_dport(struct cxl_port *port, 757 struct device *dport, int port_id, 758 resource_size_t component_reg_phys); 759 struct cxl_dport *devm_cxl_add_rch_dport(struct cxl_port *port, 760 struct device *dport_dev, int port_id, 761 resource_size_t rcrb); 762 763 #ifdef CONFIG_PCIEAER_CXL 764 void cxl_setup_parent_dport(struct device *host, struct cxl_dport *dport); 765 void cxl_dport_init_ras_reporting(struct cxl_dport *dport, struct device *host); 766 #else 767 static inline void cxl_dport_init_ras_reporting(struct cxl_dport *dport, 768 struct device *host) { } 769 #endif 770 771 struct cxl_decoder *to_cxl_decoder(struct device *dev); 772 struct cxl_root_decoder *to_cxl_root_decoder(struct device *dev); 773 struct cxl_switch_decoder *to_cxl_switch_decoder(struct device *dev); 774 struct cxl_endpoint_decoder *to_cxl_endpoint_decoder(struct device *dev); 775 bool is_root_decoder(struct device *dev); 776 bool is_switch_decoder(struct device *dev); 777 bool is_endpoint_decoder(struct device *dev); 778 struct cxl_root_decoder *cxl_root_decoder_alloc(struct cxl_port *port, 779 unsigned int nr_targets); 780 struct cxl_switch_decoder *cxl_switch_decoder_alloc(struct cxl_port *port, 781 unsigned int nr_targets); 782 int cxl_decoder_add(struct cxl_decoder *cxld, int *target_map); 783 struct cxl_endpoint_decoder *cxl_endpoint_decoder_alloc(struct cxl_port *port); 784 int cxl_decoder_add_locked(struct cxl_decoder *cxld, int *target_map); 785 int cxl_decoder_autoremove(struct device *host, struct cxl_decoder *cxld); 786 static inline int cxl_root_decoder_autoremove(struct device *host, 787 struct cxl_root_decoder *cxlrd) 788 { 789 return cxl_decoder_autoremove(host, &cxlrd->cxlsd.cxld); 790 } 791 int cxl_endpoint_autoremove(struct cxl_memdev *cxlmd, struct cxl_port *endpoint); 792 793 /** 794 * struct cxl_endpoint_dvsec_info - Cached DVSEC info 795 * @mem_enabled: cached value of mem_enabled in the DVSEC at init time 796 * @ranges: Number of active HDM ranges this device uses. 797 * @port: endpoint port associated with this info instance 798 * @dvsec_range: cached attributes of the ranges in the DVSEC, PCIE_DEVICE 799 */ 800 struct cxl_endpoint_dvsec_info { 801 bool mem_enabled; 802 int ranges; 803 struct cxl_port *port; 804 struct range dvsec_range[2]; 805 }; 806 807 struct cxl_hdm; 808 struct cxl_hdm *devm_cxl_setup_hdm(struct cxl_port *port, 809 struct cxl_endpoint_dvsec_info *info); 810 int devm_cxl_enumerate_decoders(struct cxl_hdm *cxlhdm, 811 struct cxl_endpoint_dvsec_info *info); 812 int devm_cxl_add_passthrough_decoder(struct cxl_port *port); 813 struct cxl_dev_state; 814 int cxl_dvsec_rr_decode(struct cxl_dev_state *cxlds, 815 struct cxl_endpoint_dvsec_info *info); 816 817 bool is_cxl_region(struct device *dev); 818 819 extern struct bus_type cxl_bus_type; 820 821 struct cxl_driver { 822 const char *name; 823 int (*probe)(struct device *dev); 824 void (*remove)(struct device *dev); 825 struct device_driver drv; 826 int id; 827 }; 828 829 #define to_cxl_drv(__drv) container_of_const(__drv, struct cxl_driver, drv) 830 831 int __cxl_driver_register(struct cxl_driver *cxl_drv, struct module *owner, 832 const char *modname); 833 #define cxl_driver_register(x) __cxl_driver_register(x, THIS_MODULE, KBUILD_MODNAME) 834 void cxl_driver_unregister(struct cxl_driver *cxl_drv); 835 836 #define module_cxl_driver(__cxl_driver) \ 837 module_driver(__cxl_driver, cxl_driver_register, cxl_driver_unregister) 838 839 #define CXL_DEVICE_NVDIMM_BRIDGE 1 840 #define CXL_DEVICE_NVDIMM 2 841 #define CXL_DEVICE_PORT 3 842 #define CXL_DEVICE_ROOT 4 843 #define CXL_DEVICE_MEMORY_EXPANDER 5 844 #define CXL_DEVICE_REGION 6 845 #define CXL_DEVICE_PMEM_REGION 7 846 #define CXL_DEVICE_DAX_REGION 8 847 #define CXL_DEVICE_PMU 9 848 849 #define MODULE_ALIAS_CXL(type) MODULE_ALIAS("cxl:t" __stringify(type) "*") 850 #define CXL_MODALIAS_FMT "cxl:t%d" 851 852 struct cxl_nvdimm_bridge *to_cxl_nvdimm_bridge(struct device *dev); 853 struct cxl_nvdimm_bridge *devm_cxl_add_nvdimm_bridge(struct device *host, 854 struct cxl_port *port); 855 struct cxl_nvdimm *to_cxl_nvdimm(struct device *dev); 856 bool is_cxl_nvdimm(struct device *dev); 857 int devm_cxl_add_nvdimm(struct cxl_port *parent_port, struct cxl_memdev *cxlmd); 858 struct cxl_nvdimm_bridge *cxl_find_nvdimm_bridge(struct cxl_port *port); 859 860 #ifdef CONFIG_CXL_REGION 861 bool is_cxl_pmem_region(struct device *dev); 862 struct cxl_pmem_region *to_cxl_pmem_region(struct device *dev); 863 int cxl_add_to_region(struct cxl_endpoint_decoder *cxled); 864 struct cxl_dax_region *to_cxl_dax_region(struct device *dev); 865 u64 cxl_port_get_spa_cache_alias(struct cxl_port *endpoint, u64 spa); 866 #else 867 static inline bool is_cxl_pmem_region(struct device *dev) 868 { 869 return false; 870 } 871 static inline struct cxl_pmem_region *to_cxl_pmem_region(struct device *dev) 872 { 873 return NULL; 874 } 875 static inline int cxl_add_to_region(struct cxl_endpoint_decoder *cxled) 876 { 877 return 0; 878 } 879 static inline struct cxl_dax_region *to_cxl_dax_region(struct device *dev) 880 { 881 return NULL; 882 } 883 static inline u64 cxl_port_get_spa_cache_alias(struct cxl_port *endpoint, 884 u64 spa) 885 { 886 return 0; 887 } 888 #endif 889 890 void cxl_endpoint_parse_cdat(struct cxl_port *port); 891 void cxl_switch_parse_cdat(struct cxl_port *port); 892 893 int cxl_endpoint_get_perf_coordinates(struct cxl_port *port, 894 struct access_coordinate *coord); 895 void cxl_region_perf_data_calculate(struct cxl_region *cxlr, 896 struct cxl_endpoint_decoder *cxled); 897 void cxl_region_shared_upstream_bandwidth_update(struct cxl_region *cxlr); 898 899 void cxl_memdev_update_perf(struct cxl_memdev *cxlmd); 900 901 void cxl_coordinates_combine(struct access_coordinate *out, 902 struct access_coordinate *c1, 903 struct access_coordinate *c2); 904 905 bool cxl_endpoint_decoder_reset_detected(struct cxl_port *port); 906 907 /* 908 * Unit test builds overrides this to __weak, find the 'strong' version 909 * of these symbols in tools/testing/cxl/. 910 */ 911 #ifndef __mock 912 #define __mock static 913 #endif 914 915 u16 cxl_gpf_get_dvsec(struct device *dev); 916 917 static inline struct rw_semaphore *rwsem_read_intr_acquire(struct rw_semaphore *rwsem) 918 { 919 if (down_read_interruptible(rwsem)) 920 return NULL; 921 922 return rwsem; 923 } 924 925 DEFINE_FREE(rwsem_read_release, struct rw_semaphore *, if (_T) up_read(_T)) 926 927 #endif /* __CXL_H__ */ 928