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/libnvdimm.h>
15 #include <linux/sched/mm.h>
16 #include <linux/vmalloc.h>
17 #include <linux/uaccess.h>
18 #include <linux/module.h>
19 #include <linux/blkdev.h>
20 #include <linux/fcntl.h>
21 #include <linux/async.h>
22 #include <linux/genhd.h>
23 #include <linux/ndctl.h>
24 #include <linux/sched.h>
25 #include <linux/slab.h>
35 static int nvdimm_bus_major
;
36 static struct class *nd_class
;
37 static DEFINE_IDA(nd_ida
);
39 static int to_nd_device_type(struct device
*dev
)
42 return ND_DEVICE_DIMM
;
43 else if (is_memory(dev
))
44 return ND_DEVICE_REGION_PMEM
;
45 else if (is_nd_blk(dev
))
46 return ND_DEVICE_REGION_BLK
;
47 else if (is_nd_dax(dev
))
48 return ND_DEVICE_DAX_PMEM
;
49 else if (is_nd_region(dev
->parent
))
50 return nd_region_to_nstype(to_nd_region(dev
->parent
));
55 static int nvdimm_bus_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
58 * Ensure that region devices always have their numa node set as
61 if (is_nd_region(dev
))
62 set_dev_node(dev
, to_nd_region(dev
)->numa_node
);
63 return add_uevent_var(env
, "MODALIAS=" ND_DEVICE_MODALIAS_FMT
,
64 to_nd_device_type(dev
));
67 static struct module
*to_bus_provider(struct device
*dev
)
69 /* pin bus providers while regions are enabled */
70 if (is_nd_region(dev
)) {
71 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
73 return nvdimm_bus
->nd_desc
->module
;
78 static void nvdimm_bus_probe_start(struct nvdimm_bus
*nvdimm_bus
)
80 nvdimm_bus_lock(&nvdimm_bus
->dev
);
81 nvdimm_bus
->probe_active
++;
82 nvdimm_bus_unlock(&nvdimm_bus
->dev
);
85 static void nvdimm_bus_probe_end(struct nvdimm_bus
*nvdimm_bus
)
87 nvdimm_bus_lock(&nvdimm_bus
->dev
);
88 if (--nvdimm_bus
->probe_active
== 0)
89 wake_up(&nvdimm_bus
->probe_wait
);
90 nvdimm_bus_unlock(&nvdimm_bus
->dev
);
93 static int nvdimm_bus_probe(struct device
*dev
)
95 struct nd_device_driver
*nd_drv
= to_nd_device_driver(dev
->driver
);
96 struct module
*provider
= to_bus_provider(dev
);
97 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
100 if (!try_module_get(provider
))
103 nvdimm_bus_probe_start(nvdimm_bus
);
104 rc
= nd_drv
->probe(dev
);
106 nd_region_probe_success(nvdimm_bus
, dev
);
108 nd_region_disable(nvdimm_bus
, dev
);
109 nvdimm_bus_probe_end(nvdimm_bus
);
111 dev_dbg(&nvdimm_bus
->dev
, "%s.probe(%s) = %d\n", dev
->driver
->name
,
115 module_put(provider
);
119 static int nvdimm_bus_remove(struct device
*dev
)
121 struct nd_device_driver
*nd_drv
= to_nd_device_driver(dev
->driver
);
122 struct module
*provider
= to_bus_provider(dev
);
123 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
127 rc
= nd_drv
->remove(dev
);
128 nd_region_disable(nvdimm_bus
, dev
);
130 dev_dbg(&nvdimm_bus
->dev
, "%s.remove(%s) = %d\n", dev
->driver
->name
,
132 module_put(provider
);
136 static void nvdimm_bus_shutdown(struct device
*dev
)
138 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
139 struct nd_device_driver
*nd_drv
= NULL
;
142 nd_drv
= to_nd_device_driver(dev
->driver
);
144 if (nd_drv
&& nd_drv
->shutdown
) {
145 nd_drv
->shutdown(dev
);
146 dev_dbg(&nvdimm_bus
->dev
, "%s.shutdown(%s)\n",
147 dev
->driver
->name
, dev_name(dev
));
151 void nd_device_notify(struct device
*dev
, enum nvdimm_event event
)
155 struct nd_device_driver
*nd_drv
;
157 nd_drv
= to_nd_device_driver(dev
->driver
);
159 nd_drv
->notify(dev
, event
);
163 EXPORT_SYMBOL(nd_device_notify
);
165 void nvdimm_region_notify(struct nd_region
*nd_region
, enum nvdimm_event event
)
167 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(&nd_region
->dev
);
172 /* caller is responsible for holding a reference on the device */
173 nd_device_notify(&nd_region
->dev
, event
);
175 EXPORT_SYMBOL_GPL(nvdimm_region_notify
);
177 struct clear_badblocks_context
{
178 resource_size_t phys
, cleared
;
181 static int nvdimm_clear_badblocks_region(struct device
*dev
, void *data
)
183 struct clear_badblocks_context
*ctx
= data
;
184 struct nd_region
*nd_region
;
185 resource_size_t ndr_end
;
188 /* make sure device is a region */
189 if (!is_nd_pmem(dev
))
192 nd_region
= to_nd_region(dev
);
193 ndr_end
= nd_region
->ndr_start
+ nd_region
->ndr_size
- 1;
195 /* make sure we are in the region */
196 if (ctx
->phys
< nd_region
->ndr_start
197 || (ctx
->phys
+ ctx
->cleared
) > ndr_end
)
200 sector
= (ctx
->phys
- nd_region
->ndr_start
) / 512;
201 badblocks_clear(&nd_region
->bb
, sector
, ctx
->cleared
/ 512);
203 if (nd_region
->bb_state
)
204 sysfs_notify_dirent(nd_region
->bb_state
);
209 static void nvdimm_clear_badblocks_regions(struct nvdimm_bus
*nvdimm_bus
,
210 phys_addr_t phys
, u64 cleared
)
212 struct clear_badblocks_context ctx
= {
217 device_for_each_child(&nvdimm_bus
->dev
, &ctx
,
218 nvdimm_clear_badblocks_region
);
221 static void nvdimm_account_cleared_poison(struct nvdimm_bus
*nvdimm_bus
,
222 phys_addr_t phys
, u64 cleared
)
225 badrange_forget(&nvdimm_bus
->badrange
, phys
, cleared
);
227 if (cleared
> 0 && cleared
/ 512)
228 nvdimm_clear_badblocks_regions(nvdimm_bus
, phys
, cleared
);
231 long nvdimm_clear_poison(struct device
*dev
, phys_addr_t phys
,
234 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
235 struct nvdimm_bus_descriptor
*nd_desc
;
236 struct nd_cmd_clear_error clear_err
;
237 struct nd_cmd_ars_cap ars_cap
;
238 u32 clear_err_unit
, mask
;
239 unsigned int noio_flag
;
245 nd_desc
= nvdimm_bus
->nd_desc
;
247 * if ndctl does not exist, it's PMEM_LEGACY and
248 * we want to just pretend everything is handled.
253 memset(&ars_cap
, 0, sizeof(ars_cap
));
254 ars_cap
.address
= phys
;
255 ars_cap
.length
= len
;
256 noio_flag
= memalloc_noio_save();
257 rc
= nd_desc
->ndctl(nd_desc
, NULL
, ND_CMD_ARS_CAP
, &ars_cap
,
258 sizeof(ars_cap
), &cmd_rc
);
259 memalloc_noio_restore(noio_flag
);
264 clear_err_unit
= ars_cap
.clear_err_unit
;
265 if (!clear_err_unit
|| !is_power_of_2(clear_err_unit
))
268 mask
= clear_err_unit
- 1;
269 if ((phys
| len
) & mask
)
271 memset(&clear_err
, 0, sizeof(clear_err
));
272 clear_err
.address
= phys
;
273 clear_err
.length
= len
;
274 noio_flag
= memalloc_noio_save();
275 rc
= nd_desc
->ndctl(nd_desc
, NULL
, ND_CMD_CLEAR_ERROR
, &clear_err
,
276 sizeof(clear_err
), &cmd_rc
);
277 memalloc_noio_restore(noio_flag
);
283 nvdimm_account_cleared_poison(nvdimm_bus
, phys
, clear_err
.cleared
);
285 return clear_err
.cleared
;
287 EXPORT_SYMBOL_GPL(nvdimm_clear_poison
);
289 static int nvdimm_bus_match(struct device
*dev
, struct device_driver
*drv
);
291 static struct bus_type nvdimm_bus_type
= {
293 .uevent
= nvdimm_bus_uevent
,
294 .match
= nvdimm_bus_match
,
295 .probe
= nvdimm_bus_probe
,
296 .remove
= nvdimm_bus_remove
,
297 .shutdown
= nvdimm_bus_shutdown
,
300 static void nvdimm_bus_release(struct device
*dev
)
302 struct nvdimm_bus
*nvdimm_bus
;
304 nvdimm_bus
= container_of(dev
, struct nvdimm_bus
, dev
);
305 ida_simple_remove(&nd_ida
, nvdimm_bus
->id
);
309 static bool is_nvdimm_bus(struct device
*dev
)
311 return dev
->release
== nvdimm_bus_release
;
314 struct nvdimm_bus
*walk_to_nvdimm_bus(struct device
*nd_dev
)
318 for (dev
= nd_dev
; dev
; dev
= dev
->parent
)
319 if (is_nvdimm_bus(dev
))
321 dev_WARN_ONCE(nd_dev
, !dev
, "invalid dev, not on nd bus\n");
323 return to_nvdimm_bus(dev
);
327 struct nvdimm_bus
*to_nvdimm_bus(struct device
*dev
)
329 struct nvdimm_bus
*nvdimm_bus
;
331 nvdimm_bus
= container_of(dev
, struct nvdimm_bus
, dev
);
332 WARN_ON(!is_nvdimm_bus(dev
));
335 EXPORT_SYMBOL_GPL(to_nvdimm_bus
);
337 struct nvdimm_bus
*nvdimm_bus_register(struct device
*parent
,
338 struct nvdimm_bus_descriptor
*nd_desc
)
340 struct nvdimm_bus
*nvdimm_bus
;
343 nvdimm_bus
= kzalloc(sizeof(*nvdimm_bus
), GFP_KERNEL
);
346 INIT_LIST_HEAD(&nvdimm_bus
->list
);
347 INIT_LIST_HEAD(&nvdimm_bus
->mapping_list
);
348 init_waitqueue_head(&nvdimm_bus
->probe_wait
);
349 nvdimm_bus
->id
= ida_simple_get(&nd_ida
, 0, 0, GFP_KERNEL
);
350 mutex_init(&nvdimm_bus
->reconfig_mutex
);
351 badrange_init(&nvdimm_bus
->badrange
);
352 if (nvdimm_bus
->id
< 0) {
356 nvdimm_bus
->nd_desc
= nd_desc
;
357 nvdimm_bus
->dev
.parent
= parent
;
358 nvdimm_bus
->dev
.release
= nvdimm_bus_release
;
359 nvdimm_bus
->dev
.groups
= nd_desc
->attr_groups
;
360 nvdimm_bus
->dev
.bus
= &nvdimm_bus_type
;
361 dev_set_name(&nvdimm_bus
->dev
, "ndbus%d", nvdimm_bus
->id
);
362 rc
= device_register(&nvdimm_bus
->dev
);
364 dev_dbg(&nvdimm_bus
->dev
, "registration failed: %d\n", rc
);
370 put_device(&nvdimm_bus
->dev
);
373 EXPORT_SYMBOL_GPL(nvdimm_bus_register
);
375 void nvdimm_bus_unregister(struct nvdimm_bus
*nvdimm_bus
)
379 device_unregister(&nvdimm_bus
->dev
);
381 EXPORT_SYMBOL_GPL(nvdimm_bus_unregister
);
383 static int child_unregister(struct device
*dev
, void *data
)
386 * the singular ndctl class device per bus needs to be
387 * "device_destroy"ed, so skip it here
389 * i.e. remove classless children
394 nd_device_unregister(dev
, ND_SYNC
);
398 static void free_badrange_list(struct list_head
*badrange_list
)
400 struct badrange_entry
*bre
, *next
;
402 list_for_each_entry_safe(bre
, next
, badrange_list
, list
) {
403 list_del(&bre
->list
);
406 list_del_init(badrange_list
);
409 static int nd_bus_remove(struct device
*dev
)
411 struct nvdimm_bus
*nvdimm_bus
= to_nvdimm_bus(dev
);
413 mutex_lock(&nvdimm_bus_list_mutex
);
414 list_del_init(&nvdimm_bus
->list
);
415 mutex_unlock(&nvdimm_bus_list_mutex
);
418 device_for_each_child(&nvdimm_bus
->dev
, NULL
, child_unregister
);
420 spin_lock(&nvdimm_bus
->badrange
.lock
);
421 free_badrange_list(&nvdimm_bus
->badrange
.list
);
422 spin_unlock(&nvdimm_bus
->badrange
.lock
);
424 nvdimm_bus_destroy_ndctl(nvdimm_bus
);
429 static int nd_bus_probe(struct device
*dev
)
431 struct nvdimm_bus
*nvdimm_bus
= to_nvdimm_bus(dev
);
434 rc
= nvdimm_bus_create_ndctl(nvdimm_bus
);
438 mutex_lock(&nvdimm_bus_list_mutex
);
439 list_add_tail(&nvdimm_bus
->list
, &nvdimm_bus_list
);
440 mutex_unlock(&nvdimm_bus_list_mutex
);
442 /* enable bus provider attributes to look up their local context */
443 dev_set_drvdata(dev
, nvdimm_bus
->nd_desc
);
448 static struct nd_device_driver nd_bus_driver
= {
449 .probe
= nd_bus_probe
,
450 .remove
= nd_bus_remove
,
453 .suppress_bind_attrs
= true,
454 .bus
= &nvdimm_bus_type
,
455 .owner
= THIS_MODULE
,
456 .mod_name
= KBUILD_MODNAME
,
460 static int nvdimm_bus_match(struct device
*dev
, struct device_driver
*drv
)
462 struct nd_device_driver
*nd_drv
= to_nd_device_driver(drv
);
464 if (is_nvdimm_bus(dev
) && nd_drv
== &nd_bus_driver
)
467 return !!test_bit(to_nd_device_type(dev
), &nd_drv
->type
);
470 static ASYNC_DOMAIN_EXCLUSIVE(nd_async_domain
);
472 void nd_synchronize(void)
474 async_synchronize_full_domain(&nd_async_domain
);
476 EXPORT_SYMBOL_GPL(nd_synchronize
);
478 static void nd_async_device_register(void *d
, async_cookie_t cookie
)
480 struct device
*dev
= d
;
482 if (device_add(dev
) != 0) {
483 dev_err(dev
, "%s: failed\n", __func__
);
489 static void nd_async_device_unregister(void *d
, async_cookie_t cookie
)
491 struct device
*dev
= d
;
493 /* flush bus operations before delete */
494 nvdimm_bus_lock(dev
);
495 nvdimm_bus_unlock(dev
);
497 device_unregister(dev
);
501 void __nd_device_register(struct device
*dev
)
505 dev
->bus
= &nvdimm_bus_type
;
507 async_schedule_domain(nd_async_device_register
, dev
,
511 void nd_device_register(struct device
*dev
)
513 device_initialize(dev
);
514 __nd_device_register(dev
);
516 EXPORT_SYMBOL(nd_device_register
);
518 void nd_device_unregister(struct device
*dev
, enum nd_async_mode mode
)
523 async_schedule_domain(nd_async_device_unregister
, dev
,
528 device_unregister(dev
);
532 EXPORT_SYMBOL(nd_device_unregister
);
535 * __nd_driver_register() - register a region or a namespace driver
536 * @nd_drv: driver to register
537 * @owner: automatically set by nd_driver_register() macro
538 * @mod_name: automatically set by nd_driver_register() macro
540 int __nd_driver_register(struct nd_device_driver
*nd_drv
, struct module
*owner
,
541 const char *mod_name
)
543 struct device_driver
*drv
= &nd_drv
->drv
;
546 pr_debug("driver type bitmask not set (%pf)\n",
547 __builtin_return_address(0));
551 if (!nd_drv
->probe
) {
552 pr_debug("%s ->probe() must be specified\n", mod_name
);
556 drv
->bus
= &nvdimm_bus_type
;
558 drv
->mod_name
= mod_name
;
560 return driver_register(drv
);
562 EXPORT_SYMBOL(__nd_driver_register
);
564 int nvdimm_revalidate_disk(struct gendisk
*disk
)
566 struct device
*dev
= disk_to_dev(disk
)->parent
;
567 struct nd_region
*nd_region
= to_nd_region(dev
->parent
);
568 int disk_ro
= get_disk_ro(disk
);
571 * Upgrade to read-only if the region is read-only preserve as
572 * read-only if the disk is already read-only.
574 if (disk_ro
|| nd_region
->ro
== disk_ro
)
577 dev_info(dev
, "%s read-only, marking %s read-only\n",
578 dev_name(&nd_region
->dev
), disk
->disk_name
);
579 set_disk_ro(disk
, 1);
584 EXPORT_SYMBOL(nvdimm_revalidate_disk
);
586 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*attr
,
589 return sprintf(buf
, ND_DEVICE_MODALIAS_FMT
"\n",
590 to_nd_device_type(dev
));
592 static DEVICE_ATTR_RO(modalias
);
594 static ssize_t
devtype_show(struct device
*dev
, struct device_attribute
*attr
,
597 return sprintf(buf
, "%s\n", dev
->type
->name
);
599 static DEVICE_ATTR_RO(devtype
);
601 static struct attribute
*nd_device_attributes
[] = {
602 &dev_attr_modalias
.attr
,
603 &dev_attr_devtype
.attr
,
608 * nd_device_attribute_group - generic attributes for all devices on an nd bus
610 struct attribute_group nd_device_attribute_group
= {
611 .attrs
= nd_device_attributes
,
613 EXPORT_SYMBOL_GPL(nd_device_attribute_group
);
615 static ssize_t
numa_node_show(struct device
*dev
,
616 struct device_attribute
*attr
, char *buf
)
618 return sprintf(buf
, "%d\n", dev_to_node(dev
));
620 static DEVICE_ATTR_RO(numa_node
);
622 static struct attribute
*nd_numa_attributes
[] = {
623 &dev_attr_numa_node
.attr
,
627 static umode_t
nd_numa_attr_visible(struct kobject
*kobj
, struct attribute
*a
,
630 if (!IS_ENABLED(CONFIG_NUMA
))
637 * nd_numa_attribute_group - NUMA attributes for all devices on an nd bus
639 struct attribute_group nd_numa_attribute_group
= {
640 .attrs
= nd_numa_attributes
,
641 .is_visible
= nd_numa_attr_visible
,
643 EXPORT_SYMBOL_GPL(nd_numa_attribute_group
);
645 int nvdimm_bus_create_ndctl(struct nvdimm_bus
*nvdimm_bus
)
647 dev_t devt
= MKDEV(nvdimm_bus_major
, nvdimm_bus
->id
);
650 dev
= device_create(nd_class
, &nvdimm_bus
->dev
, devt
, nvdimm_bus
,
651 "ndctl%d", nvdimm_bus
->id
);
654 dev_dbg(&nvdimm_bus
->dev
, "failed to register ndctl%d: %ld\n",
655 nvdimm_bus
->id
, PTR_ERR(dev
));
656 return PTR_ERR_OR_ZERO(dev
);
659 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus
*nvdimm_bus
)
661 device_destroy(nd_class
, MKDEV(nvdimm_bus_major
, nvdimm_bus
->id
));
664 static const struct nd_cmd_desc __nd_cmd_dimm_descs
[] = {
665 [ND_CMD_IMPLEMENTED
] = { },
668 .out_sizes
= { 4, 128, },
670 [ND_CMD_SMART_THRESHOLD
] = {
672 .out_sizes
= { 4, 8, },
674 [ND_CMD_DIMM_FLAGS
] = {
676 .out_sizes
= { 4, 4 },
678 [ND_CMD_GET_CONFIG_SIZE
] = {
680 .out_sizes
= { 4, 4, 4, },
682 [ND_CMD_GET_CONFIG_DATA
] = {
684 .in_sizes
= { 4, 4, },
686 .out_sizes
= { 4, UINT_MAX
, },
688 [ND_CMD_SET_CONFIG_DATA
] = {
690 .in_sizes
= { 4, 4, UINT_MAX
, },
696 .in_sizes
= { 4, 4, UINT_MAX
, },
698 .out_sizes
= { 4, 4, UINT_MAX
, },
702 .in_sizes
= { sizeof(struct nd_cmd_pkg
), UINT_MAX
, },
704 .out_sizes
= { UINT_MAX
, },
708 const struct nd_cmd_desc
*nd_cmd_dimm_desc(int cmd
)
710 if (cmd
< ARRAY_SIZE(__nd_cmd_dimm_descs
))
711 return &__nd_cmd_dimm_descs
[cmd
];
714 EXPORT_SYMBOL_GPL(nd_cmd_dimm_desc
);
716 static const struct nd_cmd_desc __nd_cmd_bus_descs
[] = {
717 [ND_CMD_IMPLEMENTED
] = { },
720 .in_sizes
= { 8, 8, },
722 .out_sizes
= { 4, 4, 4, 4, },
724 [ND_CMD_ARS_START
] = {
726 .in_sizes
= { 8, 8, 2, 1, 5, },
728 .out_sizes
= { 4, 4, },
730 [ND_CMD_ARS_STATUS
] = {
732 .out_sizes
= { 4, 4, UINT_MAX
, },
734 [ND_CMD_CLEAR_ERROR
] = {
736 .in_sizes
= { 8, 8, },
738 .out_sizes
= { 4, 4, 8, },
742 .in_sizes
= { sizeof(struct nd_cmd_pkg
), UINT_MAX
, },
744 .out_sizes
= { UINT_MAX
, },
748 const struct nd_cmd_desc
*nd_cmd_bus_desc(int cmd
)
750 if (cmd
< ARRAY_SIZE(__nd_cmd_bus_descs
))
751 return &__nd_cmd_bus_descs
[cmd
];
754 EXPORT_SYMBOL_GPL(nd_cmd_bus_desc
);
756 u32
nd_cmd_in_size(struct nvdimm
*nvdimm
, int cmd
,
757 const struct nd_cmd_desc
*desc
, int idx
, void *buf
)
759 if (idx
>= desc
->in_num
)
762 if (desc
->in_sizes
[idx
] < UINT_MAX
)
763 return desc
->in_sizes
[idx
];
765 if (nvdimm
&& cmd
== ND_CMD_SET_CONFIG_DATA
&& idx
== 2) {
766 struct nd_cmd_set_config_hdr
*hdr
= buf
;
768 return hdr
->in_length
;
769 } else if (nvdimm
&& cmd
== ND_CMD_VENDOR
&& idx
== 2) {
770 struct nd_cmd_vendor_hdr
*hdr
= buf
;
772 return hdr
->in_length
;
773 } else if (cmd
== ND_CMD_CALL
) {
774 struct nd_cmd_pkg
*pkg
= buf
;
776 return pkg
->nd_size_in
;
781 EXPORT_SYMBOL_GPL(nd_cmd_in_size
);
783 u32
nd_cmd_out_size(struct nvdimm
*nvdimm
, int cmd
,
784 const struct nd_cmd_desc
*desc
, int idx
, const u32
*in_field
,
785 const u32
*out_field
, unsigned long remainder
)
787 if (idx
>= desc
->out_num
)
790 if (desc
->out_sizes
[idx
] < UINT_MAX
)
791 return desc
->out_sizes
[idx
];
793 if (nvdimm
&& cmd
== ND_CMD_GET_CONFIG_DATA
&& idx
== 1)
795 else if (nvdimm
&& cmd
== ND_CMD_VENDOR
&& idx
== 2)
797 else if (!nvdimm
&& cmd
== ND_CMD_ARS_STATUS
&& idx
== 2) {
799 * Per table 9-276 ARS Data in ACPI 6.1, out_field[1] is
800 * "Size of Output Buffer in bytes, including this
803 if (out_field
[1] < 4)
806 * ACPI 6.1 is ambiguous if 'status' is included in the
807 * output size. If we encounter an output size that
808 * overshoots the remainder by 4 bytes, assume it was
809 * including 'status'.
811 if (out_field
[1] - 8 == remainder
)
813 return out_field
[1] - 4;
814 } else if (cmd
== ND_CMD_CALL
) {
815 struct nd_cmd_pkg
*pkg
= (struct nd_cmd_pkg
*) in_field
;
817 return pkg
->nd_size_out
;
823 EXPORT_SYMBOL_GPL(nd_cmd_out_size
);
825 void wait_nvdimm_bus_probe_idle(struct device
*dev
)
827 struct nvdimm_bus
*nvdimm_bus
= walk_to_nvdimm_bus(dev
);
830 if (nvdimm_bus
->probe_active
== 0)
832 nvdimm_bus_unlock(&nvdimm_bus
->dev
);
833 wait_event(nvdimm_bus
->probe_wait
,
834 nvdimm_bus
->probe_active
== 0);
835 nvdimm_bus_lock(&nvdimm_bus
->dev
);
839 static int nd_pmem_forget_poison_check(struct device
*dev
, void *data
)
841 struct nd_cmd_clear_error
*clear_err
=
842 (struct nd_cmd_clear_error
*)data
;
843 struct nd_btt
*nd_btt
= is_nd_btt(dev
) ? to_nd_btt(dev
) : NULL
;
844 struct nd_pfn
*nd_pfn
= is_nd_pfn(dev
) ? to_nd_pfn(dev
) : NULL
;
845 struct nd_dax
*nd_dax
= is_nd_dax(dev
) ? to_nd_dax(dev
) : NULL
;
846 struct nd_namespace_common
*ndns
= NULL
;
847 struct nd_namespace_io
*nsio
;
848 resource_size_t offset
= 0, end_trunc
= 0, start
, end
, pstart
, pend
;
850 if (nd_dax
|| !dev
->driver
)
853 start
= clear_err
->address
;
854 end
= clear_err
->address
+ clear_err
->cleared
- 1;
856 if (nd_btt
|| nd_pfn
|| nd_dax
) {
862 ndns
= nd_dax
->nd_pfn
.ndns
;
869 nsio
= to_nd_namespace_io(&ndns
->dev
);
870 pstart
= nsio
->res
.start
+ offset
;
871 pend
= nsio
->res
.end
- end_trunc
;
873 if ((pstart
>= start
) && (pend
<= end
))
880 static int nd_ns_forget_poison_check(struct device
*dev
, void *data
)
882 return device_for_each_child(dev
, data
, nd_pmem_forget_poison_check
);
885 /* set_config requires an idle interleave set */
886 static int nd_cmd_clear_to_send(struct nvdimm_bus
*nvdimm_bus
,
887 struct nvdimm
*nvdimm
, unsigned int cmd
, void *data
)
889 struct nvdimm_bus_descriptor
*nd_desc
= nvdimm_bus
->nd_desc
;
891 /* ask the bus provider if it would like to block this request */
892 if (nd_desc
->clear_to_send
) {
893 int rc
= nd_desc
->clear_to_send(nd_desc
, nvdimm
, cmd
);
899 /* require clear error to go through the pmem driver */
900 if (!nvdimm
&& cmd
== ND_CMD_CLEAR_ERROR
)
901 return device_for_each_child(&nvdimm_bus
->dev
, data
,
902 nd_ns_forget_poison_check
);
904 if (!nvdimm
|| cmd
!= ND_CMD_SET_CONFIG_DATA
)
907 /* prevent label manipulation while the kernel owns label updates */
908 wait_nvdimm_bus_probe_idle(&nvdimm_bus
->dev
);
909 if (atomic_read(&nvdimm
->busy
))
914 static int __nd_ioctl(struct nvdimm_bus
*nvdimm_bus
, struct nvdimm
*nvdimm
,
915 int read_only
, unsigned int ioctl_cmd
, unsigned long arg
)
917 struct nvdimm_bus_descriptor
*nd_desc
= nvdimm_bus
->nd_desc
;
918 static char out_env
[ND_CMD_MAX_ENVELOPE
];
919 static char in_env
[ND_CMD_MAX_ENVELOPE
];
920 const struct nd_cmd_desc
*desc
= NULL
;
921 unsigned int cmd
= _IOC_NR(ioctl_cmd
);
922 struct device
*dev
= &nvdimm_bus
->dev
;
923 void __user
*p
= (void __user
*) arg
;
924 const char *cmd_name
, *dimm_name
;
925 u32 in_len
= 0, out_len
= 0;
926 unsigned int func
= cmd
;
927 unsigned long cmd_mask
;
928 struct nd_cmd_pkg pkg
;
934 desc
= nd_cmd_dimm_desc(cmd
);
935 cmd_name
= nvdimm_cmd_name(cmd
);
936 cmd_mask
= nvdimm
->cmd_mask
;
937 dimm_name
= dev_name(&nvdimm
->dev
);
939 desc
= nd_cmd_bus_desc(cmd
);
940 cmd_name
= nvdimm_bus_cmd_name(cmd
);
941 cmd_mask
= nd_desc
->cmd_mask
;
945 if (cmd
== ND_CMD_CALL
) {
946 if (copy_from_user(&pkg
, p
, sizeof(pkg
)))
950 if (!desc
|| (desc
->out_num
+ desc
->in_num
== 0) ||
951 !test_bit(cmd
, &cmd_mask
))
954 /* fail write commands (when read-only) */
958 case ND_CMD_SET_CONFIG_DATA
:
959 case ND_CMD_ARS_START
:
960 case ND_CMD_CLEAR_ERROR
:
962 dev_dbg(&nvdimm_bus
->dev
, "'%s' command while read-only.\n",
963 nvdimm
? nvdimm_cmd_name(cmd
)
964 : nvdimm_bus_cmd_name(cmd
));
970 /* process an input envelope */
971 for (i
= 0; i
< desc
->in_num
; i
++) {
974 in_size
= nd_cmd_in_size(nvdimm
, cmd
, desc
, i
, in_env
);
975 if (in_size
== UINT_MAX
) {
976 dev_err(dev
, "%s:%s unknown input size cmd: %s field: %d\n",
977 __func__
, dimm_name
, cmd_name
, i
);
980 if (in_len
< sizeof(in_env
))
981 copy
= min_t(u32
, sizeof(in_env
) - in_len
, in_size
);
984 if (copy
&& copy_from_user(&in_env
[in_len
], p
+ in_len
, copy
))
989 if (cmd
== ND_CMD_CALL
) {
990 func
= pkg
.nd_command
;
991 dev_dbg(dev
, "%s:%s, idx: %llu, in: %u, out: %u, len %llu\n",
992 __func__
, dimm_name
, pkg
.nd_command
,
993 in_len
, out_len
, buf_len
);
996 /* process an output envelope */
997 for (i
= 0; i
< desc
->out_num
; i
++) {
998 u32 out_size
= nd_cmd_out_size(nvdimm
, cmd
, desc
, i
,
999 (u32
*) in_env
, (u32
*) out_env
, 0);
1002 if (out_size
== UINT_MAX
) {
1003 dev_dbg(dev
, "%s:%s unknown output size cmd: %s field: %d\n",
1004 __func__
, dimm_name
, cmd_name
, i
);
1007 if (out_len
< sizeof(out_env
))
1008 copy
= min_t(u32
, sizeof(out_env
) - out_len
, out_size
);
1011 if (copy
&& copy_from_user(&out_env
[out_len
],
1012 p
+ in_len
+ out_len
, copy
))
1014 out_len
+= out_size
;
1017 buf_len
= (u64
) out_len
+ (u64
) in_len
;
1018 if (buf_len
> ND_IOCTL_MAX_BUFLEN
) {
1019 dev_dbg(dev
, "%s:%s cmd: %s buf_len: %llu > %d\n", __func__
,
1020 dimm_name
, cmd_name
, buf_len
,
1021 ND_IOCTL_MAX_BUFLEN
);
1025 buf
= vmalloc(buf_len
);
1029 if (copy_from_user(buf
, p
, buf_len
)) {
1034 nvdimm_bus_lock(&nvdimm_bus
->dev
);
1035 rc
= nd_cmd_clear_to_send(nvdimm_bus
, nvdimm
, func
, buf
);
1039 rc
= nd_desc
->ndctl(nd_desc
, nvdimm
, cmd
, buf
, buf_len
, &cmd_rc
);
1043 if (!nvdimm
&& cmd
== ND_CMD_CLEAR_ERROR
&& cmd_rc
>= 0) {
1044 struct nd_cmd_clear_error
*clear_err
= buf
;
1046 nvdimm_account_cleared_poison(nvdimm_bus
, clear_err
->address
,
1047 clear_err
->cleared
);
1049 nvdimm_bus_unlock(&nvdimm_bus
->dev
);
1051 if (copy_to_user(p
, buf
, buf_len
))
1058 nvdimm_bus_unlock(&nvdimm_bus
->dev
);
1064 static long nd_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1066 long id
= (long) file
->private_data
;
1067 int rc
= -ENXIO
, ro
;
1068 struct nvdimm_bus
*nvdimm_bus
;
1070 ro
= ((file
->f_flags
& O_ACCMODE
) == O_RDONLY
);
1071 mutex_lock(&nvdimm_bus_list_mutex
);
1072 list_for_each_entry(nvdimm_bus
, &nvdimm_bus_list
, list
) {
1073 if (nvdimm_bus
->id
== id
) {
1074 rc
= __nd_ioctl(nvdimm_bus
, NULL
, ro
, cmd
, arg
);
1078 mutex_unlock(&nvdimm_bus_list_mutex
);
1083 static int match_dimm(struct device
*dev
, void *data
)
1085 long id
= (long) data
;
1087 if (is_nvdimm(dev
)) {
1088 struct nvdimm
*nvdimm
= to_nvdimm(dev
);
1090 return nvdimm
->id
== id
;
1096 static long nvdimm_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
1098 int rc
= -ENXIO
, ro
;
1099 struct nvdimm_bus
*nvdimm_bus
;
1101 ro
= ((file
->f_flags
& O_ACCMODE
) == O_RDONLY
);
1102 mutex_lock(&nvdimm_bus_list_mutex
);
1103 list_for_each_entry(nvdimm_bus
, &nvdimm_bus_list
, list
) {
1104 struct device
*dev
= device_find_child(&nvdimm_bus
->dev
,
1105 file
->private_data
, match_dimm
);
1106 struct nvdimm
*nvdimm
;
1111 nvdimm
= to_nvdimm(dev
);
1112 rc
= __nd_ioctl(nvdimm_bus
, nvdimm
, ro
, cmd
, arg
);
1116 mutex_unlock(&nvdimm_bus_list_mutex
);
1121 static int nd_open(struct inode
*inode
, struct file
*file
)
1123 long minor
= iminor(inode
);
1125 file
->private_data
= (void *) minor
;
1129 static const struct file_operations nvdimm_bus_fops
= {
1130 .owner
= THIS_MODULE
,
1132 .unlocked_ioctl
= nd_ioctl
,
1133 .compat_ioctl
= nd_ioctl
,
1134 .llseek
= noop_llseek
,
1137 static const struct file_operations nvdimm_fops
= {
1138 .owner
= THIS_MODULE
,
1140 .unlocked_ioctl
= nvdimm_ioctl
,
1141 .compat_ioctl
= nvdimm_ioctl
,
1142 .llseek
= noop_llseek
,
1145 int __init
nvdimm_bus_init(void)
1149 BUILD_BUG_ON(sizeof(struct nd_smart_payload
) != 128);
1150 BUILD_BUG_ON(sizeof(struct nd_smart_threshold_payload
) != 8);
1152 rc
= bus_register(&nvdimm_bus_type
);
1156 rc
= register_chrdev(0, "ndctl", &nvdimm_bus_fops
);
1158 goto err_bus_chrdev
;
1159 nvdimm_bus_major
= rc
;
1161 rc
= register_chrdev(0, "dimmctl", &nvdimm_fops
);
1163 goto err_dimm_chrdev
;
1166 nd_class
= class_create(THIS_MODULE
, "nd");
1167 if (IS_ERR(nd_class
)) {
1168 rc
= PTR_ERR(nd_class
);
1172 rc
= driver_register(&nd_bus_driver
.drv
);
1179 class_destroy(nd_class
);
1181 unregister_chrdev(nvdimm_major
, "dimmctl");
1183 unregister_chrdev(nvdimm_bus_major
, "ndctl");
1185 bus_unregister(&nvdimm_bus_type
);
1190 void nvdimm_bus_exit(void)
1192 driver_unregister(&nd_bus_driver
.drv
);
1193 class_destroy(nd_class
);
1194 unregister_chrdev(nvdimm_bus_major
, "ndctl");
1195 unregister_chrdev(nvdimm_major
, "dimmctl");
1196 bus_unregister(&nvdimm_bus_type
);
1197 ida_destroy(&nd_ida
);