2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/vmalloc.h>
15 #include <linux/uaccess.h>
16 #include <linux/module.h>
17 #include <linux/blkdev.h>
18 #include <linux/fcntl.h>
19 #include <linux/async.h>
20 #include <linux/genhd.h>
21 #include <linux/ndctl.h>
22 #include <linux/sched.h>
23 #include <linux/slab.h>
32 static int nvdimm_bus_major;
33 static struct class *nd_class;
34 static DEFINE_IDA(nd_ida);
36 static int to_nd_device_type(struct device *dev)
39 return ND_DEVICE_DIMM;
40 else if (is_nd_pmem(dev))
41 return ND_DEVICE_REGION_PMEM;
42 else if (is_nd_blk(dev))
43 return ND_DEVICE_REGION_BLK;
44 else if (is_nd_dax(dev))
45 return ND_DEVICE_DAX_PMEM;
46 else if (is_nd_pmem(dev->parent) || is_nd_blk(dev->parent))
47 return nd_region_to_nstype(to_nd_region(dev->parent));
52 static int nvdimm_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
55 * Ensure that region devices always have their numa node set as
58 if (is_nd_pmem(dev) || is_nd_blk(dev))
59 set_dev_node(dev, to_nd_region(dev)->numa_node);
60 return add_uevent_var(env, "MODALIAS=" ND_DEVICE_MODALIAS_FMT,
61 to_nd_device_type(dev));
64 static struct module *to_bus_provider(struct device *dev)
66 /* pin bus providers while regions are enabled */
67 if (is_nd_pmem(dev) || is_nd_blk(dev)) {
68 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
70 return nvdimm_bus->nd_desc->module;
75 static void nvdimm_bus_probe_start(struct nvdimm_bus *nvdimm_bus)
77 nvdimm_bus_lock(&nvdimm_bus->dev);
78 nvdimm_bus->probe_active++;
79 nvdimm_bus_unlock(&nvdimm_bus->dev);
82 static void nvdimm_bus_probe_end(struct nvdimm_bus *nvdimm_bus)
84 nvdimm_bus_lock(&nvdimm_bus->dev);
85 if (--nvdimm_bus->probe_active == 0)
86 wake_up(&nvdimm_bus->probe_wait);
87 nvdimm_bus_unlock(&nvdimm_bus->dev);
90 static int nvdimm_bus_probe(struct device *dev)
92 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
93 struct module *provider = to_bus_provider(dev);
94 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
97 if (!try_module_get(provider))
100 nvdimm_bus_probe_start(nvdimm_bus);
101 rc = nd_drv->probe(dev);
103 nd_region_probe_success(nvdimm_bus, dev);
105 nd_region_disable(nvdimm_bus, dev);
106 nvdimm_bus_probe_end(nvdimm_bus);
108 dev_dbg(&nvdimm_bus->dev, "%s.probe(%s) = %d\n", dev->driver->name,
112 module_put(provider);
116 static int nvdimm_bus_remove(struct device *dev)
118 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
119 struct module *provider = to_bus_provider(dev);
120 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
124 rc = nd_drv->remove(dev);
125 nd_region_disable(nvdimm_bus, dev);
127 dev_dbg(&nvdimm_bus->dev, "%s.remove(%s) = %d\n", dev->driver->name,
129 module_put(provider);
133 static void nvdimm_bus_shutdown(struct device *dev)
135 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
136 struct nd_device_driver *nd_drv = NULL;
139 nd_drv = to_nd_device_driver(dev->driver);
141 if (nd_drv && nd_drv->shutdown) {
142 nd_drv->shutdown(dev);
143 dev_dbg(&nvdimm_bus->dev, "%s.shutdown(%s)\n",
144 dev->driver->name, dev_name(dev));
148 void nd_device_notify(struct device *dev, enum nvdimm_event event)
152 struct nd_device_driver *nd_drv;
154 nd_drv = to_nd_device_driver(dev->driver);
156 nd_drv->notify(dev, event);
160 EXPORT_SYMBOL(nd_device_notify);
162 void nvdimm_region_notify(struct nd_region *nd_region, enum nvdimm_event event)
164 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&nd_region->dev);
169 /* caller is responsible for holding a reference on the device */
170 nd_device_notify(&nd_region->dev, event);
172 EXPORT_SYMBOL_GPL(nvdimm_region_notify);
174 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
177 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
178 struct nvdimm_bus_descriptor *nd_desc;
179 struct nd_cmd_clear_error clear_err;
180 struct nd_cmd_ars_cap ars_cap;
181 u32 clear_err_unit, mask;
187 nd_desc = nvdimm_bus->nd_desc;
189 * if ndctl does not exist, it's PMEM_LEGACY and
190 * we want to just pretend everything is handled.
195 memset(&ars_cap, 0, sizeof(ars_cap));
196 ars_cap.address = phys;
197 ars_cap.length = len;
198 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, &ars_cap,
199 sizeof(ars_cap), &cmd_rc);
204 clear_err_unit = ars_cap.clear_err_unit;
205 if (!clear_err_unit || !is_power_of_2(clear_err_unit))
208 mask = clear_err_unit - 1;
209 if ((phys | len) & mask)
211 memset(&clear_err, 0, sizeof(clear_err));
212 clear_err.address = phys;
213 clear_err.length = len;
214 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_CLEAR_ERROR, &clear_err,
215 sizeof(clear_err), &cmd_rc);
220 return clear_err.cleared;
222 EXPORT_SYMBOL_GPL(nvdimm_clear_poison);
224 static int nvdimm_bus_match(struct device *dev, struct device_driver *drv);
226 static struct bus_type nvdimm_bus_type = {
228 .uevent = nvdimm_bus_uevent,
229 .match = nvdimm_bus_match,
230 .probe = nvdimm_bus_probe,
231 .remove = nvdimm_bus_remove,
232 .shutdown = nvdimm_bus_shutdown,
235 static void nvdimm_bus_release(struct device *dev)
237 struct nvdimm_bus *nvdimm_bus;
239 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
240 ida_simple_remove(&nd_ida, nvdimm_bus->id);
244 static bool is_nvdimm_bus(struct device *dev)
246 return dev->release == nvdimm_bus_release;
249 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev)
253 for (dev = nd_dev; dev; dev = dev->parent)
254 if (is_nvdimm_bus(dev))
256 dev_WARN_ONCE(nd_dev, !dev, "invalid dev, not on nd bus\n");
258 return to_nvdimm_bus(dev);
262 struct nvdimm_bus *to_nvdimm_bus(struct device *dev)
264 struct nvdimm_bus *nvdimm_bus;
266 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
267 WARN_ON(!is_nvdimm_bus(dev));
270 EXPORT_SYMBOL_GPL(to_nvdimm_bus);
272 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
273 struct nvdimm_bus_descriptor *nd_desc)
275 struct nvdimm_bus *nvdimm_bus;
278 nvdimm_bus = kzalloc(sizeof(*nvdimm_bus), GFP_KERNEL);
281 INIT_LIST_HEAD(&nvdimm_bus->list);
282 INIT_LIST_HEAD(&nvdimm_bus->mapping_list);
283 INIT_LIST_HEAD(&nvdimm_bus->poison_list);
284 init_waitqueue_head(&nvdimm_bus->probe_wait);
285 nvdimm_bus->id = ida_simple_get(&nd_ida, 0, 0, GFP_KERNEL);
286 mutex_init(&nvdimm_bus->reconfig_mutex);
287 if (nvdimm_bus->id < 0) {
291 nvdimm_bus->nd_desc = nd_desc;
292 nvdimm_bus->dev.parent = parent;
293 nvdimm_bus->dev.release = nvdimm_bus_release;
294 nvdimm_bus->dev.groups = nd_desc->attr_groups;
295 nvdimm_bus->dev.bus = &nvdimm_bus_type;
296 dev_set_name(&nvdimm_bus->dev, "ndbus%d", nvdimm_bus->id);
297 rc = device_register(&nvdimm_bus->dev);
299 dev_dbg(&nvdimm_bus->dev, "registration failed: %d\n", rc);
305 put_device(&nvdimm_bus->dev);
308 EXPORT_SYMBOL_GPL(nvdimm_bus_register);
310 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus)
314 device_unregister(&nvdimm_bus->dev);
316 EXPORT_SYMBOL_GPL(nvdimm_bus_unregister);
318 static int child_unregister(struct device *dev, void *data)
321 * the singular ndctl class device per bus needs to be
322 * "device_destroy"ed, so skip it here
324 * i.e. remove classless children
329 nd_device_unregister(dev, ND_SYNC);
333 static void free_poison_list(struct list_head *poison_list)
335 struct nd_poison *pl, *next;
337 list_for_each_entry_safe(pl, next, poison_list, list) {
341 list_del_init(poison_list);
344 static int nd_bus_remove(struct device *dev)
346 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
348 mutex_lock(&nvdimm_bus_list_mutex);
349 list_del_init(&nvdimm_bus->list);
350 mutex_unlock(&nvdimm_bus_list_mutex);
353 device_for_each_child(&nvdimm_bus->dev, NULL, child_unregister);
355 nvdimm_bus_lock(&nvdimm_bus->dev);
356 free_poison_list(&nvdimm_bus->poison_list);
357 nvdimm_bus_unlock(&nvdimm_bus->dev);
359 nvdimm_bus_destroy_ndctl(nvdimm_bus);
364 static int nd_bus_probe(struct device *dev)
366 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
369 rc = nvdimm_bus_create_ndctl(nvdimm_bus);
373 mutex_lock(&nvdimm_bus_list_mutex);
374 list_add_tail(&nvdimm_bus->list, &nvdimm_bus_list);
375 mutex_unlock(&nvdimm_bus_list_mutex);
377 /* enable bus provider attributes to look up their local context */
378 dev_set_drvdata(dev, nvdimm_bus->nd_desc);
383 static struct nd_device_driver nd_bus_driver = {
384 .probe = nd_bus_probe,
385 .remove = nd_bus_remove,
388 .suppress_bind_attrs = true,
389 .bus = &nvdimm_bus_type,
390 .owner = THIS_MODULE,
391 .mod_name = KBUILD_MODNAME,
395 static int nvdimm_bus_match(struct device *dev, struct device_driver *drv)
397 struct nd_device_driver *nd_drv = to_nd_device_driver(drv);
399 if (is_nvdimm_bus(dev) && nd_drv == &nd_bus_driver)
402 return !!test_bit(to_nd_device_type(dev), &nd_drv->type);
405 static ASYNC_DOMAIN_EXCLUSIVE(nd_async_domain);
407 void nd_synchronize(void)
409 async_synchronize_full_domain(&nd_async_domain);
411 EXPORT_SYMBOL_GPL(nd_synchronize);
413 static void nd_async_device_register(void *d, async_cookie_t cookie)
415 struct device *dev = d;
417 if (device_add(dev) != 0) {
418 dev_err(dev, "%s: failed\n", __func__);
424 static void nd_async_device_unregister(void *d, async_cookie_t cookie)
426 struct device *dev = d;
428 /* flush bus operations before delete */
429 nvdimm_bus_lock(dev);
430 nvdimm_bus_unlock(dev);
432 device_unregister(dev);
436 void __nd_device_register(struct device *dev)
440 dev->bus = &nvdimm_bus_type;
442 async_schedule_domain(nd_async_device_register, dev,
446 void nd_device_register(struct device *dev)
448 device_initialize(dev);
449 __nd_device_register(dev);
451 EXPORT_SYMBOL(nd_device_register);
453 void nd_device_unregister(struct device *dev, enum nd_async_mode mode)
458 async_schedule_domain(nd_async_device_unregister, dev,
463 device_unregister(dev);
467 EXPORT_SYMBOL(nd_device_unregister);
470 * __nd_driver_register() - register a region or a namespace driver
471 * @nd_drv: driver to register
472 * @owner: automatically set by nd_driver_register() macro
473 * @mod_name: automatically set by nd_driver_register() macro
475 int __nd_driver_register(struct nd_device_driver *nd_drv, struct module *owner,
476 const char *mod_name)
478 struct device_driver *drv = &nd_drv->drv;
481 pr_debug("driver type bitmask not set (%pf)\n",
482 __builtin_return_address(0));
486 if (!nd_drv->probe) {
487 pr_debug("%s ->probe() must be specified\n", mod_name);
491 drv->bus = &nvdimm_bus_type;
493 drv->mod_name = mod_name;
495 return driver_register(drv);
497 EXPORT_SYMBOL(__nd_driver_register);
499 int nvdimm_revalidate_disk(struct gendisk *disk)
501 struct device *dev = disk_to_dev(disk)->parent;
502 struct nd_region *nd_region = to_nd_region(dev->parent);
503 const char *pol = nd_region->ro ? "only" : "write";
505 if (nd_region->ro == get_disk_ro(disk))
508 dev_info(dev, "%s read-%s, marking %s read-%s\n",
509 dev_name(&nd_region->dev), pol, disk->disk_name, pol);
510 set_disk_ro(disk, nd_region->ro);
515 EXPORT_SYMBOL(nvdimm_revalidate_disk);
517 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
520 return sprintf(buf, ND_DEVICE_MODALIAS_FMT "\n",
521 to_nd_device_type(dev));
523 static DEVICE_ATTR_RO(modalias);
525 static ssize_t devtype_show(struct device *dev, struct device_attribute *attr,
528 return sprintf(buf, "%s\n", dev->type->name);
530 static DEVICE_ATTR_RO(devtype);
532 static struct attribute *nd_device_attributes[] = {
533 &dev_attr_modalias.attr,
534 &dev_attr_devtype.attr,
539 * nd_device_attribute_group - generic attributes for all devices on an nd bus
541 struct attribute_group nd_device_attribute_group = {
542 .attrs = nd_device_attributes,
544 EXPORT_SYMBOL_GPL(nd_device_attribute_group);
546 static ssize_t numa_node_show(struct device *dev,
547 struct device_attribute *attr, char *buf)
549 return sprintf(buf, "%d\n", dev_to_node(dev));
551 static DEVICE_ATTR_RO(numa_node);
553 static struct attribute *nd_numa_attributes[] = {
554 &dev_attr_numa_node.attr,
558 static umode_t nd_numa_attr_visible(struct kobject *kobj, struct attribute *a,
561 if (!IS_ENABLED(CONFIG_NUMA))
568 * nd_numa_attribute_group - NUMA attributes for all devices on an nd bus
570 struct attribute_group nd_numa_attribute_group = {
571 .attrs = nd_numa_attributes,
572 .is_visible = nd_numa_attr_visible,
574 EXPORT_SYMBOL_GPL(nd_numa_attribute_group);
576 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus)
578 dev_t devt = MKDEV(nvdimm_bus_major, nvdimm_bus->id);
581 dev = device_create(nd_class, &nvdimm_bus->dev, devt, nvdimm_bus,
582 "ndctl%d", nvdimm_bus->id);
585 dev_dbg(&nvdimm_bus->dev, "failed to register ndctl%d: %ld\n",
586 nvdimm_bus->id, PTR_ERR(dev));
587 return PTR_ERR_OR_ZERO(dev);
590 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus)
592 device_destroy(nd_class, MKDEV(nvdimm_bus_major, nvdimm_bus->id));
595 static const struct nd_cmd_desc __nd_cmd_dimm_descs[] = {
596 [ND_CMD_IMPLEMENTED] = { },
599 .out_sizes = { 4, 128, },
601 [ND_CMD_SMART_THRESHOLD] = {
603 .out_sizes = { 4, 8, },
605 [ND_CMD_DIMM_FLAGS] = {
607 .out_sizes = { 4, 4 },
609 [ND_CMD_GET_CONFIG_SIZE] = {
611 .out_sizes = { 4, 4, 4, },
613 [ND_CMD_GET_CONFIG_DATA] = {
615 .in_sizes = { 4, 4, },
617 .out_sizes = { 4, UINT_MAX, },
619 [ND_CMD_SET_CONFIG_DATA] = {
621 .in_sizes = { 4, 4, UINT_MAX, },
627 .in_sizes = { 4, 4, UINT_MAX, },
629 .out_sizes = { 4, 4, UINT_MAX, },
633 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
635 .out_sizes = { UINT_MAX, },
639 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd)
641 if (cmd < ARRAY_SIZE(__nd_cmd_dimm_descs))
642 return &__nd_cmd_dimm_descs[cmd];
645 EXPORT_SYMBOL_GPL(nd_cmd_dimm_desc);
647 static const struct nd_cmd_desc __nd_cmd_bus_descs[] = {
648 [ND_CMD_IMPLEMENTED] = { },
651 .in_sizes = { 8, 8, },
653 .out_sizes = { 4, 4, 4, 4, },
655 [ND_CMD_ARS_START] = {
657 .in_sizes = { 8, 8, 2, 1, 5, },
659 .out_sizes = { 4, 4, },
661 [ND_CMD_ARS_STATUS] = {
663 .out_sizes = { 4, 4, UINT_MAX, },
665 [ND_CMD_CLEAR_ERROR] = {
667 .in_sizes = { 8, 8, },
669 .out_sizes = { 4, 4, 8, },
673 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
675 .out_sizes = { UINT_MAX, },
679 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd)
681 if (cmd < ARRAY_SIZE(__nd_cmd_bus_descs))
682 return &__nd_cmd_bus_descs[cmd];
685 EXPORT_SYMBOL_GPL(nd_cmd_bus_desc);
687 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
688 const struct nd_cmd_desc *desc, int idx, void *buf)
690 if (idx >= desc->in_num)
693 if (desc->in_sizes[idx] < UINT_MAX)
694 return desc->in_sizes[idx];
696 if (nvdimm && cmd == ND_CMD_SET_CONFIG_DATA && idx == 2) {
697 struct nd_cmd_set_config_hdr *hdr = buf;
699 return hdr->in_length;
700 } else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2) {
701 struct nd_cmd_vendor_hdr *hdr = buf;
703 return hdr->in_length;
704 } else if (cmd == ND_CMD_CALL) {
705 struct nd_cmd_pkg *pkg = buf;
707 return pkg->nd_size_in;
712 EXPORT_SYMBOL_GPL(nd_cmd_in_size);
714 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
715 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
716 const u32 *out_field)
718 if (idx >= desc->out_num)
721 if (desc->out_sizes[idx] < UINT_MAX)
722 return desc->out_sizes[idx];
724 if (nvdimm && cmd == ND_CMD_GET_CONFIG_DATA && idx == 1)
726 else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2)
728 else if (!nvdimm && cmd == ND_CMD_ARS_STATUS && idx == 2)
729 return out_field[1] - 8;
730 else if (cmd == ND_CMD_CALL) {
731 struct nd_cmd_pkg *pkg = (struct nd_cmd_pkg *) in_field;
733 return pkg->nd_size_out;
739 EXPORT_SYMBOL_GPL(nd_cmd_out_size);
741 void wait_nvdimm_bus_probe_idle(struct device *dev)
743 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
746 if (nvdimm_bus->probe_active == 0)
748 nvdimm_bus_unlock(&nvdimm_bus->dev);
749 wait_event(nvdimm_bus->probe_wait,
750 nvdimm_bus->probe_active == 0);
751 nvdimm_bus_lock(&nvdimm_bus->dev);
755 static int pmem_active(struct device *dev, void *data)
757 if (is_nd_pmem(dev) && dev->driver)
762 /* set_config requires an idle interleave set */
763 static int nd_cmd_clear_to_send(struct nvdimm_bus *nvdimm_bus,
764 struct nvdimm *nvdimm, unsigned int cmd)
766 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
768 /* ask the bus provider if it would like to block this request */
769 if (nd_desc->clear_to_send) {
770 int rc = nd_desc->clear_to_send(nd_desc, nvdimm, cmd);
776 /* require clear error to go through the pmem driver */
777 if (!nvdimm && cmd == ND_CMD_CLEAR_ERROR)
778 return device_for_each_child(&nvdimm_bus->dev, NULL,
781 if (!nvdimm || cmd != ND_CMD_SET_CONFIG_DATA)
784 /* prevent label manipulation while the kernel owns label updates */
785 wait_nvdimm_bus_probe_idle(&nvdimm_bus->dev);
786 if (atomic_read(&nvdimm->busy))
791 static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
792 int read_only, unsigned int ioctl_cmd, unsigned long arg)
794 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
795 size_t buf_len = 0, in_len = 0, out_len = 0;
796 static char out_env[ND_CMD_MAX_ENVELOPE];
797 static char in_env[ND_CMD_MAX_ENVELOPE];
798 const struct nd_cmd_desc *desc = NULL;
799 unsigned int cmd = _IOC_NR(ioctl_cmd);
800 void __user *p = (void __user *) arg;
801 struct device *dev = &nvdimm_bus->dev;
802 struct nd_cmd_pkg pkg;
803 const char *cmd_name, *dimm_name;
804 unsigned long cmd_mask;
809 desc = nd_cmd_dimm_desc(cmd);
810 cmd_name = nvdimm_cmd_name(cmd);
811 cmd_mask = nvdimm->cmd_mask;
812 dimm_name = dev_name(&nvdimm->dev);
814 desc = nd_cmd_bus_desc(cmd);
815 cmd_name = nvdimm_bus_cmd_name(cmd);
816 cmd_mask = nd_desc->cmd_mask;
820 if (cmd == ND_CMD_CALL) {
821 if (copy_from_user(&pkg, p, sizeof(pkg)))
825 if (!desc || (desc->out_num + desc->in_num == 0) ||
826 !test_bit(cmd, &cmd_mask))
829 /* fail write commands (when read-only) */
833 case ND_CMD_SET_CONFIG_DATA:
834 case ND_CMD_ARS_START:
835 case ND_CMD_CLEAR_ERROR:
837 dev_dbg(&nvdimm_bus->dev, "'%s' command while read-only.\n",
838 nvdimm ? nvdimm_cmd_name(cmd)
839 : nvdimm_bus_cmd_name(cmd));
845 /* process an input envelope */
846 for (i = 0; i < desc->in_num; i++) {
849 in_size = nd_cmd_in_size(nvdimm, cmd, desc, i, in_env);
850 if (in_size == UINT_MAX) {
851 dev_err(dev, "%s:%s unknown input size cmd: %s field: %d\n",
852 __func__, dimm_name, cmd_name, i);
855 if (in_len < sizeof(in_env))
856 copy = min_t(u32, sizeof(in_env) - in_len, in_size);
859 if (copy && copy_from_user(&in_env[in_len], p + in_len, copy))
864 if (cmd == ND_CMD_CALL) {
865 dev_dbg(dev, "%s:%s, idx: %llu, in: %zu, out: %zu, len %zu\n",
866 __func__, dimm_name, pkg.nd_command,
867 in_len, out_len, buf_len);
869 for (i = 0; i < ARRAY_SIZE(pkg.nd_reserved2); i++)
870 if (pkg.nd_reserved2[i])
874 /* process an output envelope */
875 for (i = 0; i < desc->out_num; i++) {
876 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i,
877 (u32 *) in_env, (u32 *) out_env);
880 if (out_size == UINT_MAX) {
881 dev_dbg(dev, "%s:%s unknown output size cmd: %s field: %d\n",
882 __func__, dimm_name, cmd_name, i);
885 if (out_len < sizeof(out_env))
886 copy = min_t(u32, sizeof(out_env) - out_len, out_size);
889 if (copy && copy_from_user(&out_env[out_len],
890 p + in_len + out_len, copy))
895 buf_len = out_len + in_len;
896 if (buf_len > ND_IOCTL_MAX_BUFLEN) {
897 dev_dbg(dev, "%s:%s cmd: %s buf_len: %zu > %d\n", __func__,
898 dimm_name, cmd_name, buf_len,
899 ND_IOCTL_MAX_BUFLEN);
903 buf = vmalloc(buf_len);
907 if (copy_from_user(buf, p, buf_len)) {
912 nvdimm_bus_lock(&nvdimm_bus->dev);
913 rc = nd_cmd_clear_to_send(nvdimm_bus, nvdimm, cmd);
917 rc = nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, NULL);
920 if (copy_to_user(p, buf, buf_len))
923 nvdimm_bus_unlock(&nvdimm_bus->dev);
929 static long nd_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
931 long id = (long) file->private_data;
933 struct nvdimm_bus *nvdimm_bus;
935 ro = ((file->f_flags & O_ACCMODE) == O_RDONLY);
936 mutex_lock(&nvdimm_bus_list_mutex);
937 list_for_each_entry(nvdimm_bus, &nvdimm_bus_list, list) {
938 if (nvdimm_bus->id == id) {
939 rc = __nd_ioctl(nvdimm_bus, NULL, ro, cmd, arg);
943 mutex_unlock(&nvdimm_bus_list_mutex);
948 static int match_dimm(struct device *dev, void *data)
950 long id = (long) data;
952 if (is_nvdimm(dev)) {
953 struct nvdimm *nvdimm = to_nvdimm(dev);
955 return nvdimm->id == id;
961 static long nvdimm_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
964 struct nvdimm_bus *nvdimm_bus;
966 ro = ((file->f_flags & O_ACCMODE) == O_RDONLY);
967 mutex_lock(&nvdimm_bus_list_mutex);
968 list_for_each_entry(nvdimm_bus, &nvdimm_bus_list, list) {
969 struct device *dev = device_find_child(&nvdimm_bus->dev,
970 file->private_data, match_dimm);
971 struct nvdimm *nvdimm;
976 nvdimm = to_nvdimm(dev);
977 rc = __nd_ioctl(nvdimm_bus, nvdimm, ro, cmd, arg);
981 mutex_unlock(&nvdimm_bus_list_mutex);
986 static int nd_open(struct inode *inode, struct file *file)
988 long minor = iminor(inode);
990 file->private_data = (void *) minor;
994 static const struct file_operations nvdimm_bus_fops = {
995 .owner = THIS_MODULE,
997 .unlocked_ioctl = nd_ioctl,
998 .compat_ioctl = nd_ioctl,
999 .llseek = noop_llseek,
1002 static const struct file_operations nvdimm_fops = {
1003 .owner = THIS_MODULE,
1005 .unlocked_ioctl = nvdimm_ioctl,
1006 .compat_ioctl = nvdimm_ioctl,
1007 .llseek = noop_llseek,
1010 int __init nvdimm_bus_init(void)
1014 BUILD_BUG_ON(sizeof(struct nd_smart_payload) != 128);
1015 BUILD_BUG_ON(sizeof(struct nd_smart_threshold_payload) != 8);
1017 rc = bus_register(&nvdimm_bus_type);
1021 rc = register_chrdev(0, "ndctl", &nvdimm_bus_fops);
1023 goto err_bus_chrdev;
1024 nvdimm_bus_major = rc;
1026 rc = register_chrdev(0, "dimmctl", &nvdimm_fops);
1028 goto err_dimm_chrdev;
1031 nd_class = class_create(THIS_MODULE, "nd");
1032 if (IS_ERR(nd_class)) {
1033 rc = PTR_ERR(nd_class);
1037 rc = driver_register(&nd_bus_driver.drv);
1044 class_destroy(nd_class);
1046 unregister_chrdev(nvdimm_major, "dimmctl");
1048 unregister_chrdev(nvdimm_bus_major, "ndctl");
1050 bus_unregister(&nvdimm_bus_type);
1055 void nvdimm_bus_exit(void)
1057 driver_unregister(&nd_bus_driver.drv);
1058 class_destroy(nd_class);
1059 unregister_chrdev(nvdimm_bus_major, "ndctl");
1060 unregister_chrdev(nvdimm_major, "dimmctl");
1061 bus_unregister(&nvdimm_bus_type);
1062 ida_destroy(&nd_ida);