1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
5 #include <linux/libnvdimm.h>
6 #include <linux/suspend.h>
7 #include <linux/export.h>
8 #include <linux/module.h>
9 #include <linux/blkdev.h>
10 #include <linux/blk-integrity.h>
11 #include <linux/device.h>
12 #include <linux/ctype.h>
13 #include <linux/ndctl.h>
14 #include <linux/mutex.h>
15 #include <linux/slab.h>
20 LIST_HEAD(nvdimm_bus_list);
21 DEFINE_MUTEX(nvdimm_bus_list_mutex);
23 void nvdimm_bus_lock(struct device *dev)
25 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
29 mutex_lock(&nvdimm_bus->reconfig_mutex);
31 EXPORT_SYMBOL(nvdimm_bus_lock);
33 void nvdimm_bus_unlock(struct device *dev)
35 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
39 mutex_unlock(&nvdimm_bus->reconfig_mutex);
41 EXPORT_SYMBOL(nvdimm_bus_unlock);
43 bool is_nvdimm_bus_locked(struct device *dev)
45 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
49 return mutex_is_locked(&nvdimm_bus->reconfig_mutex);
51 EXPORT_SYMBOL(is_nvdimm_bus_locked);
54 struct nvdimm_bus *nvdimm_bus;
55 struct list_head list;
56 resource_size_t offset;
66 static struct nvdimm_map *find_nvdimm_map(struct device *dev,
67 resource_size_t offset)
69 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
70 struct nvdimm_map *nvdimm_map;
72 list_for_each_entry(nvdimm_map, &nvdimm_bus->mapping_list, list)
73 if (nvdimm_map->offset == offset)
78 static struct nvdimm_map *alloc_nvdimm_map(struct device *dev,
79 resource_size_t offset, size_t size, unsigned long flags)
81 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
82 struct nvdimm_map *nvdimm_map;
84 nvdimm_map = kzalloc(sizeof(*nvdimm_map), GFP_KERNEL);
88 INIT_LIST_HEAD(&nvdimm_map->list);
89 nvdimm_map->nvdimm_bus = nvdimm_bus;
90 nvdimm_map->offset = offset;
91 nvdimm_map->flags = flags;
92 nvdimm_map->size = size;
93 kref_init(&nvdimm_map->kref);
95 if (!request_mem_region(offset, size, dev_name(&nvdimm_bus->dev))) {
96 dev_err(&nvdimm_bus->dev, "failed to request %pa + %zd for %s\n",
97 &offset, size, dev_name(dev));
98 goto err_request_region;
102 nvdimm_map->mem = memremap(offset, size, flags);
104 nvdimm_map->iomem = ioremap(offset, size);
106 if (!nvdimm_map->mem)
109 dev_WARN_ONCE(dev, !is_nvdimm_bus_locked(dev), "%s: bus unlocked!",
111 list_add(&nvdimm_map->list, &nvdimm_bus->mapping_list);
116 release_mem_region(offset, size);
122 static void nvdimm_map_release(struct kref *kref)
124 struct nvdimm_bus *nvdimm_bus;
125 struct nvdimm_map *nvdimm_map;
127 nvdimm_map = container_of(kref, struct nvdimm_map, kref);
128 nvdimm_bus = nvdimm_map->nvdimm_bus;
130 dev_dbg(&nvdimm_bus->dev, "%pa\n", &nvdimm_map->offset);
131 list_del(&nvdimm_map->list);
132 if (nvdimm_map->flags)
133 memunmap(nvdimm_map->mem);
135 iounmap(nvdimm_map->iomem);
136 release_mem_region(nvdimm_map->offset, nvdimm_map->size);
140 static void nvdimm_map_put(void *data)
142 struct nvdimm_map *nvdimm_map = data;
143 struct nvdimm_bus *nvdimm_bus = nvdimm_map->nvdimm_bus;
145 nvdimm_bus_lock(&nvdimm_bus->dev);
146 kref_put(&nvdimm_map->kref, nvdimm_map_release);
147 nvdimm_bus_unlock(&nvdimm_bus->dev);
151 * devm_nvdimm_memremap - map a resource that is shared across regions
152 * @dev: device that will own a reference to the shared mapping
153 * @offset: physical base address of the mapping
154 * @size: mapping size
155 * @flags: memremap flags, or, if zero, perform an ioremap instead
157 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
158 size_t size, unsigned long flags)
160 struct nvdimm_map *nvdimm_map;
162 nvdimm_bus_lock(dev);
163 nvdimm_map = find_nvdimm_map(dev, offset);
165 nvdimm_map = alloc_nvdimm_map(dev, offset, size, flags);
167 kref_get(&nvdimm_map->kref);
168 nvdimm_bus_unlock(dev);
173 if (devm_add_action_or_reset(dev, nvdimm_map_put, nvdimm_map))
176 return nvdimm_map->mem;
178 EXPORT_SYMBOL_GPL(devm_nvdimm_memremap);
180 u64 nd_fletcher64(void *addr, size_t len, bool le)
187 for (i = 0; i < len / sizeof(u32); i++) {
188 lo32 += le ? le32_to_cpu((__le32) buf[i]) : buf[i];
192 return hi32 << 32 | lo32;
194 EXPORT_SYMBOL_GPL(nd_fletcher64);
196 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus)
198 /* struct nvdimm_bus definition is private to libnvdimm */
199 return nvdimm_bus->nd_desc;
201 EXPORT_SYMBOL_GPL(to_nd_desc);
203 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus)
205 /* struct nvdimm_bus definition is private to libnvdimm */
206 return &nvdimm_bus->dev;
208 EXPORT_SYMBOL_GPL(to_nvdimm_bus_dev);
210 static bool is_uuid_sep(char sep)
212 if (sep == '\n' || sep == '-' || sep == ':' || sep == '\0')
217 static int nd_uuid_parse(struct device *dev, u8 *uuid_out, const char *buf,
220 const char *str = buf;
224 for (i = 0; i < 16; i++) {
225 if (!isxdigit(str[0]) || !isxdigit(str[1])) {
226 dev_dbg(dev, "pos: %d buf[%zd]: %c buf[%zd]: %c\n",
227 i, str - buf, str[0],
228 str + 1 - buf, str[1]);
232 uuid[i] = (hex_to_bin(str[0]) << 4) | hex_to_bin(str[1]);
234 if (is_uuid_sep(*str))
238 memcpy(uuid_out, uuid, sizeof(uuid));
243 * nd_uuid_store: common implementation for writing 'uuid' sysfs attributes
244 * @dev: container device for the uuid property
245 * @uuid_out: uuid buffer to replace
246 * @buf: raw sysfs buffer to parse
248 * Enforce that uuids can only be changed while the device is disabled
250 * LOCKING: expects nd_device_lock() is held on entry
252 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
261 rc = nd_uuid_parse(dev, uuid, buf, len);
266 *uuid_out = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
273 ssize_t nd_size_select_show(unsigned long current_size,
274 const unsigned long *supported, char *buf)
279 for (i = 0; supported[i]; i++)
280 if (current_size == supported[i])
281 len += sprintf(buf + len, "[%ld] ", supported[i]);
283 len += sprintf(buf + len, "%ld ", supported[i]);
284 len += sprintf(buf + len, "\n");
288 ssize_t nd_size_select_store(struct device *dev, const char *buf,
289 unsigned long *current_size, const unsigned long *supported)
291 unsigned long lbasize;
297 rc = kstrtoul(buf, 0, &lbasize);
301 for (i = 0; supported[i]; i++)
302 if (lbasize == supported[i])
306 *current_size = lbasize;
313 static ssize_t commands_show(struct device *dev,
314 struct device_attribute *attr, char *buf)
317 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
318 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
320 for_each_set_bit(cmd, &nd_desc->cmd_mask, BITS_PER_LONG)
321 len += sprintf(buf + len, "%s ", nvdimm_bus_cmd_name(cmd));
322 len += sprintf(buf + len, "\n");
325 static DEVICE_ATTR_RO(commands);
327 static const char *nvdimm_bus_provider(struct nvdimm_bus *nvdimm_bus)
329 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
330 struct device *parent = nvdimm_bus->dev.parent;
332 if (nd_desc->provider_name)
333 return nd_desc->provider_name;
335 return dev_name(parent);
340 static ssize_t provider_show(struct device *dev,
341 struct device_attribute *attr, char *buf)
343 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
345 return sprintf(buf, "%s\n", nvdimm_bus_provider(nvdimm_bus));
347 static DEVICE_ATTR_RO(provider);
349 static int flush_namespaces(struct device *dev, void *data)
352 nd_device_unlock(dev);
356 static int flush_regions_dimms(struct device *dev, void *data)
359 nd_device_unlock(dev);
360 device_for_each_child(dev, NULL, flush_namespaces);
364 static ssize_t wait_probe_show(struct device *dev,
365 struct device_attribute *attr, char *buf)
367 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
368 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
371 if (nd_desc->flush_probe) {
372 rc = nd_desc->flush_probe(nd_desc);
377 device_for_each_child(dev, NULL, flush_regions_dimms);
378 return sprintf(buf, "1\n");
380 static DEVICE_ATTR_RO(wait_probe);
382 static struct attribute *nvdimm_bus_attributes[] = {
383 &dev_attr_commands.attr,
384 &dev_attr_wait_probe.attr,
385 &dev_attr_provider.attr,
389 static const struct attribute_group nvdimm_bus_attribute_group = {
390 .attrs = nvdimm_bus_attributes,
393 static ssize_t capability_show(struct device *dev,
394 struct device_attribute *attr, char *buf)
396 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
397 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
398 enum nvdimm_fwa_capability cap;
400 if (!nd_desc->fw_ops)
403 nvdimm_bus_lock(dev);
404 cap = nd_desc->fw_ops->capability(nd_desc);
405 nvdimm_bus_unlock(dev);
408 case NVDIMM_FWA_CAP_QUIESCE:
409 return sprintf(buf, "quiesce\n");
410 case NVDIMM_FWA_CAP_LIVE:
411 return sprintf(buf, "live\n");
417 static DEVICE_ATTR_RO(capability);
419 static ssize_t activate_show(struct device *dev,
420 struct device_attribute *attr, char *buf)
422 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
423 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
424 enum nvdimm_fwa_capability cap;
425 enum nvdimm_fwa_state state;
427 if (!nd_desc->fw_ops)
430 nvdimm_bus_lock(dev);
431 cap = nd_desc->fw_ops->capability(nd_desc);
432 state = nd_desc->fw_ops->activate_state(nd_desc);
433 nvdimm_bus_unlock(dev);
435 if (cap < NVDIMM_FWA_CAP_QUIESCE)
439 case NVDIMM_FWA_IDLE:
440 return sprintf(buf, "idle\n");
441 case NVDIMM_FWA_BUSY:
442 return sprintf(buf, "busy\n");
443 case NVDIMM_FWA_ARMED:
444 return sprintf(buf, "armed\n");
445 case NVDIMM_FWA_ARM_OVERFLOW:
446 return sprintf(buf, "overflow\n");
452 static int exec_firmware_activate(void *data)
454 struct nvdimm_bus_descriptor *nd_desc = data;
456 return nd_desc->fw_ops->activate(nd_desc);
459 static ssize_t activate_store(struct device *dev,
460 struct device_attribute *attr, const char *buf, size_t len)
462 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
463 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
464 enum nvdimm_fwa_state state;
468 if (!nd_desc->fw_ops)
471 if (sysfs_streq(buf, "live"))
473 else if (sysfs_streq(buf, "quiesce"))
478 nvdimm_bus_lock(dev);
479 state = nd_desc->fw_ops->activate_state(nd_desc);
482 case NVDIMM_FWA_BUSY:
485 case NVDIMM_FWA_ARMED:
486 case NVDIMM_FWA_ARM_OVERFLOW:
488 rc = hibernate_quiet_exec(exec_firmware_activate, nd_desc);
490 rc = nd_desc->fw_ops->activate(nd_desc);
492 case NVDIMM_FWA_IDLE:
496 nvdimm_bus_unlock(dev);
503 static DEVICE_ATTR_ADMIN_RW(activate);
505 static umode_t nvdimm_bus_firmware_visible(struct kobject *kobj, struct attribute *a, int n)
507 struct device *dev = container_of(kobj, typeof(*dev), kobj);
508 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
509 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
510 enum nvdimm_fwa_capability cap;
513 * Both 'activate' and 'capability' disappear when no ops
514 * detected, or a negative capability is indicated.
516 if (!nd_desc->fw_ops)
519 nvdimm_bus_lock(dev);
520 cap = nd_desc->fw_ops->capability(nd_desc);
521 nvdimm_bus_unlock(dev);
523 if (cap < NVDIMM_FWA_CAP_QUIESCE)
528 static struct attribute *nvdimm_bus_firmware_attributes[] = {
529 &dev_attr_activate.attr,
530 &dev_attr_capability.attr,
534 static const struct attribute_group nvdimm_bus_firmware_attribute_group = {
536 .attrs = nvdimm_bus_firmware_attributes,
537 .is_visible = nvdimm_bus_firmware_visible,
540 const struct attribute_group *nvdimm_bus_attribute_groups[] = {
541 &nvdimm_bus_attribute_group,
542 &nvdimm_bus_firmware_attribute_group,
546 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length)
548 return badrange_add(&nvdimm_bus->badrange, addr, length);
550 EXPORT_SYMBOL_GPL(nvdimm_bus_add_badrange);
552 #ifdef CONFIG_BLK_DEV_INTEGRITY
553 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size)
555 struct blk_integrity bi;
560 memset(&bi, 0, sizeof(bi));
562 bi.tuple_size = meta_size;
563 bi.tag_size = meta_size;
565 blk_integrity_register(disk, &bi);
566 blk_queue_max_integrity_segments(disk->queue, 1);
570 EXPORT_SYMBOL(nd_integrity_init);
572 #else /* CONFIG_BLK_DEV_INTEGRITY */
573 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size)
577 EXPORT_SYMBOL(nd_integrity_init);
581 static __init int libnvdimm_init(void)
585 rc = nvdimm_bus_init();
591 rc = nd_region_init();
605 static __exit void libnvdimm_exit(void)
607 WARN_ON(!list_empty(&nvdimm_bus_list));
614 MODULE_LICENSE("GPL v2");
615 MODULE_AUTHOR("Intel Corporation");
616 subsys_initcall(libnvdimm_init);
617 module_exit(libnvdimm_exit);