libnvdimm, pmem: allow nfit_test to override pmem_direct_access()
[deliverable/linux.git] / drivers / nvdimm / pmem.c
CommitLineData
9e853f23
RZ
1/*
2 * Persistent Memory Driver
3 *
9f53f9fa 4 * Copyright (c) 2014-2015, Intel Corporation.
9e853f23
RZ
5 * Copyright (c) 2015, Christoph Hellwig <hch@lst.de>.
6 * Copyright (c) 2015, Boaz Harrosh <boaz@plexistor.com>.
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms and conditions of the GNU General Public License,
10 * version 2, as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * more details.
16 */
17
18#include <asm/cacheflush.h>
19#include <linux/blkdev.h>
20#include <linux/hdreg.h>
21#include <linux/init.h>
22#include <linux/platform_device.h>
23#include <linux/module.h>
24#include <linux/moduleparam.h>
b95f5f43 25#include <linux/badblocks.h>
9476df7d 26#include <linux/memremap.h>
32ab0a3f 27#include <linux/vmalloc.h>
34c0fd54 28#include <linux/pfn_t.h>
9e853f23 29#include <linux/slab.h>
61031952 30#include <linux/pmem.h>
9f53f9fa 31#include <linux/nd.h>
f295e53b 32#include "pmem.h"
32ab0a3f 33#include "pfn.h"
9f53f9fa 34#include "nd.h"
9e853f23 35
59e64739
DW
36static void pmem_clear_poison(struct pmem_device *pmem, phys_addr_t offset,
37 unsigned int len)
38{
5a92289f 39 struct device *dev = pmem->bb.dev;
59e64739
DW
40 sector_t sector;
41 long cleared;
42
43 sector = (offset - pmem->data_offset) / 512;
44 cleared = nvdimm_clear_poison(dev, pmem->phys_addr + offset, len);
45
46 if (cleared > 0 && cleared / 512) {
47 dev_dbg(dev, "%s: %llx clear %ld sector%s\n",
48 __func__, (unsigned long long) sector,
49 cleared / 512, cleared / 512 > 1 ? "s" : "");
50 badblocks_clear(&pmem->bb, sector, cleared / 512);
51 }
52 invalidate_pmem(pmem->virt_addr + offset, len);
53}
54
e10624f8 55static int pmem_do_bvec(struct pmem_device *pmem, struct page *page,
9e853f23
RZ
56 unsigned int len, unsigned int off, int rw,
57 sector_t sector)
58{
b5ebc8ec 59 int rc = 0;
59e64739 60 bool bad_pmem = false;
9e853f23 61 void *mem = kmap_atomic(page);
32ab0a3f 62 phys_addr_t pmem_off = sector * 512 + pmem->data_offset;
61031952 63 void __pmem *pmem_addr = pmem->virt_addr + pmem_off;
9e853f23 64
59e64739
DW
65 if (unlikely(is_bad_pmem(&pmem->bb, sector, len)))
66 bad_pmem = true;
67
9e853f23 68 if (rw == READ) {
59e64739 69 if (unlikely(bad_pmem))
b5ebc8ec
DW
70 rc = -EIO;
71 else {
fc0c2028 72 rc = memcpy_from_pmem(mem + off, pmem_addr, len);
b5ebc8ec
DW
73 flush_dcache_page(page);
74 }
9e853f23 75 } else {
0a370d26
DW
76 /*
77 * Note that we write the data both before and after
78 * clearing poison. The write before clear poison
79 * handles situations where the latest written data is
80 * preserved and the clear poison operation simply marks
81 * the address range as valid without changing the data.
82 * In this case application software can assume that an
83 * interrupted write will either return the new good
84 * data or an error.
85 *
86 * However, if pmem_clear_poison() leaves the data in an
87 * indeterminate state we need to perform the write
88 * after clear poison.
89 */
9e853f23 90 flush_dcache_page(page);
61031952 91 memcpy_to_pmem(pmem_addr, mem + off, len);
59e64739
DW
92 if (unlikely(bad_pmem)) {
93 pmem_clear_poison(pmem, pmem_off, len);
94 memcpy_to_pmem(pmem_addr, mem + off, len);
95 }
9e853f23
RZ
96 }
97
98 kunmap_atomic(mem);
b5ebc8ec 99 return rc;
9e853f23
RZ
100}
101
dece1635 102static blk_qc_t pmem_make_request(struct request_queue *q, struct bio *bio)
9e853f23 103{
e10624f8 104 int rc = 0;
f0dc089c
DW
105 bool do_acct;
106 unsigned long start;
9e853f23 107 struct bio_vec bvec;
9e853f23 108 struct bvec_iter iter;
bd842b8c 109 struct pmem_device *pmem = q->queuedata;
9e853f23 110
f0dc089c 111 do_acct = nd_iostat_start(bio, &start);
e10624f8
DW
112 bio_for_each_segment(bvec, bio, iter) {
113 rc = pmem_do_bvec(pmem, bvec.bv_page, bvec.bv_len,
114 bvec.bv_offset, bio_data_dir(bio),
115 iter.bi_sector);
116 if (rc) {
117 bio->bi_error = rc;
118 break;
119 }
120 }
f0dc089c
DW
121 if (do_acct)
122 nd_iostat_end(bio, start);
61031952
RZ
123
124 if (bio_data_dir(bio))
125 wmb_pmem();
126
4246a0b6 127 bio_endio(bio);
dece1635 128 return BLK_QC_T_NONE;
9e853f23
RZ
129}
130
131static int pmem_rw_page(struct block_device *bdev, sector_t sector,
132 struct page *page, int rw)
133{
bd842b8c 134 struct pmem_device *pmem = bdev->bd_queue->queuedata;
e10624f8 135 int rc;
9e853f23 136
09cbfeaf 137 rc = pmem_do_bvec(pmem, page, PAGE_SIZE, 0, rw, sector);
ba8fe0f8
RZ
138 if (rw & WRITE)
139 wmb_pmem();
9e853f23 140
e10624f8
DW
141 /*
142 * The ->rw_page interface is subtle and tricky. The core
143 * retries on any error, so we can only invoke page_endio() in
144 * the successful completion case. Otherwise, we'll see crashes
145 * caused by double completion.
146 */
147 if (rc == 0)
148 page_endio(page, rw & WRITE, 0);
149
150 return rc;
9e853f23
RZ
151}
152
f295e53b
DW
153/* see "strong" declaration in tools/testing/nvdimm/pmem-dax.c */
154__weak long pmem_direct_access(struct block_device *bdev, sector_t sector,
0a70bd43 155 void __pmem **kaddr, pfn_t *pfn, long size)
9e853f23 156{
bd842b8c 157 struct pmem_device *pmem = bdev->bd_queue->queuedata;
32ab0a3f 158 resource_size_t offset = sector * 512 + pmem->data_offset;
589e75d1 159
0a70bd43
DW
160 if (unlikely(is_bad_pmem(&pmem->bb, sector, size)))
161 return -EIO;
e2e05394 162 *kaddr = pmem->virt_addr + offset;
34c0fd54 163 *pfn = phys_to_pfn_t(pmem->phys_addr + offset, pmem->pfn_flags);
9e853f23 164
0a70bd43
DW
165 /*
166 * If badblocks are present, limit known good range to the
167 * requested range.
168 */
169 if (unlikely(pmem->bb.count))
170 return size;
cfe30b87 171 return pmem->size - pmem->pfn_pad - offset;
9e853f23
RZ
172}
173
174static const struct block_device_operations pmem_fops = {
175 .owner = THIS_MODULE,
176 .rw_page = pmem_rw_page,
177 .direct_access = pmem_direct_access,
58138820 178 .revalidate_disk = nvdimm_revalidate_disk,
9e853f23
RZ
179};
180
030b99e3
DW
181static void pmem_release_queue(void *q)
182{
183 blk_cleanup_queue(q);
184}
185
f02716db 186static void pmem_release_disk(void *disk)
030b99e3
DW
187{
188 del_gendisk(disk);
189 put_disk(disk);
190}
191
200c79da
DW
192static int pmem_attach_disk(struct device *dev,
193 struct nd_namespace_common *ndns)
9e853f23 194{
200c79da
DW
195 struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
196 struct vmem_altmap __altmap, *altmap = NULL;
197 struct resource *res = &nsio->res;
198 struct nd_pfn *nd_pfn = NULL;
199 int nid = dev_to_node(dev);
200 struct nd_pfn_sb *pfn_sb;
9e853f23 201 struct pmem_device *pmem;
200c79da 202 struct resource pfn_res;
468ded03 203 struct request_queue *q;
200c79da
DW
204 struct gendisk *disk;
205 void *addr;
206
207 /* while nsio_rw_bytes is active, parse a pfn info block if present */
208 if (is_nd_pfn(dev)) {
209 nd_pfn = to_nd_pfn(dev);
210 altmap = nvdimm_setup_pfn(nd_pfn, &pfn_res, &__altmap);
211 if (IS_ERR(altmap))
212 return PTR_ERR(altmap);
213 }
214
215 /* we're attaching a block device, disable raw namespace access */
216 devm_nsio_disable(dev, nsio);
9e853f23 217
708ab62b 218 pmem = devm_kzalloc(dev, sizeof(*pmem), GFP_KERNEL);
9e853f23 219 if (!pmem)
200c79da 220 return -ENOMEM;
9e853f23 221
200c79da 222 dev_set_drvdata(dev, pmem);
9e853f23
RZ
223 pmem->phys_addr = res->start;
224 pmem->size = resource_size(res);
96601adb 225 if (!arch_has_wmb_pmem())
61031952 226 dev_warn(dev, "unable to guarantee persistence of writes\n");
9e853f23 227
947df02d
DW
228 if (!devm_request_mem_region(dev, res->start, resource_size(res),
229 dev_name(dev))) {
230 dev_warn(dev, "could not reserve region %pR\n", res);
200c79da 231 return -EBUSY;
9e853f23
RZ
232 }
233
468ded03
DW
234 q = blk_alloc_queue_node(GFP_KERNEL, dev_to_node(dev));
235 if (!q)
200c79da 236 return -ENOMEM;
468ded03 237
34c0fd54 238 pmem->pfn_flags = PFN_DEV;
200c79da
DW
239 if (is_nd_pfn(dev)) {
240 addr = devm_memremap_pages(dev, &pfn_res, &q->q_usage_counter,
241 altmap);
242 pfn_sb = nd_pfn->pfn_sb;
243 pmem->data_offset = le64_to_cpu(pfn_sb->dataoff);
244 pmem->pfn_pad = resource_size(res) - resource_size(&pfn_res);
245 pmem->pfn_flags |= PFN_MAP;
246 res = &pfn_res; /* for badblocks populate */
247 res->start += pmem->data_offset;
248 } else if (pmem_should_map_pages(dev)) {
249 addr = devm_memremap_pages(dev, &nsio->res,
5c2c2587 250 &q->q_usage_counter, NULL);
34c0fd54
DW
251 pmem->pfn_flags |= PFN_MAP;
252 } else
200c79da
DW
253 addr = devm_memremap(dev, pmem->phys_addr,
254 pmem->size, ARCH_MEMREMAP_PMEM);
b36f4761 255
030b99e3
DW
256 /*
257 * At release time the queue must be dead before
258 * devm_memremap_pages is unwound
259 */
f02716db 260 if (devm_add_action_or_reset(dev, pmem_release_queue, q))
200c79da 261 return -ENOMEM;
8c2f7e86 262
200c79da
DW
263 if (IS_ERR(addr))
264 return PTR_ERR(addr);
265 pmem->virt_addr = (void __pmem *) addr;
9e853f23 266
5a92289f
DW
267 blk_queue_make_request(q, pmem_make_request);
268 blk_queue_physical_block_size(q, PAGE_SIZE);
269 blk_queue_max_hw_sectors(q, UINT_MAX);
270 blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
271 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, q);
272 q->queuedata = pmem;
9e853f23 273
538ea4aa 274 disk = alloc_disk_node(0, nid);
030b99e3
DW
275 if (!disk)
276 return -ENOMEM;
9e853f23 277
9e853f23 278 disk->fops = &pmem_fops;
5a92289f 279 disk->queue = q;
9e853f23 280 disk->flags = GENHD_FL_EXT_DEVT;
5212e11f 281 nvdimm_namespace_disk_name(ndns, disk->disk_name);
32ab0a3f 282 disk->driverfs_dev = dev;
cfe30b87
DW
283 set_capacity(disk, (pmem->size - pmem->pfn_pad - pmem->data_offset)
284 / 512);
b95f5f43
DW
285 if (devm_init_badblocks(dev, &pmem->bb))
286 return -ENOMEM;
200c79da 287 nvdimm_badblocks_populate(to_nd_region(dev->parent), &pmem->bb, res);
57f7f317 288 disk->bb = &pmem->bb;
9e853f23 289 add_disk(disk);
f02716db
DW
290
291 if (devm_add_action_or_reset(dev, pmem_release_disk, disk))
292 return -ENOMEM;
293
58138820 294 revalidate_disk(disk);
9e853f23 295
8c2f7e86
DW
296 return 0;
297}
9e853f23 298
9f53f9fa 299static int nd_pmem_probe(struct device *dev)
9e853f23 300{
8c2f7e86 301 struct nd_namespace_common *ndns;
9e853f23 302
8c2f7e86
DW
303 ndns = nvdimm_namespace_common_probe(dev);
304 if (IS_ERR(ndns))
305 return PTR_ERR(ndns);
bf9bccc1 306
200c79da
DW
307 if (devm_nsio_enable(dev, to_nd_namespace_io(&ndns->dev)))
308 return -ENXIO;
708ab62b 309
200c79da 310 if (is_nd_btt(dev))
708ab62b
CH
311 return nvdimm_namespace_attach_btt(ndns);
312
32ab0a3f 313 if (is_nd_pfn(dev))
200c79da 314 return pmem_attach_disk(dev, ndns);
32ab0a3f 315
200c79da 316 /* if we find a valid info-block we'll come back as that personality */
c5ed9268
DW
317 if (nd_btt_probe(dev, ndns) == 0 || nd_pfn_probe(dev, ndns) == 0
318 || nd_dax_probe(dev, ndns) == 0)
32ab0a3f 319 return -ENXIO;
32ab0a3f 320
200c79da
DW
321 /* ...otherwise we're just a raw pmem device */
322 return pmem_attach_disk(dev, ndns);
9e853f23
RZ
323}
324
9f53f9fa 325static int nd_pmem_remove(struct device *dev)
9e853f23 326{
8c2f7e86 327 if (is_nd_btt(dev))
298f2bc5 328 nvdimm_namespace_detach_btt(to_nd_btt(dev));
9e853f23
RZ
329 return 0;
330}
331
71999466
DW
332static void nd_pmem_notify(struct device *dev, enum nvdimm_event event)
333{
a3901802 334 struct nd_region *nd_region = to_nd_region(dev->parent);
298f2bc5
DW
335 struct pmem_device *pmem = dev_get_drvdata(dev);
336 resource_size_t offset = 0, end_trunc = 0;
337 struct nd_namespace_common *ndns;
338 struct nd_namespace_io *nsio;
339 struct resource res;
71999466
DW
340
341 if (event != NVDIMM_REVALIDATE_POISON)
342 return;
343
298f2bc5
DW
344 if (is_nd_btt(dev)) {
345 struct nd_btt *nd_btt = to_nd_btt(dev);
346
347 ndns = nd_btt->ndns;
348 } else if (is_nd_pfn(dev)) {
a3901802
DW
349 struct nd_pfn *nd_pfn = to_nd_pfn(dev);
350 struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
351
298f2bc5
DW
352 ndns = nd_pfn->ndns;
353 offset = pmem->data_offset + __le32_to_cpu(pfn_sb->start_pad);
354 end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
355 } else
356 ndns = to_ndns(dev);
a3901802 357
298f2bc5
DW
358 nsio = to_nd_namespace_io(&ndns->dev);
359 res.start = nsio->res.start + offset;
360 res.end = nsio->res.end - end_trunc;
a3901802 361 nvdimm_badblocks_populate(nd_region, &pmem->bb, &res);
71999466
DW
362}
363
9f53f9fa
DW
364MODULE_ALIAS("pmem");
365MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_IO);
bf9bccc1 366MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_PMEM);
9f53f9fa
DW
367static struct nd_device_driver nd_pmem_driver = {
368 .probe = nd_pmem_probe,
369 .remove = nd_pmem_remove,
71999466 370 .notify = nd_pmem_notify,
9f53f9fa
DW
371 .drv = {
372 .name = "nd_pmem",
9e853f23 373 },
bf9bccc1 374 .type = ND_DRIVER_NAMESPACE_IO | ND_DRIVER_NAMESPACE_PMEM,
9e853f23
RZ
375};
376
377static int __init pmem_init(void)
378{
55155291 379 return nd_driver_register(&nd_pmem_driver);
9e853f23
RZ
380}
381module_init(pmem_init);
382
383static void pmem_exit(void)
384{
9f53f9fa 385 driver_unregister(&nd_pmem_driver.drv);
9e853f23
RZ
386}
387module_exit(pmem_exit);
388
389MODULE_AUTHOR("Ross Zwisler <ross.zwisler@linux.intel.com>");
390MODULE_LICENSE("GPL v2");
This page took 0.081731 seconds and 5 git commands to generate.