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/fcntl.h>
17 #include <linux/async.h>
18 #include <linux/ndctl.h>
19 #include <linux/slab.h>
26 static int nvdimm_bus_major
;
27 static struct class *nd_class
;
29 struct bus_type nvdimm_bus_type
= {
33 int nvdimm_bus_create_ndctl(struct nvdimm_bus
*nvdimm_bus
)
35 dev_t devt
= MKDEV(nvdimm_bus_major
, nvdimm_bus
->id
);
38 dev
= device_create(nd_class
, &nvdimm_bus
->dev
, devt
, nvdimm_bus
,
39 "ndctl%d", nvdimm_bus
->id
);
42 dev_dbg(&nvdimm_bus
->dev
, "failed to register ndctl%d: %ld\n",
43 nvdimm_bus
->id
, PTR_ERR(dev
));
49 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus
*nvdimm_bus
)
51 device_destroy(nd_class
, MKDEV(nvdimm_bus_major
, nvdimm_bus
->id
));
54 static const struct nd_cmd_desc __nd_cmd_dimm_descs
[] = {
55 [ND_CMD_IMPLEMENTED
] = { },
58 .out_sizes
= { 4, 8, },
60 [ND_CMD_SMART_THRESHOLD
] = {
62 .out_sizes
= { 4, 8, },
64 [ND_CMD_DIMM_FLAGS
] = {
66 .out_sizes
= { 4, 4 },
68 [ND_CMD_GET_CONFIG_SIZE
] = {
70 .out_sizes
= { 4, 4, 4, },
72 [ND_CMD_GET_CONFIG_DATA
] = {
74 .in_sizes
= { 4, 4, },
76 .out_sizes
= { 4, UINT_MAX
, },
78 [ND_CMD_SET_CONFIG_DATA
] = {
80 .in_sizes
= { 4, 4, UINT_MAX
, },
86 .in_sizes
= { 4, 4, UINT_MAX
, },
88 .out_sizes
= { 4, 4, UINT_MAX
, },
92 const struct nd_cmd_desc
*nd_cmd_dimm_desc(int cmd
)
94 if (cmd
< ARRAY_SIZE(__nd_cmd_dimm_descs
))
95 return &__nd_cmd_dimm_descs
[cmd
];
98 EXPORT_SYMBOL_GPL(nd_cmd_dimm_desc
);
100 static const struct nd_cmd_desc __nd_cmd_bus_descs
[] = {
101 [ND_CMD_IMPLEMENTED
] = { },
104 .in_sizes
= { 8, 8, },
106 .out_sizes
= { 4, 4, },
108 [ND_CMD_ARS_START
] = {
110 .in_sizes
= { 8, 8, 2, 6, },
114 [ND_CMD_ARS_STATUS
] = {
116 .out_sizes
= { 4, UINT_MAX
, },
120 const struct nd_cmd_desc
*nd_cmd_bus_desc(int cmd
)
122 if (cmd
< ARRAY_SIZE(__nd_cmd_bus_descs
))
123 return &__nd_cmd_bus_descs
[cmd
];
126 EXPORT_SYMBOL_GPL(nd_cmd_bus_desc
);
128 u32
nd_cmd_in_size(struct nvdimm
*nvdimm
, int cmd
,
129 const struct nd_cmd_desc
*desc
, int idx
, void *buf
)
131 if (idx
>= desc
->in_num
)
134 if (desc
->in_sizes
[idx
] < UINT_MAX
)
135 return desc
->in_sizes
[idx
];
137 if (nvdimm
&& cmd
== ND_CMD_SET_CONFIG_DATA
&& idx
== 2) {
138 struct nd_cmd_set_config_hdr
*hdr
= buf
;
140 return hdr
->in_length
;
141 } else if (nvdimm
&& cmd
== ND_CMD_VENDOR
&& idx
== 2) {
142 struct nd_cmd_vendor_hdr
*hdr
= buf
;
144 return hdr
->in_length
;
149 EXPORT_SYMBOL_GPL(nd_cmd_in_size
);
151 u32
nd_cmd_out_size(struct nvdimm
*nvdimm
, int cmd
,
152 const struct nd_cmd_desc
*desc
, int idx
, const u32
*in_field
,
153 const u32
*out_field
)
155 if (idx
>= desc
->out_num
)
158 if (desc
->out_sizes
[idx
] < UINT_MAX
)
159 return desc
->out_sizes
[idx
];
161 if (nvdimm
&& cmd
== ND_CMD_GET_CONFIG_DATA
&& idx
== 1)
163 else if (nvdimm
&& cmd
== ND_CMD_VENDOR
&& idx
== 2)
165 else if (!nvdimm
&& cmd
== ND_CMD_ARS_STATUS
&& idx
== 1)
166 return ND_CMD_ARS_STATUS_MAX
;
170 EXPORT_SYMBOL_GPL(nd_cmd_out_size
);
172 static int __nd_ioctl(struct nvdimm_bus
*nvdimm_bus
, struct nvdimm
*nvdimm
,
173 int read_only
, unsigned int ioctl_cmd
, unsigned long arg
)
175 struct nvdimm_bus_descriptor
*nd_desc
= nvdimm_bus
->nd_desc
;
176 size_t buf_len
= 0, in_len
= 0, out_len
= 0;
177 static char out_env
[ND_CMD_MAX_ENVELOPE
];
178 static char in_env
[ND_CMD_MAX_ENVELOPE
];
179 const struct nd_cmd_desc
*desc
= NULL
;
180 unsigned int cmd
= _IOC_NR(ioctl_cmd
);
181 void __user
*p
= (void __user
*) arg
;
182 struct device
*dev
= &nvdimm_bus
->dev
;
183 const char *cmd_name
, *dimm_name
;
184 unsigned long dsm_mask
;
189 desc
= nd_cmd_dimm_desc(cmd
);
190 cmd_name
= nvdimm_cmd_name(cmd
);
191 dsm_mask
= nvdimm
->dsm_mask
? *(nvdimm
->dsm_mask
) : 0;
192 dimm_name
= dev_name(&nvdimm
->dev
);
194 desc
= nd_cmd_bus_desc(cmd
);
195 cmd_name
= nvdimm_bus_cmd_name(cmd
);
196 dsm_mask
= nd_desc
->dsm_mask
;
200 if (!desc
|| (desc
->out_num
+ desc
->in_num
== 0) ||
201 !test_bit(cmd
, &dsm_mask
))
204 /* fail write commands (when read-only) */
207 case ND_IOCTL_VENDOR
:
208 case ND_IOCTL_SET_CONFIG_DATA
:
209 case ND_IOCTL_ARS_START
:
210 dev_dbg(&nvdimm_bus
->dev
, "'%s' command while read-only.\n",
211 nvdimm
? nvdimm_cmd_name(cmd
)
212 : nvdimm_bus_cmd_name(cmd
));
218 /* process an input envelope */
219 for (i
= 0; i
< desc
->in_num
; i
++) {
222 in_size
= nd_cmd_in_size(nvdimm
, cmd
, desc
, i
, in_env
);
223 if (in_size
== UINT_MAX
) {
224 dev_err(dev
, "%s:%s unknown input size cmd: %s field: %d\n",
225 __func__
, dimm_name
, cmd_name
, i
);
228 if (!access_ok(VERIFY_READ
, p
+ in_len
, in_size
))
230 if (in_len
< sizeof(in_env
))
231 copy
= min_t(u32
, sizeof(in_env
) - in_len
, in_size
);
234 if (copy
&& copy_from_user(&in_env
[in_len
], p
+ in_len
, copy
))
239 /* process an output envelope */
240 for (i
= 0; i
< desc
->out_num
; i
++) {
241 u32 out_size
= nd_cmd_out_size(nvdimm
, cmd
, desc
, i
,
242 (u32
*) in_env
, (u32
*) out_env
);
245 if (out_size
== UINT_MAX
) {
246 dev_dbg(dev
, "%s:%s unknown output size cmd: %s field: %d\n",
247 __func__
, dimm_name
, cmd_name
, i
);
250 if (!access_ok(VERIFY_WRITE
, p
+ in_len
+ out_len
, out_size
))
252 if (out_len
< sizeof(out_env
))
253 copy
= min_t(u32
, sizeof(out_env
) - out_len
, out_size
);
256 if (copy
&& copy_from_user(&out_env
[out_len
],
257 p
+ in_len
+ out_len
, copy
))
262 buf_len
= out_len
+ in_len
;
263 if (!access_ok(VERIFY_WRITE
, p
, sizeof(buf_len
)))
266 if (buf_len
> ND_IOCTL_MAX_BUFLEN
) {
267 dev_dbg(dev
, "%s:%s cmd: %s buf_len: %zu > %d\n", __func__
,
268 dimm_name
, cmd_name
, buf_len
,
269 ND_IOCTL_MAX_BUFLEN
);
273 buf
= vmalloc(buf_len
);
277 if (copy_from_user(buf
, p
, buf_len
)) {
282 rc
= nd_desc
->ndctl(nd_desc
, nvdimm
, cmd
, buf
, buf_len
);
285 if (copy_to_user(p
, buf
, buf_len
))
292 static long nd_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
294 long id
= (long) file
->private_data
;
295 int rc
= -ENXIO
, read_only
;
296 struct nvdimm_bus
*nvdimm_bus
;
298 read_only
= (O_RDWR
!= (file
->f_flags
& O_ACCMODE
));
299 mutex_lock(&nvdimm_bus_list_mutex
);
300 list_for_each_entry(nvdimm_bus
, &nvdimm_bus_list
, list
) {
301 if (nvdimm_bus
->id
== id
) {
302 rc
= __nd_ioctl(nvdimm_bus
, NULL
, read_only
, cmd
, arg
);
306 mutex_unlock(&nvdimm_bus_list_mutex
);
311 static int match_dimm(struct device
*dev
, void *data
)
313 long id
= (long) data
;
315 if (is_nvdimm(dev
)) {
316 struct nvdimm
*nvdimm
= to_nvdimm(dev
);
318 return nvdimm
->id
== id
;
324 static long nvdimm_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
326 int rc
= -ENXIO
, read_only
;
327 struct nvdimm_bus
*nvdimm_bus
;
329 read_only
= (O_RDWR
!= (file
->f_flags
& O_ACCMODE
));
330 mutex_lock(&nvdimm_bus_list_mutex
);
331 list_for_each_entry(nvdimm_bus
, &nvdimm_bus_list
, list
) {
332 struct device
*dev
= device_find_child(&nvdimm_bus
->dev
,
333 file
->private_data
, match_dimm
);
334 struct nvdimm
*nvdimm
;
339 nvdimm
= to_nvdimm(dev
);
340 rc
= __nd_ioctl(nvdimm_bus
, nvdimm
, read_only
, cmd
, arg
);
344 mutex_unlock(&nvdimm_bus_list_mutex
);
349 static int nd_open(struct inode
*inode
, struct file
*file
)
351 long minor
= iminor(inode
);
353 file
->private_data
= (void *) minor
;
357 static const struct file_operations nvdimm_bus_fops
= {
358 .owner
= THIS_MODULE
,
360 .unlocked_ioctl
= nd_ioctl
,
361 .compat_ioctl
= nd_ioctl
,
362 .llseek
= noop_llseek
,
365 static const struct file_operations nvdimm_fops
= {
366 .owner
= THIS_MODULE
,
368 .unlocked_ioctl
= nvdimm_ioctl
,
369 .compat_ioctl
= nvdimm_ioctl
,
370 .llseek
= noop_llseek
,
373 int __init
nvdimm_bus_init(void)
377 rc
= bus_register(&nvdimm_bus_type
);
381 rc
= register_chrdev(0, "ndctl", &nvdimm_bus_fops
);
384 nvdimm_bus_major
= rc
;
386 rc
= register_chrdev(0, "dimmctl", &nvdimm_fops
);
388 goto err_dimm_chrdev
;
391 nd_class
= class_create(THIS_MODULE
, "nd");
392 if (IS_ERR(nd_class
))
398 unregister_chrdev(nvdimm_major
, "dimmctl");
400 unregister_chrdev(nvdimm_bus_major
, "ndctl");
402 bus_unregister(&nvdimm_bus_type
);
407 void __exit
nvdimm_bus_exit(void)
409 class_destroy(nd_class
);
410 unregister_chrdev(nvdimm_bus_major
, "ndctl");
411 unregister_chrdev(nvdimm_major
, "dimmctl");
412 bus_unregister(&nvdimm_bus_type
);