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/blkdev.h>
17 #include <linux/device.h>
18 #include <linux/mutex.h>
19 #include <linux/ndctl.h>
20 #include <linux/types.h>
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
31 INT_LBASIZE_ALIGNMENT = 64,
32 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
33 ND_PFN_ALIGN = PAGES_PER_SECTION * PAGE_SIZE,
34 ND_PFN_MASK = ND_PFN_ALIGN - 1,
41 struct nvdimm_drvdata {
44 struct nd_cmd_get_config_size nsarea;
46 int ns_current, ns_next;
51 struct nd_region_namespaces {
56 static inline struct nd_namespace_index *to_namespace_index(
57 struct nvdimm_drvdata *ndd, int i)
62 return ndd->data + sizeof_namespace_index(ndd) * i;
65 static inline struct nd_namespace_index *to_current_namespace_index(
66 struct nvdimm_drvdata *ndd)
68 return to_namespace_index(ndd, ndd->ns_current);
71 static inline struct nd_namespace_index *to_next_namespace_index(
72 struct nvdimm_drvdata *ndd)
74 return to_namespace_index(ndd, ndd->ns_next);
77 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
78 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
79 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
80 (unsigned long long) (res ? resource_size(res) : 0), \
81 (unsigned long long) (res ? res->start : 0), ##arg)
83 #define for_each_label(l, label, labels) \
84 for (l = 0; (label = labels ? labels[l] : NULL); l++)
86 #define for_each_dpa_resource(ndd, res) \
87 for (res = (ndd)->dpa.child; res; res = res->sibling)
89 #define for_each_dpa_resource_safe(ndd, res, next) \
90 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
91 res; res = next, next = next ? next->sibling : NULL)
93 struct nd_percpu_lane {
103 struct device *ns_seed;
104 struct device *btt_seed;
105 struct device *pfn_seed;
109 int id, num_lanes, ro, numa_node;
111 struct nd_interleave_set *nd_set;
112 struct nd_percpu_lane __percpu *lane;
113 struct nd_mapping mapping[0];
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;
126 * Lookup next in the repeating sequence of 01, 10, and 11.
128 static inline unsigned nd_inc_seq(unsigned seq)
130 static const unsigned next[] = { 0, 2, 3, 1 };
132 return next[seq & 3];
138 struct nd_namespace_common *ndns;
140 unsigned long lbasize;
156 enum nd_pfn_mode mode;
157 struct nd_pfn_sb *pfn_sb;
158 struct nd_namespace_common *ndns;
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,
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);
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);
189 char reserved[SZ_4K - 8];
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);
199 static inline int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
204 static inline bool is_nd_btt(struct device *dev)
209 static inline struct device *nd_btt_create(struct nd_region *nd_region)
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);
221 static inline int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata)
226 static inline bool is_nd_pfn(struct device *dev)
231 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
237 struct nd_region *to_nd_region(struct device *dev);
238 int nd_region_to_nstype(struct nd_region *nd_region);
239 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
240 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
241 void nvdimm_bus_lock(struct device *dev);
242 void nvdimm_bus_unlock(struct device *dev);
243 bool is_nvdimm_bus_locked(struct device *dev);
244 int nvdimm_revalidate_disk(struct gendisk *disk);
245 void nvdimm_drvdata_release(struct kref *kref);
246 void put_ndd(struct nvdimm_drvdata *ndd);
247 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
248 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
249 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
250 struct nd_label_id *label_id, resource_size_t start,
252 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
253 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
254 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
255 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
256 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
258 int nd_blk_region_init(struct nd_region *nd_region);
259 void __nd_iostat_start(struct bio *bio, unsigned long *start);
260 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
262 struct gendisk *disk = bio->bi_bdev->bd_disk;
264 if (!blk_queue_io_stat(disk->queue))
267 __nd_iostat_start(bio, start);
270 void nd_iostat_end(struct bio *bio, unsigned long start);
271 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
272 const u8 *nd_dev_to_uuid(struct device *dev);
273 #endif /* __ND_H__ */