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_data {
55 unsigned int flush_mask;
56 void __iomem *flush_wpq[0][0];
59 static inline struct nd_namespace_index *to_namespace_index(
60 struct nvdimm_drvdata *ndd, int i)
65 return ndd->data + sizeof_namespace_index(ndd) * i;
68 static inline struct nd_namespace_index *to_current_namespace_index(
69 struct nvdimm_drvdata *ndd)
71 return to_namespace_index(ndd, ndd->ns_current);
74 static inline struct nd_namespace_index *to_next_namespace_index(
75 struct nvdimm_drvdata *ndd)
77 return to_namespace_index(ndd, ndd->ns_next);
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)
86 #define for_each_label(l, label, labels) \
87 for (l = 0; (label = labels ? labels[l] : NULL); l++)
89 #define for_each_dpa_resource(ndd, res) \
90 for (res = (ndd)->dpa.child; res; res = res->sibling)
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)
96 struct nd_percpu_lane {
108 struct device *ns_seed;
109 struct device *btt_seed;
110 struct device *pfn_seed;
111 struct device *dax_seed;
115 int id, num_lanes, ro, numa_node;
117 struct nd_interleave_set *nd_set;
118 struct nd_percpu_lane __percpu *lane;
119 struct nd_mapping mapping[0];
122 struct nd_blk_region {
123 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
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;
131 * Lookup next in the repeating sequence of 01, 10, and 11.
133 static inline unsigned nd_inc_seq(unsigned seq)
135 static const unsigned next[] = { 0, 2, 3, 1 };
137 return next[seq & 3];
143 struct nd_namespace_common *ndns;
145 unsigned long lbasize;
163 enum nd_pfn_mode mode;
164 struct nd_pfn_sb *pfn_sb;
165 struct nd_namespace_common *ndns;
169 struct nd_pfn nd_pfn;
177 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
178 void wait_nvdimm_bus_probe_idle(struct device *dev);
179 void nd_device_register(struct device *dev);
180 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
181 void nd_device_notify(struct device *dev, enum nvdimm_event event);
182 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
184 ssize_t nd_sector_size_show(unsigned long current_lbasize,
185 const unsigned long *supported, char *buf);
186 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
187 unsigned long *current_lbasize, const unsigned long *supported);
188 int __init nvdimm_init(void);
189 int __init nd_region_init(void);
190 void nvdimm_exit(void);
191 void nd_region_exit(void);
193 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
194 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
195 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
196 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
197 void *buf, size_t len);
198 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
200 struct nd_btt *to_nd_btt(struct device *dev);
203 char reserved[SZ_4K - 8];
207 u64 nd_sb_checksum(struct nd_gen_sb *sb);
208 #if IS_ENABLED(CONFIG_BTT)
209 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
210 bool is_nd_btt(struct device *dev);
211 struct device *nd_btt_create(struct nd_region *nd_region);
213 static inline int nd_btt_probe(struct device *dev,
214 struct nd_namespace_common *ndns)
219 static inline bool is_nd_btt(struct device *dev)
224 static inline struct device *nd_btt_create(struct nd_region *nd_region)
230 struct nd_pfn *to_nd_pfn(struct device *dev);
231 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
232 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
233 bool is_nd_pfn(struct device *dev);
234 struct device *nd_pfn_create(struct nd_region *nd_region);
235 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
236 struct nd_namespace_common *ndns);
237 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
238 extern struct attribute_group nd_pfn_attribute_group;
240 static inline int nd_pfn_probe(struct device *dev,
241 struct nd_namespace_common *ndns)
246 static inline bool is_nd_pfn(struct device *dev)
251 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
256 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
262 struct nd_dax *to_nd_dax(struct device *dev);
263 #if IS_ENABLED(CONFIG_NVDIMM_DAX)
264 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
265 bool is_nd_dax(struct device *dev);
266 struct device *nd_dax_create(struct nd_region *nd_region);
268 static inline int nd_dax_probe(struct device *dev,
269 struct nd_namespace_common *ndns)
274 static inline bool is_nd_dax(struct device *dev)
279 static inline struct device *nd_dax_create(struct nd_region *nd_region)
285 struct nd_region *to_nd_region(struct device *dev);
286 int nd_region_to_nstype(struct nd_region *nd_region);
287 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
288 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
289 void nvdimm_bus_lock(struct device *dev);
290 void nvdimm_bus_unlock(struct device *dev);
291 bool is_nvdimm_bus_locked(struct device *dev);
292 int nvdimm_revalidate_disk(struct gendisk *disk);
293 void nvdimm_drvdata_release(struct kref *kref);
294 void put_ndd(struct nvdimm_drvdata *ndd);
295 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
296 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
297 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
298 struct nd_label_id *label_id, resource_size_t start,
300 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
301 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
302 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
303 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
304 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
306 void nvdimm_badblocks_populate(struct nd_region *nd_region,
307 struct badblocks *bb, const struct resource *res);
308 #if IS_ENABLED(CONFIG_ND_CLAIM)
309 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
310 struct resource *res, struct vmem_altmap *altmap);
311 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
312 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
314 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
315 struct resource *res, struct vmem_altmap *altmap)
317 return ERR_PTR(-ENXIO);
319 static inline int devm_nsio_enable(struct device *dev,
320 struct nd_namespace_io *nsio)
324 static inline void devm_nsio_disable(struct device *dev,
325 struct nd_namespace_io *nsio)
329 int nd_blk_region_init(struct nd_region *nd_region);
330 int nd_region_activate(struct nd_region *nd_region);
331 void __nd_iostat_start(struct bio *bio, unsigned long *start);
332 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
334 struct gendisk *disk = bio->bi_bdev->bd_disk;
336 if (!blk_queue_io_stat(disk->queue))
339 __nd_iostat_start(bio, start);
342 void nd_iostat_end(struct bio *bio, unsigned long start);
343 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
350 return !!badblocks_check(bb, sector, len / 512, &first_bad,
356 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
357 const u8 *nd_dev_to_uuid(struct device *dev);
358 bool pmem_should_map_pages(struct device *dev);
359 #endif /* __ND_H__ */