xref: /kernel/linux/linux-6.6/drivers/cxl/mem.c (revision 62306a36)
1// SPDX-License-Identifier: GPL-2.0-only
2/* Copyright(c) 2022 Intel Corporation. All rights reserved. */
3#include <linux/debugfs.h>
4#include <linux/device.h>
5#include <linux/module.h>
6#include <linux/pci.h>
7
8#include "cxlmem.h"
9#include "cxlpci.h"
10
11/**
12 * DOC: cxl mem
13 *
14 * CXL memory endpoint devices and switches are CXL capable devices that are
15 * participating in CXL.mem protocol. Their functionality builds on top of the
16 * CXL.io protocol that allows enumerating and configuring components via
17 * standard PCI mechanisms.
18 *
19 * The cxl_mem driver owns kicking off the enumeration of this CXL.mem
20 * capability. With the detection of a CXL capable endpoint, the driver will
21 * walk up to find the platform specific port it is connected to, and determine
22 * if there are intervening switches in the path. If there are switches, a
23 * secondary action is to enumerate those (implemented in cxl_core). Finally the
24 * cxl_mem driver adds the device it is bound to as a CXL endpoint-port for use
25 * in higher level operations.
26 */
27
28static void enable_suspend(void *data)
29{
30	cxl_mem_active_dec();
31}
32
33static void remove_debugfs(void *dentry)
34{
35	debugfs_remove_recursive(dentry);
36}
37
38static int cxl_mem_dpa_show(struct seq_file *file, void *data)
39{
40	struct device *dev = file->private;
41	struct cxl_memdev *cxlmd = to_cxl_memdev(dev);
42
43	cxl_dpa_debug(file, cxlmd->cxlds);
44
45	return 0;
46}
47
48static int devm_cxl_add_endpoint(struct device *host, struct cxl_memdev *cxlmd,
49				 struct cxl_dport *parent_dport)
50{
51	struct cxl_port *parent_port = parent_dport->port;
52	struct cxl_dev_state *cxlds = cxlmd->cxlds;
53	struct cxl_port *endpoint, *iter, *down;
54	int rc;
55
56	/*
57	 * Now that the path to the root is established record all the
58	 * intervening ports in the chain.
59	 */
60	for (iter = parent_port, down = NULL; !is_cxl_root(iter);
61	     down = iter, iter = to_cxl_port(iter->dev.parent)) {
62		struct cxl_ep *ep;
63
64		ep = cxl_ep_load(iter, cxlmd);
65		ep->next = down;
66	}
67
68	endpoint = devm_cxl_add_port(host, &cxlmd->dev,
69				     cxlds->component_reg_phys,
70				     parent_dport);
71	if (IS_ERR(endpoint))
72		return PTR_ERR(endpoint);
73
74	rc = cxl_endpoint_autoremove(cxlmd, endpoint);
75	if (rc)
76		return rc;
77
78	if (!endpoint->dev.driver) {
79		dev_err(&cxlmd->dev, "%s failed probe\n",
80			dev_name(&endpoint->dev));
81		return -ENXIO;
82	}
83
84	return 0;
85}
86
87static int cxl_debugfs_poison_inject(void *data, u64 dpa)
88{
89	struct cxl_memdev *cxlmd = data;
90
91	return cxl_inject_poison(cxlmd, dpa);
92}
93
94DEFINE_DEBUGFS_ATTRIBUTE(cxl_poison_inject_fops, NULL,
95			 cxl_debugfs_poison_inject, "%llx\n");
96
97static int cxl_debugfs_poison_clear(void *data, u64 dpa)
98{
99	struct cxl_memdev *cxlmd = data;
100
101	return cxl_clear_poison(cxlmd, dpa);
102}
103
104DEFINE_DEBUGFS_ATTRIBUTE(cxl_poison_clear_fops, NULL,
105			 cxl_debugfs_poison_clear, "%llx\n");
106
107static int cxl_mem_probe(struct device *dev)
108{
109	struct cxl_memdev *cxlmd = to_cxl_memdev(dev);
110	struct cxl_memdev_state *mds = to_cxl_memdev_state(cxlmd->cxlds);
111	struct cxl_dev_state *cxlds = cxlmd->cxlds;
112	struct device *endpoint_parent;
113	struct cxl_port *parent_port;
114	struct cxl_dport *dport;
115	struct dentry *dentry;
116	int rc;
117
118	if (!cxlds->media_ready)
119		return -EBUSY;
120
121	/*
122	 * Someone is trying to reattach this device after it lost its port
123	 * connection (an endpoint port previously registered by this memdev was
124	 * disabled). This racy check is ok because if the port is still gone,
125	 * no harm done, and if the port hierarchy comes back it will re-trigger
126	 * this probe. Port rescan and memdev detach work share the same
127	 * single-threaded workqueue.
128	 */
129	if (work_pending(&cxlmd->detach_work))
130		return -EBUSY;
131
132	dentry = cxl_debugfs_create_dir(dev_name(dev));
133	debugfs_create_devm_seqfile(dev, "dpamem", dentry, cxl_mem_dpa_show);
134
135	if (test_bit(CXL_POISON_ENABLED_INJECT, mds->poison.enabled_cmds))
136		debugfs_create_file("inject_poison", 0200, dentry, cxlmd,
137				    &cxl_poison_inject_fops);
138	if (test_bit(CXL_POISON_ENABLED_CLEAR, mds->poison.enabled_cmds))
139		debugfs_create_file("clear_poison", 0200, dentry, cxlmd,
140				    &cxl_poison_clear_fops);
141
142	rc = devm_add_action_or_reset(dev, remove_debugfs, dentry);
143	if (rc)
144		return rc;
145
146	rc = devm_cxl_enumerate_ports(cxlmd);
147	if (rc)
148		return rc;
149
150	parent_port = cxl_mem_find_port(cxlmd, &dport);
151	if (!parent_port) {
152		dev_err(dev, "CXL port topology not found\n");
153		return -ENXIO;
154	}
155
156	if (dport->rch)
157		endpoint_parent = parent_port->uport_dev;
158	else
159		endpoint_parent = &parent_port->dev;
160
161	device_lock(endpoint_parent);
162	if (!endpoint_parent->driver) {
163		dev_err(dev, "CXL port topology %s not enabled\n",
164			dev_name(endpoint_parent));
165		rc = -ENXIO;
166		goto unlock;
167	}
168
169	rc = devm_cxl_add_endpoint(endpoint_parent, cxlmd, dport);
170unlock:
171	device_unlock(endpoint_parent);
172	put_device(&parent_port->dev);
173	if (rc)
174		return rc;
175
176	if (resource_size(&cxlds->pmem_res) && IS_ENABLED(CONFIG_CXL_PMEM)) {
177		rc = devm_cxl_add_nvdimm(cxlmd);
178		if (rc == -ENODEV)
179			dev_info(dev, "PMEM disabled by platform\n");
180		else
181			return rc;
182	}
183
184	/*
185	 * The kernel may be operating out of CXL memory on this device,
186	 * there is no spec defined way to determine whether this device
187	 * preserves contents over suspend, and there is no simple way
188	 * to arrange for the suspend image to avoid CXL memory which
189	 * would setup a circular dependency between PCI resume and save
190	 * state restoration.
191	 *
192	 * TODO: support suspend when all the regions this device is
193	 * hosting are locked and covered by the system address map,
194	 * i.e. platform firmware owns restoring the HDM configuration
195	 * that it locked.
196	 */
197	cxl_mem_active_inc();
198	return devm_add_action_or_reset(dev, enable_suspend, NULL);
199}
200
201static ssize_t trigger_poison_list_store(struct device *dev,
202					 struct device_attribute *attr,
203					 const char *buf, size_t len)
204{
205	bool trigger;
206	int rc;
207
208	if (kstrtobool(buf, &trigger) || !trigger)
209		return -EINVAL;
210
211	rc = cxl_trigger_poison_list(to_cxl_memdev(dev));
212
213	return rc ? rc : len;
214}
215static DEVICE_ATTR_WO(trigger_poison_list);
216
217static umode_t cxl_mem_visible(struct kobject *kobj, struct attribute *a, int n)
218{
219	if (a == &dev_attr_trigger_poison_list.attr) {
220		struct device *dev = kobj_to_dev(kobj);
221		struct cxl_memdev *cxlmd = to_cxl_memdev(dev);
222		struct cxl_memdev_state *mds =
223			to_cxl_memdev_state(cxlmd->cxlds);
224
225		if (!test_bit(CXL_POISON_ENABLED_LIST,
226			      mds->poison.enabled_cmds))
227			return 0;
228	}
229	return a->mode;
230}
231
232static struct attribute *cxl_mem_attrs[] = {
233	&dev_attr_trigger_poison_list.attr,
234	NULL
235};
236
237static struct attribute_group cxl_mem_group = {
238	.attrs = cxl_mem_attrs,
239	.is_visible = cxl_mem_visible,
240};
241
242__ATTRIBUTE_GROUPS(cxl_mem);
243
244static struct cxl_driver cxl_mem_driver = {
245	.name = "cxl_mem",
246	.probe = cxl_mem_probe,
247	.id = CXL_DEVICE_MEMORY_EXPANDER,
248	.drv = {
249		.dev_groups = cxl_mem_groups,
250	},
251};
252
253module_cxl_driver(cxl_mem_driver);
254
255MODULE_LICENSE("GPL v2");
256MODULE_IMPORT_NS(CXL);
257MODULE_ALIAS_CXL(CXL_DEVICE_MEMORY_EXPANDER);
258/*
259 * create_endpoint() wants to validate port driver attach immediately after
260 * endpoint registration.
261 */
262MODULE_SOFTDEP("pre: cxl_port");
263