1
2
3
4
5
6
7
8
9
10
11
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
28
29
30
31 ND_MAX_LANES = 256,
32 SECTOR_SHIFT = 9,
33 INT_LBASIZE_ALIGNMENT = 64,
34 NVDIMM_IO_ATOMIC = 1,
35};
36
37struct nvdimm_drvdata {
38 struct device *dev;
39 int nslabel_size;
40 struct nd_cmd_get_config_size nsarea;
41 void *data;
42 int ns_current, ns_next;
43 struct resource dpa;
44 struct kref kref;
45};
46
47struct nd_region_data {
48 int ns_count;
49 int ns_active;
50 unsigned int hints_shift;
51 void __iomem *flush_wpq[0];
52};
53
54static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
55 int dimm, int hint)
56{
57 unsigned int num = 1 << ndrd->hints_shift;
58 unsigned int mask = num - 1;
59
60 return ndrd->flush_wpq[dimm * num + (hint & mask)];
61}
62
63static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
64 int hint, void __iomem *flush)
65{
66 unsigned int num = 1 << ndrd->hints_shift;
67 unsigned int mask = num - 1;
68
69 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
70}
71
72static inline struct nd_namespace_index *to_namespace_index(
73 struct nvdimm_drvdata *ndd, int i)
74{
75 if (i < 0)
76 return NULL;
77
78 return ndd->data + sizeof_namespace_index(ndd) * i;
79}
80
81static inline struct nd_namespace_index *to_current_namespace_index(
82 struct nvdimm_drvdata *ndd)
83{
84 return to_namespace_index(ndd, ndd->ns_current);
85}
86
87static inline struct nd_namespace_index *to_next_namespace_index(
88 struct nvdimm_drvdata *ndd)
89{
90 return to_namespace_index(ndd, ndd->ns_next);
91}
92
93unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
94
95#define namespace_label_has(ndd, field) \
96 (offsetof(struct nd_namespace_label, field) \
97 < sizeof_namespace_label(ndd))
98
99#define nd_dbg_dpa(r, d, res, fmt, arg...) \
100 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
101 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
102 (unsigned long long) (res ? resource_size(res) : 0), \
103 (unsigned long long) (res ? res->start : 0), ##arg)
104
105#define for_each_dpa_resource(ndd, res) \
106 for (res = (ndd)->dpa.child; res; res = res->sibling)
107
108#define for_each_dpa_resource_safe(ndd, res, next) \
109 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
110 res; res = next, next = next ? next->sibling : NULL)
111
112struct nd_percpu_lane {
113 int count;
114 spinlock_t lock;
115};
116
117struct nd_label_ent {
118 struct list_head list;
119 struct nd_namespace_label *label;
120};
121
122enum nd_mapping_lock_class {
123 ND_MAPPING_CLASS0,
124 ND_MAPPING_UUID_SCAN,
125};
126
127struct nd_mapping {
128 struct nvdimm *nvdimm;
129 u64 start;
130 u64 size;
131 int position;
132 struct list_head labels;
133 struct mutex lock;
134
135
136
137
138
139
140 struct nvdimm_drvdata *ndd;
141};
142
143struct nd_region {
144 struct device dev;
145 struct ida ns_ida;
146 struct ida btt_ida;
147 struct ida pfn_ida;
148 struct ida dax_ida;
149 unsigned long flags;
150 struct device *ns_seed;
151 struct device *btt_seed;
152 struct device *pfn_seed;
153 struct device *dax_seed;
154 u16 ndr_mappings;
155 u64 ndr_size;
156 u64 ndr_start;
157 int id, num_lanes, ro, numa_node;
158 void *provider_data;
159 struct kernfs_node *bb_state;
160 struct badblocks bb;
161 struct nd_interleave_set *nd_set;
162 struct nd_percpu_lane __percpu *lane;
163 struct nd_mapping mapping[0];
164};
165
166struct nd_blk_region {
167 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
168 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
169 void *iobuf, u64 len, int rw);
170 void *blk_provider_data;
171 struct nd_region nd_region;
172};
173
174
175
176
177static inline unsigned nd_inc_seq(unsigned seq)
178{
179 static const unsigned next[] = { 0, 2, 3, 1 };
180
181 return next[seq & 3];
182}
183
184struct btt;
185struct nd_btt {
186 struct device dev;
187 struct nd_namespace_common *ndns;
188 struct btt *btt;
189 unsigned long lbasize;
190 u64 size;
191 u8 *uuid;
192 int id;
193 int initial_offset;
194 u16 version_major;
195 u16 version_minor;
196};
197
198enum nd_pfn_mode {
199 PFN_MODE_NONE,
200 PFN_MODE_RAM,
201 PFN_MODE_PMEM,
202};
203
204struct nd_pfn {
205 int id;
206 u8 *uuid;
207 struct device dev;
208 unsigned long align;
209 unsigned long npfns;
210 enum nd_pfn_mode mode;
211 struct nd_pfn_sb *pfn_sb;
212 struct nd_namespace_common *ndns;
213};
214
215struct nd_dax {
216 struct nd_pfn nd_pfn;
217};
218
219enum nd_async_mode {
220 ND_SYNC,
221 ND_ASYNC,
222};
223
224int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
225void wait_nvdimm_bus_probe_idle(struct device *dev);
226void nd_device_register(struct device *dev);
227void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
228void nd_device_notify(struct device *dev, enum nvdimm_event event);
229int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
230 size_t len);
231ssize_t nd_size_select_show(unsigned long current_size,
232 const unsigned long *supported, char *buf);
233ssize_t nd_size_select_store(struct device *dev, const char *buf,
234 unsigned long *current_size, const unsigned long *supported);
235int __init nvdimm_init(void);
236int __init nd_region_init(void);
237int __init nd_label_init(void);
238void nvdimm_exit(void);
239void nd_region_exit(void);
240struct nvdimm;
241struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
242int nvdimm_check_config_data(struct device *dev);
243int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
244int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
245int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
246 void *buf, size_t len);
247long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
248 unsigned int len);
249void nvdimm_set_aliasing(struct device *dev);
250void nvdimm_set_locked(struct device *dev);
251void nvdimm_clear_locked(struct device *dev);
252struct nd_btt *to_nd_btt(struct device *dev);
253
254struct nd_gen_sb {
255 char reserved[SZ_4K - 8];
256 __le64 checksum;
257};
258
259u64 nd_sb_checksum(struct nd_gen_sb *sb);
260#if IS_ENABLED(CONFIG_BTT)
261int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
262bool is_nd_btt(struct device *dev);
263struct device *nd_btt_create(struct nd_region *nd_region);
264#else
265static inline int nd_btt_probe(struct device *dev,
266 struct nd_namespace_common *ndns)
267{
268 return -ENODEV;
269}
270
271static inline bool is_nd_btt(struct device *dev)
272{
273 return false;
274}
275
276static inline struct device *nd_btt_create(struct nd_region *nd_region)
277{
278 return NULL;
279}
280#endif
281
282struct nd_pfn *to_nd_pfn(struct device *dev);
283#if IS_ENABLED(CONFIG_NVDIMM_PFN)
284
285#ifdef CONFIG_TRANSPARENT_HUGEPAGE
286#define PFN_DEFAULT_ALIGNMENT HPAGE_PMD_SIZE
287#else
288#define PFN_DEFAULT_ALIGNMENT PAGE_SIZE
289#endif
290
291int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
292bool is_nd_pfn(struct device *dev);
293struct device *nd_pfn_create(struct nd_region *nd_region);
294struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
295 struct nd_namespace_common *ndns);
296int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
297extern struct attribute_group nd_pfn_attribute_group;
298#else
299static inline int nd_pfn_probe(struct device *dev,
300 struct nd_namespace_common *ndns)
301{
302 return -ENODEV;
303}
304
305static inline bool is_nd_pfn(struct device *dev)
306{
307 return false;
308}
309
310static inline struct device *nd_pfn_create(struct nd_region *nd_region)
311{
312 return NULL;
313}
314
315static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
316{
317 return -ENODEV;
318}
319#endif
320
321struct nd_dax *to_nd_dax(struct device *dev);
322#if IS_ENABLED(CONFIG_NVDIMM_DAX)
323int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
324bool is_nd_dax(struct device *dev);
325struct device *nd_dax_create(struct nd_region *nd_region);
326#else
327static inline int nd_dax_probe(struct device *dev,
328 struct nd_namespace_common *ndns)
329{
330 return -ENODEV;
331}
332
333static inline bool is_nd_dax(struct device *dev)
334{
335 return false;
336}
337
338static inline struct device *nd_dax_create(struct nd_region *nd_region)
339{
340 return NULL;
341}
342#endif
343
344struct nd_region *to_nd_region(struct device *dev);
345int nd_region_to_nstype(struct nd_region *nd_region);
346int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
347u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
348 struct nd_namespace_index *nsindex);
349u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
350void nvdimm_bus_lock(struct device *dev);
351void nvdimm_bus_unlock(struct device *dev);
352bool is_nvdimm_bus_locked(struct device *dev);
353int nvdimm_revalidate_disk(struct gendisk *disk);
354void nvdimm_drvdata_release(struct kref *kref);
355void put_ndd(struct nvdimm_drvdata *ndd);
356int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
357void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
358struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
359 struct nd_label_id *label_id, resource_size_t start,
360 resource_size_t n);
361resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
362struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
363int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
364int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
365const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
366 char *name);
367unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
368void nvdimm_badblocks_populate(struct nd_region *nd_region,
369 struct badblocks *bb, const struct resource *res);
370#if IS_ENABLED(CONFIG_ND_CLAIM)
371struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
372 struct resource *res, struct vmem_altmap *altmap);
373int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
374void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
375#else
376static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
377 struct resource *res, struct vmem_altmap *altmap)
378{
379 return ERR_PTR(-ENXIO);
380}
381static inline int devm_nsio_enable(struct device *dev,
382 struct nd_namespace_io *nsio)
383{
384 return -ENXIO;
385}
386static inline void devm_nsio_disable(struct device *dev,
387 struct nd_namespace_io *nsio)
388{
389}
390#endif
391int nd_blk_region_init(struct nd_region *nd_region);
392int nd_region_activate(struct nd_region *nd_region);
393void __nd_iostat_start(struct bio *bio, unsigned long *start);
394static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
395{
396 struct gendisk *disk = bio->bi_disk;
397
398 if (!blk_queue_io_stat(disk->queue))
399 return false;
400
401 *start = jiffies;
402 generic_start_io_acct(disk->queue, bio_data_dir(bio),
403 bio_sectors(bio), &disk->part0);
404 return true;
405}
406static inline void nd_iostat_end(struct bio *bio, unsigned long start)
407{
408 struct gendisk *disk = bio->bi_disk;
409
410 generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0,
411 start);
412}
413static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
414 unsigned int len)
415{
416 if (bb->count) {
417 sector_t first_bad;
418 int num_bad;
419
420 return !!badblocks_check(bb, sector, len / 512, &first_bad,
421 &num_bad);
422 }
423
424 return false;
425}
426resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
427const u8 *nd_dev_to_uuid(struct device *dev);
428bool pmem_should_map_pages(struct device *dev);
429#endif
430
