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 #include <linux/libnvdimm.h>
14 #include <linux/export.h>
15 #include <linux/module.h>
16 #include <linux/blkdev.h>
17 #include <linux/device.h>
18 #include <linux/ctype.h>
19 #include <linux/ndctl.h>
20 #include <linux/mutex.h>
21 #include <linux/slab.h>
25 LIST_HEAD(nvdimm_bus_list);
26 DEFINE_MUTEX(nvdimm_bus_list_mutex);
27 static DEFINE_IDA(nd_ida);
29 void nvdimm_bus_lock(struct device *dev)
31 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
35 mutex_lock(&nvdimm_bus->reconfig_mutex);
37 EXPORT_SYMBOL(nvdimm_bus_lock);
39 void nvdimm_bus_unlock(struct device *dev)
41 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
45 mutex_unlock(&nvdimm_bus->reconfig_mutex);
47 EXPORT_SYMBOL(nvdimm_bus_unlock);
49 bool is_nvdimm_bus_locked(struct device *dev)
51 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
55 return mutex_is_locked(&nvdimm_bus->reconfig_mutex);
57 EXPORT_SYMBOL(is_nvdimm_bus_locked);
59 u64 nd_fletcher64(void *addr, size_t len, bool le)
66 for (i = 0; i < len / sizeof(u32); i++) {
67 lo32 += le ? le32_to_cpu((__le32) buf[i]) : buf[i];
71 return hi32 << 32 | lo32;
73 EXPORT_SYMBOL_GPL(nd_fletcher64);
75 static void nvdimm_bus_release(struct device *dev)
77 struct nvdimm_bus *nvdimm_bus;
79 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
80 ida_simple_remove(&nd_ida, nvdimm_bus->id);
84 struct nvdimm_bus *to_nvdimm_bus(struct device *dev)
86 struct nvdimm_bus *nvdimm_bus;
88 nvdimm_bus = container_of(dev, struct nvdimm_bus, dev);
89 WARN_ON(nvdimm_bus->dev.release != nvdimm_bus_release);
92 EXPORT_SYMBOL_GPL(to_nvdimm_bus);
94 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus)
96 /* struct nvdimm_bus definition is private to libnvdimm */
97 return nvdimm_bus->nd_desc;
99 EXPORT_SYMBOL_GPL(to_nd_desc);
101 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev)
105 for (dev = nd_dev; dev; dev = dev->parent)
106 if (dev->release == nvdimm_bus_release)
108 dev_WARN_ONCE(nd_dev, !dev, "invalid dev, not on nd bus\n");
110 return to_nvdimm_bus(dev);
114 static bool is_uuid_sep(char sep)
116 if (sep == '\n' || sep == '-' || sep == ':' || sep == '\0')
121 static int nd_uuid_parse(struct device *dev, u8 *uuid_out, const char *buf,
124 const char *str = buf;
128 for (i = 0; i < 16; i++) {
129 if (!isxdigit(str[0]) || !isxdigit(str[1])) {
130 dev_dbg(dev, "%s: pos: %d buf[%zd]: %c buf[%zd]: %c\n",
131 __func__, i, str - buf, str[0],
132 str + 1 - buf, str[1]);
136 uuid[i] = (hex_to_bin(str[0]) << 4) | hex_to_bin(str[1]);
138 if (is_uuid_sep(*str))
142 memcpy(uuid_out, uuid, sizeof(uuid));
147 * nd_uuid_store: common implementation for writing 'uuid' sysfs attributes
148 * @dev: container device for the uuid property
149 * @uuid_out: uuid buffer to replace
150 * @buf: raw sysfs buffer to parse
152 * Enforce that uuids can only be changed while the device is disabled
154 * LOCKING: expects device_lock() is held on entry
156 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
165 rc = nd_uuid_parse(dev, uuid, buf, len);
170 *uuid_out = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
177 ssize_t nd_sector_size_show(unsigned long current_lbasize,
178 const unsigned long *supported, char *buf)
183 for (i = 0; supported[i]; i++)
184 if (current_lbasize == supported[i])
185 len += sprintf(buf + len, "[%ld] ", supported[i]);
187 len += sprintf(buf + len, "%ld ", supported[i]);
188 len += sprintf(buf + len, "\n");
192 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
193 unsigned long *current_lbasize, const unsigned long *supported)
195 unsigned long lbasize;
201 rc = kstrtoul(buf, 0, &lbasize);
205 for (i = 0; supported[i]; i++)
206 if (lbasize == supported[i])
210 *current_lbasize = lbasize;
217 static ssize_t commands_show(struct device *dev,
218 struct device_attribute *attr, char *buf)
221 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
222 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
224 for_each_set_bit(cmd, &nd_desc->dsm_mask, BITS_PER_LONG)
225 len += sprintf(buf + len, "%s ", nvdimm_bus_cmd_name(cmd));
226 len += sprintf(buf + len, "\n");
229 static DEVICE_ATTR_RO(commands);
231 static const char *nvdimm_bus_provider(struct nvdimm_bus *nvdimm_bus)
233 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
234 struct device *parent = nvdimm_bus->dev.parent;
236 if (nd_desc->provider_name)
237 return nd_desc->provider_name;
239 return dev_name(parent);
244 static ssize_t provider_show(struct device *dev,
245 struct device_attribute *attr, char *buf)
247 struct nvdimm_bus *nvdimm_bus = to_nvdimm_bus(dev);
249 return sprintf(buf, "%s\n", nvdimm_bus_provider(nvdimm_bus));
251 static DEVICE_ATTR_RO(provider);
253 static int flush_namespaces(struct device *dev, void *data)
260 static int flush_regions_dimms(struct device *dev, void *data)
264 device_for_each_child(dev, NULL, flush_namespaces);
268 static ssize_t wait_probe_show(struct device *dev,
269 struct device_attribute *attr, char *buf)
272 device_for_each_child(dev, NULL, flush_regions_dimms);
273 return sprintf(buf, "1\n");
275 static DEVICE_ATTR_RO(wait_probe);
277 static struct attribute *nvdimm_bus_attributes[] = {
278 &dev_attr_commands.attr,
279 &dev_attr_wait_probe.attr,
280 &dev_attr_provider.attr,
284 struct attribute_group nvdimm_bus_attribute_group = {
285 .attrs = nvdimm_bus_attributes,
287 EXPORT_SYMBOL_GPL(nvdimm_bus_attribute_group);
289 struct nvdimm_bus *__nvdimm_bus_register(struct device *parent,
290 struct nvdimm_bus_descriptor *nd_desc, struct module *module)
292 struct nvdimm_bus *nvdimm_bus;
295 nvdimm_bus = kzalloc(sizeof(*nvdimm_bus), GFP_KERNEL);
298 INIT_LIST_HEAD(&nvdimm_bus->list);
299 init_waitqueue_head(&nvdimm_bus->probe_wait);
300 nvdimm_bus->id = ida_simple_get(&nd_ida, 0, 0, GFP_KERNEL);
301 mutex_init(&nvdimm_bus->reconfig_mutex);
302 if (nvdimm_bus->id < 0) {
306 nvdimm_bus->nd_desc = nd_desc;
307 nvdimm_bus->module = module;
308 nvdimm_bus->dev.parent = parent;
309 nvdimm_bus->dev.release = nvdimm_bus_release;
310 nvdimm_bus->dev.groups = nd_desc->attr_groups;
311 dev_set_name(&nvdimm_bus->dev, "ndbus%d", nvdimm_bus->id);
312 rc = device_register(&nvdimm_bus->dev);
314 dev_dbg(&nvdimm_bus->dev, "registration failed: %d\n", rc);
318 rc = nvdimm_bus_create_ndctl(nvdimm_bus);
322 mutex_lock(&nvdimm_bus_list_mutex);
323 list_add_tail(&nvdimm_bus->list, &nvdimm_bus_list);
324 mutex_unlock(&nvdimm_bus_list_mutex);
328 put_device(&nvdimm_bus->dev);
331 EXPORT_SYMBOL_GPL(__nvdimm_bus_register);
333 static int child_unregister(struct device *dev, void *data)
336 * the singular ndctl class device per bus needs to be
337 * "device_destroy"ed, so skip it here
339 * i.e. remove classless children
344 nd_device_unregister(dev, ND_SYNC);
348 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus)
353 mutex_lock(&nvdimm_bus_list_mutex);
354 list_del_init(&nvdimm_bus->list);
355 mutex_unlock(&nvdimm_bus_list_mutex);
358 device_for_each_child(&nvdimm_bus->dev, NULL, child_unregister);
359 nvdimm_bus_destroy_ndctl(nvdimm_bus);
361 device_unregister(&nvdimm_bus->dev);
363 EXPORT_SYMBOL_GPL(nvdimm_bus_unregister);
365 #ifdef CONFIG_BLK_DEV_INTEGRITY
366 static int nd_pi_nop_generate_verify(struct blk_integrity_iter *iter)
371 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size)
373 struct blk_integrity integrity = {
375 .generate_fn = nd_pi_nop_generate_verify,
376 .verify_fn = nd_pi_nop_generate_verify,
377 .tuple_size = meta_size,
378 .tag_size = meta_size,
385 ret = blk_integrity_register(disk, &integrity);
389 blk_queue_max_integrity_segments(disk->queue, 1);
393 EXPORT_SYMBOL(nd_integrity_init);
395 #else /* CONFIG_BLK_DEV_INTEGRITY */
396 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size)
400 EXPORT_SYMBOL(nd_integrity_init);
404 static __init int libnvdimm_init(void)
408 rc = nvdimm_bus_init();
414 rc = nd_region_init();
425 static __exit void libnvdimm_exit(void)
427 WARN_ON(!list_empty(&nvdimm_bus_list));
433 MODULE_LICENSE("GPL v2");
434 MODULE_AUTHOR("Intel Corporation");
435 subsys_initcall(libnvdimm_init);
436 module_exit(libnvdimm_exit);