]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/nvdimm/nd.h
Merge remote-tracking branches 'asoc/topic/sgtl5000', 'asoc/topic/simple', 'asoc...
[mirror_ubuntu-zesty-kernel.git] / drivers / nvdimm / nd.h
CommitLineData
4d88a97a
DW
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__
1f7df6f8 15#include <linux/libnvdimm.h>
200c79da 16#include <linux/badblocks.h>
f0dc089c 17#include <linux/blkdev.h>
4d88a97a
DW
18#include <linux/device.h>
19#include <linux/mutex.h>
20#include <linux/ndctl.h>
bf9bccc1 21#include <linux/types.h>
71999466 22#include <linux/nd.h>
4a826c83 23#include "label.h"
4d88a97a 24
8c2f7e86 25enum {
5212e11f
VV
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,
8c2f7e86 32 SECTOR_SHIFT = 9,
fcae6957 33 INT_LBASIZE_ALIGNMENT = 64,
8c2f7e86
DW
34};
35
0caeef63
VV
36struct nd_poison {
37 u64 start;
38 u64 length;
39 struct list_head list;
40};
41
4d88a97a
DW
42struct nvdimm_drvdata {
43 struct device *dev;
4a826c83 44 int nsindex_size;
4d88a97a
DW
45 struct nd_cmd_get_config_size nsarea;
46 void *data;
4a826c83
DW
47 int ns_current, ns_next;
48 struct resource dpa;
bf9bccc1 49 struct kref kref;
4d88a97a
DW
50};
51
e5ae3b25
DW
52struct nd_region_data {
53 int ns_count;
54 int ns_active;
0c27af60 55 unsigned int flush_mask;
e5ae3b25 56 void __iomem *flush_wpq[0][0];
3d88002e
DW
57};
58
4a826c83
DW
59static inline struct nd_namespace_index *to_namespace_index(
60 struct nvdimm_drvdata *ndd, int i)
61{
62 if (i < 0)
63 return NULL;
64
65 return ndd->data + sizeof_namespace_index(ndd) * i;
66}
67
68static inline struct nd_namespace_index *to_current_namespace_index(
69 struct nvdimm_drvdata *ndd)
70{
71 return to_namespace_index(ndd, ndd->ns_current);
72}
73
74static inline struct nd_namespace_index *to_next_namespace_index(
75 struct nvdimm_drvdata *ndd)
76{
77 return to_namespace_index(ndd, ndd->ns_next);
78}
79
80#define nd_dbg_dpa(r, d, res, fmt, arg...) \
81 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
82 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
83 (unsigned long long) (res ? resource_size(res) : 0), \
84 (unsigned long long) (res ? res->start : 0), ##arg)
85
bf9bccc1
DW
86#define for_each_label(l, label, labels) \
87 for (l = 0; (label = labels ? labels[l] : NULL); l++)
88
89#define for_each_dpa_resource(ndd, res) \
90 for (res = (ndd)->dpa.child; res; res = res->sibling)
91
4a826c83
DW
92#define for_each_dpa_resource_safe(ndd, res, next) \
93 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
94 res; res = next, next = next ? next->sibling : NULL)
95
5212e11f
VV
96struct nd_percpu_lane {
97 int count;
98 spinlock_t lock;
99};
100
1f7df6f8
DW
101struct nd_region {
102 struct device dev;
1b40e09a 103 struct ida ns_ida;
8c2f7e86 104 struct ida btt_ida;
e1455744 105 struct ida pfn_ida;
cd03412a 106 struct ida dax_ida;
004f1afb 107 unsigned long flags;
bf9bccc1 108 struct device *ns_seed;
8c2f7e86 109 struct device *btt_seed;
e1455744 110 struct device *pfn_seed;
cd03412a 111 struct device *dax_seed;
1f7df6f8
DW
112 u16 ndr_mappings;
113 u64 ndr_size;
114 u64 ndr_start;
41d7a6d6 115 int id, num_lanes, ro, numa_node;
1f7df6f8 116 void *provider_data;
eaf96153 117 struct nd_interleave_set *nd_set;
5212e11f 118 struct nd_percpu_lane __percpu *lane;
1f7df6f8
DW
119 struct nd_mapping mapping[0];
120};
121
047fc8a1
RZ
122struct nd_blk_region {
123 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
047fc8a1
RZ
124 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
125 void *iobuf, u64 len, int rw);
126 void *blk_provider_data;
127 struct nd_region nd_region;
128};
129
4a826c83
DW
130/*
131 * Lookup next in the repeating sequence of 01, 10, and 11.
132 */
133static inline unsigned nd_inc_seq(unsigned seq)
134{
135 static const unsigned next[] = { 0, 2, 3, 1 };
136
137 return next[seq & 3];
138}
f524bf27 139
5212e11f 140struct btt;
8c2f7e86
DW
141struct nd_btt {
142 struct device dev;
143 struct nd_namespace_common *ndns;
5212e11f 144 struct btt *btt;
8c2f7e86 145 unsigned long lbasize;
abe8b4e3 146 u64 size;
8c2f7e86
DW
147 u8 *uuid;
148 int id;
149};
150
e1455744
DW
151enum nd_pfn_mode {
152 PFN_MODE_NONE,
153 PFN_MODE_RAM,
154 PFN_MODE_PMEM,
155};
156
157struct nd_pfn {
158 int id;
159 u8 *uuid;
160 struct device dev;
315c5625 161 unsigned long align;
e1455744
DW
162 unsigned long npfns;
163 enum nd_pfn_mode mode;
164 struct nd_pfn_sb *pfn_sb;
165 struct nd_namespace_common *ndns;
166};
167
cd03412a
DW
168struct nd_dax {
169 struct nd_pfn nd_pfn;
170};
171
4d88a97a
DW
172enum nd_async_mode {
173 ND_SYNC,
174 ND_ASYNC,
175};
176
41cd8b70 177int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
bf9bccc1 178void wait_nvdimm_bus_probe_idle(struct device *dev);
4d88a97a
DW
179void nd_device_register(struct device *dev);
180void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
71999466 181void nd_device_notify(struct device *dev, enum nvdimm_event event);
bf9bccc1
DW
182int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
183 size_t len);
1b40e09a
DW
184ssize_t nd_sector_size_show(unsigned long current_lbasize,
185 const unsigned long *supported, char *buf);
186ssize_t nd_sector_size_store(struct device *dev, const char *buf,
187 unsigned long *current_lbasize, const unsigned long *supported);
4d88a97a 188int __init nvdimm_init(void);
3d88002e 189int __init nd_region_init(void);
4d88a97a 190void nvdimm_exit(void);
3d88002e 191void nd_region_exit(void);
bf9bccc1
DW
192struct nvdimm;
193struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
4d88a97a
DW
194int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
195int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
f524bf27
DW
196int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
197 void *buf, size_t len);
59e64739
DW
198long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
199 unsigned int len);
8c2f7e86 200struct nd_btt *to_nd_btt(struct device *dev);
e1455744
DW
201
202struct nd_gen_sb {
203 char reserved[SZ_4K - 8];
204 __le64 checksum;
205};
206
207u64 nd_sb_checksum(struct nd_gen_sb *sb);
8c2f7e86 208#if IS_ENABLED(CONFIG_BTT)
200c79da 209int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
8c2f7e86
DW
210bool is_nd_btt(struct device *dev);
211struct device *nd_btt_create(struct nd_region *nd_region);
212#else
e32bc729 213static inline int nd_btt_probe(struct device *dev,
200c79da 214 struct nd_namespace_common *ndns)
8c2f7e86
DW
215{
216 return -ENODEV;
217}
218
219static inline bool is_nd_btt(struct device *dev)
220{
221 return false;
222}
223
224static inline struct device *nd_btt_create(struct nd_region *nd_region)
225{
226 return NULL;
227}
e1455744 228#endif
8c2f7e86 229
e1455744
DW
230struct nd_pfn *to_nd_pfn(struct device *dev);
231#if IS_ENABLED(CONFIG_NVDIMM_PFN)
200c79da 232int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
e1455744
DW
233bool is_nd_pfn(struct device *dev);
234struct device *nd_pfn_create(struct nd_region *nd_region);
cd03412a
DW
235struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
236 struct nd_namespace_common *ndns);
c5ed9268 237int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
cd03412a 238extern struct attribute_group nd_pfn_attribute_group;
e1455744 239#else
200c79da
DW
240static inline int nd_pfn_probe(struct device *dev,
241 struct nd_namespace_common *ndns)
e1455744
DW
242{
243 return -ENODEV;
244}
245
246static inline bool is_nd_pfn(struct device *dev)
247{
248 return false;
249}
250
251static inline struct device *nd_pfn_create(struct nd_region *nd_region)
252{
253 return NULL;
254}
32ab0a3f 255
c5ed9268 256static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
32ab0a3f
DW
257{
258 return -ENODEV;
259}
8c2f7e86 260#endif
e1455744 261
cd03412a
DW
262struct nd_dax *to_nd_dax(struct device *dev);
263#if IS_ENABLED(CONFIG_NVDIMM_DAX)
c5ed9268 264int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
cd03412a
DW
265bool is_nd_dax(struct device *dev);
266struct device *nd_dax_create(struct nd_region *nd_region);
267#else
c5ed9268
DW
268static inline int nd_dax_probe(struct device *dev,
269 struct nd_namespace_common *ndns)
270{
271 return -ENODEV;
272}
273
cd03412a
DW
274static inline bool is_nd_dax(struct device *dev)
275{
276 return false;
277}
278
279static inline struct device *nd_dax_create(struct nd_region *nd_region)
280{
281 return NULL;
282}
283#endif
284
3d88002e
DW
285struct nd_region *to_nd_region(struct device *dev);
286int nd_region_to_nstype(struct nd_region *nd_region);
287int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
bf9bccc1 288u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
3d88002e
DW
289void nvdimm_bus_lock(struct device *dev);
290void nvdimm_bus_unlock(struct device *dev);
291bool is_nvdimm_bus_locked(struct device *dev);
58138820 292int nvdimm_revalidate_disk(struct gendisk *disk);
bf9bccc1
DW
293void nvdimm_drvdata_release(struct kref *kref);
294void put_ndd(struct nvdimm_drvdata *ndd);
4a826c83
DW
295int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
296void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
297struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
298 struct nd_label_id *label_id, resource_size_t start,
299 resource_size_t n);
8c2f7e86
DW
300resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
301struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
5212e11f 302int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
298f2bc5 303int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
5212e11f
VV
304const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
305 char *name);
a3901802
DW
306void nvdimm_badblocks_populate(struct nd_region *nd_region,
307 struct badblocks *bb, const struct resource *res);
200c79da 308#if IS_ENABLED(CONFIG_ND_CLAIM)
ac515c08
DW
309struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
310 struct resource *res, struct vmem_altmap *altmap);
200c79da
DW
311int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
312void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
313#else
ac515c08
DW
314static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
315 struct resource *res, struct vmem_altmap *altmap)
316{
317 return ERR_PTR(-ENXIO);
318}
200c79da
DW
319static inline int devm_nsio_enable(struct device *dev,
320 struct nd_namespace_io *nsio)
321{
322 return -ENXIO;
323}
324static inline void devm_nsio_disable(struct device *dev,
325 struct nd_namespace_io *nsio)
326{
327}
328#endif
047fc8a1 329int nd_blk_region_init(struct nd_region *nd_region);
e5ae3b25 330int nd_region_activate(struct nd_region *nd_region);
f0dc089c
DW
331void __nd_iostat_start(struct bio *bio, unsigned long *start);
332static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
333{
334 struct gendisk *disk = bio->bi_bdev->bd_disk;
335
336 if (!blk_queue_io_stat(disk->queue))
337 return false;
338
339 __nd_iostat_start(bio, start);
340 return true;
341}
342void nd_iostat_end(struct bio *bio, unsigned long start);
200c79da
DW
343static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
344 unsigned int len)
345{
346 if (bb->count) {
347 sector_t first_bad;
348 int num_bad;
349
350 return !!badblocks_check(bb, sector, len / 512, &first_bad,
351 &num_bad);
352 }
353
354 return false;
355}
047fc8a1 356resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
6ec68954 357const u8 *nd_dev_to_uuid(struct device *dev);
004f1afb 358bool pmem_should_map_pages(struct device *dev);
4d88a97a 359#endif /* __ND_H__ */