15b497af4SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2e1455744SDan Williams /*
3e1455744SDan Williams * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
4e1455744SDan Williams */
5e1455744SDan Williams #include <linux/device.h>
6e1455744SDan Williams #include <linux/sizes.h>
7*5ae96d77SEnrico Weigelt #include <linux/badblocks.h>
8e1455744SDan Williams #include "nd-core.h"
9f2b61257SDan Williams #include "pmem.h"
10e1455744SDan Williams #include "pfn.h"
11e1455744SDan Williams #include "btt.h"
12e1455744SDan Williams #include "nd.h"
13e1455744SDan Williams
__nd_detach_ndns(struct device * dev,struct nd_namespace_common ** _ndns)14e1455744SDan Williams void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns)
15e1455744SDan Williams {
16e1455744SDan Williams struct nd_namespace_common *ndns = *_ndns;
17452bae0aSDan Williams struct nvdimm_bus *nvdimm_bus;
18e1455744SDan Williams
19452bae0aSDan Williams if (!ndns)
20452bae0aSDan Williams return;
21452bae0aSDan Williams
22452bae0aSDan Williams nvdimm_bus = walk_to_nvdimm_bus(&ndns->dev);
23452bae0aSDan Williams lockdep_assert_held(&nvdimm_bus->reconfig_mutex);
249cf8bd52SDan Williams dev_WARN_ONCE(dev, ndns->claim != dev, "%s: invalid claim\n", __func__);
25e1455744SDan Williams ndns->claim = NULL;
26e1455744SDan Williams *_ndns = NULL;
27e1455744SDan Williams put_device(&ndns->dev);
28e1455744SDan Williams }
29e1455744SDan Williams
nd_detach_ndns(struct device * dev,struct nd_namespace_common ** _ndns)30e1455744SDan Williams void nd_detach_ndns(struct device *dev,
31e1455744SDan Williams struct nd_namespace_common **_ndns)
32e1455744SDan Williams {
33e1455744SDan Williams struct nd_namespace_common *ndns = *_ndns;
34e1455744SDan Williams
35e1455744SDan Williams if (!ndns)
36e1455744SDan Williams return;
37e1455744SDan Williams get_device(&ndns->dev);
38452bae0aSDan Williams nvdimm_bus_lock(&ndns->dev);
39e1455744SDan Williams __nd_detach_ndns(dev, _ndns);
40452bae0aSDan Williams nvdimm_bus_unlock(&ndns->dev);
41e1455744SDan Williams put_device(&ndns->dev);
42e1455744SDan Williams }
43e1455744SDan Williams
__nd_attach_ndns(struct device * dev,struct nd_namespace_common * attach,struct nd_namespace_common ** _ndns)44e1455744SDan Williams bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
45e1455744SDan Williams struct nd_namespace_common **_ndns)
46e1455744SDan Williams {
47452bae0aSDan Williams struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&attach->dev);
48452bae0aSDan Williams
49e1455744SDan Williams if (attach->claim)
50e1455744SDan Williams return false;
51452bae0aSDan Williams lockdep_assert_held(&nvdimm_bus->reconfig_mutex);
529cf8bd52SDan Williams dev_WARN_ONCE(dev, *_ndns, "%s: invalid claim\n", __func__);
53e1455744SDan Williams attach->claim = dev;
54e1455744SDan Williams *_ndns = attach;
55e1455744SDan Williams get_device(&attach->dev);
56e1455744SDan Williams return true;
57e1455744SDan Williams }
58e1455744SDan Williams
nd_attach_ndns(struct device * dev,struct nd_namespace_common * attach,struct nd_namespace_common ** _ndns)59e1455744SDan Williams bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
60e1455744SDan Williams struct nd_namespace_common **_ndns)
61e1455744SDan Williams {
62e1455744SDan Williams bool claimed;
63e1455744SDan Williams
64452bae0aSDan Williams nvdimm_bus_lock(&attach->dev);
65e1455744SDan Williams claimed = __nd_attach_ndns(dev, attach, _ndns);
66452bae0aSDan Williams nvdimm_bus_unlock(&attach->dev);
67e1455744SDan Williams return claimed;
68e1455744SDan Williams }
69e1455744SDan Williams
namespace_match(struct device * dev,void * data)70e1455744SDan Williams static int namespace_match(struct device *dev, void *data)
71e1455744SDan Williams {
72e1455744SDan Williams char *name = data;
73e1455744SDan Williams
74e1455744SDan Williams return strcmp(name, dev_name(dev)) == 0;
75e1455744SDan Williams }
76e1455744SDan Williams
is_idle(struct device * dev,struct nd_namespace_common * ndns)77e1455744SDan Williams static bool is_idle(struct device *dev, struct nd_namespace_common *ndns)
78e1455744SDan Williams {
79e1455744SDan Williams struct nd_region *nd_region = to_nd_region(dev->parent);
80e1455744SDan Williams struct device *seed = NULL;
81e1455744SDan Williams
82e1455744SDan Williams if (is_nd_btt(dev))
83e1455744SDan Williams seed = nd_region->btt_seed;
84e1455744SDan Williams else if (is_nd_pfn(dev))
85e1455744SDan Williams seed = nd_region->pfn_seed;
86cd03412aSDan Williams else if (is_nd_dax(dev))
87cd03412aSDan Williams seed = nd_region->dax_seed;
88e1455744SDan Williams
89e1455744SDan Williams if (seed == dev || ndns || dev->driver)
90e1455744SDan Williams return false;
91e1455744SDan Williams return true;
92e1455744SDan Williams }
93e1455744SDan Williams
to_nd_pfn_safe(struct device * dev)9403dca343SDan Williams struct nd_pfn *to_nd_pfn_safe(struct device *dev)
9503dca343SDan Williams {
9603dca343SDan Williams /*
9703dca343SDan Williams * pfn device attributes are re-used by dax device instances, so we
9803dca343SDan Williams * need to be careful to correct device-to-nd_pfn conversion.
9903dca343SDan Williams */
10003dca343SDan Williams if (is_nd_pfn(dev))
10103dca343SDan Williams return to_nd_pfn(dev);
10203dca343SDan Williams
10303dca343SDan Williams if (is_nd_dax(dev)) {
10403dca343SDan Williams struct nd_dax *nd_dax = to_nd_dax(dev);
10503dca343SDan Williams
10603dca343SDan Williams return &nd_dax->nd_pfn;
10703dca343SDan Williams }
10803dca343SDan Williams
10903dca343SDan Williams WARN_ON(1);
11003dca343SDan Williams return NULL;
11103dca343SDan Williams }
11203dca343SDan Williams
nd_detach_and_reset(struct device * dev,struct nd_namespace_common ** _ndns)113e1455744SDan Williams static void nd_detach_and_reset(struct device *dev,
114e1455744SDan Williams struct nd_namespace_common **_ndns)
115e1455744SDan Williams {
116e1455744SDan Williams /* detach the namespace and destroy / reset the device */
117452bae0aSDan Williams __nd_detach_ndns(dev, _ndns);
118e1455744SDan Williams if (is_idle(dev, *_ndns)) {
119e1455744SDan Williams nd_device_unregister(dev, ND_ASYNC);
120e1455744SDan Williams } else if (is_nd_btt(dev)) {
121e1455744SDan Williams struct nd_btt *nd_btt = to_nd_btt(dev);
122e1455744SDan Williams
123e1455744SDan Williams nd_btt->lbasize = 0;
124e1455744SDan Williams kfree(nd_btt->uuid);
125e1455744SDan Williams nd_btt->uuid = NULL;
12603dca343SDan Williams } else if (is_nd_pfn(dev) || is_nd_dax(dev)) {
12703dca343SDan Williams struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev);
128e1455744SDan Williams
129e1455744SDan Williams kfree(nd_pfn->uuid);
130e1455744SDan Williams nd_pfn->uuid = NULL;
131e1455744SDan Williams nd_pfn->mode = PFN_MODE_NONE;
132e1455744SDan Williams }
133e1455744SDan Williams }
134e1455744SDan Williams
nd_namespace_store(struct device * dev,struct nd_namespace_common ** _ndns,const char * buf,size_t len)135e1455744SDan Williams ssize_t nd_namespace_store(struct device *dev,
136e1455744SDan Williams struct nd_namespace_common **_ndns, const char *buf,
137e1455744SDan Williams size_t len)
138e1455744SDan Williams {
139e1455744SDan Williams struct nd_namespace_common *ndns;
140e1455744SDan Williams struct device *found;
141e1455744SDan Williams char *name;
142e1455744SDan Williams
143e1455744SDan Williams if (dev->driver) {
144426824d6SDan Williams dev_dbg(dev, "namespace already active\n");
145e1455744SDan Williams return -EBUSY;
146e1455744SDan Williams }
147e1455744SDan Williams
148e1455744SDan Williams name = kstrndup(buf, len, GFP_KERNEL);
149e1455744SDan Williams if (!name)
150e1455744SDan Williams return -ENOMEM;
151e1455744SDan Williams strim(name);
152e1455744SDan Williams
153e1455744SDan Williams if (strncmp(name, "namespace", 9) == 0 || strcmp(name, "") == 0)
154e1455744SDan Williams /* pass */;
155e1455744SDan Williams else {
156e1455744SDan Williams len = -EINVAL;
157e1455744SDan Williams goto out;
158e1455744SDan Williams }
159e1455744SDan Williams
160e1455744SDan Williams ndns = *_ndns;
161e1455744SDan Williams if (strcmp(name, "") == 0) {
162e1455744SDan Williams nd_detach_and_reset(dev, _ndns);
163e1455744SDan Williams goto out;
164e1455744SDan Williams } else if (ndns) {
165e1455744SDan Williams dev_dbg(dev, "namespace already set to: %s\n",
166e1455744SDan Williams dev_name(&ndns->dev));
167e1455744SDan Williams len = -EBUSY;
168e1455744SDan Williams goto out;
169e1455744SDan Williams }
170e1455744SDan Williams
171e1455744SDan Williams found = device_find_child(dev->parent, name, namespace_match);
172e1455744SDan Williams if (!found) {
173e1455744SDan Williams dev_dbg(dev, "'%s' not found under %s\n", name,
174e1455744SDan Williams dev_name(dev->parent));
175e1455744SDan Williams len = -ENODEV;
176e1455744SDan Williams goto out;
177e1455744SDan Williams }
178e1455744SDan Williams
179e1455744SDan Williams ndns = to_ndns(found);
180b3fde74eSDan Williams
181b3fde74eSDan Williams switch (ndns->claim_class) {
182b3fde74eSDan Williams case NVDIMM_CCLASS_NONE:
183b3fde74eSDan Williams break;
184b3fde74eSDan Williams case NVDIMM_CCLASS_BTT:
18514e49454SVishal Verma case NVDIMM_CCLASS_BTT2:
186b3fde74eSDan Williams if (!is_nd_btt(dev)) {
187b3fde74eSDan Williams len = -EBUSY;
188b3fde74eSDan Williams goto out_attach;
189b3fde74eSDan Williams }
190b3fde74eSDan Williams break;
191b3fde74eSDan Williams case NVDIMM_CCLASS_PFN:
192b3fde74eSDan Williams if (!is_nd_pfn(dev)) {
193b3fde74eSDan Williams len = -EBUSY;
194b3fde74eSDan Williams goto out_attach;
195b3fde74eSDan Williams }
196b3fde74eSDan Williams break;
197b3fde74eSDan Williams case NVDIMM_CCLASS_DAX:
198b3fde74eSDan Williams if (!is_nd_dax(dev)) {
199b3fde74eSDan Williams len = -EBUSY;
200b3fde74eSDan Williams goto out_attach;
201b3fde74eSDan Williams }
202b3fde74eSDan Williams break;
203b3fde74eSDan Williams default:
204b3fde74eSDan Williams len = -EBUSY;
205b3fde74eSDan Williams goto out_attach;
206b3fde74eSDan Williams break;
207b3fde74eSDan Williams }
208b3fde74eSDan Williams
209e1455744SDan Williams if (__nvdimm_namespace_capacity(ndns) < SZ_16M) {
210e1455744SDan Williams dev_dbg(dev, "%s too small to host\n", name);
211e1455744SDan Williams len = -ENXIO;
212e1455744SDan Williams goto out_attach;
213e1455744SDan Williams }
214e1455744SDan Williams
215e1455744SDan Williams WARN_ON_ONCE(!is_nvdimm_bus_locked(dev));
216452bae0aSDan Williams if (!__nd_attach_ndns(dev, ndns, _ndns)) {
217e1455744SDan Williams dev_dbg(dev, "%s already claimed\n",
218e1455744SDan Williams dev_name(&ndns->dev));
219e1455744SDan Williams len = -EBUSY;
220e1455744SDan Williams }
221e1455744SDan Williams
222e1455744SDan Williams out_attach:
223e1455744SDan Williams put_device(&ndns->dev); /* from device_find_child */
224e1455744SDan Williams out:
225e1455744SDan Williams kfree(name);
226e1455744SDan Williams return len;
227e1455744SDan Williams }
228e1455744SDan Williams
229e1455744SDan Williams /*
230e1455744SDan Williams * nd_sb_checksum: compute checksum for a generic info block
231e1455744SDan Williams *
232e1455744SDan Williams * Returns a fletcher64 checksum of everything in the given info block
233e1455744SDan Williams * except the last field (since that's where the checksum lives).
234e1455744SDan Williams */
nd_sb_checksum(struct nd_gen_sb * nd_gen_sb)235e1455744SDan Williams u64 nd_sb_checksum(struct nd_gen_sb *nd_gen_sb)
236e1455744SDan Williams {
237e1455744SDan Williams u64 sum;
238e1455744SDan Williams __le64 sum_save;
239e1455744SDan Williams
240e1455744SDan Williams BUILD_BUG_ON(sizeof(struct btt_sb) != SZ_4K);
241e1455744SDan Williams BUILD_BUG_ON(sizeof(struct nd_pfn_sb) != SZ_4K);
242e1455744SDan Williams BUILD_BUG_ON(sizeof(struct nd_gen_sb) != SZ_4K);
243e1455744SDan Williams
244e1455744SDan Williams sum_save = nd_gen_sb->checksum;
245e1455744SDan Williams nd_gen_sb->checksum = 0;
246e1455744SDan Williams sum = nd_fletcher64(nd_gen_sb, sizeof(*nd_gen_sb), 1);
247e1455744SDan Williams nd_gen_sb->checksum = sum_save;
248e1455744SDan Williams return sum;
249e1455744SDan Williams }
250e1455744SDan Williams EXPORT_SYMBOL(nd_sb_checksum);
251200c79daSDan Williams
nsio_rw_bytes(struct nd_namespace_common * ndns,resource_size_t offset,void * buf,size_t size,int rw,unsigned long flags)252200c79daSDan Williams static int nsio_rw_bytes(struct nd_namespace_common *ndns,
2533ae3d67bSVishal Verma resource_size_t offset, void *buf, size_t size, int rw,
2543ae3d67bSVishal Verma unsigned long flags)
255200c79daSDan Williams {
256200c79daSDan Williams struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
25782bf1037SDave Jiang unsigned int sz_align = ALIGN(size + (offset & (512 - 1)), 512);
25882bf1037SDave Jiang sector_t sector = offset >> 9;
259c5d4355dSPankaj Gupta int rc = 0, ret = 0;
26082bf1037SDave Jiang
26182bf1037SDave Jiang if (unlikely(!size))
26282bf1037SDave Jiang return 0;
263200c79daSDan Williams
264200c79daSDan Williams if (unlikely(offset + size > nsio->size)) {
265200c79daSDan Williams dev_WARN_ONCE(&ndns->dev, 1, "request out of range\n");
266200c79daSDan Williams return -EFAULT;
267200c79daSDan Williams }
268200c79daSDan Williams
269200c79daSDan Williams if (rw == READ) {
27082bf1037SDave Jiang if (unlikely(is_bad_pmem(&nsio->bb, sector, sz_align)))
271200c79daSDan Williams return -EIO;
272ec6347bbSDan Williams if (copy_mc_to_kernel(buf, nsio->addr + offset, size) != 0)
27360622d68SDan Williams return -EIO;
274b62cc6fdSDan Williams return 0;
275d37806dcSFabian Frederick }
27682bf1037SDave Jiang
27782bf1037SDave Jiang if (unlikely(is_bad_pmem(&nsio->bb, sector, sz_align))) {
278a3e9af95SDan Williams if (IS_ALIGNED(offset, 512) && IS_ALIGNED(size, 512)
2797e5a21dfSVishal Verma && !(flags & NVDIMM_IO_ATOMIC)) {
28082bf1037SDave Jiang long cleared;
28182bf1037SDave Jiang
2821db1f3ceSVishal Verma might_sleep();
28397681f9bSToshi Kani cleared = nvdimm_clear_poison(&ndns->dev,
28497681f9bSToshi Kani nsio->res.start + offset, size);
285868f036fSDan Williams if (cleared < size)
28682bf1037SDave Jiang rc = -EIO;
287868f036fSDan Williams if (cleared > 0 && cleared / 512) {
288868f036fSDan Williams cleared /= 512;
289868f036fSDan Williams badblocks_clear(&nsio->bb, sector, cleared);
29082bf1037SDave Jiang }
291f2b61257SDan Williams arch_invalidate_pmem(nsio->addr + offset, size);
29282bf1037SDave Jiang } else
29382bf1037SDave Jiang rc = -EIO;
29482bf1037SDave Jiang }
29582bf1037SDave Jiang
2960aed55afSDan Williams memcpy_flushcache(nsio->addr + offset, buf, size);
297c5d4355dSPankaj Gupta ret = nvdimm_flush(to_nd_region(ndns->dev.parent), NULL);
298c5d4355dSPankaj Gupta if (ret)
299c5d4355dSPankaj Gupta rc = ret;
300200c79daSDan Williams
30182bf1037SDave Jiang return rc;
302200c79daSDan Williams }
303200c79daSDan Williams
devm_nsio_enable(struct device * dev,struct nd_namespace_io * nsio,resource_size_t size)3048f4b01fcSAneesh Kumar K.V int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio,
3058f4b01fcSAneesh Kumar K.V resource_size_t size)
306200c79daSDan Williams {
307200c79daSDan Williams struct nd_namespace_common *ndns = &nsio->common;
308a4574f63SDan Williams struct range range = {
309a4574f63SDan Williams .start = nsio->res.start,
310a4574f63SDan Williams .end = nsio->res.end,
311a4574f63SDan Williams };
312200c79daSDan Williams
3138f4b01fcSAneesh Kumar K.V nsio->size = size;
314a4574f63SDan Williams if (!devm_request_mem_region(dev, range.start, size,
315450c6633SDan Williams dev_name(&ndns->dev))) {
316a4574f63SDan Williams dev_warn(dev, "could not reserve region %pR\n", &nsio->res);
317200c79daSDan Williams return -EBUSY;
318200c79daSDan Williams }
319200c79daSDan Williams
320200c79daSDan Williams ndns->rw_bytes = nsio_rw_bytes;
321200c79daSDan Williams if (devm_init_badblocks(dev, &nsio->bb))
322200c79daSDan Williams return -ENOMEM;
323200c79daSDan Williams nvdimm_badblocks_populate(to_nd_region(ndns->dev.parent), &nsio->bb,
324a4574f63SDan Williams &range);
325200c79daSDan Williams
326a4574f63SDan Williams nsio->addr = devm_memremap(dev, range.start, size, ARCH_MEMREMAP_PMEM);
32742588958SDan Williams
32842588958SDan Williams return PTR_ERR_OR_ZERO(nsio->addr);
329200c79daSDan Williams }
330200c79daSDan Williams
devm_nsio_disable(struct device * dev,struct nd_namespace_io * nsio)331200c79daSDan Williams void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio)
332200c79daSDan Williams {
333200c79daSDan Williams struct resource *res = &nsio->res;
334200c79daSDan Williams
335200c79daSDan Williams devm_memunmap(dev, nsio->addr);
336200c79daSDan Williams devm_exit_badblocks(dev, &nsio->bb);
3378f4b01fcSAneesh Kumar K.V devm_release_mem_region(dev, res->start, nsio->size);
338200c79daSDan Williams }
339