xref: /linux/drivers/cxl/cxlpci.h (revision 6a4aee277740d04ac0fd54cfa17cc28261932ddc)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright(c) 2020 Intel Corporation. All rights reserved. */
3 #ifndef __CXL_PCI_H__
4 #define __CXL_PCI_H__
5 #include <linux/pci.h>
6 #include "cxl.h"
7 
8 #define CXL_MEMORY_PROGIF	0x10
9 
10 /*
11  * See section 8.1 Configuration Space Registers in the CXL 2.0
12  * Specification. Names are taken straight from the specification with "CXL" and
13  * "DVSEC" redundancies removed. When obvious, abbreviations may be used.
14  */
15 #define PCI_DVSEC_HEADER1_LENGTH_MASK	GENMASK(31, 20)
16 #define PCI_DVSEC_VENDOR_ID_CXL		0x1E98
17 
18 /* CXL 2.0 8.1.3: PCIe DVSEC for CXL Device */
19 #define CXL_DVSEC_PCIE_DEVICE					0
20 #define   CXL_DVSEC_CAP_OFFSET		0xA
21 #define     CXL_DVSEC_MEM_CAPABLE	BIT(2)
22 #define     CXL_DVSEC_HDM_COUNT_MASK	GENMASK(5, 4)
23 #define   CXL_DVSEC_CTRL_OFFSET		0xC
24 #define     CXL_DVSEC_MEM_ENABLE	BIT(2)
25 #define   CXL_DVSEC_RANGE_SIZE_HIGH(i)	(0x18 + (i * 0x10))
26 #define   CXL_DVSEC_RANGE_SIZE_LOW(i)	(0x1C + (i * 0x10))
27 #define     CXL_DVSEC_MEM_INFO_VALID	BIT(0)
28 #define     CXL_DVSEC_MEM_ACTIVE	BIT(1)
29 #define     CXL_DVSEC_MEM_SIZE_LOW_MASK	GENMASK(31, 28)
30 #define   CXL_DVSEC_RANGE_BASE_HIGH(i)	(0x20 + (i * 0x10))
31 #define   CXL_DVSEC_RANGE_BASE_LOW(i)	(0x24 + (i * 0x10))
32 #define     CXL_DVSEC_MEM_BASE_LOW_MASK	GENMASK(31, 28)
33 
34 #define CXL_DVSEC_RANGE_MAX		2
35 
36 /* CXL 2.0 8.1.4: Non-CXL Function Map DVSEC */
37 #define CXL_DVSEC_FUNCTION_MAP					2
38 
39 /* CXL 2.0 8.1.5: CXL 2.0 Extensions DVSEC for Ports */
40 #define CXL_DVSEC_PORT_EXTENSIONS				3
41 
42 /* CXL 2.0 8.1.6: GPF DVSEC for CXL Port */
43 #define CXL_DVSEC_PORT_GPF					4
44 
45 /* CXL 2.0 8.1.7: GPF DVSEC for CXL Device */
46 #define CXL_DVSEC_DEVICE_GPF					5
47 
48 /* CXL 2.0 8.1.8: PCIe DVSEC for Flex Bus Port */
49 #define CXL_DVSEC_PCIE_FLEXBUS_PORT				7
50 
51 /* CXL 2.0 8.1.9: Register Locator DVSEC */
52 #define CXL_DVSEC_REG_LOCATOR					8
53 #define   CXL_DVSEC_REG_LOCATOR_BLOCK1_OFFSET			0xC
54 #define     CXL_DVSEC_REG_LOCATOR_BIR_MASK			GENMASK(2, 0)
55 #define	    CXL_DVSEC_REG_LOCATOR_BLOCK_ID_MASK			GENMASK(15, 8)
56 #define     CXL_DVSEC_REG_LOCATOR_BLOCK_OFF_LOW_MASK		GENMASK(31, 16)
57 
58 /*
59  * NOTE: Currently all the functions which are enabled for CXL require their
60  * vectors to be in the first 16.  Use this as the default max.
61  */
62 #define CXL_PCI_DEFAULT_MAX_VECTORS 16
63 
64 /* Register Block Identifier (RBI) */
65 enum cxl_regloc_type {
66 	CXL_REGLOC_RBI_EMPTY = 0,
67 	CXL_REGLOC_RBI_COMPONENT,
68 	CXL_REGLOC_RBI_VIRT,
69 	CXL_REGLOC_RBI_MEMDEV,
70 	CXL_REGLOC_RBI_PMU,
71 	CXL_REGLOC_RBI_TYPES
72 };
73 
74 /*
75  * Table Access DOE, CDAT Read Entry Response
76  *
77  * Spec refs:
78  *
79  * CXL 3.1 8.1.11, Table 8-14: Read Entry Response
80  * CDAT Specification 1.03: 2 CDAT Data Structures
81  */
82 
83 struct cdat_header {
84 	__le32 length;
85 	u8 revision;
86 	u8 checksum;
87 	u8 reserved[6];
88 	__le32 sequence;
89 } __packed;
90 
91 struct cdat_entry_header {
92 	u8 type;
93 	u8 reserved;
94 	__le16 length;
95 } __packed;
96 
97 /*
98  * The DOE CDAT read response contains a CDAT read entry (either the
99  * CDAT header or a structure).
100  */
101 union cdat_data {
102 	struct cdat_header header;
103 	struct cdat_entry_header entry;
104 } __packed;
105 
106 /* There is an additional CDAT response header of 4 bytes. */
107 struct cdat_doe_rsp {
108 	__le32 doe_header;
109 	u8 data[];
110 } __packed;
111 
112 /*
113  * CXL v3.0 6.2.3 Table 6-4
114  * The table indicates that if PCIe Flit Mode is set, then CXL is in 256B flits
115  * mode, otherwise it's 68B flits mode.
116  */
117 static inline bool cxl_pci_flit_256(struct pci_dev *pdev)
118 {
119 	u16 lnksta2;
120 
121 	pcie_capability_read_word(pdev, PCI_EXP_LNKSTA2, &lnksta2);
122 	return lnksta2 & PCI_EXP_LNKSTA2_FLIT;
123 }
124 
125 int devm_cxl_port_enumerate_dports(struct cxl_port *port);
126 struct cxl_dev_state;
127 int cxl_hdm_decode_init(struct cxl_dev_state *cxlds, struct cxl_hdm *cxlhdm,
128 			struct cxl_endpoint_dvsec_info *info);
129 void read_cdat_data(struct cxl_port *port);
130 void cxl_cor_error_detected(struct pci_dev *pdev);
131 pci_ers_result_t cxl_error_detected(struct pci_dev *pdev,
132 				    pci_channel_state_t state);
133 #endif /* __CXL_PCI_H__ */
134