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/blkdev.h>
17 #include <linux/device.h>
18 #include <linux/mutex.h>
19 #include <linux/ndctl.h>
20 #include <linux/types.h>
21 #include "label.h"
22
23 enum {
24 /*
25 * Limits the maximum number of block apertures a dimm can
26 * support and is an input to the geometry/on-disk-format of a
27 * BTT instance
28 */
29 ND_MAX_LANES = 256,
30 INT_LBASIZE_ALIGNMENT = 64,
31 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
32 ND_PFN_ALIGN = PAGES_PER_SECTION * PAGE_SIZE,
33 ND_PFN_MASK = ND_PFN_ALIGN - 1,
34 #else
35 ND_PFN_ALIGN = 0,
36 ND_PFN_MASK = 0,
37 #endif
38 };
39
40 struct nvdimm_drvdata {
41 struct device *dev;
42 int nsindex_size;
43 struct nd_cmd_get_config_size nsarea;
44 void *data;
45 int ns_current, ns_next;
46 struct resource dpa;
47 struct kref kref;
48 };
49
50 struct nd_region_namespaces {
51 int count;
52 int active;
53 };
54
to_namespace_index(struct nvdimm_drvdata * ndd,int i)55 static inline struct nd_namespace_index *to_namespace_index(
56 struct nvdimm_drvdata *ndd, int i)
57 {
58 if (i < 0)
59 return NULL;
60
61 return ndd->data + sizeof_namespace_index(ndd) * i;
62 }
63
to_current_namespace_index(struct nvdimm_drvdata * ndd)64 static inline struct nd_namespace_index *to_current_namespace_index(
65 struct nvdimm_drvdata *ndd)
66 {
67 return to_namespace_index(ndd, ndd->ns_current);
68 }
69
to_next_namespace_index(struct nvdimm_drvdata * ndd)70 static inline struct nd_namespace_index *to_next_namespace_index(
71 struct nvdimm_drvdata *ndd)
72 {
73 return to_namespace_index(ndd, ndd->ns_next);
74 }
75
76 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
77 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
78 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
79 (unsigned long long) (res ? resource_size(res) : 0), \
80 (unsigned long long) (res ? res->start : 0), ##arg)
81
82 #define for_each_label(l, label, labels) \
83 for (l = 0; (label = labels ? labels[l] : NULL); l++)
84
85 #define for_each_dpa_resource(ndd, res) \
86 for (res = (ndd)->dpa.child; res; res = res->sibling)
87
88 #define for_each_dpa_resource_safe(ndd, res, next) \
89 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
90 res; res = next, next = next ? next->sibling : NULL)
91
92 struct nd_percpu_lane {
93 int count;
94 spinlock_t lock;
95 };
96
97 struct nd_region {
98 struct device dev;
99 struct ida ns_ida;
100 struct ida btt_ida;
101 struct ida pfn_ida;
102 unsigned long flags;
103 struct device *ns_seed;
104 struct device *btt_seed;
105 struct device *pfn_seed;
106 u16 ndr_mappings;
107 u64 ndr_size;
108 u64 ndr_start;
109 int id, num_lanes, ro, numa_node;
110 void *provider_data;
111 struct nd_interleave_set *nd_set;
112 struct nd_percpu_lane __percpu *lane;
113 struct nd_mapping mapping[0];
114 };
115
116 struct nd_blk_region {
117 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
118 void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
119 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
120 void *iobuf, u64 len, int rw);
121 void *blk_provider_data;
122 struct nd_region nd_region;
123 };
124
125 /*
126 * Lookup next in the repeating sequence of 01, 10, and 11.
127 */
nd_inc_seq(unsigned seq)128 static inline unsigned nd_inc_seq(unsigned seq)
129 {
130 static const unsigned next[] = { 0, 2, 3, 1 };
131
132 return next[seq & 3];
133 }
134
135 struct btt;
136 struct nd_btt {
137 struct device dev;
138 struct nd_namespace_common *ndns;
139 struct btt *btt;
140 unsigned long lbasize;
141 u8 *uuid;
142 int id;
143 };
144
145 enum nd_pfn_mode {
146 PFN_MODE_NONE,
147 PFN_MODE_RAM,
148 PFN_MODE_PMEM,
149 };
150
151 struct nd_pfn {
152 int id;
153 u8 *uuid;
154 struct device dev;
155 unsigned long npfns;
156 enum nd_pfn_mode mode;
157 struct nd_pfn_sb *pfn_sb;
158 struct nd_namespace_common *ndns;
159 };
160
161 enum nd_async_mode {
162 ND_SYNC,
163 ND_ASYNC,
164 };
165
166 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
167 void wait_nvdimm_bus_probe_idle(struct device *dev);
168 void nd_device_register(struct device *dev);
169 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
170 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
171 size_t len);
172 ssize_t nd_sector_size_show(unsigned long current_lbasize,
173 const unsigned long *supported, char *buf);
174 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
175 unsigned long *current_lbasize, const unsigned long *supported);
176 int __init nvdimm_init(void);
177 int __init nd_region_init(void);
178 void nvdimm_exit(void);
179 void nd_region_exit(void);
180 struct nvdimm;
181 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
182 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
183 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
184 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
185 void *buf, size_t len);
186 struct nd_btt *to_nd_btt(struct device *dev);
187
188 struct nd_gen_sb {
189 char reserved[SZ_4K - 8];
190 __le64 checksum;
191 };
192
193 u64 nd_sb_checksum(struct nd_gen_sb *sb);
194 #if IS_ENABLED(CONFIG_BTT)
195 int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
196 bool is_nd_btt(struct device *dev);
197 struct device *nd_btt_create(struct nd_region *nd_region);
198 #else
nd_btt_probe(struct nd_namespace_common * ndns,void * drvdata)199 static inline int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
200 {
201 return -ENODEV;
202 }
203
is_nd_btt(struct device * dev)204 static inline bool is_nd_btt(struct device *dev)
205 {
206 return false;
207 }
208
nd_btt_create(struct nd_region * nd_region)209 static inline struct device *nd_btt_create(struct nd_region *nd_region)
210 {
211 return NULL;
212 }
213 #endif
214
215 struct nd_pfn *to_nd_pfn(struct device *dev);
216 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
217 int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata);
218 bool is_nd_pfn(struct device *dev);
219 struct device *nd_pfn_create(struct nd_region *nd_region);
220 int nd_pfn_validate(struct nd_pfn *nd_pfn);
221 #else
nd_pfn_probe(struct nd_namespace_common * ndns,void * drvdata)222 static inline int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata)
223 {
224 return -ENODEV;
225 }
226
is_nd_pfn(struct device * dev)227 static inline bool is_nd_pfn(struct device *dev)
228 {
229 return false;
230 }
231
nd_pfn_create(struct nd_region * nd_region)232 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
233 {
234 return NULL;
235 }
236
nd_pfn_validate(struct nd_pfn * nd_pfn)237 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn)
238 {
239 return -ENODEV;
240 }
241 #endif
242
243 struct nd_region *to_nd_region(struct device *dev);
244 int nd_region_to_nstype(struct nd_region *nd_region);
245 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
246 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
247 u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
248 void nvdimm_bus_lock(struct device *dev);
249 void nvdimm_bus_unlock(struct device *dev);
250 bool is_nvdimm_bus_locked(struct device *dev);
251 int nvdimm_revalidate_disk(struct gendisk *disk);
252 void nvdimm_drvdata_release(struct kref *kref);
253 void put_ndd(struct nvdimm_drvdata *ndd);
254 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
255 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
256 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
257 struct nd_label_id *label_id, resource_size_t start,
258 resource_size_t n);
259 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
260 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
261 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
262 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
263 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
264 char *name);
265 int nd_blk_region_init(struct nd_region *nd_region);
266 void __nd_iostat_start(struct bio *bio, unsigned long *start);
nd_iostat_start(struct bio * bio,unsigned long * start)267 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
268 {
269 struct gendisk *disk = bio->bi_bdev->bd_disk;
270
271 if (!blk_queue_io_stat(disk->queue))
272 return false;
273
274 __nd_iostat_start(bio, start);
275 return true;
276 }
277 void nd_iostat_end(struct bio *bio, unsigned long start);
278 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
279 const u8 *nd_dev_to_uuid(struct device *dev);
280 bool pmem_should_map_pages(struct device *dev);
281 #endif /* __ND_H__ */
282