1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
5 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
6 #include <linux/libnvdimm.h>
7 #include <linux/sched/mm.h>
8 #include <linux/vmalloc.h>
9 #include <linux/uaccess.h>
10 #include <linux/module.h>
11 #include <linux/blkdev.h>
12 #include <linux/fcntl.h>
13 #include <linux/async.h>
14 #include <linux/genhd.h>
15 #include <linux/ndctl.h>
16 #include <linux/sched.h>
17 #include <linux/slab.h>
18 #include <linux/cpu.h>
28 static int nvdimm_bus_major;
29 struct class *nd_class;
30 static DEFINE_IDA(nd_ida);
32 static int to_nd_device_type(struct device *dev)
35 return ND_DEVICE_DIMM;
36 else if (is_memory(dev))
37 return ND_DEVICE_REGION_PMEM;
38 else if (is_nd_blk(dev))
39 return ND_DEVICE_REGION_BLK;
40 else if (is_nd_dax(dev))
41 return ND_DEVICE_DAX_PMEM;
42 else if (is_nd_region(dev->parent))
43 return nd_region_to_nstype(to_nd_region(dev->parent));
48 static int nvdimm_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
50 return add_uevent_var(env, "MODALIAS=" ND_DEVICE_MODALIAS_FMT,
51 to_nd_device_type(dev));
54 static struct module *to_bus_provider(struct device *dev)
56 /* pin bus providers while regions are enabled */
57 if (is_nd_region(dev)) {
58 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
60 return nvdimm_bus->nd_desc->module;
65 static void nvdimm_bus_probe_start(struct nvdimm_bus *nvdimm_bus)
67 nvdimm_bus_lock(&nvdimm_bus->dev);
68 nvdimm_bus->probe_active++;
69 nvdimm_bus_unlock(&nvdimm_bus->dev);
72 static void nvdimm_bus_probe_end(struct nvdimm_bus *nvdimm_bus)
74 nvdimm_bus_lock(&nvdimm_bus->dev);
75 if (--nvdimm_bus->probe_active == 0)
76 wake_up(&nvdimm_bus->wait);
77 nvdimm_bus_unlock(&nvdimm_bus->dev);
80 static int nvdimm_bus_probe(struct device *dev)
82 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
83 struct module *provider = to_bus_provider(dev);
84 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
87 if (!try_module_get(provider))
90 dev_dbg(&nvdimm_bus->dev, "START: %s.probe(%s)\n",
91 dev->driver->name, dev_name(dev));
93 nvdimm_bus_probe_start(nvdimm_bus);
94 debug_nvdimm_lock(dev);
95 rc = nd_drv->probe(dev);
96 debug_nvdimm_unlock(dev);
98 if ((rc == 0 || rc == -EOPNOTSUPP) &&
99 dev->parent && is_nd_region(dev->parent))
100 nd_region_advance_seeds(to_nd_region(dev->parent), dev);
101 nvdimm_bus_probe_end(nvdimm_bus);
103 dev_dbg(&nvdimm_bus->dev, "END: %s.probe(%s) = %d\n", dev->driver->name,
107 module_put(provider);
111 static int nvdimm_bus_remove(struct device *dev)
113 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
114 struct module *provider = to_bus_provider(dev);
115 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
117 if (nd_drv->remove) {
118 debug_nvdimm_lock(dev);
120 debug_nvdimm_unlock(dev);
123 dev_dbg(&nvdimm_bus->dev, "%s.remove(%s)\n", dev->driver->name,
125 module_put(provider);
129 static void nvdimm_bus_shutdown(struct device *dev)
131 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
132 struct nd_device_driver *nd_drv = NULL;
135 nd_drv = to_nd_device_driver(dev->driver);
137 if (nd_drv && nd_drv->shutdown) {
138 nd_drv->shutdown(dev);
139 dev_dbg(&nvdimm_bus->dev, "%s.shutdown(%s)\n",
140 dev->driver->name, dev_name(dev));
144 void nd_device_notify(struct device *dev, enum nvdimm_event event)
148 struct nd_device_driver *nd_drv;
150 nd_drv = to_nd_device_driver(dev->driver);
152 nd_drv->notify(dev, event);
154 nd_device_unlock(dev);
156 EXPORT_SYMBOL(nd_device_notify);
158 void nvdimm_region_notify(struct nd_region *nd_region, enum nvdimm_event event)
160 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&nd_region->dev);
165 /* caller is responsible for holding a reference on the device */
166 nd_device_notify(&nd_region->dev, event);
168 EXPORT_SYMBOL_GPL(nvdimm_region_notify);
170 struct clear_badblocks_context {
171 resource_size_t phys, cleared;
174 static int nvdimm_clear_badblocks_region(struct device *dev, void *data)
176 struct clear_badblocks_context *ctx = data;
177 struct nd_region *nd_region;
178 resource_size_t ndr_end;
181 /* make sure device is a region */
185 nd_region = to_nd_region(dev);
186 ndr_end = nd_region->ndr_start + nd_region->ndr_size - 1;
188 /* make sure we are in the region */
189 if (ctx->phys < nd_region->ndr_start
190 || (ctx->phys + ctx->cleared) > ndr_end)
193 sector = (ctx->phys - nd_region->ndr_start) / 512;
194 badblocks_clear(&nd_region->bb, sector, ctx->cleared / 512);
196 if (nd_region->bb_state)
197 sysfs_notify_dirent(nd_region->bb_state);
202 static void nvdimm_clear_badblocks_regions(struct nvdimm_bus *nvdimm_bus,
203 phys_addr_t phys, u64 cleared)
205 struct clear_badblocks_context ctx = {
210 device_for_each_child(&nvdimm_bus->dev, &ctx,
211 nvdimm_clear_badblocks_region);
214 static void nvdimm_account_cleared_poison(struct nvdimm_bus *nvdimm_bus,
215 phys_addr_t phys, u64 cleared)
218 badrange_forget(&nvdimm_bus->badrange, phys, cleared);
220 if (cleared > 0 && cleared / 512)
221 nvdimm_clear_badblocks_regions(nvdimm_bus, phys, cleared);
224 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
227 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
228 struct nvdimm_bus_descriptor *nd_desc;
229 struct nd_cmd_clear_error clear_err;
230 struct nd_cmd_ars_cap ars_cap;
231 u32 clear_err_unit, mask;
232 unsigned int noio_flag;
238 nd_desc = nvdimm_bus->nd_desc;
240 * if ndctl does not exist, it's PMEM_LEGACY and
241 * we want to just pretend everything is handled.
246 memset(&ars_cap, 0, sizeof(ars_cap));
247 ars_cap.address = phys;
248 ars_cap.length = len;
249 noio_flag = memalloc_noio_save();
250 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, &ars_cap,
251 sizeof(ars_cap), &cmd_rc);
252 memalloc_noio_restore(noio_flag);
257 clear_err_unit = ars_cap.clear_err_unit;
258 if (!clear_err_unit || !is_power_of_2(clear_err_unit))
261 mask = clear_err_unit - 1;
262 if ((phys | len) & mask)
264 memset(&clear_err, 0, sizeof(clear_err));
265 clear_err.address = phys;
266 clear_err.length = len;
267 noio_flag = memalloc_noio_save();
268 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_CLEAR_ERROR, &clear_err,
269 sizeof(clear_err), &cmd_rc);
270 memalloc_noio_restore(noio_flag);
276 nvdimm_account_cleared_poison(nvdimm_bus, phys, clear_err.cleared);
278 return clear_err.cleared;
280 EXPORT_SYMBOL_GPL(nvdimm_clear_poison);
282 static int nvdimm_bus_match(struct device *dev, struct device_driver *drv);
284 static struct bus_type nvdimm_bus_type = {
286 .uevent = nvdimm_bus_uevent,
287 .match = nvdimm_bus_match,
288 .probe = nvdimm_bus_probe,
289 .remove = nvdimm_bus_remove,
290 .shutdown = nvdimm_bus_shutdown,
293 static void nvdimm_bus_release(struct device *dev)
295 struct nvdimm_bus *nvdimm_bus;
297 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
298 ida_simple_remove(&nd_ida, nvdimm_bus->id);
302 static const struct device_type nvdimm_bus_dev_type = {
303 .release = nvdimm_bus_release,
304 .groups = nvdimm_bus_attribute_groups,
307 bool is_nvdimm_bus(struct device *dev)
309 return dev->type == &nvdimm_bus_dev_type;
312 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev)
316 for (dev = nd_dev; dev; dev = dev->parent)
317 if (is_nvdimm_bus(dev))
319 dev_WARN_ONCE(nd_dev, !dev, "invalid dev, not on nd bus\n");
321 return to_nvdimm_bus(dev);
325 struct nvdimm_bus *to_nvdimm_bus(struct device *dev)
327 struct nvdimm_bus *nvdimm_bus;
329 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
330 WARN_ON(!is_nvdimm_bus(dev));
333 EXPORT_SYMBOL_GPL(to_nvdimm_bus);
335 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm)
337 return to_nvdimm_bus(nvdimm->dev.parent);
339 EXPORT_SYMBOL_GPL(nvdimm_to_bus);
341 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
342 struct nvdimm_bus_descriptor *nd_desc)
344 struct nvdimm_bus *nvdimm_bus;
347 nvdimm_bus = kzalloc(sizeof(*nvdimm_bus), GFP_KERNEL);
350 INIT_LIST_HEAD(&nvdimm_bus->list);
351 INIT_LIST_HEAD(&nvdimm_bus->mapping_list);
352 init_waitqueue_head(&nvdimm_bus->wait);
353 nvdimm_bus->id = ida_simple_get(&nd_ida, 0, 0, GFP_KERNEL);
354 if (nvdimm_bus->id < 0) {
358 mutex_init(&nvdimm_bus->reconfig_mutex);
359 badrange_init(&nvdimm_bus->badrange);
360 nvdimm_bus->nd_desc = nd_desc;
361 nvdimm_bus->dev.parent = parent;
362 nvdimm_bus->dev.type = &nvdimm_bus_dev_type;
363 nvdimm_bus->dev.groups = nd_desc->attr_groups;
364 nvdimm_bus->dev.bus = &nvdimm_bus_type;
365 nvdimm_bus->dev.of_node = nd_desc->of_node;
366 device_initialize(&nvdimm_bus->dev);
367 device_set_pm_not_required(&nvdimm_bus->dev);
368 rc = dev_set_name(&nvdimm_bus->dev, "ndbus%d", nvdimm_bus->id);
372 rc = device_add(&nvdimm_bus->dev);
374 dev_dbg(&nvdimm_bus->dev, "registration failed: %d\n", rc);
380 put_device(&nvdimm_bus->dev);
383 EXPORT_SYMBOL_GPL(nvdimm_bus_register);
385 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus)
389 device_unregister(&nvdimm_bus->dev);
391 EXPORT_SYMBOL_GPL(nvdimm_bus_unregister);
393 static int child_unregister(struct device *dev, void *data)
396 * the singular ndctl class device per bus needs to be
397 * "device_destroy"ed, so skip it here
399 * i.e. remove classless children
405 nvdimm_delete(to_nvdimm(dev));
407 nd_device_unregister(dev, ND_SYNC);
412 static void free_badrange_list(struct list_head *badrange_list)
414 struct badrange_entry *bre, *next;
416 list_for_each_entry_safe(bre, next, badrange_list, list) {
417 list_del(&bre->list);
420 list_del_init(badrange_list);
423 static void nd_bus_remove(struct device *dev)
425 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
427 mutex_lock(&nvdimm_bus_list_mutex);
428 list_del_init(&nvdimm_bus->list);
429 mutex_unlock(&nvdimm_bus_list_mutex);
431 wait_event(nvdimm_bus->wait,
432 atomic_read(&nvdimm_bus->ioctl_active) == 0);
435 device_for_each_child(&nvdimm_bus->dev, NULL, child_unregister);
437 spin_lock(&nvdimm_bus->badrange.lock);
438 free_badrange_list(&nvdimm_bus->badrange.list);
439 spin_unlock(&nvdimm_bus->badrange.lock);
441 nvdimm_bus_destroy_ndctl(nvdimm_bus);
444 static int nd_bus_probe(struct device *dev)
446 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
449 rc = nvdimm_bus_create_ndctl(nvdimm_bus);
453 mutex_lock(&nvdimm_bus_list_mutex);
454 list_add_tail(&nvdimm_bus->list, &nvdimm_bus_list);
455 mutex_unlock(&nvdimm_bus_list_mutex);
457 /* enable bus provider attributes to look up their local context */
458 dev_set_drvdata(dev, nvdimm_bus->nd_desc);
463 static struct nd_device_driver nd_bus_driver = {
464 .probe = nd_bus_probe,
465 .remove = nd_bus_remove,
468 .suppress_bind_attrs = true,
469 .bus = &nvdimm_bus_type,
470 .owner = THIS_MODULE,
471 .mod_name = KBUILD_MODNAME,
475 static int nvdimm_bus_match(struct device *dev, struct device_driver *drv)
477 struct nd_device_driver *nd_drv = to_nd_device_driver(drv);
479 if (is_nvdimm_bus(dev) && nd_drv == &nd_bus_driver)
482 return !!test_bit(to_nd_device_type(dev), &nd_drv->type);
485 static ASYNC_DOMAIN_EXCLUSIVE(nd_async_domain);
487 void nd_synchronize(void)
489 async_synchronize_full_domain(&nd_async_domain);
491 EXPORT_SYMBOL_GPL(nd_synchronize);
493 static void nd_async_device_register(void *d, async_cookie_t cookie)
495 struct device *dev = d;
497 if (device_add(dev) != 0) {
498 dev_err(dev, "%s: failed\n", __func__);
503 put_device(dev->parent);
506 static void nd_async_device_unregister(void *d, async_cookie_t cookie)
508 struct device *dev = d;
510 /* flush bus operations before delete */
511 nvdimm_bus_lock(dev);
512 nvdimm_bus_unlock(dev);
514 device_unregister(dev);
518 void __nd_device_register(struct device *dev)
524 * Ensure that region devices always have their NUMA node set as
525 * early as possible. This way we are able to make certain that
526 * any memory associated with the creation and the creation
527 * itself of the region is associated with the correct node.
529 if (is_nd_region(dev))
530 set_dev_node(dev, to_nd_region(dev)->numa_node);
532 dev->bus = &nvdimm_bus_type;
533 device_set_pm_not_required(dev);
535 get_device(dev->parent);
536 if (dev_to_node(dev) == NUMA_NO_NODE)
537 set_dev_node(dev, dev_to_node(dev->parent));
541 async_schedule_dev_domain(nd_async_device_register, dev,
545 void nd_device_register(struct device *dev)
547 device_initialize(dev);
548 __nd_device_register(dev);
550 EXPORT_SYMBOL(nd_device_register);
552 void nd_device_unregister(struct device *dev, enum nd_async_mode mode)
559 * In the async case this is being triggered with the
560 * device lock held and the unregistration work needs to
561 * be moved out of line iff this is thread has won the
562 * race to schedule the deletion.
564 if (!kill_device(dev))
568 async_schedule_domain(nd_async_device_unregister, dev,
573 * In the sync case the device is being unregistered due
574 * to a state change of the parent. Claim the kill state
575 * to synchronize against other unregistration requests,
576 * or otherwise let the async path handle it if the
577 * unregistration was already queued.
580 killed = kill_device(dev);
581 nd_device_unlock(dev);
587 device_unregister(dev);
591 EXPORT_SYMBOL(nd_device_unregister);
594 * __nd_driver_register() - register a region or a namespace driver
595 * @nd_drv: driver to register
596 * @owner: automatically set by nd_driver_register() macro
597 * @mod_name: automatically set by nd_driver_register() macro
599 int __nd_driver_register(struct nd_device_driver *nd_drv, struct module *owner,
600 const char *mod_name)
602 struct device_driver *drv = &nd_drv->drv;
605 pr_debug("driver type bitmask not set (%ps)\n",
606 __builtin_return_address(0));
610 if (!nd_drv->probe) {
611 pr_debug("%s ->probe() must be specified\n", mod_name);
615 drv->bus = &nvdimm_bus_type;
617 drv->mod_name = mod_name;
619 return driver_register(drv);
621 EXPORT_SYMBOL(__nd_driver_register);
623 void nvdimm_check_and_set_ro(struct gendisk *disk)
625 struct device *dev = disk_to_dev(disk)->parent;
626 struct nd_region *nd_region = to_nd_region(dev->parent);
627 int disk_ro = get_disk_ro(disk);
629 /* catch the disk up with the region ro state */
630 if (disk_ro == nd_region->ro)
633 dev_info(dev, "%s read-%s, marking %s read-%s\n",
634 dev_name(&nd_region->dev), nd_region->ro ? "only" : "write",
635 disk->disk_name, nd_region->ro ? "only" : "write");
636 set_disk_ro(disk, nd_region->ro);
638 EXPORT_SYMBOL(nvdimm_check_and_set_ro);
640 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
643 return sprintf(buf, ND_DEVICE_MODALIAS_FMT "\n",
644 to_nd_device_type(dev));
646 static DEVICE_ATTR_RO(modalias);
648 static ssize_t devtype_show(struct device *dev, struct device_attribute *attr,
651 return sprintf(buf, "%s\n", dev->type->name);
653 static DEVICE_ATTR_RO(devtype);
655 static struct attribute *nd_device_attributes[] = {
656 &dev_attr_modalias.attr,
657 &dev_attr_devtype.attr,
662 * nd_device_attribute_group - generic attributes for all devices on an nd bus
664 const struct attribute_group nd_device_attribute_group = {
665 .attrs = nd_device_attributes,
668 static ssize_t numa_node_show(struct device *dev,
669 struct device_attribute *attr, char *buf)
671 return sprintf(buf, "%d\n", dev_to_node(dev));
673 static DEVICE_ATTR_RO(numa_node);
675 static int nvdimm_dev_to_target_node(struct device *dev)
677 struct device *parent = dev->parent;
678 struct nd_region *nd_region = NULL;
680 if (is_nd_region(dev))
681 nd_region = to_nd_region(dev);
682 else if (parent && is_nd_region(parent))
683 nd_region = to_nd_region(parent);
687 return nd_region->target_node;
690 static ssize_t target_node_show(struct device *dev,
691 struct device_attribute *attr, char *buf)
693 return sprintf(buf, "%d\n", nvdimm_dev_to_target_node(dev));
695 static DEVICE_ATTR_RO(target_node);
697 static struct attribute *nd_numa_attributes[] = {
698 &dev_attr_numa_node.attr,
699 &dev_attr_target_node.attr,
703 static umode_t nd_numa_attr_visible(struct kobject *kobj, struct attribute *a,
706 struct device *dev = container_of(kobj, typeof(*dev), kobj);
708 if (!IS_ENABLED(CONFIG_NUMA))
711 if (a == &dev_attr_target_node.attr &&
712 nvdimm_dev_to_target_node(dev) == NUMA_NO_NODE)
719 * nd_numa_attribute_group - NUMA attributes for all devices on an nd bus
721 const struct attribute_group nd_numa_attribute_group = {
722 .attrs = nd_numa_attributes,
723 .is_visible = nd_numa_attr_visible,
726 static void ndctl_release(struct device *dev)
731 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus)
733 dev_t devt = MKDEV(nvdimm_bus_major, nvdimm_bus->id);
737 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
740 device_initialize(dev);
741 device_set_pm_not_required(dev);
742 dev->class = nd_class;
743 dev->parent = &nvdimm_bus->dev;
745 dev->release = ndctl_release;
746 rc = dev_set_name(dev, "ndctl%d", nvdimm_bus->id);
750 rc = device_add(dev);
752 dev_dbg(&nvdimm_bus->dev, "failed to register ndctl%d: %d\n",
763 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus)
765 device_destroy(nd_class, MKDEV(nvdimm_bus_major, nvdimm_bus->id));
768 static const struct nd_cmd_desc __nd_cmd_dimm_descs[] = {
769 [ND_CMD_IMPLEMENTED] = { },
772 .out_sizes = { 4, 128, },
774 [ND_CMD_SMART_THRESHOLD] = {
776 .out_sizes = { 4, 8, },
778 [ND_CMD_DIMM_FLAGS] = {
780 .out_sizes = { 4, 4 },
782 [ND_CMD_GET_CONFIG_SIZE] = {
784 .out_sizes = { 4, 4, 4, },
786 [ND_CMD_GET_CONFIG_DATA] = {
788 .in_sizes = { 4, 4, },
790 .out_sizes = { 4, UINT_MAX, },
792 [ND_CMD_SET_CONFIG_DATA] = {
794 .in_sizes = { 4, 4, UINT_MAX, },
800 .in_sizes = { 4, 4, UINT_MAX, },
802 .out_sizes = { 4, 4, UINT_MAX, },
806 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
808 .out_sizes = { UINT_MAX, },
812 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd)
814 if (cmd < ARRAY_SIZE(__nd_cmd_dimm_descs))
815 return &__nd_cmd_dimm_descs[cmd];
818 EXPORT_SYMBOL_GPL(nd_cmd_dimm_desc);
820 static const struct nd_cmd_desc __nd_cmd_bus_descs[] = {
821 [ND_CMD_IMPLEMENTED] = { },
824 .in_sizes = { 8, 8, },
826 .out_sizes = { 4, 4, 4, 4, },
828 [ND_CMD_ARS_START] = {
830 .in_sizes = { 8, 8, 2, 1, 5, },
832 .out_sizes = { 4, 4, },
834 [ND_CMD_ARS_STATUS] = {
836 .out_sizes = { 4, 4, UINT_MAX, },
838 [ND_CMD_CLEAR_ERROR] = {
840 .in_sizes = { 8, 8, },
842 .out_sizes = { 4, 4, 8, },
846 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
848 .out_sizes = { UINT_MAX, },
852 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd)
854 if (cmd < ARRAY_SIZE(__nd_cmd_bus_descs))
855 return &__nd_cmd_bus_descs[cmd];
858 EXPORT_SYMBOL_GPL(nd_cmd_bus_desc);
860 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
861 const struct nd_cmd_desc *desc, int idx, void *buf)
863 if (idx >= desc->in_num)
866 if (desc->in_sizes[idx] < UINT_MAX)
867 return desc->in_sizes[idx];
869 if (nvdimm && cmd == ND_CMD_SET_CONFIG_DATA && idx == 2) {
870 struct nd_cmd_set_config_hdr *hdr = buf;
872 return hdr->in_length;
873 } else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2) {
874 struct nd_cmd_vendor_hdr *hdr = buf;
876 return hdr->in_length;
877 } else if (cmd == ND_CMD_CALL) {
878 struct nd_cmd_pkg *pkg = buf;
880 return pkg->nd_size_in;
885 EXPORT_SYMBOL_GPL(nd_cmd_in_size);
887 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
888 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
889 const u32 *out_field, unsigned long remainder)
891 if (idx >= desc->out_num)
894 if (desc->out_sizes[idx] < UINT_MAX)
895 return desc->out_sizes[idx];
897 if (nvdimm && cmd == ND_CMD_GET_CONFIG_DATA && idx == 1)
899 else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2)
901 else if (!nvdimm && cmd == ND_CMD_ARS_STATUS && idx == 2) {
903 * Per table 9-276 ARS Data in ACPI 6.1, out_field[1] is
904 * "Size of Output Buffer in bytes, including this
907 if (out_field[1] < 4)
910 * ACPI 6.1 is ambiguous if 'status' is included in the
911 * output size. If we encounter an output size that
912 * overshoots the remainder by 4 bytes, assume it was
913 * including 'status'.
915 if (out_field[1] - 4 == remainder)
917 return out_field[1] - 8;
918 } else if (cmd == ND_CMD_CALL) {
919 struct nd_cmd_pkg *pkg = (struct nd_cmd_pkg *) in_field;
921 return pkg->nd_size_out;
927 EXPORT_SYMBOL_GPL(nd_cmd_out_size);
929 void wait_nvdimm_bus_probe_idle(struct device *dev)
931 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
934 if (nvdimm_bus->probe_active == 0)
936 nvdimm_bus_unlock(dev);
937 nd_device_unlock(dev);
938 wait_event(nvdimm_bus->wait,
939 nvdimm_bus->probe_active == 0);
941 nvdimm_bus_lock(dev);
945 static int nd_pmem_forget_poison_check(struct device *dev, void *data)
947 struct nd_cmd_clear_error *clear_err =
948 (struct nd_cmd_clear_error *)data;
949 struct nd_btt *nd_btt = is_nd_btt(dev) ? to_nd_btt(dev) : NULL;
950 struct nd_pfn *nd_pfn = is_nd_pfn(dev) ? to_nd_pfn(dev) : NULL;
951 struct nd_dax *nd_dax = is_nd_dax(dev) ? to_nd_dax(dev) : NULL;
952 struct nd_namespace_common *ndns = NULL;
953 struct nd_namespace_io *nsio;
954 resource_size_t offset = 0, end_trunc = 0, start, end, pstart, pend;
956 if (nd_dax || !dev->driver)
959 start = clear_err->address;
960 end = clear_err->address + clear_err->cleared - 1;
962 if (nd_btt || nd_pfn || nd_dax) {
968 ndns = nd_dax->nd_pfn.ndns;
975 nsio = to_nd_namespace_io(&ndns->dev);
976 pstart = nsio->res.start + offset;
977 pend = nsio->res.end - end_trunc;
979 if ((pstart >= start) && (pend <= end))
986 static int nd_ns_forget_poison_check(struct device *dev, void *data)
988 return device_for_each_child(dev, data, nd_pmem_forget_poison_check);
991 /* set_config requires an idle interleave set */
992 static int nd_cmd_clear_to_send(struct nvdimm_bus *nvdimm_bus,
993 struct nvdimm *nvdimm, unsigned int cmd, void *data)
995 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
997 /* ask the bus provider if it would like to block this request */
998 if (nd_desc->clear_to_send) {
999 int rc = nd_desc->clear_to_send(nd_desc, nvdimm, cmd, data);
1005 /* require clear error to go through the pmem driver */
1006 if (!nvdimm && cmd == ND_CMD_CLEAR_ERROR)
1007 return device_for_each_child(&nvdimm_bus->dev, data,
1008 nd_ns_forget_poison_check);
1010 if (!nvdimm || cmd != ND_CMD_SET_CONFIG_DATA)
1013 /* prevent label manipulation while the kernel owns label updates */
1014 wait_nvdimm_bus_probe_idle(&nvdimm_bus->dev);
1015 if (atomic_read(&nvdimm->busy))
1020 static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
1021 int read_only, unsigned int ioctl_cmd, unsigned long arg)
1023 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
1024 const struct nd_cmd_desc *desc = NULL;
1025 unsigned int cmd = _IOC_NR(ioctl_cmd);
1026 struct device *dev = &nvdimm_bus->dev;
1027 void __user *p = (void __user *) arg;
1028 char *out_env = NULL, *in_env = NULL;
1029 const char *cmd_name, *dimm_name;
1030 u32 in_len = 0, out_len = 0;
1031 unsigned int func = cmd;
1032 unsigned long cmd_mask;
1033 struct nd_cmd_pkg pkg;
1039 desc = nd_cmd_dimm_desc(cmd);
1040 cmd_name = nvdimm_cmd_name(cmd);
1041 cmd_mask = nvdimm->cmd_mask;
1042 dimm_name = dev_name(&nvdimm->dev);
1044 desc = nd_cmd_bus_desc(cmd);
1045 cmd_name = nvdimm_bus_cmd_name(cmd);
1046 cmd_mask = nd_desc->cmd_mask;
1050 /* Validate command family support against bus declared support */
1051 if (cmd == ND_CMD_CALL) {
1052 unsigned long *mask;
1054 if (copy_from_user(&pkg, p, sizeof(pkg)))
1058 if (pkg.nd_family > NVDIMM_FAMILY_MAX)
1060 mask = &nd_desc->dimm_family_mask;
1062 if (pkg.nd_family > NVDIMM_BUS_FAMILY_MAX)
1064 mask = &nd_desc->bus_family_mask;
1067 if (!test_bit(pkg.nd_family, mask))
1072 (desc->out_num + desc->in_num == 0) ||
1073 cmd > ND_CMD_CALL ||
1074 !test_bit(cmd, &cmd_mask))
1077 /* fail write commands (when read-only) */
1081 case ND_CMD_SET_CONFIG_DATA:
1082 case ND_CMD_ARS_START:
1083 case ND_CMD_CLEAR_ERROR:
1085 dev_dbg(dev, "'%s' command while read-only.\n",
1086 nvdimm ? nvdimm_cmd_name(cmd)
1087 : nvdimm_bus_cmd_name(cmd));
1093 /* process an input envelope */
1094 in_env = kzalloc(ND_CMD_MAX_ENVELOPE, GFP_KERNEL);
1097 for (i = 0; i < desc->in_num; i++) {
1100 in_size = nd_cmd_in_size(nvdimm, cmd, desc, i, in_env);
1101 if (in_size == UINT_MAX) {
1102 dev_err(dev, "%s:%s unknown input size cmd: %s field: %d\n",
1103 __func__, dimm_name, cmd_name, i);
1107 if (in_len < ND_CMD_MAX_ENVELOPE)
1108 copy = min_t(u32, ND_CMD_MAX_ENVELOPE - in_len, in_size);
1111 if (copy && copy_from_user(&in_env[in_len], p + in_len, copy)) {
1118 if (cmd == ND_CMD_CALL) {
1119 func = pkg.nd_command;
1120 dev_dbg(dev, "%s, idx: %llu, in: %u, out: %u, len %llu\n",
1121 dimm_name, pkg.nd_command,
1122 in_len, out_len, buf_len);
1125 /* process an output envelope */
1126 out_env = kzalloc(ND_CMD_MAX_ENVELOPE, GFP_KERNEL);
1132 for (i = 0; i < desc->out_num; i++) {
1133 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i,
1134 (u32 *) in_env, (u32 *) out_env, 0);
1137 if (out_size == UINT_MAX) {
1138 dev_dbg(dev, "%s unknown output size cmd: %s field: %d\n",
1139 dimm_name, cmd_name, i);
1143 if (out_len < ND_CMD_MAX_ENVELOPE)
1144 copy = min_t(u32, ND_CMD_MAX_ENVELOPE - out_len, out_size);
1147 if (copy && copy_from_user(&out_env[out_len],
1148 p + in_len + out_len, copy)) {
1152 out_len += out_size;
1155 buf_len = (u64) out_len + (u64) in_len;
1156 if (buf_len > ND_IOCTL_MAX_BUFLEN) {
1157 dev_dbg(dev, "%s cmd: %s buf_len: %llu > %d\n", dimm_name,
1158 cmd_name, buf_len, ND_IOCTL_MAX_BUFLEN);
1163 buf = vmalloc(buf_len);
1169 if (copy_from_user(buf, p, buf_len)) {
1174 nd_device_lock(dev);
1175 nvdimm_bus_lock(dev);
1176 rc = nd_cmd_clear_to_send(nvdimm_bus, nvdimm, func, buf);
1180 rc = nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, &cmd_rc);
1184 if (!nvdimm && cmd == ND_CMD_CLEAR_ERROR && cmd_rc >= 0) {
1185 struct nd_cmd_clear_error *clear_err = buf;
1187 nvdimm_account_cleared_poison(nvdimm_bus, clear_err->address,
1188 clear_err->cleared);
1191 if (copy_to_user(p, buf, buf_len))
1195 nvdimm_bus_unlock(dev);
1196 nd_device_unlock(dev);
1204 enum nd_ioctl_mode {
1209 static int match_dimm(struct device *dev, void *data)
1211 long id = (long) data;
1213 if (is_nvdimm(dev)) {
1214 struct nvdimm *nvdimm = to_nvdimm(dev);
1216 return nvdimm->id == id;
1222 static long nd_ioctl(struct file *file, unsigned int cmd, unsigned long arg,
1223 enum nd_ioctl_mode mode)
1226 struct nvdimm_bus *nvdimm_bus, *found = NULL;
1227 long id = (long) file->private_data;
1228 struct nvdimm *nvdimm = NULL;
1231 ro = ((file->f_flags & O_ACCMODE) == O_RDONLY);
1232 mutex_lock(&nvdimm_bus_list_mutex);
1233 list_for_each_entry(nvdimm_bus, &nvdimm_bus_list, list) {
1234 if (mode == DIMM_IOCTL) {
1237 dev = device_find_child(&nvdimm_bus->dev,
1238 file->private_data, match_dimm);
1241 nvdimm = to_nvdimm(dev);
1243 } else if (nvdimm_bus->id == id) {
1248 atomic_inc(&nvdimm_bus->ioctl_active);
1252 mutex_unlock(&nvdimm_bus_list_mutex);
1258 rc = __nd_ioctl(nvdimm_bus, nvdimm, ro, cmd, arg);
1261 put_device(&nvdimm->dev);
1262 if (atomic_dec_and_test(&nvdimm_bus->ioctl_active))
1263 wake_up(&nvdimm_bus->wait);
1268 static long bus_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1270 return nd_ioctl(file, cmd, arg, BUS_IOCTL);
1273 static long dimm_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1275 return nd_ioctl(file, cmd, arg, DIMM_IOCTL);
1278 static int nd_open(struct inode *inode, struct file *file)
1280 long minor = iminor(inode);
1282 file->private_data = (void *) minor;
1286 static const struct file_operations nvdimm_bus_fops = {
1287 .owner = THIS_MODULE,
1289 .unlocked_ioctl = bus_ioctl,
1290 .compat_ioctl = compat_ptr_ioctl,
1291 .llseek = noop_llseek,
1294 static const struct file_operations nvdimm_fops = {
1295 .owner = THIS_MODULE,
1297 .unlocked_ioctl = dimm_ioctl,
1298 .compat_ioctl = compat_ptr_ioctl,
1299 .llseek = noop_llseek,
1302 int __init nvdimm_bus_init(void)
1306 rc = bus_register(&nvdimm_bus_type);
1310 rc = register_chrdev(0, "ndctl", &nvdimm_bus_fops);
1312 goto err_bus_chrdev;
1313 nvdimm_bus_major = rc;
1315 rc = register_chrdev(0, "dimmctl", &nvdimm_fops);
1317 goto err_dimm_chrdev;
1320 nd_class = class_create(THIS_MODULE, "nd");
1321 if (IS_ERR(nd_class)) {
1322 rc = PTR_ERR(nd_class);
1326 rc = driver_register(&nd_bus_driver.drv);
1333 class_destroy(nd_class);
1335 unregister_chrdev(nvdimm_major, "dimmctl");
1337 unregister_chrdev(nvdimm_bus_major, "ndctl");
1339 bus_unregister(&nvdimm_bus_type);
1344 void nvdimm_bus_exit(void)
1346 driver_unregister(&nd_bus_driver.drv);
1347 class_destroy(nd_class);
1348 unregister_chrdev(nvdimm_bus_major, "ndctl");
1349 unregister_chrdev(nvdimm_major, "dimmctl");
1350 bus_unregister(&nvdimm_bus_type);
1351 ida_destroy(&nd_ida);