Merge tag 'xsa448-6.8-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/xen/tip
[linux-block.git] / drivers / nvdimm / pmem.c
CommitLineData
2025cf9e 1// SPDX-License-Identifier: GPL-2.0-only
9e853f23
RZ
2/*
3 * Persistent Memory Driver
4 *
9f53f9fa 5 * Copyright (c) 2014-2015, Intel Corporation.
9e853f23
RZ
6 * Copyright (c) 2015, Christoph Hellwig <hch@lst.de>.
7 * Copyright (c) 2015, Boaz Harrosh <boaz@plexistor.com>.
9e853f23
RZ
8 */
9
9e853f23 10#include <linux/blkdev.h>
4ee60ec1 11#include <linux/pagemap.h>
9e853f23
RZ
12#include <linux/hdreg.h>
13#include <linux/init.h>
14#include <linux/platform_device.h>
c953cc98 15#include <linux/set_memory.h>
9e853f23
RZ
16#include <linux/module.h>
17#include <linux/moduleparam.h>
b95f5f43 18#include <linux/badblocks.h>
9476df7d 19#include <linux/memremap.h>
44f23dab 20#include <linux/kstrtox.h>
32ab0a3f 21#include <linux/vmalloc.h>
71389703 22#include <linux/blk-mq.h>
34c0fd54 23#include <linux/pfn_t.h>
9e853f23 24#include <linux/slab.h>
0aed55af 25#include <linux/uio.h>
c1d6e828 26#include <linux/dax.h>
9f53f9fa 27#include <linux/nd.h>
e0cf615d
CH
28#include <linux/mm.h>
29#include <asm/cacheflush.h>
f295e53b 30#include "pmem.h"
2361db89 31#include "btt.h"
32ab0a3f 32#include "pfn.h"
9f53f9fa 33#include "nd.h"
9e853f23 34
f284a4f2
DW
35static struct device *to_dev(struct pmem_device *pmem)
36{
37 /*
38 * nvdimm bus services need a 'dev' parameter, and we record the device
39 * at init in bb.dev.
40 */
41 return pmem->bb.dev;
42}
43
44static struct nd_region *to_region(struct pmem_device *pmem)
45{
46 return to_nd_region(to_dev(pmem)->parent);
47}
9e853f23 48
149d1714 49static phys_addr_t pmem_to_phys(struct pmem_device *pmem, phys_addr_t offset)
c953cc98 50{
9409c9b6
JC
51 return pmem->phys_addr + offset;
52}
53
54static sector_t to_sect(struct pmem_device *pmem, phys_addr_t offset)
55{
56 return (offset - pmem->data_offset) >> SECTOR_SHIFT;
57}
58
59static phys_addr_t to_offset(struct pmem_device *pmem, sector_t sector)
60{
61 return (sector << SECTOR_SHIFT) + pmem->data_offset;
62}
63
64static void pmem_mkpage_present(struct pmem_device *pmem, phys_addr_t offset,
65 unsigned int len)
66{
149d1714 67 phys_addr_t phys = pmem_to_phys(pmem, offset);
c953cc98
DW
68 unsigned long pfn_start, pfn_end, pfn;
69
70 /* only pmem in the linear map supports HWPoison */
71 if (is_vmalloc_addr(pmem->virt_addr))
72 return;
73
74 pfn_start = PHYS_PFN(phys);
75 pfn_end = pfn_start + PHYS_PFN(len);
76 for (pfn = pfn_start; pfn < pfn_end; pfn++) {
77 struct page *page = pfn_to_page(pfn);
78
79 /*
80 * Note, no need to hold a get_dev_pagemap() reference
81 * here since we're in the driver I/O path and
82 * outstanding I/O requests pin the dev_pagemap.
83 */
84 if (test_and_clear_pmem_poison(page))
85 clear_mce_nospec(pfn);
86 }
87}
88
9409c9b6 89static void pmem_clear_bb(struct pmem_device *pmem, sector_t sector, long blks)
59e64739 90{
9409c9b6
JC
91 if (blks == 0)
92 return;
93 badblocks_clear(&pmem->bb, sector, blks);
94 if (pmem->bb_state)
95 sysfs_notify_dirent(pmem->bb_state);
96}
59e64739 97
9409c9b6
JC
98static long __pmem_clear_poison(struct pmem_device *pmem,
99 phys_addr_t offset, unsigned int len)
100{
149d1714 101 phys_addr_t phys = pmem_to_phys(pmem, offset);
9409c9b6 102 long cleared = nvdimm_clear_poison(to_dev(pmem), phys, len);
59e64739 103
9409c9b6
JC
104 if (cleared > 0) {
105 pmem_mkpage_present(pmem, offset, cleared);
106 arch_invalidate_pmem(pmem->virt_addr + offset, len);
59e64739 107 }
9409c9b6
JC
108 return cleared;
109}
3115bb02 110
9409c9b6
JC
111static blk_status_t pmem_clear_poison(struct pmem_device *pmem,
112 phys_addr_t offset, unsigned int len)
113{
114 long cleared = __pmem_clear_poison(pmem, offset, len);
868f036f 115
9409c9b6
JC
116 if (cleared < 0)
117 return BLK_STS_IOERR;
118
119 pmem_clear_bb(pmem, to_sect(pmem, offset), cleared >> SECTOR_SHIFT);
120 if (cleared < len)
121 return BLK_STS_IOERR;
122 return BLK_STS_OK;
59e64739
DW
123}
124
bd697a80
VV
125static void write_pmem(void *pmem_addr, struct page *page,
126 unsigned int off, unsigned int len)
127{
98cc093c
HY
128 unsigned int chunk;
129 void *mem;
130
131 while (len) {
132 mem = kmap_atomic(page);
9dc6488e 133 chunk = min_t(unsigned int, len, PAGE_SIZE - off);
98cc093c
HY
134 memcpy_flushcache(pmem_addr, mem + off, chunk);
135 kunmap_atomic(mem);
136 len -= chunk;
137 off = 0;
138 page++;
9dc6488e 139 pmem_addr += chunk;
98cc093c 140 }
bd697a80
VV
141}
142
4e4cbee9 143static blk_status_t read_pmem(struct page *page, unsigned int off,
bd697a80
VV
144 void *pmem_addr, unsigned int len)
145{
98cc093c 146 unsigned int chunk;
60622d68 147 unsigned long rem;
98cc093c
HY
148 void *mem;
149
150 while (len) {
151 mem = kmap_atomic(page);
9dc6488e 152 chunk = min_t(unsigned int, len, PAGE_SIZE - off);
ec6347bb 153 rem = copy_mc_to_kernel(mem + off, pmem_addr, chunk);
98cc093c 154 kunmap_atomic(mem);
60622d68 155 if (rem)
98cc093c
HY
156 return BLK_STS_IOERR;
157 len -= chunk;
158 off = 0;
159 page++;
9dc6488e 160 pmem_addr += chunk;
98cc093c 161 }
4e4cbee9 162 return BLK_STS_OK;
bd697a80
VV
163}
164
5d64efe7
VG
165static blk_status_t pmem_do_read(struct pmem_device *pmem,
166 struct page *page, unsigned int page_off,
167 sector_t sector, unsigned int len)
168{
169 blk_status_t rc;
9409c9b6 170 phys_addr_t pmem_off = to_offset(pmem, sector);
5d64efe7
VG
171 void *pmem_addr = pmem->virt_addr + pmem_off;
172
173 if (unlikely(is_bad_pmem(&pmem->bb, sector, len)))
174 return BLK_STS_IOERR;
175
176 rc = read_pmem(page, page_off, pmem_addr, len);
177 flush_dcache_page(page);
178 return rc;
179}
180
181static blk_status_t pmem_do_write(struct pmem_device *pmem,
182 struct page *page, unsigned int page_off,
183 sector_t sector, unsigned int len)
9e853f23 184{
9409c9b6 185 phys_addr_t pmem_off = to_offset(pmem, sector);
7a9eb206 186 void *pmem_addr = pmem->virt_addr + pmem_off;
9e853f23 187
5898b43a
JC
188 if (unlikely(is_bad_pmem(&pmem->bb, sector, len))) {
189 blk_status_t rc = pmem_clear_poison(pmem, pmem_off, len);
190
191 if (rc != BLK_STS_OK)
192 return rc;
193 }
59e64739 194
5d64efe7
VG
195 flush_dcache_page(page);
196 write_pmem(pmem_addr, page, page_off, len);
9e853f23 197
5898b43a 198 return BLK_STS_OK;
9e853f23
RZ
199}
200
3e08773c 201static void pmem_submit_bio(struct bio *bio)
9e853f23 202{
c5d4355d 203 int ret = 0;
4e4cbee9 204 blk_status_t rc = 0;
f0dc089c
DW
205 bool do_acct;
206 unsigned long start;
9e853f23 207 struct bio_vec bvec;
9e853f23 208 struct bvec_iter iter;
309dca30 209 struct pmem_device *pmem = bio->bi_bdev->bd_disk->private_data;
7e267a8c
DW
210 struct nd_region *nd_region = to_region(pmem);
211
d2d6364d 212 if (bio->bi_opf & REQ_PREFLUSH)
c5d4355d 213 ret = nvdimm_flush(nd_region, bio);
9e853f23 214
309dca30 215 do_acct = blk_queue_io_stat(bio->bi_bdev->bd_disk->queue);
0fd92f89
CH
216 if (do_acct)
217 start = bio_start_io_acct(bio);
e10624f8 218 bio_for_each_segment(bvec, bio, iter) {
5d64efe7
VG
219 if (op_is_write(bio_op(bio)))
220 rc = pmem_do_write(pmem, bvec.bv_page, bvec.bv_offset,
221 iter.bi_sector, bvec.bv_len);
222 else
223 rc = pmem_do_read(pmem, bvec.bv_page, bvec.bv_offset,
224 iter.bi_sector, bvec.bv_len);
e10624f8 225 if (rc) {
4e4cbee9 226 bio->bi_status = rc;
e10624f8
DW
227 break;
228 }
229 }
f0dc089c 230 if (do_acct)
0fd92f89 231 bio_end_io_acct(bio, start);
61031952 232
1eff9d32 233 if (bio->bi_opf & REQ_FUA)
c5d4355d
PG
234 ret = nvdimm_flush(nd_region, bio);
235
236 if (ret)
237 bio->bi_status = errno_to_blk_status(ret);
61031952 238
4246a0b6 239 bio_endio(bio);
9e853f23
RZ
240}
241
f295e53b 242/* see "strong" declaration in tools/testing/nvdimm/pmem-dax.c */
c1d6e828 243__weak long __pmem_direct_access(struct pmem_device *pmem, pgoff_t pgoff,
e511c4a3
JC
244 long nr_pages, enum dax_access_mode mode, void **kaddr,
245 pfn_t *pfn)
9e853f23 246{
c1d6e828 247 resource_size_t offset = PFN_PHYS(pgoff) + pmem->data_offset;
f42e8e50
JC
248 sector_t sector = PFN_PHYS(pgoff) >> SECTOR_SHIFT;
249 unsigned int num = PFN_PHYS(nr_pages) >> SECTOR_SHIFT;
250 struct badblocks *bb = &pmem->bb;
251 sector_t first_bad;
252 int num_bad;
46a590cd
HY
253
254 if (kaddr)
255 *kaddr = pmem->virt_addr + offset;
256 if (pfn)
257 *pfn = phys_to_pfn_t(pmem->phys_addr + offset, pmem->pfn_flags);
9e853f23 258
f42e8e50
JC
259 if (bb->count &&
260 badblocks_check(bb, sector, num, &first_bad, &num_bad)) {
261 long actual_nr;
262
263 if (mode != DAX_RECOVERY_WRITE)
1ea7ca1b 264 return -EHWPOISON;
f42e8e50
JC
265
266 /*
267 * Set the recovery stride is set to kernel page size because
268 * the underlying driver and firmware clear poison functions
269 * don't appear to handle large chunk(such as 2MiB) reliably.
270 */
271 actual_nr = PHYS_PFN(
272 PAGE_ALIGN((first_bad - sector) << SECTOR_SHIFT));
273 dev_dbg(pmem->bb.dev, "start sector(%llu), nr_pages(%ld), first_bad(%llu), actual_nr(%ld)\n",
274 sector, nr_pages, first_bad, actual_nr);
275 if (actual_nr)
276 return actual_nr;
277 return 1;
278 }
279
0a70bd43 280 /*
f42e8e50
JC
281 * If badblocks are present but not in the range, limit known good range
282 * to the requested range.
0a70bd43 283 */
f42e8e50 284 if (bb->count)
c1d6e828
DW
285 return nr_pages;
286 return PHYS_PFN(pmem->size - pmem->pfn_pad - offset);
9e853f23
RZ
287}
288
289static const struct block_device_operations pmem_fops = {
290 .owner = THIS_MODULE,
c62b37d9 291 .submit_bio = pmem_submit_bio,
9e853f23
RZ
292};
293
f605a263
VG
294static int pmem_dax_zero_page_range(struct dax_device *dax_dev, pgoff_t pgoff,
295 size_t nr_pages)
296{
297 struct pmem_device *pmem = dax_get_private(dax_dev);
298
299 return blk_status_to_errno(pmem_do_write(pmem, ZERO_PAGE(0), 0,
300 PFN_PHYS(pgoff) >> SECTOR_SHIFT,
301 PAGE_SIZE));
302}
303
c1d6e828 304static long pmem_dax_direct_access(struct dax_device *dax_dev,
e511c4a3
JC
305 pgoff_t pgoff, long nr_pages, enum dax_access_mode mode,
306 void **kaddr, pfn_t *pfn)
c1d6e828
DW
307{
308 struct pmem_device *pmem = dax_get_private(dax_dev);
309
e511c4a3 310 return __pmem_direct_access(pmem, pgoff, nr_pages, mode, kaddr, pfn);
c1d6e828
DW
311}
312
f42e8e50
JC
313/*
314 * The recovery write thread started out as a normal pwrite thread and
315 * when the filesystem was told about potential media error in the
316 * range, filesystem turns the normal pwrite to a dax_recovery_write.
317 *
318 * The recovery write consists of clearing media poison, clearing page
319 * HWPoison bit, reenable page-wide read-write permission, flush the
320 * caches and finally write. A competing pread thread will be held
321 * off during the recovery process since data read back might not be
322 * valid, and this is achieved by clearing the badblock records after
323 * the recovery write is complete. Competing recovery write threads
324 * are already serialized by writer lock held by dax_iomap_rw().
325 */
047218ec
JC
326static size_t pmem_recovery_write(struct dax_device *dax_dev, pgoff_t pgoff,
327 void *addr, size_t bytes, struct iov_iter *i)
328{
f42e8e50
JC
329 struct pmem_device *pmem = dax_get_private(dax_dev);
330 size_t olen, len, off;
331 phys_addr_t pmem_off;
332 struct device *dev = pmem->bb.dev;
333 long cleared;
334
335 off = offset_in_page(addr);
336 len = PFN_PHYS(PFN_UP(off + bytes));
337 if (!is_bad_pmem(&pmem->bb, PFN_PHYS(pgoff) >> SECTOR_SHIFT, len))
338 return _copy_from_iter_flushcache(addr, bytes, i);
339
340 /*
341 * Not page-aligned range cannot be recovered. This should not
342 * happen unless something else went wrong.
343 */
344 if (off || !PAGE_ALIGNED(bytes)) {
345 dev_dbg(dev, "Found poison, but addr(%p) or bytes(%#zx) not page aligned\n",
346 addr, bytes);
347 return 0;
348 }
349
350 pmem_off = PFN_PHYS(pgoff) + pmem->data_offset;
351 cleared = __pmem_clear_poison(pmem, pmem_off, len);
352 if (cleared > 0 && cleared < len) {
353 dev_dbg(dev, "poison cleared only %ld out of %zu bytes\n",
354 cleared, len);
355 return 0;
356 }
357 if (cleared < 0) {
358 dev_dbg(dev, "poison clear failed: %ld\n", cleared);
359 return 0;
360 }
361
362 olen = _copy_from_iter_flushcache(addr, bytes, i);
363 pmem_clear_bb(pmem, to_sect(pmem, pmem_off), cleared >> SECTOR_SHIFT);
364
365 return olen;
047218ec
JC
366}
367
c1d6e828
DW
368static const struct dax_operations pmem_dax_ops = {
369 .direct_access = pmem_dax_direct_access,
f605a263 370 .zero_page_range = pmem_dax_zero_page_range,
047218ec 371 .recovery_write = pmem_recovery_write,
c1d6e828
DW
372};
373
e765f13e
CH
374static ssize_t write_cache_show(struct device *dev,
375 struct device_attribute *attr, char *buf)
376{
377 struct pmem_device *pmem = dev_to_disk(dev)->private_data;
378
379 return sprintf(buf, "%d\n", !!dax_write_cache_enabled(pmem->dax_dev));
380}
381
382static ssize_t write_cache_store(struct device *dev,
383 struct device_attribute *attr, const char *buf, size_t len)
384{
385 struct pmem_device *pmem = dev_to_disk(dev)->private_data;
386 bool write_cache;
387 int rc;
388
44f23dab 389 rc = kstrtobool(buf, &write_cache);
e765f13e
CH
390 if (rc)
391 return rc;
392 dax_write_cache(pmem->dax_dev, write_cache);
393 return len;
394}
395static DEVICE_ATTR_RW(write_cache);
396
397static umode_t dax_visible(struct kobject *kobj, struct attribute *a, int n)
398{
399#ifndef CONFIG_ARCH_HAS_PMEM_API
400 if (a == &dev_attr_write_cache.attr)
401 return 0;
402#endif
403 return a->mode;
404}
405
406static struct attribute *dax_attributes[] = {
407 &dev_attr_write_cache.attr,
408 NULL,
409};
410
411static const struct attribute_group dax_attribute_group = {
412 .name = "dax",
413 .attrs = dax_attributes,
414 .is_visible = dax_visible,
415};
416
6e0c90d6
DW
417static const struct attribute_group *pmem_attribute_groups[] = {
418 &dax_attribute_group,
419 NULL,
c1d6e828
DW
420};
421
c1d6e828 422static void pmem_release_disk(void *__pmem)
030b99e3 423{
c1d6e828
DW
424 struct pmem_device *pmem = __pmem;
425
fb08a190 426 dax_remove_host(pmem->disk);
c1d6e828
DW
427 kill_dax(pmem->dax_dev);
428 put_dax(pmem->dax_dev);
429 del_gendisk(pmem->disk);
030b99e3 430
8b9ab626 431 put_disk(pmem->disk);
3dd60fb9 432}
1e240e8d 433
33a8f7f2
SR
434static int pmem_pagemap_memory_failure(struct dev_pagemap *pgmap,
435 unsigned long pfn, unsigned long nr_pages, int mf_flags)
436{
437 struct pmem_device *pmem =
438 container_of(pgmap, struct pmem_device, pgmap);
439 u64 offset = PFN_PHYS(pfn) - pmem->phys_addr - pmem->data_offset;
440 u64 len = nr_pages << PAGE_SHIFT;
441
442 return dax_holder_notify_failure(pmem->dax_dev, offset, len, mf_flags);
443}
444
445static const struct dev_pagemap_ops fsdax_pagemap_ops = {
446 .memory_failure = pmem_pagemap_memory_failure,
447};
448
200c79da
DW
449static int pmem_attach_disk(struct device *dev,
450 struct nd_namespace_common *ndns)
9e853f23 451{
200c79da 452 struct nd_namespace_io *nsio = to_nd_namespace_io(&ndns->dev);
f284a4f2 453 struct nd_region *nd_region = to_nd_region(dev->parent);
ce7f11a2 454 int nid = dev_to_node(dev), fua;
200c79da 455 struct resource *res = &nsio->res;
a4574f63 456 struct range bb_range;
200c79da 457 struct nd_pfn *nd_pfn = NULL;
c1d6e828 458 struct dax_device *dax_dev;
200c79da 459 struct nd_pfn_sb *pfn_sb;
9e853f23 460 struct pmem_device *pmem;
468ded03 461 struct request_queue *q;
200c79da
DW
462 struct gendisk *disk;
463 void *addr;
e8d51348
CH
464 int rc;
465
466 pmem = devm_kzalloc(dev, sizeof(*pmem), GFP_KERNEL);
467 if (!pmem)
468 return -ENOMEM;
200c79da 469
8f4b01fc
AK
470 rc = devm_namespace_enable(dev, ndns, nd_info_block_reserve());
471 if (rc)
472 return rc;
473
200c79da
DW
474 /* while nsio_rw_bytes is active, parse a pfn info block if present */
475 if (is_nd_pfn(dev)) {
476 nd_pfn = to_nd_pfn(dev);
e8d51348
CH
477 rc = nvdimm_setup_pfn(nd_pfn, &pmem->pgmap);
478 if (rc)
479 return rc;
200c79da
DW
480 }
481
482 /* we're attaching a block device, disable raw namespace access */
8f4b01fc 483 devm_namespace_disable(dev, ndns);
9e853f23 484
200c79da 485 dev_set_drvdata(dev, pmem);
9e853f23
RZ
486 pmem->phys_addr = res->start;
487 pmem->size = resource_size(res);
0b277961
DW
488 fua = nvdimm_has_flush(nd_region);
489 if (!IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) || fua < 0) {
61031952 490 dev_warn(dev, "unable to guarantee persistence of writes\n");
0b277961
DW
491 fua = 0;
492 }
9e853f23 493
947df02d 494 if (!devm_request_mem_region(dev, res->start, resource_size(res),
450c6633 495 dev_name(&ndns->dev))) {
947df02d 496 dev_warn(dev, "could not reserve region %pR\n", res);
200c79da 497 return -EBUSY;
9e853f23
RZ
498 }
499
87eb73b2
CH
500 disk = blk_alloc_disk(nid);
501 if (!disk)
200c79da 502 return -ENOMEM;
87eb73b2 503 q = disk->queue;
468ded03 504
87eb73b2 505 pmem->disk = disk;
a624eb52 506 pmem->pgmap.owner = pmem;
34c0fd54 507 pmem->pfn_flags = PFN_DEV;
200c79da 508 if (is_nd_pfn(dev)) {
f6a55e1a 509 pmem->pgmap.type = MEMORY_DEVICE_FS_DAX;
33a8f7f2 510 pmem->pgmap.ops = &fsdax_pagemap_ops;
e8d51348 511 addr = devm_memremap_pages(dev, &pmem->pgmap);
200c79da
DW
512 pfn_sb = nd_pfn->pfn_sb;
513 pmem->data_offset = le64_to_cpu(pfn_sb->dataoff);
e8d51348 514 pmem->pfn_pad = resource_size(res) -
a4574f63 515 range_len(&pmem->pgmap.range);
200c79da 516 pmem->pfn_flags |= PFN_MAP;
a4574f63
DW
517 bb_range = pmem->pgmap.range;
518 bb_range.start += pmem->data_offset;
200c79da 519 } else if (pmem_should_map_pages(dev)) {
a4574f63
DW
520 pmem->pgmap.range.start = res->start;
521 pmem->pgmap.range.end = res->end;
b7b3c01b 522 pmem->pgmap.nr_range = 1;
f6a55e1a 523 pmem->pgmap.type = MEMORY_DEVICE_FS_DAX;
33a8f7f2 524 pmem->pgmap.ops = &fsdax_pagemap_ops;
e8d51348 525 addr = devm_memremap_pages(dev, &pmem->pgmap);
34c0fd54 526 pmem->pfn_flags |= PFN_MAP;
a4574f63 527 bb_range = pmem->pgmap.range;
91ed7ac4 528 } else {
32b2397c 529 addr = devm_memremap(dev, pmem->phys_addr,
530 pmem->size, ARCH_MEMREMAP_PMEM);
a4574f63
DW
531 bb_range.start = res->start;
532 bb_range.end = res->end;
91ed7ac4 533 }
b36f4761 534
accf58af
LC
535 if (IS_ERR(addr)) {
536 rc = PTR_ERR(addr);
537 goto out;
538 }
7a9eb206 539 pmem->virt_addr = addr;
9e853f23 540
ce7f11a2 541 blk_queue_write_cache(q, true, fua);
5a92289f 542 blk_queue_physical_block_size(q, PAGE_SIZE);
f979b13c 543 blk_queue_logical_block_size(q, pmem_sector_size(ndns));
5a92289f 544 blk_queue_max_hw_sectors(q, UINT_MAX);
8b904b5b 545 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
3222d8c2 546 blk_queue_flag_set(QUEUE_FLAG_SYNCHRONOUS, q);
4557641b
RZ
547 if (pmem->pfn_flags & PFN_MAP)
548 blk_queue_flag_set(QUEUE_FLAG_DAX, q);
9e853f23 549
9e853f23 550 disk->fops = &pmem_fops;
6ec26b8b 551 disk->private_data = pmem;
5212e11f 552 nvdimm_namespace_disk_name(ndns, disk->disk_name);
cfe30b87
DW
553 set_capacity(disk, (pmem->size - pmem->pfn_pad - pmem->data_offset)
554 / 512);
b95f5f43
DW
555 if (devm_init_badblocks(dev, &pmem->bb))
556 return -ENOMEM;
a4574f63 557 nvdimm_badblocks_populate(nd_region, &pmem->bb, &bb_range);
57f7f317 558 disk->bb = &pmem->bb;
f02716db 559
30c6828a 560 dax_dev = alloc_dax(pmem, &pmem_dax_ops);
4e4ced93 561 if (IS_ERR(dax_dev)) {
accf58af
LC
562 rc = PTR_ERR(dax_dev);
563 goto out;
c1d6e828 564 }
7ac5360c
CH
565 set_dax_nocache(dax_dev);
566 set_dax_nomc(dax_dev);
30c6828a
CH
567 if (is_nvdimm_sync(nd_region))
568 set_dax_synchronous(dax_dev);
fb08a190
CH
569 rc = dax_add_host(dax_dev, disk);
570 if (rc)
571 goto out_cleanup_dax;
ce7f11a2 572 dax_write_cache(dax_dev, nvdimm_has_cache(nd_region));
c1d6e828 573 pmem->dax_dev = dax_dev;
6e0c90d6 574
5a192ccc
LC
575 rc = device_add_disk(dev, disk, pmem_attribute_groups);
576 if (rc)
fb08a190 577 goto out_remove_host;
c1d6e828 578 if (devm_add_action_or_reset(dev, pmem_release_disk, pmem))
f02716db
DW
579 return -ENOMEM;
580
32f61d67 581 nvdimm_check_and_set_ro(disk);
9e853f23 582
975750a9
TK
583 pmem->bb_state = sysfs_get_dirent(disk_to_dev(disk)->kobj.sd,
584 "badblocks");
6aa734a2
DW
585 if (!pmem->bb_state)
586 dev_warn(dev, "'badblocks' notification disabled\n");
8c2f7e86 587 return 0;
5a192ccc 588
fb08a190
CH
589out_remove_host:
590 dax_remove_host(pmem->disk);
5a192ccc
LC
591out_cleanup_dax:
592 kill_dax(pmem->dax_dev);
593 put_dax(pmem->dax_dev);
accf58af 594out:
8b9ab626 595 put_disk(pmem->disk);
accf58af 596 return rc;
8c2f7e86 597}
9e853f23 598
9f53f9fa 599static int nd_pmem_probe(struct device *dev)
9e853f23 600{
1c97afa7 601 int ret;
8c2f7e86 602 struct nd_namespace_common *ndns;
9e853f23 603
8c2f7e86
DW
604 ndns = nvdimm_namespace_common_probe(dev);
605 if (IS_ERR(ndns))
606 return PTR_ERR(ndns);
bf9bccc1 607
200c79da 608 if (is_nd_btt(dev))
708ab62b
CH
609 return nvdimm_namespace_attach_btt(ndns);
610
32ab0a3f 611 if (is_nd_pfn(dev))
200c79da 612 return pmem_attach_disk(dev, ndns);
32ab0a3f 613
8f4b01fc
AK
614 ret = devm_namespace_enable(dev, ndns, nd_info_block_reserve());
615 if (ret)
616 return ret;
617
1c97afa7
AK
618 ret = nd_btt_probe(dev, ndns);
619 if (ret == 0)
32ab0a3f 620 return -ENXIO;
32ab0a3f 621
1c97afa7
AK
622 /*
623 * We have two failure conditions here, there is no
624 * info reserver block or we found a valid info reserve block
625 * but failed to initialize the pfn superblock.
626 *
627 * For the first case consider namespace as a raw pmem namespace
628 * and attach a disk.
629 *
630 * For the latter, consider this a success and advance the namespace
631 * seed.
632 */
633 ret = nd_pfn_probe(dev, ndns);
634 if (ret == 0)
635 return -ENXIO;
636 else if (ret == -EOPNOTSUPP)
637 return ret;
638
639 ret = nd_dax_probe(dev, ndns);
640 if (ret == 0)
641 return -ENXIO;
642 else if (ret == -EOPNOTSUPP)
643 return ret;
8f4b01fc
AK
644
645 /* probe complete, attach handles namespace enabling */
646 devm_namespace_disable(dev, ndns);
647
200c79da 648 return pmem_attach_disk(dev, ndns);
9e853f23
RZ
649}
650
1f975074 651static void nd_pmem_remove(struct device *dev)
9e853f23 652{
6aa734a2
DW
653 struct pmem_device *pmem = dev_get_drvdata(dev);
654
8c2f7e86 655 if (is_nd_btt(dev))
298f2bc5 656 nvdimm_namespace_detach_btt(to_nd_btt(dev));
6aa734a2
DW
657 else {
658 /*
81beea55 659 * Note, this assumes device_lock() context to not
87a30e1f 660 * race nd_pmem_notify()
6aa734a2
DW
661 */
662 sysfs_put(pmem->bb_state);
663 pmem->bb_state = NULL;
664 }
c5d4355d 665 nvdimm_flush(to_nd_region(dev->parent), NULL);
9e853f23
RZ
666}
667
476f848a
DW
668static void nd_pmem_shutdown(struct device *dev)
669{
c5d4355d 670 nvdimm_flush(to_nd_region(dev->parent), NULL);
476f848a
DW
671}
672
2361db89 673static void pmem_revalidate_poison(struct device *dev)
71999466 674{
b2518c78 675 struct nd_region *nd_region;
298f2bc5
DW
676 resource_size_t offset = 0, end_trunc = 0;
677 struct nd_namespace_common *ndns;
678 struct nd_namespace_io *nsio;
b2518c78 679 struct badblocks *bb;
a4574f63 680 struct range range;
975750a9 681 struct kernfs_node *bb_state;
71999466 682
298f2bc5
DW
683 if (is_nd_btt(dev)) {
684 struct nd_btt *nd_btt = to_nd_btt(dev);
685
686 ndns = nd_btt->ndns;
b2518c78
TK
687 nd_region = to_nd_region(ndns->dev.parent);
688 nsio = to_nd_namespace_io(&ndns->dev);
689 bb = &nsio->bb;
975750a9 690 bb_state = NULL;
b2518c78
TK
691 } else {
692 struct pmem_device *pmem = dev_get_drvdata(dev);
a3901802 693
b2518c78
TK
694 nd_region = to_region(pmem);
695 bb = &pmem->bb;
975750a9 696 bb_state = pmem->bb_state;
b2518c78
TK
697
698 if (is_nd_pfn(dev)) {
699 struct nd_pfn *nd_pfn = to_nd_pfn(dev);
700 struct nd_pfn_sb *pfn_sb = nd_pfn->pfn_sb;
701
702 ndns = nd_pfn->ndns;
703 offset = pmem->data_offset +
704 __le32_to_cpu(pfn_sb->start_pad);
705 end_trunc = __le32_to_cpu(pfn_sb->end_trunc);
706 } else {
707 ndns = to_ndns(dev);
708 }
709
710 nsio = to_nd_namespace_io(&ndns->dev);
711 }
a3901802 712
a4574f63
DW
713 range.start = nsio->res.start + offset;
714 range.end = nsio->res.end - end_trunc;
715 nvdimm_badblocks_populate(nd_region, bb, &range);
975750a9
TK
716 if (bb_state)
717 sysfs_notify_dirent(bb_state);
71999466
DW
718}
719
2361db89
DW
720static void pmem_revalidate_region(struct device *dev)
721{
722 struct pmem_device *pmem;
723
724 if (is_nd_btt(dev)) {
725 struct nd_btt *nd_btt = to_nd_btt(dev);
726 struct btt *btt = nd_btt->btt;
727
728 nvdimm_check_and_set_ro(btt->btt_disk);
729 return;
730 }
731
732 pmem = dev_get_drvdata(dev);
733 nvdimm_check_and_set_ro(pmem->disk);
734}
735
736static void nd_pmem_notify(struct device *dev, enum nvdimm_event event)
737{
738 switch (event) {
739 case NVDIMM_REVALIDATE_POISON:
740 pmem_revalidate_poison(dev);
741 break;
742 case NVDIMM_REVALIDATE_REGION:
743 pmem_revalidate_region(dev);
744 break;
745 default:
746 dev_WARN_ONCE(dev, 1, "notify: unknown event: %d\n", event);
747 break;
748 }
749}
750
9f53f9fa
DW
751MODULE_ALIAS("pmem");
752MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_IO);
bf9bccc1 753MODULE_ALIAS_ND_DEVICE(ND_DEVICE_NAMESPACE_PMEM);
9f53f9fa
DW
754static struct nd_device_driver nd_pmem_driver = {
755 .probe = nd_pmem_probe,
756 .remove = nd_pmem_remove,
71999466 757 .notify = nd_pmem_notify,
476f848a 758 .shutdown = nd_pmem_shutdown,
9f53f9fa
DW
759 .drv = {
760 .name = "nd_pmem",
9e853f23 761 },
bf9bccc1 762 .type = ND_DRIVER_NAMESPACE_IO | ND_DRIVER_NAMESPACE_PMEM,
9e853f23
RZ
763};
764
03e90843 765module_nd_driver(nd_pmem_driver);
9e853f23
RZ
766
767MODULE_AUTHOR("Ross Zwisler <ross.zwisler@linux.intel.com>");
768MODULE_LICENSE("GPL v2");