Merge tag 'for-linus-2023030901' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-block.git] / drivers / cxl / pmem.c
CommitLineData
8fdcb170
DW
1// SPDX-License-Identifier: GPL-2.0-only
2/* Copyright(c) 2021 Intel Corporation. All rights reserved. */
3#include <linux/libnvdimm.h>
60b8f172 4#include <asm/unaligned.h>
8fdcb170
DW
5#include <linux/device.h>
6#include <linux/module.h>
21083f51
DW
7#include <linux/ndctl.h>
8#include <linux/async.h>
8fdcb170 9#include <linux/slab.h>
04ad63f0 10#include <linux/nd.h>
5161a55c 11#include "cxlmem.h"
8fdcb170
DW
12#include "cxl.h"
13
32828115
DJ
14extern const struct nvdimm_security_ops *cxl_security_ops;
15
12f3856a
DW
16static __read_mostly DECLARE_BITMAP(exclusive_cmds, CXL_MEM_COMMAND_ID_MAX);
17
5e2411ae 18static void clear_exclusive(void *cxlds)
12f3856a 19{
5e2411ae 20 clear_exclusive_cxl_commands(cxlds, exclusive_cmds);
12f3856a
DW
21}
22
21083f51
DW
23static void unregister_nvdimm(void *nvdimm)
24{
25 nvdimm_delete(nvdimm);
26}
27
452996fa
DJ
28static ssize_t provider_show(struct device *dev, struct device_attribute *attr, char *buf)
29{
30 struct nvdimm *nvdimm = to_nvdimm(dev);
31 struct cxl_nvdimm *cxl_nvd = nvdimm_provider_data(nvdimm);
32
33 return sysfs_emit(buf, "%s\n", dev_name(&cxl_nvd->dev));
34}
35static DEVICE_ATTR_RO(provider);
36
bd429e53
DJ
37static ssize_t id_show(struct device *dev, struct device_attribute *attr, char *buf)
38{
39 struct nvdimm *nvdimm = to_nvdimm(dev);
40 struct cxl_nvdimm *cxl_nvd = nvdimm_provider_data(nvdimm);
41 struct cxl_dev_state *cxlds = cxl_nvd->cxlmd->cxlds;
42
43 return sysfs_emit(buf, "%lld\n", cxlds->serial);
44}
45static DEVICE_ATTR_RO(id);
46
47static struct attribute *cxl_dimm_attributes[] = {
48 &dev_attr_id.attr,
452996fa 49 &dev_attr_provider.attr,
bd429e53
DJ
50 NULL
51};
52
53static const struct attribute_group cxl_dimm_attribute_group = {
54 .name = "cxl",
55 .attrs = cxl_dimm_attributes,
56};
57
58static const struct attribute_group *cxl_dimm_attribute_groups[] = {
59 &cxl_dimm_attribute_group,
60 NULL
61};
62
21083f51
DW
63static int cxl_nvdimm_probe(struct device *dev)
64{
65 struct cxl_nvdimm *cxl_nvd = to_cxl_nvdimm(dev);
12f3856a 66 struct cxl_memdev *cxlmd = cxl_nvd->cxlmd;
f17b558d 67 struct cxl_nvdimm_bridge *cxl_nvb = cxlmd->cxl_nvb;
60b8f172 68 unsigned long flags = 0, cmd_mask = 0;
5e2411ae 69 struct cxl_dev_state *cxlds = cxlmd->cxlds;
21083f51 70 struct nvdimm *nvdimm;
12f3856a 71 int rc;
21083f51 72
5e2411ae
IW
73 set_exclusive_cxl_commands(cxlds, exclusive_cmds);
74 rc = devm_add_action_or_reset(dev, clear_exclusive, cxlds);
12f3856a 75 if (rc)
f17b558d 76 return rc;
21083f51
DW
77
78 set_bit(NDD_LABELING, &flags);
f57aec44 79 set_bit(NDD_REGISTER_SYNC, &flags);
60b8f172
DW
80 set_bit(ND_CMD_GET_CONFIG_SIZE, &cmd_mask);
81 set_bit(ND_CMD_GET_CONFIG_DATA, &cmd_mask);
82 set_bit(ND_CMD_SET_CONFIG_DATA, &cmd_mask);
bd429e53
DJ
83 nvdimm = __nvdimm_create(cxl_nvb->nvdimm_bus, cxl_nvd,
84 cxl_dimm_attribute_groups, flags,
b5807c80
DJ
85 cmd_mask, 0, NULL, cxl_nvd->dev_id,
86 cxl_security_ops, NULL);
f17b558d
DW
87 if (!nvdimm)
88 return -ENOMEM;
21083f51 89
12f3856a 90 dev_set_drvdata(dev, nvdimm);
f17b558d 91 return devm_add_action_or_reset(dev, unregister_nvdimm, nvdimm);
21083f51
DW
92}
93
94static struct cxl_driver cxl_nvdimm_driver = {
95 .name = "cxl_nvdimm",
96 .probe = cxl_nvdimm_probe,
97 .id = CXL_DEVICE_NVDIMM,
cb9cfff8
DW
98 .drv = {
99 .suppress_bind_attrs = true,
100 },
21083f51
DW
101};
102
5e2411ae 103static int cxl_pmem_get_config_size(struct cxl_dev_state *cxlds,
60b8f172
DW
104 struct nd_cmd_get_config_size *cmd,
105 unsigned int buf_len)
106{
107 if (sizeof(*cmd) > buf_len)
108 return -EINVAL;
109
110 *cmd = (struct nd_cmd_get_config_size) {
5e2411ae 111 .config_size = cxlds->lsa_size,
f010c75c 112 .max_xfer = cxlds->payload_size - sizeof(struct cxl_mbox_set_lsa),
60b8f172
DW
113 };
114
115 return 0;
116}
117
5e2411ae 118static int cxl_pmem_get_config_data(struct cxl_dev_state *cxlds,
60b8f172
DW
119 struct nd_cmd_get_config_data_hdr *cmd,
120 unsigned int buf_len)
121{
49be6dd8 122 struct cxl_mbox_get_lsa get_lsa;
5331cdf4 123 struct cxl_mbox_cmd mbox_cmd;
60b8f172
DW
124 int rc;
125
126 if (sizeof(*cmd) > buf_len)
127 return -EINVAL;
128 if (struct_size(cmd, out_buf, cmd->in_length) > buf_len)
129 return -EINVAL;
130
131 get_lsa = (struct cxl_mbox_get_lsa) {
8a664875
AS
132 .offset = cpu_to_le32(cmd->in_offset),
133 .length = cpu_to_le32(cmd->in_length),
60b8f172 134 };
5331cdf4
DW
135 mbox_cmd = (struct cxl_mbox_cmd) {
136 .opcode = CXL_MBOX_OP_GET_LSA,
137 .payload_in = &get_lsa,
138 .size_in = sizeof(get_lsa),
139 .size_out = cmd->in_length,
140 .payload_out = cmd->out_buf,
141 };
60b8f172 142
5331cdf4 143 rc = cxl_internal_send_cmd(cxlds, &mbox_cmd);
60b8f172
DW
144 cmd->status = 0;
145
146 return rc;
147}
148
5e2411ae 149static int cxl_pmem_set_config_data(struct cxl_dev_state *cxlds,
60b8f172
DW
150 struct nd_cmd_set_config_hdr *cmd,
151 unsigned int buf_len)
152{
49be6dd8 153 struct cxl_mbox_set_lsa *set_lsa;
5331cdf4 154 struct cxl_mbox_cmd mbox_cmd;
60b8f172
DW
155 int rc;
156
157 if (sizeof(*cmd) > buf_len)
158 return -EINVAL;
159
160 /* 4-byte status follows the input data in the payload */
4f1aa35f 161 if (size_add(struct_size(cmd, in_buf, cmd->in_length), 4) > buf_len)
60b8f172
DW
162 return -EINVAL;
163
164 set_lsa =
165 kvzalloc(struct_size(set_lsa, data, cmd->in_length), GFP_KERNEL);
166 if (!set_lsa)
167 return -ENOMEM;
168
169 *set_lsa = (struct cxl_mbox_set_lsa) {
8a664875 170 .offset = cpu_to_le32(cmd->in_offset),
60b8f172
DW
171 };
172 memcpy(set_lsa->data, cmd->in_buf, cmd->in_length);
5331cdf4
DW
173 mbox_cmd = (struct cxl_mbox_cmd) {
174 .opcode = CXL_MBOX_OP_SET_LSA,
175 .payload_in = set_lsa,
176 .size_in = struct_size(set_lsa, data, cmd->in_length),
177 };
60b8f172 178
5331cdf4 179 rc = cxl_internal_send_cmd(cxlds, &mbox_cmd);
60b8f172
DW
180
181 /*
182 * Set "firmware" status (4-packed bytes at the end of the input
183 * payload.
184 */
185 put_unaligned(0, (u32 *) &cmd->in_buf[cmd->in_length]);
186 kvfree(set_lsa);
187
188 return rc;
189}
190
191static int cxl_pmem_nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd,
192 void *buf, unsigned int buf_len)
193{
194 struct cxl_nvdimm *cxl_nvd = nvdimm_provider_data(nvdimm);
195 unsigned long cmd_mask = nvdimm_cmd_mask(nvdimm);
196 struct cxl_memdev *cxlmd = cxl_nvd->cxlmd;
5e2411ae 197 struct cxl_dev_state *cxlds = cxlmd->cxlds;
60b8f172
DW
198
199 if (!test_bit(cmd, &cmd_mask))
200 return -ENOTTY;
201
202 switch (cmd) {
203 case ND_CMD_GET_CONFIG_SIZE:
5e2411ae 204 return cxl_pmem_get_config_size(cxlds, buf, buf_len);
60b8f172 205 case ND_CMD_GET_CONFIG_DATA:
5e2411ae 206 return cxl_pmem_get_config_data(cxlds, buf, buf_len);
60b8f172 207 case ND_CMD_SET_CONFIG_DATA:
5e2411ae 208 return cxl_pmem_set_config_data(cxlds, buf, buf_len);
60b8f172
DW
209 default:
210 return -ENOTTY;
211 }
212}
213
8fdcb170
DW
214static int cxl_pmem_ctl(struct nvdimm_bus_descriptor *nd_desc,
215 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
216 unsigned int buf_len, int *cmd_rc)
217{
60b8f172
DW
218 /*
219 * No firmware response to translate, let the transport error
220 * code take precedence.
221 */
222 *cmd_rc = 0;
223
224 if (!nvdimm)
225 return -ENOTTY;
226 return cxl_pmem_nvdimm_ctl(nvdimm, cmd, buf, buf_len);
8fdcb170
DW
227}
228
19398821
DW
229static int detach_nvdimm(struct device *dev, void *data)
230{
231 struct cxl_nvdimm *cxl_nvd;
232 bool release = false;
233
234 if (!is_cxl_nvdimm(dev))
235 return 0;
236
237 device_lock(dev);
238 if (!dev->driver)
239 goto out;
240
241 cxl_nvd = to_cxl_nvdimm(dev);
242 if (cxl_nvd->cxlmd && cxl_nvd->cxlmd->cxl_nvb == data)
243 release = true;
244out:
245 device_unlock(dev);
246 if (release)
247 device_release_driver(dev);
248 return 0;
249}
250
f17b558d
DW
251static void unregister_nvdimm_bus(void *_cxl_nvb)
252{
253 struct cxl_nvdimm_bridge *cxl_nvb = _cxl_nvb;
254 struct nvdimm_bus *nvdimm_bus = cxl_nvb->nvdimm_bus;
255
19398821
DW
256 bus_for_each_dev(&cxl_bus_type, NULL, cxl_nvb, detach_nvdimm);
257
f17b558d
DW
258 cxl_nvb->nvdimm_bus = NULL;
259 nvdimm_bus_unregister(nvdimm_bus);
260}
261
8fdcb170
DW
262static int cxl_nvdimm_bridge_probe(struct device *dev)
263{
264 struct cxl_nvdimm_bridge *cxl_nvb = to_cxl_nvdimm_bridge(dev);
265
f17b558d
DW
266 cxl_nvb->nd_desc = (struct nvdimm_bus_descriptor) {
267 .provider_name = "CXL",
268 .module = THIS_MODULE,
269 .ndctl = cxl_pmem_ctl,
270 };
8fdcb170 271
f17b558d
DW
272 cxl_nvb->nvdimm_bus =
273 nvdimm_bus_register(&cxl_nvb->dev, &cxl_nvb->nd_desc);
8fdcb170 274
f17b558d
DW
275 if (!cxl_nvb->nvdimm_bus)
276 return -ENOMEM;
8fdcb170 277
f17b558d 278 return devm_add_action_or_reset(dev, unregister_nvdimm_bus, cxl_nvb);
8fdcb170
DW
279}
280
281static struct cxl_driver cxl_nvdimm_bridge_driver = {
282 .name = "cxl_nvdimm_bridge",
283 .probe = cxl_nvdimm_bridge_probe,
8fdcb170 284 .id = CXL_DEVICE_NVDIMM_BRIDGE,
cb9cfff8
DW
285 .drv = {
286 .suppress_bind_attrs = true,
287 },
8fdcb170
DW
288};
289
04ad63f0
DW
290static void unregister_nvdimm_region(void *nd_region)
291{
4d07ae22
DW
292 nvdimm_region_delete(nd_region);
293}
294
04ad63f0
DW
295static void cxlr_pmem_remove_resource(void *res)
296{
297 remove_resource(res);
298}
299
300struct cxl_pmem_region_info {
301 u64 offset;
302 u64 serial;
303};
304
305static int cxl_pmem_region_probe(struct device *dev)
306{
307 struct nd_mapping_desc mappings[CXL_DECODER_MAX_INTERLEAVE];
308 struct cxl_pmem_region *cxlr_pmem = to_cxl_pmem_region(dev);
309 struct cxl_region *cxlr = cxlr_pmem->cxlr;
f17b558d 310 struct cxl_nvdimm_bridge *cxl_nvb = cxlr->cxl_nvb;
04ad63f0 311 struct cxl_pmem_region_info *info = NULL;
04ad63f0
DW
312 struct nd_interleave_set *nd_set;
313 struct nd_region_desc ndr_desc;
314 struct cxl_nvdimm *cxl_nvd;
315 struct nvdimm *nvdimm;
316 struct resource *res;
317 int rc, i = 0;
318
04ad63f0
DW
319 memset(&mappings, 0, sizeof(mappings));
320 memset(&ndr_desc, 0, sizeof(ndr_desc));
321
322 res = devm_kzalloc(dev, sizeof(*res), GFP_KERNEL);
f17b558d
DW
323 if (!res)
324 return -ENOMEM;
04ad63f0
DW
325
326 res->name = "Persistent Memory";
327 res->start = cxlr_pmem->hpa_range.start;
328 res->end = cxlr_pmem->hpa_range.end;
329 res->flags = IORESOURCE_MEM;
330 res->desc = IORES_DESC_PERSISTENT_MEMORY;
331
332 rc = insert_resource(&iomem_resource, res);
333 if (rc)
f17b558d 334 return rc;
04ad63f0
DW
335
336 rc = devm_add_action_or_reset(dev, cxlr_pmem_remove_resource, res);
337 if (rc)
f17b558d 338 return rc;
04ad63f0
DW
339
340 ndr_desc.res = res;
341 ndr_desc.provider_data = cxlr_pmem;
342
343 ndr_desc.numa_node = memory_add_physaddr_to_nid(res->start);
344 ndr_desc.target_node = phys_to_target_node(res->start);
345 if (ndr_desc.target_node == NUMA_NO_NODE) {
346 ndr_desc.target_node = ndr_desc.numa_node;
347 dev_dbg(&cxlr->dev, "changing target node from %d to %d",
348 NUMA_NO_NODE, ndr_desc.target_node);
349 }
350
351 nd_set = devm_kzalloc(dev, sizeof(*nd_set), GFP_KERNEL);
f17b558d
DW
352 if (!nd_set)
353 return -ENOMEM;
04ad63f0
DW
354
355 ndr_desc.memregion = cxlr->id;
356 set_bit(ND_REGION_CXL, &ndr_desc.flags);
357 set_bit(ND_REGION_PERSIST_MEMCTRL, &ndr_desc.flags);
358
359 info = kmalloc_array(cxlr_pmem->nr_mappings, sizeof(*info), GFP_KERNEL);
f17b558d
DW
360 if (!info)
361 return -ENOMEM;
04ad63f0
DW
362
363 for (i = 0; i < cxlr_pmem->nr_mappings; i++) {
364 struct cxl_pmem_region_mapping *m = &cxlr_pmem->mapping[i];
365 struct cxl_memdev *cxlmd = m->cxlmd;
366 struct cxl_dev_state *cxlds = cxlmd->cxlds;
04ad63f0 367
f17b558d 368 cxl_nvd = cxlmd->cxl_nvd;
04ad63f0
DW
369 nvdimm = dev_get_drvdata(&cxl_nvd->dev);
370 if (!nvdimm) {
371 dev_dbg(dev, "[%d]: %s: no nvdimm found\n", i,
372 dev_name(&cxlmd->dev));
373 rc = -ENODEV;
4d07ae22 374 goto out_nvd;
04ad63f0 375 }
4d07ae22 376
04ad63f0
DW
377 m->cxl_nvd = cxl_nvd;
378 mappings[i] = (struct nd_mapping_desc) {
379 .nvdimm = nvdimm,
380 .start = m->start,
381 .size = m->size,
382 .position = i,
383 };
384 info[i].offset = m->start;
385 info[i].serial = cxlds->serial;
386 }
387 ndr_desc.num_mappings = cxlr_pmem->nr_mappings;
388 ndr_desc.mapping = mappings;
389
390 /*
391 * TODO enable CXL labels which skip the need for 'interleave-set cookie'
392 */
393 nd_set->cookie1 =
394 nd_fletcher64(info, sizeof(*info) * cxlr_pmem->nr_mappings, 0);
395 nd_set->cookie2 = nd_set->cookie1;
396 ndr_desc.nd_set = nd_set;
397
398 cxlr_pmem->nd_region =
399 nvdimm_pmem_region_create(cxl_nvb->nvdimm_bus, &ndr_desc);
9fd2cf4d
DC
400 if (!cxlr_pmem->nd_region) {
401 rc = -ENOMEM;
4d07ae22 402 goto out_nvd;
04ad63f0
DW
403 }
404
405 rc = devm_add_action_or_reset(dev, unregister_nvdimm_region,
406 cxlr_pmem->nd_region);
4d07ae22 407out_nvd:
04ad63f0 408 kfree(info);
04ad63f0
DW
409
410 return rc;
04ad63f0
DW
411}
412
413static struct cxl_driver cxl_pmem_region_driver = {
414 .name = "cxl_pmem_region",
415 .probe = cxl_pmem_region_probe,
416 .id = CXL_DEVICE_PMEM_REGION,
cb9cfff8
DW
417 .drv = {
418 .suppress_bind_attrs = true,
419 },
04ad63f0
DW
420};
421
8fdcb170
DW
422static __init int cxl_pmem_init(void)
423{
424 int rc;
425
12f3856a
DW
426 set_bit(CXL_MEM_COMMAND_ID_SET_SHUTDOWN_STATE, exclusive_cmds);
427 set_bit(CXL_MEM_COMMAND_ID_SET_LSA, exclusive_cmds);
428
8fdcb170
DW
429 rc = cxl_driver_register(&cxl_nvdimm_bridge_driver);
430 if (rc)
03ff079a 431 return rc;
21083f51
DW
432
433 rc = cxl_driver_register(&cxl_nvdimm_driver);
434 if (rc)
435 goto err_nvdimm;
8fdcb170 436
04ad63f0
DW
437 rc = cxl_driver_register(&cxl_pmem_region_driver);
438 if (rc)
439 goto err_region;
440
8fdcb170
DW
441 return 0;
442
04ad63f0
DW
443err_region:
444 cxl_driver_unregister(&cxl_nvdimm_driver);
21083f51
DW
445err_nvdimm:
446 cxl_driver_unregister(&cxl_nvdimm_bridge_driver);
8fdcb170
DW
447 return rc;
448}
449
450static __exit void cxl_pmem_exit(void)
451{
04ad63f0 452 cxl_driver_unregister(&cxl_pmem_region_driver);
21083f51 453 cxl_driver_unregister(&cxl_nvdimm_driver);
8fdcb170 454 cxl_driver_unregister(&cxl_nvdimm_bridge_driver);
8fdcb170
DW
455}
456
457MODULE_LICENSE("GPL v2");
458module_init(cxl_pmem_init);
459module_exit(cxl_pmem_exit);
460MODULE_IMPORT_NS(CXL);
461MODULE_ALIAS_CXL(CXL_DEVICE_NVDIMM_BRIDGE);
21083f51 462MODULE_ALIAS_CXL(CXL_DEVICE_NVDIMM);
04ad63f0 463MODULE_ALIAS_CXL(CXL_DEVICE_PMEM_REGION);