Loading...
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
4 */
5#ifndef __ND_H__
6#define __ND_H__
7#include <linux/libnvdimm.h>
8#include <linux/badblocks.h>
9#include <linux/blkdev.h>
10#include <linux/device.h>
11#include <linux/mutex.h>
12#include <linux/ndctl.h>
13#include <linux/types.h>
14#include <linux/nd.h>
15#include "label.h"
16
17enum {
18 /*
19 * Limits the maximum number of block apertures a dimm can
20 * support and is an input to the geometry/on-disk-format of a
21 * BTT instance
22 */
23 ND_MAX_LANES = 256,
24 INT_LBASIZE_ALIGNMENT = 64,
25 NVDIMM_IO_ATOMIC = 1,
26};
27
28struct nvdimm_drvdata {
29 struct device *dev;
30 int nslabel_size;
31 struct nd_cmd_get_config_size nsarea;
32 void *data;
33 bool cxl;
34 int ns_current, ns_next;
35 struct resource dpa;
36 struct kref kref;
37};
38
39static inline const u8 *nsl_ref_name(struct nvdimm_drvdata *ndd,
40 struct nd_namespace_label *nd_label)
41{
42 if (ndd->cxl)
43 return nd_label->cxl.name;
44 return nd_label->efi.name;
45}
46
47static inline u8 *nsl_get_name(struct nvdimm_drvdata *ndd,
48 struct nd_namespace_label *nd_label, u8 *name)
49{
50 if (ndd->cxl)
51 return memcpy(name, nd_label->cxl.name, NSLABEL_NAME_LEN);
52 return memcpy(name, nd_label->efi.name, NSLABEL_NAME_LEN);
53}
54
55static inline u8 *nsl_set_name(struct nvdimm_drvdata *ndd,
56 struct nd_namespace_label *nd_label, u8 *name)
57{
58 if (!name)
59 return NULL;
60 if (ndd->cxl)
61 return memcpy(nd_label->cxl.name, name, NSLABEL_NAME_LEN);
62 return memcpy(nd_label->efi.name, name, NSLABEL_NAME_LEN);
63}
64
65static inline u32 nsl_get_slot(struct nvdimm_drvdata *ndd,
66 struct nd_namespace_label *nd_label)
67{
68 if (ndd->cxl)
69 return __le32_to_cpu(nd_label->cxl.slot);
70 return __le32_to_cpu(nd_label->efi.slot);
71}
72
73static inline void nsl_set_slot(struct nvdimm_drvdata *ndd,
74 struct nd_namespace_label *nd_label, u32 slot)
75{
76 if (ndd->cxl)
77 nd_label->cxl.slot = __cpu_to_le32(slot);
78 else
79 nd_label->efi.slot = __cpu_to_le32(slot);
80}
81
82static inline u64 nsl_get_checksum(struct nvdimm_drvdata *ndd,
83 struct nd_namespace_label *nd_label)
84{
85 if (ndd->cxl)
86 return __le64_to_cpu(nd_label->cxl.checksum);
87 return __le64_to_cpu(nd_label->efi.checksum);
88}
89
90static inline void nsl_set_checksum(struct nvdimm_drvdata *ndd,
91 struct nd_namespace_label *nd_label,
92 u64 checksum)
93{
94 if (ndd->cxl)
95 nd_label->cxl.checksum = __cpu_to_le64(checksum);
96 else
97 nd_label->efi.checksum = __cpu_to_le64(checksum);
98}
99
100static inline u32 nsl_get_flags(struct nvdimm_drvdata *ndd,
101 struct nd_namespace_label *nd_label)
102{
103 if (ndd->cxl)
104 return __le32_to_cpu(nd_label->cxl.flags);
105 return __le32_to_cpu(nd_label->efi.flags);
106}
107
108static inline void nsl_set_flags(struct nvdimm_drvdata *ndd,
109 struct nd_namespace_label *nd_label, u32 flags)
110{
111 if (ndd->cxl)
112 nd_label->cxl.flags = __cpu_to_le32(flags);
113 else
114 nd_label->efi.flags = __cpu_to_le32(flags);
115}
116
117static inline u64 nsl_get_dpa(struct nvdimm_drvdata *ndd,
118 struct nd_namespace_label *nd_label)
119{
120 if (ndd->cxl)
121 return __le64_to_cpu(nd_label->cxl.dpa);
122 return __le64_to_cpu(nd_label->efi.dpa);
123}
124
125static inline void nsl_set_dpa(struct nvdimm_drvdata *ndd,
126 struct nd_namespace_label *nd_label, u64 dpa)
127{
128 if (ndd->cxl)
129 nd_label->cxl.dpa = __cpu_to_le64(dpa);
130 else
131 nd_label->efi.dpa = __cpu_to_le64(dpa);
132}
133
134static inline u64 nsl_get_rawsize(struct nvdimm_drvdata *ndd,
135 struct nd_namespace_label *nd_label)
136{
137 if (ndd->cxl)
138 return __le64_to_cpu(nd_label->cxl.rawsize);
139 return __le64_to_cpu(nd_label->efi.rawsize);
140}
141
142static inline void nsl_set_rawsize(struct nvdimm_drvdata *ndd,
143 struct nd_namespace_label *nd_label,
144 u64 rawsize)
145{
146 if (ndd->cxl)
147 nd_label->cxl.rawsize = __cpu_to_le64(rawsize);
148 else
149 nd_label->efi.rawsize = __cpu_to_le64(rawsize);
150}
151
152static inline u64 nsl_get_isetcookie(struct nvdimm_drvdata *ndd,
153 struct nd_namespace_label *nd_label)
154{
155 /* WARN future refactor attempts that break this assumption */
156 if (dev_WARN_ONCE(ndd->dev, ndd->cxl,
157 "CXL labels do not use the isetcookie concept\n"))
158 return 0;
159 return __le64_to_cpu(nd_label->efi.isetcookie);
160}
161
162static inline void nsl_set_isetcookie(struct nvdimm_drvdata *ndd,
163 struct nd_namespace_label *nd_label,
164 u64 isetcookie)
165{
166 if (!ndd->cxl)
167 nd_label->efi.isetcookie = __cpu_to_le64(isetcookie);
168}
169
170static inline bool nsl_validate_isetcookie(struct nvdimm_drvdata *ndd,
171 struct nd_namespace_label *nd_label,
172 u64 cookie)
173{
174 /*
175 * Let the EFI and CXL validation comingle, where fields that
176 * don't matter to CXL always validate.
177 */
178 if (ndd->cxl)
179 return true;
180 return cookie == __le64_to_cpu(nd_label->efi.isetcookie);
181}
182
183static inline u16 nsl_get_position(struct nvdimm_drvdata *ndd,
184 struct nd_namespace_label *nd_label)
185{
186 if (ndd->cxl)
187 return __le16_to_cpu(nd_label->cxl.position);
188 return __le16_to_cpu(nd_label->efi.position);
189}
190
191static inline void nsl_set_position(struct nvdimm_drvdata *ndd,
192 struct nd_namespace_label *nd_label,
193 u16 position)
194{
195 if (ndd->cxl)
196 nd_label->cxl.position = __cpu_to_le16(position);
197 else
198 nd_label->efi.position = __cpu_to_le16(position);
199}
200
201static inline u16 nsl_get_nlabel(struct nvdimm_drvdata *ndd,
202 struct nd_namespace_label *nd_label)
203{
204 if (ndd->cxl)
205 return 0;
206 return __le16_to_cpu(nd_label->efi.nlabel);
207}
208
209static inline void nsl_set_nlabel(struct nvdimm_drvdata *ndd,
210 struct nd_namespace_label *nd_label,
211 u16 nlabel)
212{
213 if (!ndd->cxl)
214 nd_label->efi.nlabel = __cpu_to_le16(nlabel);
215}
216
217static inline u16 nsl_get_nrange(struct nvdimm_drvdata *ndd,
218 struct nd_namespace_label *nd_label)
219{
220 if (ndd->cxl)
221 return __le16_to_cpu(nd_label->cxl.nrange);
222 return 1;
223}
224
225static inline void nsl_set_nrange(struct nvdimm_drvdata *ndd,
226 struct nd_namespace_label *nd_label,
227 u16 nrange)
228{
229 if (ndd->cxl)
230 nd_label->cxl.nrange = __cpu_to_le16(nrange);
231}
232
233static inline u64 nsl_get_lbasize(struct nvdimm_drvdata *ndd,
234 struct nd_namespace_label *nd_label)
235{
236 /*
237 * Yes, for some reason the EFI labels convey a massive 64-bit
238 * lbasize, that got fixed for CXL.
239 */
240 if (ndd->cxl)
241 return __le16_to_cpu(nd_label->cxl.lbasize);
242 return __le64_to_cpu(nd_label->efi.lbasize);
243}
244
245static inline void nsl_set_lbasize(struct nvdimm_drvdata *ndd,
246 struct nd_namespace_label *nd_label,
247 u64 lbasize)
248{
249 if (ndd->cxl)
250 nd_label->cxl.lbasize = __cpu_to_le16(lbasize);
251 else
252 nd_label->efi.lbasize = __cpu_to_le64(lbasize);
253}
254
255static inline const uuid_t *nsl_get_uuid(struct nvdimm_drvdata *ndd,
256 struct nd_namespace_label *nd_label,
257 uuid_t *uuid)
258{
259 if (ndd->cxl)
260 import_uuid(uuid, nd_label->cxl.uuid);
261 else
262 import_uuid(uuid, nd_label->efi.uuid);
263 return uuid;
264}
265
266static inline const uuid_t *nsl_set_uuid(struct nvdimm_drvdata *ndd,
267 struct nd_namespace_label *nd_label,
268 const uuid_t *uuid)
269{
270 if (ndd->cxl)
271 export_uuid(nd_label->cxl.uuid, uuid);
272 else
273 export_uuid(nd_label->efi.uuid, uuid);
274 return uuid;
275}
276
277static inline bool nsl_uuid_equal(struct nvdimm_drvdata *ndd,
278 struct nd_namespace_label *nd_label,
279 const uuid_t *uuid)
280{
281 uuid_t tmp;
282
283 if (ndd->cxl)
284 import_uuid(&tmp, nd_label->cxl.uuid);
285 else
286 import_uuid(&tmp, nd_label->efi.uuid);
287 return uuid_equal(&tmp, uuid);
288}
289
290static inline const u8 *nsl_uuid_raw(struct nvdimm_drvdata *ndd,
291 struct nd_namespace_label *nd_label)
292{
293 if (ndd->cxl)
294 return nd_label->cxl.uuid;
295 return nd_label->efi.uuid;
296}
297
298bool nsl_validate_type_guid(struct nvdimm_drvdata *ndd,
299 struct nd_namespace_label *nd_label, guid_t *guid);
300enum nvdimm_claim_class nsl_get_claim_class(struct nvdimm_drvdata *ndd,
301 struct nd_namespace_label *nd_label);
302
303struct nd_region_data {
304 int ns_count;
305 int ns_active;
306 unsigned int hints_shift;
307 void __iomem *flush_wpq[];
308};
309
310static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
311 int dimm, int hint)
312{
313 unsigned int num = 1 << ndrd->hints_shift;
314 unsigned int mask = num - 1;
315
316 return ndrd->flush_wpq[dimm * num + (hint & mask)];
317}
318
319static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
320 int hint, void __iomem *flush)
321{
322 unsigned int num = 1 << ndrd->hints_shift;
323 unsigned int mask = num - 1;
324
325 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
326}
327
328static inline struct nd_namespace_index *to_namespace_index(
329 struct nvdimm_drvdata *ndd, int i)
330{
331 if (i < 0)
332 return NULL;
333
334 return ndd->data + sizeof_namespace_index(ndd) * i;
335}
336
337static inline struct nd_namespace_index *to_current_namespace_index(
338 struct nvdimm_drvdata *ndd)
339{
340 return to_namespace_index(ndd, ndd->ns_current);
341}
342
343static inline struct nd_namespace_index *to_next_namespace_index(
344 struct nvdimm_drvdata *ndd)
345{
346 return to_namespace_index(ndd, ndd->ns_next);
347}
348
349unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
350
351#define efi_namespace_label_has(ndd, field) \
352 (!ndd->cxl && offsetof(struct nvdimm_efi_label, field) \
353 < sizeof_namespace_label(ndd))
354
355#define nd_dbg_dpa(r, d, res, fmt, arg...) \
356 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
357 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
358 (unsigned long long) (res ? resource_size(res) : 0), \
359 (unsigned long long) (res ? res->start : 0), ##arg)
360
361#define for_each_dpa_resource(ndd, res) \
362 for (res = (ndd)->dpa.child; res; res = res->sibling)
363
364#define for_each_dpa_resource_safe(ndd, res, next) \
365 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
366 res; res = next, next = next ? next->sibling : NULL)
367
368struct nd_percpu_lane {
369 int count;
370 spinlock_t lock;
371};
372
373enum nd_label_flags {
374 ND_LABEL_REAP,
375};
376struct nd_label_ent {
377 struct list_head list;
378 unsigned long flags;
379 struct nd_namespace_label *label;
380};
381
382enum nd_mapping_lock_class {
383 ND_MAPPING_CLASS0,
384 ND_MAPPING_UUID_SCAN,
385};
386
387struct nd_mapping {
388 struct nvdimm *nvdimm;
389 u64 start;
390 u64 size;
391 int position;
392 struct list_head labels;
393 struct mutex lock;
394 /*
395 * @ndd is for private use at region enable / disable time for
396 * get_ndd() + put_ndd(), all other nd_mapping to ndd
397 * conversions use to_ndd() which respects enabled state of the
398 * nvdimm.
399 */
400 struct nvdimm_drvdata *ndd;
401};
402
403struct nd_region {
404 struct device dev;
405 struct ida ns_ida;
406 struct ida btt_ida;
407 struct ida pfn_ida;
408 struct ida dax_ida;
409 unsigned long flags;
410 struct device *ns_seed;
411 struct device *btt_seed;
412 struct device *pfn_seed;
413 struct device *dax_seed;
414 unsigned long align;
415 u16 ndr_mappings;
416 u64 ndr_size;
417 u64 ndr_start;
418 int id, num_lanes, ro, numa_node, target_node;
419 void *provider_data;
420 struct kernfs_node *bb_state;
421 struct badblocks bb;
422 struct nd_interleave_set *nd_set;
423 struct nd_percpu_lane __percpu *lane;
424 int (*flush)(struct nd_region *nd_region, struct bio *bio);
425 struct nd_mapping mapping[] __counted_by(ndr_mappings);
426};
427
428static inline bool nsl_validate_nlabel(struct nd_region *nd_region,
429 struct nvdimm_drvdata *ndd,
430 struct nd_namespace_label *nd_label)
431{
432 if (ndd->cxl)
433 return true;
434 return nsl_get_nlabel(ndd, nd_label) == nd_region->ndr_mappings;
435}
436
437/*
438 * Lookup next in the repeating sequence of 01, 10, and 11.
439 */
440static inline unsigned nd_inc_seq(unsigned seq)
441{
442 static const unsigned next[] = { 0, 2, 3, 1 };
443
444 return next[seq & 3];
445}
446
447struct btt;
448struct nd_btt {
449 struct device dev;
450 struct nd_namespace_common *ndns;
451 struct btt *btt;
452 unsigned long lbasize;
453 u64 size;
454 uuid_t *uuid;
455 int id;
456 int initial_offset;
457 u16 version_major;
458 u16 version_minor;
459};
460
461enum nd_pfn_mode {
462 PFN_MODE_NONE,
463 PFN_MODE_RAM,
464 PFN_MODE_PMEM,
465};
466
467struct nd_pfn {
468 int id;
469 uuid_t *uuid;
470 struct device dev;
471 unsigned long align;
472 unsigned long npfns;
473 enum nd_pfn_mode mode;
474 struct nd_pfn_sb *pfn_sb;
475 struct nd_namespace_common *ndns;
476};
477
478struct nd_dax {
479 struct nd_pfn nd_pfn;
480};
481
482static inline u32 nd_info_block_reserve(void)
483{
484 return ALIGN(SZ_8K, PAGE_SIZE);
485}
486
487enum nd_async_mode {
488 ND_SYNC,
489 ND_ASYNC,
490};
491
492void wait_nvdimm_bus_probe_idle(struct device *dev);
493void nd_device_register(struct device *dev);
494void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
495void nd_device_notify(struct device *dev, enum nvdimm_event event);
496int nd_uuid_store(struct device *dev, uuid_t **uuid_out, const char *buf,
497 size_t len);
498ssize_t nd_size_select_show(unsigned long current_size,
499 const unsigned long *supported, char *buf);
500ssize_t nd_size_select_store(struct device *dev, const char *buf,
501 unsigned long *current_size, const unsigned long *supported);
502int __init nvdimm_init(void);
503int __init nd_region_init(void);
504int __init nd_label_init(void);
505void nvdimm_exit(void);
506void nd_region_exit(void);
507struct nvdimm;
508extern const struct attribute_group nd_device_attribute_group;
509extern const struct attribute_group nd_numa_attribute_group;
510extern const struct attribute_group *nvdimm_bus_attribute_groups[];
511struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
512int nvdimm_check_config_data(struct device *dev);
513int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
514int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
515int nvdimm_get_config_data(struct nvdimm_drvdata *ndd, void *buf,
516 size_t offset, size_t len);
517int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
518 void *buf, size_t len);
519long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
520 unsigned int len);
521void nvdimm_set_labeling(struct device *dev);
522void nvdimm_set_locked(struct device *dev);
523void nvdimm_clear_locked(struct device *dev);
524int nvdimm_security_setup_events(struct device *dev);
525#if IS_ENABLED(CONFIG_NVDIMM_KEYS)
526int nvdimm_security_unlock(struct device *dev);
527#else
528static inline int nvdimm_security_unlock(struct device *dev)
529{
530 return 0;
531}
532#endif
533struct nd_btt *to_nd_btt(struct device *dev);
534
535struct nd_gen_sb {
536 char reserved[SZ_4K - 8];
537 __le64 checksum;
538};
539
540u64 nd_sb_checksum(struct nd_gen_sb *sb);
541#if IS_ENABLED(CONFIG_BTT)
542int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
543bool is_nd_btt(struct device *dev);
544struct device *nd_btt_create(struct nd_region *nd_region);
545#else
546static inline int nd_btt_probe(struct device *dev,
547 struct nd_namespace_common *ndns)
548{
549 return -ENODEV;
550}
551
552static inline bool is_nd_btt(struct device *dev)
553{
554 return false;
555}
556
557static inline struct device *nd_btt_create(struct nd_region *nd_region)
558{
559 return NULL;
560}
561#endif
562
563struct nd_pfn *to_nd_pfn(struct device *dev);
564#if IS_ENABLED(CONFIG_NVDIMM_PFN)
565
566#define MAX_NVDIMM_ALIGN 4
567
568int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
569bool is_nd_pfn(struct device *dev);
570struct device *nd_pfn_create(struct nd_region *nd_region);
571struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
572 struct nd_namespace_common *ndns);
573int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
574extern const struct attribute_group *nd_pfn_attribute_groups[];
575#else
576static inline int nd_pfn_probe(struct device *dev,
577 struct nd_namespace_common *ndns)
578{
579 return -ENODEV;
580}
581
582static inline bool is_nd_pfn(struct device *dev)
583{
584 return false;
585}
586
587static inline struct device *nd_pfn_create(struct nd_region *nd_region)
588{
589 return NULL;
590}
591
592static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
593{
594 return -ENODEV;
595}
596#endif
597
598struct nd_dax *to_nd_dax(struct device *dev);
599#if IS_ENABLED(CONFIG_NVDIMM_DAX)
600int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
601bool is_nd_dax(const struct device *dev);
602struct device *nd_dax_create(struct nd_region *nd_region);
603static inline struct device *nd_dax_devinit(struct nd_dax *nd_dax,
604 struct nd_namespace_common *ndns)
605{
606 if (!nd_dax)
607 return NULL;
608 return nd_pfn_devinit(&nd_dax->nd_pfn, ndns);
609}
610#else
611static inline int nd_dax_probe(struct device *dev,
612 struct nd_namespace_common *ndns)
613{
614 return -ENODEV;
615}
616
617static inline bool is_nd_dax(const struct device *dev)
618{
619 return false;
620}
621
622static inline struct device *nd_dax_create(struct nd_region *nd_region)
623{
624 return NULL;
625}
626#endif
627
628int nd_region_to_nstype(struct nd_region *nd_region);
629int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
630u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
631 struct nd_namespace_index *nsindex);
632u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
633void nvdimm_bus_lock(struct device *dev);
634void nvdimm_bus_unlock(struct device *dev);
635bool is_nvdimm_bus_locked(struct device *dev);
636void nvdimm_check_and_set_ro(struct gendisk *disk);
637void nvdimm_drvdata_release(struct kref *kref);
638void put_ndd(struct nvdimm_drvdata *ndd);
639int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
640void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
641struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
642 struct nd_label_id *label_id, resource_size_t start,
643 resource_size_t n);
644resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
645bool nvdimm_namespace_locked(struct nd_namespace_common *ndns);
646struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
647int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
648int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
649const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
650 char *name);
651unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
652struct range;
653void nvdimm_badblocks_populate(struct nd_region *nd_region,
654 struct badblocks *bb, const struct range *range);
655int devm_namespace_enable(struct device *dev, struct nd_namespace_common *ndns,
656 resource_size_t size);
657void devm_namespace_disable(struct device *dev,
658 struct nd_namespace_common *ndns);
659#if IS_ENABLED(CONFIG_ND_CLAIM)
660/* max struct page size independent of kernel config */
661#define MAX_STRUCT_PAGE_SIZE 64
662int nvdimm_setup_pfn(struct nd_pfn *nd_pfn, struct dev_pagemap *pgmap);
663#else
664static inline int nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
665 struct dev_pagemap *pgmap)
666{
667 return -ENXIO;
668}
669#endif
670int nd_region_activate(struct nd_region *nd_region);
671static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
672 unsigned int len)
673{
674 if (bb->count) {
675 sector_t first_bad;
676 int num_bad;
677
678 return !!badblocks_check(bb, sector, len / 512, &first_bad,
679 &num_bad);
680 }
681
682 return false;
683}
684const uuid_t *nd_dev_to_uuid(struct device *dev);
685bool pmem_should_map_pages(struct device *dev);
686#endif /* __ND_H__ */
1/*
2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
3 *
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.
7 *
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.
12 */
13#ifndef __ND_H__
14#define __ND_H__
15#include <linux/libnvdimm.h>
16#include <linux/badblocks.h>
17#include <linux/blkdev.h>
18#include <linux/device.h>
19#include <linux/mutex.h>
20#include <linux/ndctl.h>
21#include <linux/types.h>
22#include <linux/nd.h>
23#include "label.h"
24
25enum {
26 /*
27 * Limits the maximum number of block apertures a dimm can
28 * support and is an input to the geometry/on-disk-format of a
29 * BTT instance
30 */
31 ND_MAX_LANES = 256,
32 INT_LBASIZE_ALIGNMENT = 64,
33 NVDIMM_IO_ATOMIC = 1,
34};
35
36struct nvdimm_drvdata {
37 struct device *dev;
38 int nslabel_size;
39 struct nd_cmd_get_config_size nsarea;
40 void *data;
41 int ns_current, ns_next;
42 struct resource dpa;
43 struct kref kref;
44};
45
46struct nd_region_data {
47 int ns_count;
48 int ns_active;
49 unsigned int hints_shift;
50 void __iomem *flush_wpq[0];
51};
52
53static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
54 int dimm, int hint)
55{
56 unsigned int num = 1 << ndrd->hints_shift;
57 unsigned int mask = num - 1;
58
59 return ndrd->flush_wpq[dimm * num + (hint & mask)];
60}
61
62static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
63 int hint, void __iomem *flush)
64{
65 unsigned int num = 1 << ndrd->hints_shift;
66 unsigned int mask = num - 1;
67
68 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
69}
70
71static inline struct nd_namespace_index *to_namespace_index(
72 struct nvdimm_drvdata *ndd, int i)
73{
74 if (i < 0)
75 return NULL;
76
77 return ndd->data + sizeof_namespace_index(ndd) * i;
78}
79
80static inline struct nd_namespace_index *to_current_namespace_index(
81 struct nvdimm_drvdata *ndd)
82{
83 return to_namespace_index(ndd, ndd->ns_current);
84}
85
86static inline struct nd_namespace_index *to_next_namespace_index(
87 struct nvdimm_drvdata *ndd)
88{
89 return to_namespace_index(ndd, ndd->ns_next);
90}
91
92unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
93
94#define namespace_label_has(ndd, field) \
95 (offsetof(struct nd_namespace_label, field) \
96 < sizeof_namespace_label(ndd))
97
98#define nd_dbg_dpa(r, d, res, fmt, arg...) \
99 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
100 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
101 (unsigned long long) (res ? resource_size(res) : 0), \
102 (unsigned long long) (res ? res->start : 0), ##arg)
103
104#define for_each_dpa_resource(ndd, res) \
105 for (res = (ndd)->dpa.child; res; res = res->sibling)
106
107#define for_each_dpa_resource_safe(ndd, res, next) \
108 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
109 res; res = next, next = next ? next->sibling : NULL)
110
111struct nd_percpu_lane {
112 int count;
113 spinlock_t lock;
114};
115
116struct nd_label_ent {
117 struct list_head list;
118 struct nd_namespace_label *label;
119};
120
121enum nd_mapping_lock_class {
122 ND_MAPPING_CLASS0,
123 ND_MAPPING_UUID_SCAN,
124};
125
126struct nd_mapping {
127 struct nvdimm *nvdimm;
128 u64 start;
129 u64 size;
130 int position;
131 struct list_head labels;
132 struct mutex lock;
133 /*
134 * @ndd is for private use at region enable / disable time for
135 * get_ndd() + put_ndd(), all other nd_mapping to ndd
136 * conversions use to_ndd() which respects enabled state of the
137 * nvdimm.
138 */
139 struct nvdimm_drvdata *ndd;
140};
141
142struct nd_region {
143 struct device dev;
144 struct ida ns_ida;
145 struct ida btt_ida;
146 struct ida pfn_ida;
147 struct ida dax_ida;
148 unsigned long flags;
149 struct device *ns_seed;
150 struct device *btt_seed;
151 struct device *pfn_seed;
152 struct device *dax_seed;
153 u16 ndr_mappings;
154 u64 ndr_size;
155 u64 ndr_start;
156 int id, num_lanes, ro, numa_node;
157 void *provider_data;
158 struct kernfs_node *bb_state;
159 struct badblocks bb;
160 struct nd_interleave_set *nd_set;
161 struct nd_percpu_lane __percpu *lane;
162 struct nd_mapping mapping[0];
163};
164
165struct nd_blk_region {
166 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
167 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
168 void *iobuf, u64 len, int rw);
169 void *blk_provider_data;
170 struct nd_region nd_region;
171};
172
173/*
174 * Lookup next in the repeating sequence of 01, 10, and 11.
175 */
176static inline unsigned nd_inc_seq(unsigned seq)
177{
178 static const unsigned next[] = { 0, 2, 3, 1 };
179
180 return next[seq & 3];
181}
182
183struct btt;
184struct nd_btt {
185 struct device dev;
186 struct nd_namespace_common *ndns;
187 struct btt *btt;
188 unsigned long lbasize;
189 u64 size;
190 u8 *uuid;
191 int id;
192 int initial_offset;
193 u16 version_major;
194 u16 version_minor;
195};
196
197enum nd_pfn_mode {
198 PFN_MODE_NONE,
199 PFN_MODE_RAM,
200 PFN_MODE_PMEM,
201};
202
203struct nd_pfn {
204 int id;
205 u8 *uuid;
206 struct device dev;
207 unsigned long align;
208 unsigned long npfns;
209 enum nd_pfn_mode mode;
210 struct nd_pfn_sb *pfn_sb;
211 struct nd_namespace_common *ndns;
212};
213
214struct nd_dax {
215 struct nd_pfn nd_pfn;
216};
217
218enum nd_async_mode {
219 ND_SYNC,
220 ND_ASYNC,
221};
222
223int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
224void wait_nvdimm_bus_probe_idle(struct device *dev);
225void nd_device_register(struct device *dev);
226void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
227void nd_device_notify(struct device *dev, enum nvdimm_event event);
228int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
229 size_t len);
230ssize_t nd_size_select_show(unsigned long current_size,
231 const unsigned long *supported, char *buf);
232ssize_t nd_size_select_store(struct device *dev, const char *buf,
233 unsigned long *current_size, const unsigned long *supported);
234int __init nvdimm_init(void);
235int __init nd_region_init(void);
236int __init nd_label_init(void);
237void nvdimm_exit(void);
238void nd_region_exit(void);
239struct nvdimm;
240struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
241int nvdimm_check_config_data(struct device *dev);
242int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
243int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
244int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
245 void *buf, size_t len);
246long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
247 unsigned int len);
248void nvdimm_set_aliasing(struct device *dev);
249void nvdimm_set_locked(struct device *dev);
250void nvdimm_clear_locked(struct device *dev);
251struct nd_btt *to_nd_btt(struct device *dev);
252
253struct nd_gen_sb {
254 char reserved[SZ_4K - 8];
255 __le64 checksum;
256};
257
258u64 nd_sb_checksum(struct nd_gen_sb *sb);
259#if IS_ENABLED(CONFIG_BTT)
260int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
261bool is_nd_btt(struct device *dev);
262struct device *nd_btt_create(struct nd_region *nd_region);
263#else
264static inline int nd_btt_probe(struct device *dev,
265 struct nd_namespace_common *ndns)
266{
267 return -ENODEV;
268}
269
270static inline bool is_nd_btt(struct device *dev)
271{
272 return false;
273}
274
275static inline struct device *nd_btt_create(struct nd_region *nd_region)
276{
277 return NULL;
278}
279#endif
280
281struct nd_pfn *to_nd_pfn(struct device *dev);
282#if IS_ENABLED(CONFIG_NVDIMM_PFN)
283
284#ifdef CONFIG_TRANSPARENT_HUGEPAGE
285#define PFN_DEFAULT_ALIGNMENT HPAGE_PMD_SIZE
286#else
287#define PFN_DEFAULT_ALIGNMENT PAGE_SIZE
288#endif
289
290int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
291bool is_nd_pfn(struct device *dev);
292struct device *nd_pfn_create(struct nd_region *nd_region);
293struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
294 struct nd_namespace_common *ndns);
295int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
296extern struct attribute_group nd_pfn_attribute_group;
297#else
298static inline int nd_pfn_probe(struct device *dev,
299 struct nd_namespace_common *ndns)
300{
301 return -ENODEV;
302}
303
304static inline bool is_nd_pfn(struct device *dev)
305{
306 return false;
307}
308
309static inline struct device *nd_pfn_create(struct nd_region *nd_region)
310{
311 return NULL;
312}
313
314static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
315{
316 return -ENODEV;
317}
318#endif
319
320struct nd_dax *to_nd_dax(struct device *dev);
321#if IS_ENABLED(CONFIG_NVDIMM_DAX)
322int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
323bool is_nd_dax(struct device *dev);
324struct device *nd_dax_create(struct nd_region *nd_region);
325#else
326static inline int nd_dax_probe(struct device *dev,
327 struct nd_namespace_common *ndns)
328{
329 return -ENODEV;
330}
331
332static inline bool is_nd_dax(struct device *dev)
333{
334 return false;
335}
336
337static inline struct device *nd_dax_create(struct nd_region *nd_region)
338{
339 return NULL;
340}
341#endif
342
343int nd_region_to_nstype(struct nd_region *nd_region);
344int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
345u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
346 struct nd_namespace_index *nsindex);
347u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
348void nvdimm_bus_lock(struct device *dev);
349void nvdimm_bus_unlock(struct device *dev);
350bool is_nvdimm_bus_locked(struct device *dev);
351int nvdimm_revalidate_disk(struct gendisk *disk);
352void nvdimm_drvdata_release(struct kref *kref);
353void put_ndd(struct nvdimm_drvdata *ndd);
354int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
355void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
356struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
357 struct nd_label_id *label_id, resource_size_t start,
358 resource_size_t n);
359resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
360struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
361int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
362int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
363const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
364 char *name);
365unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
366void nvdimm_badblocks_populate(struct nd_region *nd_region,
367 struct badblocks *bb, const struct resource *res);
368#if IS_ENABLED(CONFIG_ND_CLAIM)
369int nvdimm_setup_pfn(struct nd_pfn *nd_pfn, struct dev_pagemap *pgmap);
370int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
371void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
372#else
373static inline int nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
374 struct dev_pagemap *pgmap)
375{
376 return -ENXIO;
377}
378static inline int devm_nsio_enable(struct device *dev,
379 struct nd_namespace_io *nsio)
380{
381 return -ENXIO;
382}
383static inline void devm_nsio_disable(struct device *dev,
384 struct nd_namespace_io *nsio)
385{
386}
387#endif
388int nd_blk_region_init(struct nd_region *nd_region);
389int nd_region_activate(struct nd_region *nd_region);
390void __nd_iostat_start(struct bio *bio, unsigned long *start);
391static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
392{
393 struct gendisk *disk = bio->bi_disk;
394
395 if (!blk_queue_io_stat(disk->queue))
396 return false;
397
398 *start = jiffies;
399 generic_start_io_acct(disk->queue, bio_data_dir(bio),
400 bio_sectors(bio), &disk->part0);
401 return true;
402}
403static inline void nd_iostat_end(struct bio *bio, unsigned long start)
404{
405 struct gendisk *disk = bio->bi_disk;
406
407 generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0,
408 start);
409}
410static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
411 unsigned int len)
412{
413 if (bb->count) {
414 sector_t first_bad;
415 int num_bad;
416
417 return !!badblocks_check(bb, sector, len / 512, &first_bad,
418 &num_bad);
419 }
420
421 return false;
422}
423resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
424const u8 *nd_dev_to_uuid(struct device *dev);
425bool pmem_should_map_pages(struct device *dev);
426#endif /* __ND_H__ */