Documentation: DT: net: Add Xilinx gmiitorgmii converter device tree binding document...
[deliverable/linux.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
DW
145 unsigned long lbasize;
146 u8 *uuid;
147 int id;
148};
149
e1455744
DW
150enum nd_pfn_mode {
151 PFN_MODE_NONE,
152 PFN_MODE_RAM,
153 PFN_MODE_PMEM,
154};
155
156struct nd_pfn {
157 int id;
158 u8 *uuid;
159 struct device dev;
315c5625 160 unsigned long align;
e1455744
DW
161 unsigned long npfns;
162 enum nd_pfn_mode mode;
163 struct nd_pfn_sb *pfn_sb;
164 struct nd_namespace_common *ndns;
165};
166
cd03412a
DW
167struct nd_dax {
168 struct nd_pfn nd_pfn;
169};
170
4d88a97a
DW
171enum nd_async_mode {
172 ND_SYNC,
173 ND_ASYNC,
174};
175
41cd8b70 176int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
bf9bccc1 177void wait_nvdimm_bus_probe_idle(struct device *dev);
4d88a97a
DW
178void nd_device_register(struct device *dev);
179void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
71999466 180void nd_device_notify(struct device *dev, enum nvdimm_event event);
bf9bccc1
DW
181int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
182 size_t len);
1b40e09a
DW
183ssize_t nd_sector_size_show(unsigned long current_lbasize,
184 const unsigned long *supported, char *buf);
185ssize_t nd_sector_size_store(struct device *dev, const char *buf,
186 unsigned long *current_lbasize, const unsigned long *supported);
4d88a97a 187int __init nvdimm_init(void);
3d88002e 188int __init nd_region_init(void);
4d88a97a 189void nvdimm_exit(void);
3d88002e 190void nd_region_exit(void);
bf9bccc1
DW
191struct nvdimm;
192struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
4d88a97a
DW
193int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
194int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
f524bf27
DW
195int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
196 void *buf, size_t len);
59e64739
DW
197long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
198 unsigned int len);
8c2f7e86 199struct nd_btt *to_nd_btt(struct device *dev);
e1455744
DW
200
201struct nd_gen_sb {
202 char reserved[SZ_4K - 8];
203 __le64 checksum;
204};
205
206u64 nd_sb_checksum(struct nd_gen_sb *sb);
8c2f7e86 207#if IS_ENABLED(CONFIG_BTT)
200c79da 208int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
8c2f7e86
DW
209bool is_nd_btt(struct device *dev);
210struct device *nd_btt_create(struct nd_region *nd_region);
211#else
e32bc729 212static inline int nd_btt_probe(struct device *dev,
200c79da 213 struct nd_namespace_common *ndns)
8c2f7e86
DW
214{
215 return -ENODEV;
216}
217
218static inline bool is_nd_btt(struct device *dev)
219{
220 return false;
221}
222
223static inline struct device *nd_btt_create(struct nd_region *nd_region)
224{
225 return NULL;
226}
e1455744 227#endif
8c2f7e86 228
e1455744
DW
229struct nd_pfn *to_nd_pfn(struct device *dev);
230#if IS_ENABLED(CONFIG_NVDIMM_PFN)
200c79da 231int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
e1455744
DW
232bool is_nd_pfn(struct device *dev);
233struct device *nd_pfn_create(struct nd_region *nd_region);
cd03412a
DW
234struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
235 struct nd_namespace_common *ndns);
c5ed9268 236int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
cd03412a 237extern struct attribute_group nd_pfn_attribute_group;
e1455744 238#else
200c79da
DW
239static inline int nd_pfn_probe(struct device *dev,
240 struct nd_namespace_common *ndns)
e1455744
DW
241{
242 return -ENODEV;
243}
244
245static inline bool is_nd_pfn(struct device *dev)
246{
247 return false;
248}
249
250static inline struct device *nd_pfn_create(struct nd_region *nd_region)
251{
252 return NULL;
253}
32ab0a3f 254
c5ed9268 255static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
32ab0a3f
DW
256{
257 return -ENODEV;
258}
8c2f7e86 259#endif
e1455744 260
cd03412a
DW
261struct nd_dax *to_nd_dax(struct device *dev);
262#if IS_ENABLED(CONFIG_NVDIMM_DAX)
c5ed9268 263int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
cd03412a
DW
264bool is_nd_dax(struct device *dev);
265struct device *nd_dax_create(struct nd_region *nd_region);
266#else
c5ed9268
DW
267static inline int nd_dax_probe(struct device *dev,
268 struct nd_namespace_common *ndns)
269{
270 return -ENODEV;
271}
272
cd03412a
DW
273static inline bool is_nd_dax(struct device *dev)
274{
275 return false;
276}
277
278static inline struct device *nd_dax_create(struct nd_region *nd_region)
279{
280 return NULL;
281}
282#endif
283
3d88002e
DW
284struct nd_region *to_nd_region(struct device *dev);
285int nd_region_to_nstype(struct nd_region *nd_region);
286int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
bf9bccc1 287u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
3d88002e
DW
288void nvdimm_bus_lock(struct device *dev);
289void nvdimm_bus_unlock(struct device *dev);
290bool is_nvdimm_bus_locked(struct device *dev);
58138820 291int nvdimm_revalidate_disk(struct gendisk *disk);
bf9bccc1
DW
292void nvdimm_drvdata_release(struct kref *kref);
293void put_ndd(struct nvdimm_drvdata *ndd);
4a826c83
DW
294int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
295void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
296struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
297 struct nd_label_id *label_id, resource_size_t start,
298 resource_size_t n);
8c2f7e86
DW
299resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
300struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
5212e11f 301int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
298f2bc5 302int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
5212e11f
VV
303const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
304 char *name);
a3901802
DW
305void nvdimm_badblocks_populate(struct nd_region *nd_region,
306 struct badblocks *bb, const struct resource *res);
200c79da 307#if IS_ENABLED(CONFIG_ND_CLAIM)
ac515c08
DW
308struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
309 struct resource *res, struct vmem_altmap *altmap);
200c79da
DW
310int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
311void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
312#else
ac515c08
DW
313static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
314 struct resource *res, struct vmem_altmap *altmap)
315{
316 return ERR_PTR(-ENXIO);
317}
200c79da
DW
318static inline int devm_nsio_enable(struct device *dev,
319 struct nd_namespace_io *nsio)
320{
321 return -ENXIO;
322}
323static inline void devm_nsio_disable(struct device *dev,
324 struct nd_namespace_io *nsio)
325{
326}
327#endif
047fc8a1 328int nd_blk_region_init(struct nd_region *nd_region);
e5ae3b25 329int nd_region_activate(struct nd_region *nd_region);
f0dc089c
DW
330void __nd_iostat_start(struct bio *bio, unsigned long *start);
331static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
332{
333 struct gendisk *disk = bio->bi_bdev->bd_disk;
334
335 if (!blk_queue_io_stat(disk->queue))
336 return false;
337
338 __nd_iostat_start(bio, start);
339 return true;
340}
341void nd_iostat_end(struct bio *bio, unsigned long start);
200c79da
DW
342static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
343 unsigned int len)
344{
345 if (bb->count) {
346 sector_t first_bad;
347 int num_bad;
348
349 return !!badblocks_check(bb, sector, len / 512, &first_bad,
350 &num_bad);
351 }
352
353 return false;
354}
047fc8a1 355resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
6ec68954 356const u8 *nd_dev_to_uuid(struct device *dev);
004f1afb 357bool pmem_should_map_pages(struct device *dev);
4d88a97a 358#endif /* __ND_H__ */
This page took 0.079591 seconds and 5 git commands to generate.