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, target_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_get_config_data(struct nvdimm_drvdata *ndd, void *buf,
245 size_t offset, size_t len);
246int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
247 void *buf, size_t len);
248long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
249 unsigned int len);
250void nvdimm_set_aliasing(struct device *dev);
251void nvdimm_set_locked(struct device *dev);
252void nvdimm_clear_locked(struct device *dev);
253int nvdimm_security_setup_events(struct device *dev);
254#if IS_ENABLED(CONFIG_NVDIMM_KEYS)
255int nvdimm_security_unlock(struct device *dev);
256#else
257static inline int nvdimm_security_unlock(struct device *dev)
258{
259 return 0;
260}
261#endif
262struct nd_btt *to_nd_btt(struct device *dev);
263
264struct nd_gen_sb {
265 char reserved[SZ_4K - 8];
266 __le64 checksum;
267};
268
269u64 nd_sb_checksum(struct nd_gen_sb *sb);
270#if IS_ENABLED(CONFIG_BTT)
271int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
272bool is_nd_btt(struct device *dev);
273struct device *nd_btt_create(struct nd_region *nd_region);
274#else
275static inline int nd_btt_probe(struct device *dev,
276 struct nd_namespace_common *ndns)
277{
278 return -ENODEV;
279}
280
281static inline bool is_nd_btt(struct device *dev)
282{
283 return false;
284}
285
286static inline struct device *nd_btt_create(struct nd_region *nd_region)
287{
288 return NULL;
289}
290#endif
291
292struct nd_pfn *to_nd_pfn(struct device *dev);
293#if IS_ENABLED(CONFIG_NVDIMM_PFN)
294
295#ifdef CONFIG_TRANSPARENT_HUGEPAGE
296#define PFN_DEFAULT_ALIGNMENT HPAGE_PMD_SIZE
297#else
298#define PFN_DEFAULT_ALIGNMENT PAGE_SIZE
299#endif
300
301int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
302bool is_nd_pfn(struct device *dev);
303struct device *nd_pfn_create(struct nd_region *nd_region);
304struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
305 struct nd_namespace_common *ndns);
306int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
307extern struct attribute_group nd_pfn_attribute_group;
308#else
309static inline int nd_pfn_probe(struct device *dev,
310 struct nd_namespace_common *ndns)
311{
312 return -ENODEV;
313}
314
315static inline bool is_nd_pfn(struct device *dev)
316{
317 return false;
318}
319
320static inline struct device *nd_pfn_create(struct nd_region *nd_region)
321{
322 return NULL;
323}
324
325static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
326{
327 return -ENODEV;
328}
329#endif
330
331struct nd_dax *to_nd_dax(struct device *dev);
332#if IS_ENABLED(CONFIG_NVDIMM_DAX)
333int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
334bool is_nd_dax(struct device *dev);
335struct device *nd_dax_create(struct nd_region *nd_region);
336#else
337static inline int nd_dax_probe(struct device *dev,
338 struct nd_namespace_common *ndns)
339{
340 return -ENODEV;
341}
342
343static inline bool is_nd_dax(struct device *dev)
344{
345 return false;
346}
347
348static inline struct device *nd_dax_create(struct nd_region *nd_region)
349{
350 return NULL;
351}
352#endif
353
354int nd_region_to_nstype(struct nd_region *nd_region);
355int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
356u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
357 struct nd_namespace_index *nsindex);
358u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
359void nvdimm_bus_lock(struct device *dev);
360void nvdimm_bus_unlock(struct device *dev);
361bool is_nvdimm_bus_locked(struct device *dev);
362int nvdimm_revalidate_disk(struct gendisk *disk);
363void nvdimm_drvdata_release(struct kref *kref);
364void put_ndd(struct nvdimm_drvdata *ndd);
365int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
366void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
367struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
368 struct nd_label_id *label_id, resource_size_t start,
369 resource_size_t n);
370resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
371bool nvdimm_namespace_locked(struct nd_namespace_common *ndns);
372struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
373int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
374int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
375const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
376 char *name);
377unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
378void nvdimm_badblocks_populate(struct nd_region *nd_region,
379 struct badblocks *bb, const struct resource *res);
380#if IS_ENABLED(CONFIG_ND_CLAIM)
381int nvdimm_setup_pfn(struct nd_pfn *nd_pfn, struct dev_pagemap *pgmap);
382int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
383void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
384#else
385static inline int nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
386 struct dev_pagemap *pgmap)
387{
388 return -ENXIO;
389}
390static inline int devm_nsio_enable(struct device *dev,
391 struct nd_namespace_io *nsio)
392{
393 return -ENXIO;
394}
395static inline void devm_nsio_disable(struct device *dev,
396 struct nd_namespace_io *nsio)
397{
398}
399#endif
400int nd_blk_region_init(struct nd_region *nd_region);
401int nd_region_activate(struct nd_region *nd_region);
402void __nd_iostat_start(struct bio *bio, unsigned long *start);
403static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
404{
405 struct gendisk *disk = bio->bi_disk;
406
407 if (!blk_queue_io_stat(disk->queue))
408 return false;
409
410 *start = jiffies;
411 generic_start_io_acct(disk->queue, bio_op(bio), bio_sectors(bio),
412 &disk->part0);
413 return true;
414}
415static inline void nd_iostat_end(struct bio *bio, unsigned long start)
416{
417 struct gendisk *disk = bio->bi_disk;
418
419 generic_end_io_acct(disk->queue, bio_op(bio), &disk->part0, start);
420}
421static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
422 unsigned int len)
423{
424 if (bb->count) {
425 sector_t first_bad;
426 int num_bad;
427
428 return !!badblocks_check(bb, sector, len / 512, &first_bad,
429 &num_bad);
430 }
431
432 return false;
433}
434resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
435const u8 *nd_dev_to_uuid(struct device *dev);
436bool pmem_should_map_pages(struct device *dev);
437#endif /* __ND_H__ */
438