2 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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.
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.
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>
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
33 INT_LBASIZE_ALIGNMENT = 64,
39 struct list_head list;
42 struct nvdimm_drvdata {
45 struct nd_cmd_get_config_size nsarea;
47 int ns_current, ns_next;
52 struct nd_region_namespaces {
57 static inline struct nd_namespace_index *to_namespace_index(
58 struct nvdimm_drvdata *ndd, int i)
63 return ndd->data + sizeof_namespace_index(ndd) * i;
66 static inline struct nd_namespace_index *to_current_namespace_index(
67 struct nvdimm_drvdata *ndd)
69 return to_namespace_index(ndd, ndd->ns_current);
72 static inline struct nd_namespace_index *to_next_namespace_index(
73 struct nvdimm_drvdata *ndd)
75 return to_namespace_index(ndd, ndd->ns_next);
78 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
79 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
80 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
81 (unsigned long long) (res ? resource_size(res) : 0), \
82 (unsigned long long) (res ? res->start : 0), ##arg)
84 #define for_each_label(l, label, labels) \
85 for (l = 0; (label = labels ? labels[l] : NULL); l++)
87 #define for_each_dpa_resource(ndd, res) \
88 for (res = (ndd)->dpa.child; res; res = res->sibling)
90 #define for_each_dpa_resource_safe(ndd, res, next) \
91 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
92 res; res = next, next = next ? next->sibling : NULL)
94 struct nd_percpu_lane {
106 struct device *ns_seed;
107 struct device *btt_seed;
108 struct device *pfn_seed;
109 struct device *dax_seed;
113 int id, num_lanes, ro, numa_node;
115 struct nd_interleave_set *nd_set;
116 struct nd_percpu_lane __percpu *lane;
117 struct nd_mapping mapping[0];
120 struct nd_blk_region {
121 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
122 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
123 void *iobuf, u64 len, int rw);
124 void *blk_provider_data;
125 struct nd_region nd_region;
129 * Lookup next in the repeating sequence of 01, 10, and 11.
131 static inline unsigned nd_inc_seq(unsigned seq)
133 static const unsigned next[] = { 0, 2, 3, 1 };
135 return next[seq & 3];
141 struct nd_namespace_common *ndns;
143 unsigned long lbasize;
160 enum nd_pfn_mode mode;
161 struct nd_pfn_sb *pfn_sb;
162 struct nd_namespace_common *ndns;
166 struct nd_pfn nd_pfn;
174 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
175 void wait_nvdimm_bus_probe_idle(struct device *dev);
176 void nd_device_register(struct device *dev);
177 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
178 void nd_device_notify(struct device *dev, enum nvdimm_event event);
179 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
181 ssize_t nd_sector_size_show(unsigned long current_lbasize,
182 const unsigned long *supported, char *buf);
183 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
184 unsigned long *current_lbasize, const unsigned long *supported);
185 int __init nvdimm_init(void);
186 int __init nd_region_init(void);
187 void nvdimm_exit(void);
188 void nd_region_exit(void);
190 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
191 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
192 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
193 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
194 void *buf, size_t len);
195 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
197 struct nd_btt *to_nd_btt(struct device *dev);
200 char reserved[SZ_4K - 8];
204 u64 nd_sb_checksum(struct nd_gen_sb *sb);
205 #if IS_ENABLED(CONFIG_BTT)
206 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
207 bool is_nd_btt(struct device *dev);
208 struct device *nd_btt_create(struct nd_region *nd_region);
210 static inline int nd_btt_probe(struct device *dev,
211 struct nd_namespace_common *ndns)
216 static inline bool is_nd_btt(struct device *dev)
221 static inline struct device *nd_btt_create(struct nd_region *nd_region)
227 struct nd_pfn *to_nd_pfn(struct device *dev);
228 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
229 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
230 bool is_nd_pfn(struct device *dev);
231 struct device *nd_pfn_create(struct nd_region *nd_region);
232 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
233 struct nd_namespace_common *ndns);
234 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
235 extern struct attribute_group nd_pfn_attribute_group;
237 static inline int nd_pfn_probe(struct device *dev,
238 struct nd_namespace_common *ndns)
243 static inline bool is_nd_pfn(struct device *dev)
248 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
253 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
259 struct nd_dax *to_nd_dax(struct device *dev);
260 #if IS_ENABLED(CONFIG_NVDIMM_DAX)
261 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
262 bool is_nd_dax(struct device *dev);
263 struct device *nd_dax_create(struct nd_region *nd_region);
265 static inline int nd_dax_probe(struct device *dev,
266 struct nd_namespace_common *ndns)
271 static inline bool is_nd_dax(struct device *dev)
276 static inline struct device *nd_dax_create(struct nd_region *nd_region)
282 struct nd_region *to_nd_region(struct device *dev);
283 int nd_region_to_nstype(struct nd_region *nd_region);
284 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
285 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
286 void nvdimm_bus_lock(struct device *dev);
287 void nvdimm_bus_unlock(struct device *dev);
288 bool is_nvdimm_bus_locked(struct device *dev);
289 int nvdimm_revalidate_disk(struct gendisk *disk);
290 void nvdimm_drvdata_release(struct kref *kref);
291 void put_ndd(struct nvdimm_drvdata *ndd);
292 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
293 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
294 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
295 struct nd_label_id *label_id, resource_size_t start,
297 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
298 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
299 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
300 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
301 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
303 void nvdimm_badblocks_populate(struct nd_region *nd_region,
304 struct badblocks *bb, const struct resource *res);
305 #if IS_ENABLED(CONFIG_ND_CLAIM)
306 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
307 struct resource *res, struct vmem_altmap *altmap);
308 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
309 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
311 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
312 struct resource *res, struct vmem_altmap *altmap)
314 return ERR_PTR(-ENXIO);
316 static inline int devm_nsio_enable(struct device *dev,
317 struct nd_namespace_io *nsio)
321 static inline void devm_nsio_disable(struct device *dev,
322 struct nd_namespace_io *nsio)
326 int nd_blk_region_init(struct nd_region *nd_region);
327 void __nd_iostat_start(struct bio *bio, unsigned long *start);
328 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
330 struct gendisk *disk = bio->bi_bdev->bd_disk;
332 if (!blk_queue_io_stat(disk->queue))
335 __nd_iostat_start(bio, start);
338 void nd_iostat_end(struct bio *bio, unsigned long start);
339 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
346 return !!badblocks_check(bb, sector, len / 512, &first_bad,
352 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
353 const u8 *nd_dev_to_uuid(struct device *dev);
354 bool pmem_should_map_pages(struct device *dev);
355 #endif /* __ND_H__ */