1e1455744SDan Williams /* 2e1455744SDan Williams * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. 3e1455744SDan Williams * 4e1455744SDan Williams * This program is free software; you can redistribute it and/or modify 5e1455744SDan Williams * it under the terms of version 2 of the GNU General Public License as 6e1455744SDan Williams * published by the Free Software Foundation. 7e1455744SDan Williams * 8e1455744SDan Williams * This program is distributed in the hope that it will be useful, but 9e1455744SDan Williams * WITHOUT ANY WARRANTY; without even the implied warranty of 10e1455744SDan Williams * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11e1455744SDan Williams * General Public License for more details. 12e1455744SDan Williams */ 13e1455744SDan Williams #include <linux/device.h> 14e1455744SDan Williams #include <linux/sizes.h> 15200c79daSDan Williams #include <linux/pmem.h> 16e1455744SDan Williams #include "nd-core.h" 17e1455744SDan Williams #include "pfn.h" 18e1455744SDan Williams #include "btt.h" 19e1455744SDan Williams #include "nd.h" 20e1455744SDan Williams 21e1455744SDan Williams void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns) 22e1455744SDan Williams { 23e1455744SDan Williams struct nd_namespace_common *ndns = *_ndns; 24452bae0aSDan Williams struct nvdimm_bus *nvdimm_bus; 25e1455744SDan Williams 26452bae0aSDan Williams if (!ndns) 27452bae0aSDan Williams return; 28452bae0aSDan Williams 29452bae0aSDan Williams nvdimm_bus = walk_to_nvdimm_bus(&ndns->dev); 30452bae0aSDan Williams lockdep_assert_held(&nvdimm_bus->reconfig_mutex); 319cf8bd52SDan Williams dev_WARN_ONCE(dev, ndns->claim != dev, "%s: invalid claim\n", __func__); 32e1455744SDan Williams ndns->claim = NULL; 33e1455744SDan Williams *_ndns = NULL; 34e1455744SDan Williams put_device(&ndns->dev); 35e1455744SDan Williams } 36e1455744SDan Williams 37e1455744SDan Williams void nd_detach_ndns(struct device *dev, 38e1455744SDan Williams struct nd_namespace_common **_ndns) 39e1455744SDan Williams { 40e1455744SDan Williams struct nd_namespace_common *ndns = *_ndns; 41e1455744SDan Williams 42e1455744SDan Williams if (!ndns) 43e1455744SDan Williams return; 44e1455744SDan Williams get_device(&ndns->dev); 45452bae0aSDan Williams nvdimm_bus_lock(&ndns->dev); 46e1455744SDan Williams __nd_detach_ndns(dev, _ndns); 47452bae0aSDan Williams nvdimm_bus_unlock(&ndns->dev); 48e1455744SDan Williams put_device(&ndns->dev); 49e1455744SDan Williams } 50e1455744SDan Williams 51e1455744SDan Williams bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 52e1455744SDan Williams struct nd_namespace_common **_ndns) 53e1455744SDan Williams { 54452bae0aSDan Williams struct nvdimm_bus *nvdimm_bus = walk_to_nvdimm_bus(&attach->dev); 55452bae0aSDan Williams 56e1455744SDan Williams if (attach->claim) 57e1455744SDan Williams return false; 58452bae0aSDan Williams lockdep_assert_held(&nvdimm_bus->reconfig_mutex); 599cf8bd52SDan Williams dev_WARN_ONCE(dev, *_ndns, "%s: invalid claim\n", __func__); 60e1455744SDan Williams attach->claim = dev; 61e1455744SDan Williams *_ndns = attach; 62e1455744SDan Williams get_device(&attach->dev); 63e1455744SDan Williams return true; 64e1455744SDan Williams } 65e1455744SDan Williams 66e1455744SDan Williams bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 67e1455744SDan Williams struct nd_namespace_common **_ndns) 68e1455744SDan Williams { 69e1455744SDan Williams bool claimed; 70e1455744SDan Williams 71452bae0aSDan Williams nvdimm_bus_lock(&attach->dev); 72e1455744SDan Williams claimed = __nd_attach_ndns(dev, attach, _ndns); 73452bae0aSDan Williams nvdimm_bus_unlock(&attach->dev); 74e1455744SDan Williams return claimed; 75e1455744SDan Williams } 76e1455744SDan Williams 77e1455744SDan Williams static int namespace_match(struct device *dev, void *data) 78e1455744SDan Williams { 79e1455744SDan Williams char *name = data; 80e1455744SDan Williams 81e1455744SDan Williams return strcmp(name, dev_name(dev)) == 0; 82e1455744SDan Williams } 83e1455744SDan Williams 84e1455744SDan Williams static bool is_idle(struct device *dev, struct nd_namespace_common *ndns) 85e1455744SDan Williams { 86e1455744SDan Williams struct nd_region *nd_region = to_nd_region(dev->parent); 87e1455744SDan Williams struct device *seed = NULL; 88e1455744SDan Williams 89e1455744SDan Williams if (is_nd_btt(dev)) 90e1455744SDan Williams seed = nd_region->btt_seed; 91e1455744SDan Williams else if (is_nd_pfn(dev)) 92e1455744SDan Williams seed = nd_region->pfn_seed; 93cd03412aSDan Williams else if (is_nd_dax(dev)) 94cd03412aSDan Williams seed = nd_region->dax_seed; 95e1455744SDan Williams 96e1455744SDan Williams if (seed == dev || ndns || dev->driver) 97e1455744SDan Williams return false; 98e1455744SDan Williams return true; 99e1455744SDan Williams } 100e1455744SDan Williams 10103dca343SDan Williams struct nd_pfn *to_nd_pfn_safe(struct device *dev) 10203dca343SDan Williams { 10303dca343SDan Williams /* 10403dca343SDan Williams * pfn device attributes are re-used by dax device instances, so we 10503dca343SDan Williams * need to be careful to correct device-to-nd_pfn conversion. 10603dca343SDan Williams */ 10703dca343SDan Williams if (is_nd_pfn(dev)) 10803dca343SDan Williams return to_nd_pfn(dev); 10903dca343SDan Williams 11003dca343SDan Williams if (is_nd_dax(dev)) { 11103dca343SDan Williams struct nd_dax *nd_dax = to_nd_dax(dev); 11203dca343SDan Williams 11303dca343SDan Williams return &nd_dax->nd_pfn; 11403dca343SDan Williams } 11503dca343SDan Williams 11603dca343SDan Williams WARN_ON(1); 11703dca343SDan Williams return NULL; 11803dca343SDan Williams } 11903dca343SDan Williams 120e1455744SDan Williams static void nd_detach_and_reset(struct device *dev, 121e1455744SDan Williams struct nd_namespace_common **_ndns) 122e1455744SDan Williams { 123e1455744SDan Williams /* detach the namespace and destroy / reset the device */ 124452bae0aSDan Williams __nd_detach_ndns(dev, _ndns); 125e1455744SDan Williams if (is_idle(dev, *_ndns)) { 126e1455744SDan Williams nd_device_unregister(dev, ND_ASYNC); 127e1455744SDan Williams } else if (is_nd_btt(dev)) { 128e1455744SDan Williams struct nd_btt *nd_btt = to_nd_btt(dev); 129e1455744SDan Williams 130e1455744SDan Williams nd_btt->lbasize = 0; 131e1455744SDan Williams kfree(nd_btt->uuid); 132e1455744SDan Williams nd_btt->uuid = NULL; 13303dca343SDan Williams } else if (is_nd_pfn(dev) || is_nd_dax(dev)) { 13403dca343SDan Williams struct nd_pfn *nd_pfn = to_nd_pfn_safe(dev); 135e1455744SDan Williams 136e1455744SDan Williams kfree(nd_pfn->uuid); 137e1455744SDan Williams nd_pfn->uuid = NULL; 138e1455744SDan Williams nd_pfn->mode = PFN_MODE_NONE; 139e1455744SDan Williams } 140e1455744SDan Williams } 141e1455744SDan Williams 142e1455744SDan Williams ssize_t nd_namespace_store(struct device *dev, 143e1455744SDan Williams struct nd_namespace_common **_ndns, const char *buf, 144e1455744SDan Williams size_t len) 145e1455744SDan Williams { 146e1455744SDan Williams struct nd_namespace_common *ndns; 147e1455744SDan Williams struct device *found; 148e1455744SDan Williams char *name; 149e1455744SDan Williams 150e1455744SDan Williams if (dev->driver) { 151e1455744SDan Williams dev_dbg(dev, "%s: -EBUSY\n", __func__); 152e1455744SDan Williams return -EBUSY; 153e1455744SDan Williams } 154e1455744SDan Williams 155e1455744SDan Williams name = kstrndup(buf, len, GFP_KERNEL); 156e1455744SDan Williams if (!name) 157e1455744SDan Williams return -ENOMEM; 158e1455744SDan Williams strim(name); 159e1455744SDan Williams 160e1455744SDan Williams if (strncmp(name, "namespace", 9) == 0 || strcmp(name, "") == 0) 161e1455744SDan Williams /* pass */; 162e1455744SDan Williams else { 163e1455744SDan Williams len = -EINVAL; 164e1455744SDan Williams goto out; 165e1455744SDan Williams } 166e1455744SDan Williams 167e1455744SDan Williams ndns = *_ndns; 168e1455744SDan Williams if (strcmp(name, "") == 0) { 169e1455744SDan Williams nd_detach_and_reset(dev, _ndns); 170e1455744SDan Williams goto out; 171e1455744SDan Williams } else if (ndns) { 172e1455744SDan Williams dev_dbg(dev, "namespace already set to: %s\n", 173e1455744SDan Williams dev_name(&ndns->dev)); 174e1455744SDan Williams len = -EBUSY; 175e1455744SDan Williams goto out; 176e1455744SDan Williams } 177e1455744SDan Williams 178e1455744SDan Williams found = device_find_child(dev->parent, name, namespace_match); 179e1455744SDan Williams if (!found) { 180e1455744SDan Williams dev_dbg(dev, "'%s' not found under %s\n", name, 181e1455744SDan Williams dev_name(dev->parent)); 182e1455744SDan Williams len = -ENODEV; 183e1455744SDan Williams goto out; 184e1455744SDan Williams } 185e1455744SDan Williams 186e1455744SDan Williams ndns = to_ndns(found); 187e1455744SDan Williams if (__nvdimm_namespace_capacity(ndns) < SZ_16M) { 188e1455744SDan Williams dev_dbg(dev, "%s too small to host\n", name); 189e1455744SDan Williams len = -ENXIO; 190e1455744SDan Williams goto out_attach; 191e1455744SDan Williams } 192e1455744SDan Williams 193e1455744SDan Williams WARN_ON_ONCE(!is_nvdimm_bus_locked(dev)); 194452bae0aSDan Williams if (!__nd_attach_ndns(dev, ndns, _ndns)) { 195e1455744SDan Williams dev_dbg(dev, "%s already claimed\n", 196e1455744SDan Williams dev_name(&ndns->dev)); 197e1455744SDan Williams len = -EBUSY; 198e1455744SDan Williams } 199e1455744SDan Williams 200e1455744SDan Williams out_attach: 201e1455744SDan Williams put_device(&ndns->dev); /* from device_find_child */ 202e1455744SDan Williams out: 203e1455744SDan Williams kfree(name); 204e1455744SDan Williams return len; 205e1455744SDan Williams } 206e1455744SDan Williams 207e1455744SDan Williams /* 208e1455744SDan Williams * nd_sb_checksum: compute checksum for a generic info block 209e1455744SDan Williams * 210e1455744SDan Williams * Returns a fletcher64 checksum of everything in the given info block 211e1455744SDan Williams * except the last field (since that's where the checksum lives). 212e1455744SDan Williams */ 213e1455744SDan Williams u64 nd_sb_checksum(struct nd_gen_sb *nd_gen_sb) 214e1455744SDan Williams { 215e1455744SDan Williams u64 sum; 216e1455744SDan Williams __le64 sum_save; 217e1455744SDan Williams 218e1455744SDan Williams BUILD_BUG_ON(sizeof(struct btt_sb) != SZ_4K); 219e1455744SDan Williams BUILD_BUG_ON(sizeof(struct nd_pfn_sb) != SZ_4K); 220e1455744SDan Williams BUILD_BUG_ON(sizeof(struct nd_gen_sb) != SZ_4K); 221e1455744SDan Williams 222e1455744SDan Williams sum_save = nd_gen_sb->checksum; 223e1455744SDan Williams nd_gen_sb->checksum = 0; 224e1455744SDan Williams sum = nd_fletcher64(nd_gen_sb, sizeof(*nd_gen_sb), 1); 225e1455744SDan Williams nd_gen_sb->checksum = sum_save; 226e1455744SDan Williams return sum; 227e1455744SDan Williams } 228e1455744SDan Williams EXPORT_SYMBOL(nd_sb_checksum); 229200c79daSDan Williams 230200c79daSDan Williams static int nsio_rw_bytes(struct nd_namespace_common *ndns, 2313ae3d67bSVishal Verma resource_size_t offset, void *buf, size_t size, int rw, 2323ae3d67bSVishal Verma unsigned long flags) 233200c79daSDan Williams { 234200c79daSDan Williams struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev); 23582bf1037SDave Jiang unsigned int sz_align = ALIGN(size + (offset & (512 - 1)), 512); 23682bf1037SDave Jiang sector_t sector = offset >> 9; 23782bf1037SDave Jiang int rc = 0; 23882bf1037SDave Jiang 23982bf1037SDave Jiang if (unlikely(!size)) 24082bf1037SDave Jiang return 0; 241200c79daSDan Williams 242200c79daSDan Williams if (unlikely(offset + size > nsio->size)) { 243200c79daSDan Williams dev_WARN_ONCE(&ndns->dev, 1, "request out of range\n"); 244200c79daSDan Williams return -EFAULT; 245200c79daSDan Williams } 246200c79daSDan Williams 247200c79daSDan Williams if (rw == READ) { 24882bf1037SDave Jiang if (unlikely(is_bad_pmem(&nsio->bb, sector, sz_align))) 249200c79daSDan Williams return -EIO; 2506abccd1bSDan Williams return memcpy_mcsafe(buf, nsio->addr + offset, size); 251d37806dcSFabian Frederick } 25282bf1037SDave Jiang 25382bf1037SDave Jiang if (unlikely(is_bad_pmem(&nsio->bb, sector, sz_align))) { 254a3e9af95SDan Williams /* 255a3e9af95SDan Williams * FIXME: nsio_rw_bytes() may be called from atomic 256a3e9af95SDan Williams * context in the btt case and the ACPI DSM path for 257a3e9af95SDan Williams * clearing the error takes sleeping locks and allocates 258a3e9af95SDan Williams * memory. An explicit error clearing path, and support 259a3e9af95SDan Williams * for tracking badblocks in BTT metadata is needed to 260a3e9af95SDan Williams * work around this collision. 261a3e9af95SDan Williams */ 262a3e9af95SDan Williams if (IS_ALIGNED(offset, 512) && IS_ALIGNED(size, 512) 2633ae3d67bSVishal Verma && !(flags & NVDIMM_IO_ATOMIC) 2643ae3d67bSVishal Verma && !ndns->claim) { 26582bf1037SDave Jiang long cleared; 26682bf1037SDave Jiang 26797681f9bSToshi Kani cleared = nvdimm_clear_poison(&ndns->dev, 26897681f9bSToshi Kani nsio->res.start + offset, size); 269868f036fSDan Williams if (cleared < size) 27082bf1037SDave Jiang rc = -EIO; 271868f036fSDan Williams if (cleared > 0 && cleared / 512) { 272868f036fSDan Williams cleared /= 512; 273868f036fSDan Williams badblocks_clear(&nsio->bb, sector, cleared); 27482bf1037SDave Jiang } 275868f036fSDan Williams invalidate_pmem(nsio->addr + offset, size); 27682bf1037SDave Jiang } else 27782bf1037SDave Jiang rc = -EIO; 27882bf1037SDave Jiang } 27982bf1037SDave Jiang 280*0aed55afSDan Williams memcpy_flushcache(nsio->addr + offset, buf, size); 28191131dbdSDan Williams nvdimm_flush(to_nd_region(ndns->dev.parent)); 282200c79daSDan Williams 28382bf1037SDave Jiang return rc; 284200c79daSDan Williams } 285200c79daSDan Williams 286200c79daSDan Williams int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio) 287200c79daSDan Williams { 288200c79daSDan Williams struct resource *res = &nsio->res; 289200c79daSDan Williams struct nd_namespace_common *ndns = &nsio->common; 290200c79daSDan Williams 291200c79daSDan Williams nsio->size = resource_size(res); 292200c79daSDan Williams if (!devm_request_mem_region(dev, res->start, resource_size(res), 293450c6633SDan Williams dev_name(&ndns->dev))) { 294200c79daSDan Williams dev_warn(dev, "could not reserve region %pR\n", res); 295200c79daSDan Williams return -EBUSY; 296200c79daSDan Williams } 297200c79daSDan Williams 298200c79daSDan Williams ndns->rw_bytes = nsio_rw_bytes; 299200c79daSDan Williams if (devm_init_badblocks(dev, &nsio->bb)) 300200c79daSDan Williams return -ENOMEM; 301200c79daSDan Williams nvdimm_badblocks_populate(to_nd_region(ndns->dev.parent), &nsio->bb, 302200c79daSDan Williams &nsio->res); 303200c79daSDan Williams 304200c79daSDan Williams nsio->addr = devm_memremap(dev, res->start, resource_size(res), 305200c79daSDan Williams ARCH_MEMREMAP_PMEM); 30642588958SDan Williams 30742588958SDan Williams return PTR_ERR_OR_ZERO(nsio->addr); 308200c79daSDan Williams } 309200c79daSDan Williams EXPORT_SYMBOL_GPL(devm_nsio_enable); 310200c79daSDan Williams 311200c79daSDan Williams void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio) 312200c79daSDan Williams { 313200c79daSDan Williams struct resource *res = &nsio->res; 314200c79daSDan Williams 315200c79daSDan Williams devm_memunmap(dev, nsio->addr); 316200c79daSDan Williams devm_exit_badblocks(dev, &nsio->bb); 317200c79daSDan Williams devm_release_mem_region(dev, res->start, resource_size(res)); 318200c79daSDan Williams } 319200c79daSDan Williams EXPORT_SYMBOL_GPL(devm_nsio_disable); 320