blob: 275dd5c0a3018a45cfa66ae03bd179779b9c7041 [file] [log] [blame]
Dan Williams45def222015-04-26 19:26:48 -04001/*
2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
3 *
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.
7 *
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.
12 */
13#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
Dan Williams62232e452015-06-08 14:27:06 -040014#include <linux/vmalloc.h>
Dan Williams45def222015-04-26 19:26:48 -040015#include <linux/uaccess.h>
Dan Williams3d880022015-05-31 15:02:11 -040016#include <linux/module.h>
Dan Williams8c2f7e82015-06-25 04:20:04 -040017#include <linux/blkdev.h>
Dan Williams45def222015-04-26 19:26:48 -040018#include <linux/fcntl.h>
Dan Williamse6dfb2d2015-04-25 03:56:17 -040019#include <linux/async.h>
Dan Williams8c2f7e82015-06-25 04:20:04 -040020#include <linux/genhd.h>
Dan Williams62232e452015-06-08 14:27:06 -040021#include <linux/ndctl.h>
Dan Williams4d88a972015-05-31 14:41:48 -040022#include <linux/sched.h>
Dan Williams45def222015-04-26 19:26:48 -040023#include <linux/slab.h>
24#include <linux/fs.h>
25#include <linux/io.h>
Dan Williams62232e452015-06-08 14:27:06 -040026#include <linux/mm.h>
Dan Williams4d88a972015-05-31 14:41:48 -040027#include <linux/nd.h>
Dan Williams45def222015-04-26 19:26:48 -040028#include "nd-core.h"
Dan Williams4d88a972015-05-31 14:41:48 -040029#include "nd.h"
Dan Williams45def222015-04-26 19:26:48 -040030
Dan Williams62232e452015-06-08 14:27:06 -040031int nvdimm_major;
Dan Williams45def222015-04-26 19:26:48 -040032static int nvdimm_bus_major;
33static struct class *nd_class;
34
Dan Williams4d88a972015-05-31 14:41:48 -040035static int to_nd_device_type(struct device *dev)
36{
37 if (is_nvdimm(dev))
38 return ND_DEVICE_DIMM;
Dan Williams3d880022015-05-31 15:02:11 -040039 else if (is_nd_pmem(dev))
40 return ND_DEVICE_REGION_PMEM;
41 else if (is_nd_blk(dev))
42 return ND_DEVICE_REGION_BLK;
Dan Williamscd034122016-03-11 10:15:36 -080043 else if (is_nd_dax(dev))
44 return ND_DEVICE_DAX_PMEM;
Dan Williams3d880022015-05-31 15:02:11 -040045 else if (is_nd_pmem(dev->parent) || is_nd_blk(dev->parent))
46 return nd_region_to_nstype(to_nd_region(dev->parent));
Dan Williams4d88a972015-05-31 14:41:48 -040047
48 return 0;
49}
50
51static int nvdimm_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
52{
Toshi Kani41d7a6d2015-06-19 12:18:33 -060053 /*
54 * Ensure that region devices always have their numa node set as
55 * early as possible.
56 */
57 if (is_nd_pmem(dev) || is_nd_blk(dev))
58 set_dev_node(dev, to_nd_region(dev)->numa_node);
Dan Williams4d88a972015-05-31 14:41:48 -040059 return add_uevent_var(env, "MODALIAS=" ND_DEVICE_MODALIAS_FMT,
60 to_nd_device_type(dev));
61}
62
63static int nvdimm_bus_match(struct device *dev, struct device_driver *drv)
64{
65 struct nd_device_driver *nd_drv = to_nd_device_driver(drv);
66
Dan Williams82ec2ba2016-02-15 09:22:36 +010067 return !!test_bit(to_nd_device_type(dev), &nd_drv->type);
Dan Williams4d88a972015-05-31 14:41:48 -040068}
69
Dan Williams3d880022015-05-31 15:02:11 -040070static struct module *to_bus_provider(struct device *dev)
71{
72 /* pin bus providers while regions are enabled */
73 if (is_nd_pmem(dev) || is_nd_blk(dev)) {
74 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
75
Dan Williamsbc9775d2016-07-21 20:03:19 -070076 return nvdimm_bus->nd_desc->module;
Dan Williams3d880022015-05-31 15:02:11 -040077 }
78 return NULL;
79}
80
Dan Williamseaf96152015-05-01 13:11:27 -040081static void nvdimm_bus_probe_start(struct nvdimm_bus *nvdimm_bus)
82{
83 nvdimm_bus_lock(&nvdimm_bus->dev);
84 nvdimm_bus->probe_active++;
85 nvdimm_bus_unlock(&nvdimm_bus->dev);
86}
87
88static void nvdimm_bus_probe_end(struct nvdimm_bus *nvdimm_bus)
89{
90 nvdimm_bus_lock(&nvdimm_bus->dev);
91 if (--nvdimm_bus->probe_active == 0)
92 wake_up(&nvdimm_bus->probe_wait);
93 nvdimm_bus_unlock(&nvdimm_bus->dev);
94}
95
Dan Williams4d88a972015-05-31 14:41:48 -040096static int nvdimm_bus_probe(struct device *dev)
97{
98 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
Dan Williams3d880022015-05-31 15:02:11 -040099 struct module *provider = to_bus_provider(dev);
Dan Williams4d88a972015-05-31 14:41:48 -0400100 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
101 int rc;
102
Dan Williams3d880022015-05-31 15:02:11 -0400103 if (!try_module_get(provider))
104 return -ENXIO;
105
Dan Williamseaf96152015-05-01 13:11:27 -0400106 nvdimm_bus_probe_start(nvdimm_bus);
Dan Williams4d88a972015-05-31 14:41:48 -0400107 rc = nd_drv->probe(dev);
Dan Williamseaf96152015-05-01 13:11:27 -0400108 if (rc == 0)
109 nd_region_probe_success(nvdimm_bus, dev);
Dan Williamsbf9bccc2015-06-17 17:14:46 -0400110 else
111 nd_region_disable(nvdimm_bus, dev);
Dan Williamseaf96152015-05-01 13:11:27 -0400112 nvdimm_bus_probe_end(nvdimm_bus);
113
Dan Williams4d88a972015-05-31 14:41:48 -0400114 dev_dbg(&nvdimm_bus->dev, "%s.probe(%s) = %d\n", dev->driver->name,
115 dev_name(dev), rc);
Dan Williams8c2f7e82015-06-25 04:20:04 -0400116
Dan Williams3d880022015-05-31 15:02:11 -0400117 if (rc != 0)
118 module_put(provider);
Dan Williams4d88a972015-05-31 14:41:48 -0400119 return rc;
120}
121
122static int nvdimm_bus_remove(struct device *dev)
123{
124 struct nd_device_driver *nd_drv = to_nd_device_driver(dev->driver);
Dan Williams3d880022015-05-31 15:02:11 -0400125 struct module *provider = to_bus_provider(dev);
Dan Williams4d88a972015-05-31 14:41:48 -0400126 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
Dan Williams6cf9c5b2016-05-18 09:13:13 -0700127 int rc = 0;
Dan Williams4d88a972015-05-31 14:41:48 -0400128
Dan Williams6cf9c5b2016-05-18 09:13:13 -0700129 if (nd_drv->remove)
130 rc = nd_drv->remove(dev);
Dan Williamseaf96152015-05-01 13:11:27 -0400131 nd_region_disable(nvdimm_bus, dev);
132
Dan Williams4d88a972015-05-31 14:41:48 -0400133 dev_dbg(&nvdimm_bus->dev, "%s.remove(%s) = %d\n", dev->driver->name,
134 dev_name(dev), rc);
Dan Williams3d880022015-05-31 15:02:11 -0400135 module_put(provider);
Dan Williams4d88a972015-05-31 14:41:48 -0400136 return rc;
137}
138
Dan Williams476f8482016-07-09 00:12:52 -0700139static void nvdimm_bus_shutdown(struct device *dev)
140{
141 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
142 struct nd_device_driver *nd_drv = NULL;
143
144 if (dev->driver)
145 nd_drv = to_nd_device_driver(dev->driver);
146
147 if (nd_drv && nd_drv->shutdown) {
148 nd_drv->shutdown(dev);
149 dev_dbg(&nvdimm_bus->dev, "%s.shutdown(%s)\n",
150 dev->driver->name, dev_name(dev));
151 }
152}
153
Dan Williams71999462016-02-18 10:29:49 -0800154void nd_device_notify(struct device *dev, enum nvdimm_event event)
155{
156 device_lock(dev);
157 if (dev->driver) {
158 struct nd_device_driver *nd_drv;
159
160 nd_drv = to_nd_device_driver(dev->driver);
161 if (nd_drv->notify)
162 nd_drv->notify(dev, event);
163 }
164 device_unlock(dev);
165}
166EXPORT_SYMBOL(nd_device_notify);
167
168void nvdimm_region_notify(struct nd_region *nd_region, enum nvdimm_event event)
169{
170 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&nd_region->dev);
171
172 if (!nvdimm_bus)
173 return;
174
175 /* caller is responsible for holding a reference on the device */
176 nd_device_notify(&nd_region->dev, event);
177}
178EXPORT_SYMBOL_GPL(nvdimm_region_notify);
179
Dan Williams59e64732016-03-08 07:16:07 -0800180long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
181 unsigned int len)
182{
183 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
184 struct nvdimm_bus_descriptor *nd_desc;
185 struct nd_cmd_clear_error clear_err;
186 struct nd_cmd_ars_cap ars_cap;
187 u32 clear_err_unit, mask;
188 int cmd_rc, rc;
189
190 if (!nvdimm_bus)
191 return -ENXIO;
192
193 nd_desc = nvdimm_bus->nd_desc;
194 if (!nd_desc->ndctl)
195 return -ENXIO;
196
197 memset(&ars_cap, 0, sizeof(ars_cap));
198 ars_cap.address = phys;
199 ars_cap.length = len;
200 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_ARS_CAP, &ars_cap,
201 sizeof(ars_cap), &cmd_rc);
202 if (rc < 0)
203 return rc;
204 if (cmd_rc < 0)
205 return cmd_rc;
206 clear_err_unit = ars_cap.clear_err_unit;
207 if (!clear_err_unit || !is_power_of_2(clear_err_unit))
208 return -ENXIO;
209
210 mask = clear_err_unit - 1;
211 if ((phys | len) & mask)
212 return -ENXIO;
213 memset(&clear_err, 0, sizeof(clear_err));
214 clear_err.address = phys;
215 clear_err.length = len;
216 rc = nd_desc->ndctl(nd_desc, NULL, ND_CMD_CLEAR_ERROR, &clear_err,
217 sizeof(clear_err), &cmd_rc);
218 if (rc < 0)
219 return rc;
220 if (cmd_rc < 0)
221 return cmd_rc;
222 return clear_err.cleared;
223}
224EXPORT_SYMBOL_GPL(nvdimm_clear_poison);
225
Dan Williams4d88a972015-05-31 14:41:48 -0400226static struct bus_type nvdimm_bus_type = {
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400227 .name = "nd",
Dan Williams4d88a972015-05-31 14:41:48 -0400228 .uevent = nvdimm_bus_uevent,
229 .match = nvdimm_bus_match,
230 .probe = nvdimm_bus_probe,
231 .remove = nvdimm_bus_remove,
Dan Williams476f8482016-07-09 00:12:52 -0700232 .shutdown = nvdimm_bus_shutdown,
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400233};
234
Dan Williams4d88a972015-05-31 14:41:48 -0400235static ASYNC_DOMAIN_EXCLUSIVE(nd_async_domain);
236
237void nd_synchronize(void)
238{
239 async_synchronize_full_domain(&nd_async_domain);
240}
241EXPORT_SYMBOL_GPL(nd_synchronize);
242
243static void nd_async_device_register(void *d, async_cookie_t cookie)
244{
245 struct device *dev = d;
246
247 if (device_add(dev) != 0) {
248 dev_err(dev, "%s: failed\n", __func__);
249 put_device(dev);
250 }
251 put_device(dev);
252}
253
254static void nd_async_device_unregister(void *d, async_cookie_t cookie)
255{
256 struct device *dev = d;
257
Dan Williams0ba1c632015-05-30 12:35:36 -0400258 /* flush bus operations before delete */
259 nvdimm_bus_lock(dev);
260 nvdimm_bus_unlock(dev);
261
Dan Williams4d88a972015-05-31 14:41:48 -0400262 device_unregister(dev);
263 put_device(dev);
264}
265
Dan Williams8c2f7e82015-06-25 04:20:04 -0400266void __nd_device_register(struct device *dev)
Dan Williams4d88a972015-05-31 14:41:48 -0400267{
Dan Williamscd034122016-03-11 10:15:36 -0800268 if (!dev)
269 return;
Dan Williams4d88a972015-05-31 14:41:48 -0400270 dev->bus = &nvdimm_bus_type;
Dan Williams4d88a972015-05-31 14:41:48 -0400271 get_device(dev);
272 async_schedule_domain(nd_async_device_register, dev,
273 &nd_async_domain);
274}
Dan Williams8c2f7e82015-06-25 04:20:04 -0400275
276void nd_device_register(struct device *dev)
277{
278 device_initialize(dev);
279 __nd_device_register(dev);
280}
Dan Williams4d88a972015-05-31 14:41:48 -0400281EXPORT_SYMBOL(nd_device_register);
282
283void nd_device_unregister(struct device *dev, enum nd_async_mode mode)
284{
285 switch (mode) {
286 case ND_ASYNC:
287 get_device(dev);
288 async_schedule_domain(nd_async_device_unregister, dev,
289 &nd_async_domain);
290 break;
291 case ND_SYNC:
292 nd_synchronize();
293 device_unregister(dev);
294 break;
295 }
296}
297EXPORT_SYMBOL(nd_device_unregister);
298
299/**
300 * __nd_driver_register() - register a region or a namespace driver
301 * @nd_drv: driver to register
302 * @owner: automatically set by nd_driver_register() macro
303 * @mod_name: automatically set by nd_driver_register() macro
304 */
305int __nd_driver_register(struct nd_device_driver *nd_drv, struct module *owner,
306 const char *mod_name)
307{
308 struct device_driver *drv = &nd_drv->drv;
309
310 if (!nd_drv->type) {
311 pr_debug("driver type bitmask not set (%pf)\n",
312 __builtin_return_address(0));
313 return -EINVAL;
314 }
315
Dan Williams6cf9c5b2016-05-18 09:13:13 -0700316 if (!nd_drv->probe) {
317 pr_debug("%s ->probe() must be specified\n", mod_name);
Dan Williams4d88a972015-05-31 14:41:48 -0400318 return -EINVAL;
319 }
320
321 drv->bus = &nvdimm_bus_type;
322 drv->owner = owner;
323 drv->mod_name = mod_name;
324
325 return driver_register(drv);
326}
327EXPORT_SYMBOL(__nd_driver_register);
328
Dan Williams58138822015-06-23 20:08:34 -0400329int nvdimm_revalidate_disk(struct gendisk *disk)
330{
331 struct device *dev = disk->driverfs_dev;
332 struct nd_region *nd_region = to_nd_region(dev->parent);
333 const char *pol = nd_region->ro ? "only" : "write";
334
335 if (nd_region->ro == get_disk_ro(disk))
336 return 0;
337
338 dev_info(dev, "%s read-%s, marking %s read-%s\n",
339 dev_name(&nd_region->dev), pol, disk->disk_name, pol);
340 set_disk_ro(disk, nd_region->ro);
341
342 return 0;
343
344}
345EXPORT_SYMBOL(nvdimm_revalidate_disk);
346
Dan Williams4d88a972015-05-31 14:41:48 -0400347static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
348 char *buf)
349{
350 return sprintf(buf, ND_DEVICE_MODALIAS_FMT "\n",
351 to_nd_device_type(dev));
352}
353static DEVICE_ATTR_RO(modalias);
354
355static ssize_t devtype_show(struct device *dev, struct device_attribute *attr,
356 char *buf)
357{
358 return sprintf(buf, "%s\n", dev->type->name);
359}
360static DEVICE_ATTR_RO(devtype);
361
362static struct attribute *nd_device_attributes[] = {
363 &dev_attr_modalias.attr,
364 &dev_attr_devtype.attr,
365 NULL,
366};
367
368/**
369 * nd_device_attribute_group - generic attributes for all devices on an nd bus
370 */
371struct attribute_group nd_device_attribute_group = {
372 .attrs = nd_device_attributes,
373};
374EXPORT_SYMBOL_GPL(nd_device_attribute_group);
375
Toshi Kani74ae66c2015-06-19 12:18:34 -0600376static ssize_t numa_node_show(struct device *dev,
377 struct device_attribute *attr, char *buf)
378{
379 return sprintf(buf, "%d\n", dev_to_node(dev));
380}
381static DEVICE_ATTR_RO(numa_node);
382
383static struct attribute *nd_numa_attributes[] = {
384 &dev_attr_numa_node.attr,
385 NULL,
386};
387
388static umode_t nd_numa_attr_visible(struct kobject *kobj, struct attribute *a,
389 int n)
390{
391 if (!IS_ENABLED(CONFIG_NUMA))
392 return 0;
393
394 return a->mode;
395}
396
397/**
398 * nd_numa_attribute_group - NUMA attributes for all devices on an nd bus
399 */
400struct attribute_group nd_numa_attribute_group = {
401 .attrs = nd_numa_attributes,
402 .is_visible = nd_numa_attr_visible,
403};
404EXPORT_SYMBOL_GPL(nd_numa_attribute_group);
405
Dan Williams45def222015-04-26 19:26:48 -0400406int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus)
407{
408 dev_t devt = MKDEV(nvdimm_bus_major, nvdimm_bus->id);
409 struct device *dev;
410
411 dev = device_create(nd_class, &nvdimm_bus->dev, devt, nvdimm_bus,
412 "ndctl%d", nvdimm_bus->id);
413
Dan Williams42588952016-05-27 13:28:31 -0700414 if (IS_ERR(dev))
Dan Williams45def222015-04-26 19:26:48 -0400415 dev_dbg(&nvdimm_bus->dev, "failed to register ndctl%d: %ld\n",
416 nvdimm_bus->id, PTR_ERR(dev));
Dan Williams42588952016-05-27 13:28:31 -0700417 return PTR_ERR_OR_ZERO(dev);
Dan Williams45def222015-04-26 19:26:48 -0400418}
419
420void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus)
421{
422 device_destroy(nd_class, MKDEV(nvdimm_bus_major, nvdimm_bus->id));
423}
424
Dan Williams62232e452015-06-08 14:27:06 -0400425static const struct nd_cmd_desc __nd_cmd_dimm_descs[] = {
426 [ND_CMD_IMPLEMENTED] = { },
427 [ND_CMD_SMART] = {
428 .out_num = 2,
Dan Williams21129112016-04-07 19:58:44 -0700429 .out_sizes = { 4, 128, },
Dan Williams62232e452015-06-08 14:27:06 -0400430 },
431 [ND_CMD_SMART_THRESHOLD] = {
432 .out_num = 2,
433 .out_sizes = { 4, 8, },
434 },
435 [ND_CMD_DIMM_FLAGS] = {
436 .out_num = 2,
437 .out_sizes = { 4, 4 },
438 },
439 [ND_CMD_GET_CONFIG_SIZE] = {
440 .out_num = 3,
441 .out_sizes = { 4, 4, 4, },
442 },
443 [ND_CMD_GET_CONFIG_DATA] = {
444 .in_num = 2,
445 .in_sizes = { 4, 4, },
446 .out_num = 2,
447 .out_sizes = { 4, UINT_MAX, },
448 },
449 [ND_CMD_SET_CONFIG_DATA] = {
450 .in_num = 3,
451 .in_sizes = { 4, 4, UINT_MAX, },
452 .out_num = 1,
453 .out_sizes = { 4, },
454 },
455 [ND_CMD_VENDOR] = {
456 .in_num = 3,
457 .in_sizes = { 4, 4, UINT_MAX, },
458 .out_num = 3,
459 .out_sizes = { 4, 4, UINT_MAX, },
460 },
Dan Williams31eca762016-04-28 16:23:43 -0700461 [ND_CMD_CALL] = {
462 .in_num = 2,
463 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
464 .out_num = 1,
465 .out_sizes = { UINT_MAX, },
466 },
Dan Williams62232e452015-06-08 14:27:06 -0400467};
468
469const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd)
470{
471 if (cmd < ARRAY_SIZE(__nd_cmd_dimm_descs))
472 return &__nd_cmd_dimm_descs[cmd];
473 return NULL;
474}
475EXPORT_SYMBOL_GPL(nd_cmd_dimm_desc);
476
477static const struct nd_cmd_desc __nd_cmd_bus_descs[] = {
478 [ND_CMD_IMPLEMENTED] = { },
479 [ND_CMD_ARS_CAP] = {
480 .in_num = 2,
481 .in_sizes = { 8, 8, },
Dan Williams4577b062016-02-17 13:08:58 -0800482 .out_num = 4,
483 .out_sizes = { 4, 4, 4, 4, },
Dan Williams62232e452015-06-08 14:27:06 -0400484 },
485 [ND_CMD_ARS_START] = {
Dan Williams4577b062016-02-17 13:08:58 -0800486 .in_num = 5,
487 .in_sizes = { 8, 8, 2, 1, 5, },
488 .out_num = 2,
489 .out_sizes = { 4, 4, },
Dan Williams62232e452015-06-08 14:27:06 -0400490 },
491 [ND_CMD_ARS_STATUS] = {
Dan Williams747ffe12016-02-19 15:21:14 -0800492 .out_num = 3,
493 .out_sizes = { 4, 4, UINT_MAX, },
Dan Williams62232e452015-06-08 14:27:06 -0400494 },
Dan Williamsd4f32362016-03-03 16:08:54 -0800495 [ND_CMD_CLEAR_ERROR] = {
496 .in_num = 2,
497 .in_sizes = { 8, 8, },
498 .out_num = 3,
499 .out_sizes = { 4, 4, 8, },
500 },
Dan Williams31eca762016-04-28 16:23:43 -0700501 [ND_CMD_CALL] = {
502 .in_num = 2,
503 .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
504 .out_num = 1,
505 .out_sizes = { UINT_MAX, },
506 },
Dan Williams62232e452015-06-08 14:27:06 -0400507};
508
509const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd)
510{
511 if (cmd < ARRAY_SIZE(__nd_cmd_bus_descs))
512 return &__nd_cmd_bus_descs[cmd];
513 return NULL;
514}
515EXPORT_SYMBOL_GPL(nd_cmd_bus_desc);
516
517u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
518 const struct nd_cmd_desc *desc, int idx, void *buf)
519{
520 if (idx >= desc->in_num)
521 return UINT_MAX;
522
523 if (desc->in_sizes[idx] < UINT_MAX)
524 return desc->in_sizes[idx];
525
526 if (nvdimm && cmd == ND_CMD_SET_CONFIG_DATA && idx == 2) {
527 struct nd_cmd_set_config_hdr *hdr = buf;
528
529 return hdr->in_length;
530 } else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2) {
531 struct nd_cmd_vendor_hdr *hdr = buf;
532
533 return hdr->in_length;
Dan Williams31eca762016-04-28 16:23:43 -0700534 } else if (cmd == ND_CMD_CALL) {
535 struct nd_cmd_pkg *pkg = buf;
536
537 return pkg->nd_size_in;
Dan Williams62232e452015-06-08 14:27:06 -0400538 }
539
540 return UINT_MAX;
541}
542EXPORT_SYMBOL_GPL(nd_cmd_in_size);
543
544u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
545 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
546 const u32 *out_field)
547{
548 if (idx >= desc->out_num)
549 return UINT_MAX;
550
551 if (desc->out_sizes[idx] < UINT_MAX)
552 return desc->out_sizes[idx];
553
554 if (nvdimm && cmd == ND_CMD_GET_CONFIG_DATA && idx == 1)
555 return in_field[1];
556 else if (nvdimm && cmd == ND_CMD_VENDOR && idx == 2)
557 return out_field[1];
Dan Williams747ffe12016-02-19 15:21:14 -0800558 else if (!nvdimm && cmd == ND_CMD_ARS_STATUS && idx == 2)
559 return out_field[1] - 8;
Dan Williams31eca762016-04-28 16:23:43 -0700560 else if (cmd == ND_CMD_CALL) {
561 struct nd_cmd_pkg *pkg = (struct nd_cmd_pkg *) in_field;
562
563 return pkg->nd_size_out;
564 }
565
Dan Williams62232e452015-06-08 14:27:06 -0400566
567 return UINT_MAX;
568}
569EXPORT_SYMBOL_GPL(nd_cmd_out_size);
570
Dan Williamsbf9bccc2015-06-17 17:14:46 -0400571void wait_nvdimm_bus_probe_idle(struct device *dev)
Dan Williamseaf96152015-05-01 13:11:27 -0400572{
Dan Williamsbf9bccc2015-06-17 17:14:46 -0400573 struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(dev);
574
Dan Williamseaf96152015-05-01 13:11:27 -0400575 do {
576 if (nvdimm_bus->probe_active == 0)
577 break;
578 nvdimm_bus_unlock(&nvdimm_bus->dev);
579 wait_event(nvdimm_bus->probe_wait,
580 nvdimm_bus->probe_active == 0);
581 nvdimm_bus_lock(&nvdimm_bus->dev);
582 } while (true);
583}
584
Dan Williamsd4f32362016-03-03 16:08:54 -0800585static int pmem_active(struct device *dev, void *data)
586{
587 if (is_nd_pmem(dev) && dev->driver)
588 return -EBUSY;
589 return 0;
590}
591
Dan Williamseaf96152015-05-01 13:11:27 -0400592/* set_config requires an idle interleave set */
Dan Williams87bf5722016-02-22 21:50:31 -0800593static int nd_cmd_clear_to_send(struct nvdimm_bus *nvdimm_bus,
594 struct nvdimm *nvdimm, unsigned int cmd)
Dan Williamseaf96152015-05-01 13:11:27 -0400595{
Dan Williams87bf5722016-02-22 21:50:31 -0800596 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
597
598 /* ask the bus provider if it would like to block this request */
599 if (nd_desc->clear_to_send) {
600 int rc = nd_desc->clear_to_send(nd_desc, nvdimm, cmd);
601
602 if (rc)
603 return rc;
604 }
Dan Williamseaf96152015-05-01 13:11:27 -0400605
Dan Williamsd4f32362016-03-03 16:08:54 -0800606 /* require clear error to go through the pmem driver */
607 if (!nvdimm && cmd == ND_CMD_CLEAR_ERROR)
608 return device_for_each_child(&nvdimm_bus->dev, NULL,
609 pmem_active);
610
Dan Williamseaf96152015-05-01 13:11:27 -0400611 if (!nvdimm || cmd != ND_CMD_SET_CONFIG_DATA)
612 return 0;
613
Dan Williams87bf5722016-02-22 21:50:31 -0800614 /* prevent label manipulation while the kernel owns label updates */
Dan Williamsbf9bccc2015-06-17 17:14:46 -0400615 wait_nvdimm_bus_probe_idle(&nvdimm_bus->dev);
Dan Williamseaf96152015-05-01 13:11:27 -0400616 if (atomic_read(&nvdimm->busy))
617 return -EBUSY;
618 return 0;
619}
620
Dan Williams62232e452015-06-08 14:27:06 -0400621static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
622 int read_only, unsigned int ioctl_cmd, unsigned long arg)
623{
624 struct nvdimm_bus_descriptor *nd_desc = nvdimm_bus->nd_desc;
625 size_t buf_len = 0, in_len = 0, out_len = 0;
626 static char out_env[ND_CMD_MAX_ENVELOPE];
627 static char in_env[ND_CMD_MAX_ENVELOPE];
628 const struct nd_cmd_desc *desc = NULL;
629 unsigned int cmd = _IOC_NR(ioctl_cmd);
630 void __user *p = (void __user *) arg;
631 struct device *dev = &nvdimm_bus->dev;
Dan Williams31eca762016-04-28 16:23:43 -0700632 struct nd_cmd_pkg pkg;
Dan Williams62232e452015-06-08 14:27:06 -0400633 const char *cmd_name, *dimm_name;
Dan Williamse3654ec2016-04-28 16:17:07 -0700634 unsigned long cmd_mask;
Dan Williams62232e452015-06-08 14:27:06 -0400635 void *buf;
636 int rc, i;
637
638 if (nvdimm) {
639 desc = nd_cmd_dimm_desc(cmd);
640 cmd_name = nvdimm_cmd_name(cmd);
Dan Williamse3654ec2016-04-28 16:17:07 -0700641 cmd_mask = nvdimm->cmd_mask;
Dan Williams62232e452015-06-08 14:27:06 -0400642 dimm_name = dev_name(&nvdimm->dev);
643 } else {
644 desc = nd_cmd_bus_desc(cmd);
645 cmd_name = nvdimm_bus_cmd_name(cmd);
Dan Williamse3654ec2016-04-28 16:17:07 -0700646 cmd_mask = nd_desc->cmd_mask;
Dan Williams62232e452015-06-08 14:27:06 -0400647 dimm_name = "bus";
648 }
649
Dan Williams31eca762016-04-28 16:23:43 -0700650 if (cmd == ND_CMD_CALL) {
651 if (copy_from_user(&pkg, p, sizeof(pkg)))
652 return -EFAULT;
653 }
654
Dan Williams62232e452015-06-08 14:27:06 -0400655 if (!desc || (desc->out_num + desc->in_num == 0) ||
Dan Williamse3654ec2016-04-28 16:17:07 -0700656 !test_bit(cmd, &cmd_mask))
Dan Williams62232e452015-06-08 14:27:06 -0400657 return -ENOTTY;
658
659 /* fail write commands (when read-only) */
660 if (read_only)
Jerry Hoemann07accfa2016-01-06 16:03:41 -0700661 switch (cmd) {
662 case ND_CMD_VENDOR:
663 case ND_CMD_SET_CONFIG_DATA:
664 case ND_CMD_ARS_START:
Dan Williamsd4f32362016-03-03 16:08:54 -0800665 case ND_CMD_CLEAR_ERROR:
Dan Williams31eca762016-04-28 16:23:43 -0700666 case ND_CMD_CALL:
Dan Williams62232e452015-06-08 14:27:06 -0400667 dev_dbg(&nvdimm_bus->dev, "'%s' command while read-only.\n",
668 nvdimm ? nvdimm_cmd_name(cmd)
669 : nvdimm_bus_cmd_name(cmd));
670 return -EPERM;
671 default:
672 break;
673 }
674
675 /* process an input envelope */
676 for (i = 0; i < desc->in_num; i++) {
677 u32 in_size, copy;
678
679 in_size = nd_cmd_in_size(nvdimm, cmd, desc, i, in_env);
680 if (in_size == UINT_MAX) {
681 dev_err(dev, "%s:%s unknown input size cmd: %s field: %d\n",
682 __func__, dimm_name, cmd_name, i);
683 return -ENXIO;
684 }
Dan Williams62232e452015-06-08 14:27:06 -0400685 if (in_len < sizeof(in_env))
686 copy = min_t(u32, sizeof(in_env) - in_len, in_size);
687 else
688 copy = 0;
689 if (copy && copy_from_user(&in_env[in_len], p + in_len, copy))
690 return -EFAULT;
691 in_len += in_size;
692 }
693
Dan Williams31eca762016-04-28 16:23:43 -0700694 if (cmd == ND_CMD_CALL) {
695 dev_dbg(dev, "%s:%s, idx: %llu, in: %zu, out: %zu, len %zu\n",
696 __func__, dimm_name, pkg.nd_command,
697 in_len, out_len, buf_len);
698
699 for (i = 0; i < ARRAY_SIZE(pkg.nd_reserved2); i++)
700 if (pkg.nd_reserved2[i])
701 return -EINVAL;
702 }
703
Dan Williams62232e452015-06-08 14:27:06 -0400704 /* process an output envelope */
705 for (i = 0; i < desc->out_num; i++) {
706 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i,
707 (u32 *) in_env, (u32 *) out_env);
708 u32 copy;
709
710 if (out_size == UINT_MAX) {
711 dev_dbg(dev, "%s:%s unknown output size cmd: %s field: %d\n",
712 __func__, dimm_name, cmd_name, i);
713 return -EFAULT;
714 }
Dan Williams62232e452015-06-08 14:27:06 -0400715 if (out_len < sizeof(out_env))
716 copy = min_t(u32, sizeof(out_env) - out_len, out_size);
717 else
718 copy = 0;
719 if (copy && copy_from_user(&out_env[out_len],
720 p + in_len + out_len, copy))
721 return -EFAULT;
722 out_len += out_size;
723 }
724
725 buf_len = out_len + in_len;
Dan Williams62232e452015-06-08 14:27:06 -0400726 if (buf_len > ND_IOCTL_MAX_BUFLEN) {
727 dev_dbg(dev, "%s:%s cmd: %s buf_len: %zu > %d\n", __func__,
728 dimm_name, cmd_name, buf_len,
729 ND_IOCTL_MAX_BUFLEN);
730 return -EINVAL;
731 }
732
733 buf = vmalloc(buf_len);
734 if (!buf)
735 return -ENOMEM;
736
737 if (copy_from_user(buf, p, buf_len)) {
738 rc = -EFAULT;
739 goto out;
740 }
741
Dan Williamseaf96152015-05-01 13:11:27 -0400742 nvdimm_bus_lock(&nvdimm_bus->dev);
Dan Williams87bf5722016-02-22 21:50:31 -0800743 rc = nd_cmd_clear_to_send(nvdimm_bus, nvdimm, cmd);
Dan Williamseaf96152015-05-01 13:11:27 -0400744 if (rc)
745 goto out_unlock;
746
Dan Williamsaef25332016-02-12 17:01:11 -0800747 rc = nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, NULL);
Dan Williams62232e452015-06-08 14:27:06 -0400748 if (rc < 0)
Dan Williamseaf96152015-05-01 13:11:27 -0400749 goto out_unlock;
Dan Williams62232e452015-06-08 14:27:06 -0400750 if (copy_to_user(p, buf, buf_len))
751 rc = -EFAULT;
Dan Williamseaf96152015-05-01 13:11:27 -0400752 out_unlock:
753 nvdimm_bus_unlock(&nvdimm_bus->dev);
Dan Williams62232e452015-06-08 14:27:06 -0400754 out:
755 vfree(buf);
756 return rc;
757}
758
Dan Williams45def222015-04-26 19:26:48 -0400759static long nd_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
760{
Dan Williams62232e452015-06-08 14:27:06 -0400761 long id = (long) file->private_data;
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700762 int rc = -ENXIO, ro;
Dan Williams62232e452015-06-08 14:27:06 -0400763 struct nvdimm_bus *nvdimm_bus;
764
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700765 ro = ((file->f_flags & O_ACCMODE) == O_RDONLY);
Dan Williams62232e452015-06-08 14:27:06 -0400766 mutex_lock(&nvdimm_bus_list_mutex);
767 list_for_each_entry(nvdimm_bus, &nvdimm_bus_list, list) {
768 if (nvdimm_bus->id == id) {
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700769 rc = __nd_ioctl(nvdimm_bus, NULL, ro, cmd, arg);
Dan Williams62232e452015-06-08 14:27:06 -0400770 break;
771 }
772 }
773 mutex_unlock(&nvdimm_bus_list_mutex);
774
775 return rc;
776}
777
778static int match_dimm(struct device *dev, void *data)
779{
780 long id = (long) data;
781
782 if (is_nvdimm(dev)) {
783 struct nvdimm *nvdimm = to_nvdimm(dev);
784
785 return nvdimm->id == id;
786 }
787
788 return 0;
789}
790
791static long nvdimm_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
792{
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700793 int rc = -ENXIO, ro;
Dan Williams62232e452015-06-08 14:27:06 -0400794 struct nvdimm_bus *nvdimm_bus;
795
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700796 ro = ((file->f_flags & O_ACCMODE) == O_RDONLY);
Dan Williams62232e452015-06-08 14:27:06 -0400797 mutex_lock(&nvdimm_bus_list_mutex);
798 list_for_each_entry(nvdimm_bus, &nvdimm_bus_list, list) {
799 struct device *dev = device_find_child(&nvdimm_bus->dev,
800 file->private_data, match_dimm);
801 struct nvdimm *nvdimm;
802
803 if (!dev)
804 continue;
805
806 nvdimm = to_nvdimm(dev);
Jerry Hoemann4dc0e7b2016-01-06 16:03:39 -0700807 rc = __nd_ioctl(nvdimm_bus, nvdimm, ro, cmd, arg);
Dan Williams62232e452015-06-08 14:27:06 -0400808 put_device(dev);
809 break;
810 }
811 mutex_unlock(&nvdimm_bus_list_mutex);
812
813 return rc;
814}
815
816static int nd_open(struct inode *inode, struct file *file)
817{
818 long minor = iminor(inode);
819
820 file->private_data = (void *) minor;
821 return 0;
Dan Williams45def222015-04-26 19:26:48 -0400822}
823
824static const struct file_operations nvdimm_bus_fops = {
825 .owner = THIS_MODULE,
Dan Williams62232e452015-06-08 14:27:06 -0400826 .open = nd_open,
Dan Williams45def222015-04-26 19:26:48 -0400827 .unlocked_ioctl = nd_ioctl,
828 .compat_ioctl = nd_ioctl,
829 .llseek = noop_llseek,
830};
831
Dan Williams62232e452015-06-08 14:27:06 -0400832static const struct file_operations nvdimm_fops = {
833 .owner = THIS_MODULE,
834 .open = nd_open,
835 .unlocked_ioctl = nvdimm_ioctl,
836 .compat_ioctl = nvdimm_ioctl,
837 .llseek = noop_llseek,
838};
839
Dan Williams45def222015-04-26 19:26:48 -0400840int __init nvdimm_bus_init(void)
841{
842 int rc;
843
Dan Williamsbaa51272016-04-05 17:40:52 -0700844 BUILD_BUG_ON(sizeof(struct nd_smart_payload) != 128);
845 BUILD_BUG_ON(sizeof(struct nd_smart_threshold_payload) != 8);
846
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400847 rc = bus_register(&nvdimm_bus_type);
848 if (rc)
849 return rc;
850
Dan Williams45def222015-04-26 19:26:48 -0400851 rc = register_chrdev(0, "ndctl", &nvdimm_bus_fops);
852 if (rc < 0)
Dan Williams62232e452015-06-08 14:27:06 -0400853 goto err_bus_chrdev;
Dan Williams45def222015-04-26 19:26:48 -0400854 nvdimm_bus_major = rc;
855
Dan Williams62232e452015-06-08 14:27:06 -0400856 rc = register_chrdev(0, "dimmctl", &nvdimm_fops);
857 if (rc < 0)
858 goto err_dimm_chrdev;
859 nvdimm_major = rc;
860
Dan Williams45def222015-04-26 19:26:48 -0400861 nd_class = class_create(THIS_MODULE, "nd");
Axel Lindaa1dee2015-06-28 17:00:57 +0800862 if (IS_ERR(nd_class)) {
863 rc = PTR_ERR(nd_class);
Dan Williams45def222015-04-26 19:26:48 -0400864 goto err_class;
Axel Lindaa1dee2015-06-28 17:00:57 +0800865 }
Dan Williams45def222015-04-26 19:26:48 -0400866
867 return 0;
868
869 err_class:
Dan Williams62232e452015-06-08 14:27:06 -0400870 unregister_chrdev(nvdimm_major, "dimmctl");
871 err_dimm_chrdev:
Dan Williams45def222015-04-26 19:26:48 -0400872 unregister_chrdev(nvdimm_bus_major, "ndctl");
Dan Williams62232e452015-06-08 14:27:06 -0400873 err_bus_chrdev:
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400874 bus_unregister(&nvdimm_bus_type);
Dan Williams45def222015-04-26 19:26:48 -0400875
876 return rc;
877}
878
Dan Williams4d88a972015-05-31 14:41:48 -0400879void nvdimm_bus_exit(void)
Dan Williams45def222015-04-26 19:26:48 -0400880{
881 class_destroy(nd_class);
882 unregister_chrdev(nvdimm_bus_major, "ndctl");
Dan Williams62232e452015-06-08 14:27:06 -0400883 unregister_chrdev(nvdimm_major, "dimmctl");
Dan Williamse6dfb2d2015-04-25 03:56:17 -0400884 bus_unregister(&nvdimm_bus_type);
Dan Williams45def222015-04-26 19:26:48 -0400885}