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 nd_poison {
38 u64 start;
39 u64 length;
40 struct list_head list;
41};
42
43struct nvdimm_drvdata {
44 struct device *dev;
45 int nsindex_size;
46 struct nd_cmd_get_config_size nsarea;
47 void *data;
48 int ns_current, ns_next;
49 struct resource dpa;
50 struct kref kref;
51};
52
53struct nd_region_data {
54 int ns_count;
55 int ns_active;
56 unsigned int hints_shift;
57 void __iomem *flush_wpq[0];
58};
59
60static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
61 int dimm, int hint)
62{
63 unsigned int num = 1 << ndrd->hints_shift;
64 unsigned int mask = num - 1;
65
66 return ndrd->flush_wpq[dimm * num + (hint & mask)];
67}
68
69static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
70 int hint, void __iomem *flush)
71{
72 unsigned int num = 1 << ndrd->hints_shift;
73 unsigned int mask = num - 1;
74
75 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
76}
77
78static inline struct nd_namespace_index *to_namespace_index(
79 struct nvdimm_drvdata *ndd, int i)
80{
81 if (i < 0)
82 return NULL;
83
84 return ndd->data + sizeof_namespace_index(ndd) * i;
85}
86
87static inline struct nd_namespace_index *to_current_namespace_index(
88 struct nvdimm_drvdata *ndd)
89{
90 return to_namespace_index(ndd, ndd->ns_current);
91}
92
93static inline struct nd_namespace_index *to_next_namespace_index(
94 struct nvdimm_drvdata *ndd)
95{
96 return to_namespace_index(ndd, ndd->ns_next);
97}
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 struct list_head labels;
132 struct mutex lock;
133
134
135
136
137
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 badblocks bb;
159 struct nd_interleave_set *nd_set;
160 struct nd_percpu_lane __percpu *lane;
161 struct nd_mapping mapping[0];
162};
163
164struct nd_blk_region {
165 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
166 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
167 void *iobuf, u64 len, int rw);
168 void *blk_provider_data;
169 struct nd_region nd_region;
170};
171
172
173
174
175static inline unsigned nd_inc_seq(unsigned seq)
176{
177 static const unsigned next[] = { 0, 2, 3, 1 };
178
179 return next[seq & 3];
180}
181
182struct btt;
183struct nd_btt {
184 struct device dev;
185 struct nd_namespace_common *ndns;
186 struct btt *btt;
187 unsigned long lbasize;
188 u64 size;
189 u8 *uuid;
190 int id;
191};
192
193enum nd_pfn_mode {
194 PFN_MODE_NONE,
195 PFN_MODE_RAM,
196 PFN_MODE_PMEM,
197};
198
199struct nd_pfn {
200 int id;
201 u8 *uuid;
202 struct device dev;
203 unsigned long align;
204 unsigned long npfns;
205 enum nd_pfn_mode mode;
206 struct nd_pfn_sb *pfn_sb;
207 struct nd_namespace_common *ndns;
208};
209
210struct nd_dax {
211 struct nd_pfn nd_pfn;
212};
213
214enum nd_async_mode {
215 ND_SYNC,
216 ND_ASYNC,
217};
218
219int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
220void wait_nvdimm_bus_probe_idle(struct device *dev);
221void nd_device_register(struct device *dev);
222void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
223void nd_device_notify(struct device *dev, enum nvdimm_event event);
224int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
225 size_t len);
226ssize_t nd_sector_size_show(unsigned long current_lbasize,
227 const unsigned long *supported, char *buf);
228ssize_t nd_sector_size_store(struct device *dev, const char *buf,
229 unsigned long *current_lbasize, const unsigned long *supported);
230int __init nvdimm_init(void);
231int __init nd_region_init(void);
232void nvdimm_exit(void);
233void nd_region_exit(void);
234struct nvdimm;
235struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
236int nvdimm_check_config_data(struct device *dev);
237int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
238int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
239int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
240 void *buf, size_t len);
241long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
242 unsigned int len);
243void nvdimm_set_aliasing(struct device *dev);
244void nvdimm_set_locked(struct device *dev);
245struct nd_btt *to_nd_btt(struct device *dev);
246
247struct nd_gen_sb {
248 char reserved[SZ_4K - 8];
249 __le64 checksum;
250};
251
252u64 nd_sb_checksum(struct nd_gen_sb *sb);
253#if IS_ENABLED(CONFIG_BTT)
254int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
255bool is_nd_btt(struct device *dev);
256struct device *nd_btt_create(struct nd_region *nd_region);
257#else
258static inline int nd_btt_probe(struct device *dev,
259 struct nd_namespace_common *ndns)
260{
261 return -ENODEV;
262}
263
264static inline bool is_nd_btt(struct device *dev)
265{
266 return false;
267}
268
269static inline struct device *nd_btt_create(struct nd_region *nd_region)
270{
271 return NULL;
272}
273#endif
274
275struct nd_pfn *to_nd_pfn(struct device *dev);
276#if IS_ENABLED(CONFIG_NVDIMM_PFN)
277int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
278bool is_nd_pfn(struct device *dev);
279struct device *nd_pfn_create(struct nd_region *nd_region);
280struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
281 struct nd_namespace_common *ndns);
282int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
283extern struct attribute_group nd_pfn_attribute_group;
284#else
285static inline int nd_pfn_probe(struct device *dev,
286 struct nd_namespace_common *ndns)
287{
288 return -ENODEV;
289}
290
291static inline bool is_nd_pfn(struct device *dev)
292{
293 return false;
294}
295
296static inline struct device *nd_pfn_create(struct nd_region *nd_region)
297{
298 return NULL;
299}
300
301static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
302{
303 return -ENODEV;
304}
305#endif
306
307struct nd_dax *to_nd_dax(struct device *dev);
308#if IS_ENABLED(CONFIG_NVDIMM_DAX)
309int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
310bool is_nd_dax(struct device *dev);
311struct device *nd_dax_create(struct nd_region *nd_region);
312#else
313static inline int nd_dax_probe(struct device *dev,
314 struct nd_namespace_common *ndns)
315{
316 return -ENODEV;
317}
318
319static inline bool is_nd_dax(struct device *dev)
320{
321 return false;
322}
323
324static inline struct device *nd_dax_create(struct nd_region *nd_region)
325{
326 return NULL;
327}
328#endif
329
330struct nd_region *to_nd_region(struct device *dev);
331int nd_region_to_nstype(struct nd_region *nd_region);
332int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
333u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
334u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
335void nvdimm_bus_lock(struct device *dev);
336void nvdimm_bus_unlock(struct device *dev);
337bool is_nvdimm_bus_locked(struct device *dev);
338int nvdimm_revalidate_disk(struct gendisk *disk);
339void nvdimm_drvdata_release(struct kref *kref);
340void put_ndd(struct nvdimm_drvdata *ndd);
341int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
342void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
343struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
344 struct nd_label_id *label_id, resource_size_t start,
345 resource_size_t n);
346resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
347struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
348int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
349int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
350const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
351 char *name);
352void nvdimm_badblocks_populate(struct nd_region *nd_region,
353 struct badblocks *bb, const struct resource *res);
354#if IS_ENABLED(CONFIG_ND_CLAIM)
355struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
356 struct resource *res, struct vmem_altmap *altmap);
357int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
358void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
359#else
360static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
361 struct resource *res, struct vmem_altmap *altmap)
362{
363 return ERR_PTR(-ENXIO);
364}
365static inline int devm_nsio_enable(struct device *dev,
366 struct nd_namespace_io *nsio)
367{
368 return -ENXIO;
369}
370static inline void devm_nsio_disable(struct device *dev,
371 struct nd_namespace_io *nsio)
372{
373}
374#endif
375int nd_blk_region_init(struct nd_region *nd_region);
376int nd_region_activate(struct nd_region *nd_region);
377void __nd_iostat_start(struct bio *bio, unsigned long *start);
378static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
379{
380 struct gendisk *disk = bio->bi_bdev->bd_disk;
381
382 if (!blk_queue_io_stat(disk->queue))
383 return false;
384
385 *start = jiffies;
386 generic_start_io_acct(bio_data_dir(bio),
387 bio_sectors(bio), &disk->part0);
388 return true;
389}
390static inline void nd_iostat_end(struct bio *bio, unsigned long start)
391{
392 struct gendisk *disk = bio->bi_bdev->bd_disk;
393
394 generic_end_io_acct(bio_data_dir(bio), &disk->part0, start);
395}
396static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
397 unsigned int len)
398{
399 if (bb->count) {
400 sector_t first_bad;
401 int num_bad;
402
403 return !!badblocks_check(bb, sector, len / 512, &first_bad,
404 &num_bad);
405 }
406
407 return false;
408}
409resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
410const u8 *nd_dev_to_uuid(struct device *dev);
411bool pmem_should_map_pages(struct device *dev);
412#endif
413
