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/device.h>
17 #include <linux/mutex.h>
18 #include <linux/ndctl.h>
19 #include <linux/types.h>
24 * Limits the maximum number of block apertures a dimm can
25 * support and is an input to the geometry/on-disk-format of a
32 struct nvdimm_drvdata {
35 struct nd_cmd_get_config_size nsarea;
37 int ns_current, ns_next;
42 struct nd_region_namespaces {
47 static inline struct nd_namespace_index *to_namespace_index(
48 struct nvdimm_drvdata *ndd, int i)
53 return ndd->data + sizeof_namespace_index(ndd) * i;
56 static inline struct nd_namespace_index *to_current_namespace_index(
57 struct nvdimm_drvdata *ndd)
59 return to_namespace_index(ndd, ndd->ns_current);
62 static inline struct nd_namespace_index *to_next_namespace_index(
63 struct nvdimm_drvdata *ndd)
65 return to_namespace_index(ndd, ndd->ns_next);
68 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
69 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
70 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
71 (unsigned long long) (res ? resource_size(res) : 0), \
72 (unsigned long long) (res ? res->start : 0), ##arg)
74 #define for_each_label(l, label, labels) \
75 for (l = 0; (label = labels ? labels[l] : NULL); l++)
77 #define for_each_dpa_resource(ndd, res) \
78 for (res = (ndd)->dpa.child; res; res = res->sibling)
80 #define for_each_dpa_resource_safe(ndd, res, next) \
81 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
82 res; res = next, next = next ? next->sibling : NULL)
84 struct nd_percpu_lane {
93 struct device *ns_seed;
94 struct device *btt_seed;
100 struct nd_interleave_set *nd_set;
101 struct nd_percpu_lane __percpu *lane;
102 struct nd_mapping mapping[0];
105 struct nd_blk_region {
106 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
107 void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
108 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
109 void *iobuf, u64 len, int rw);
110 void *blk_provider_data;
111 struct nd_region nd_region;
115 * Lookup next in the repeating sequence of 01, 10, and 11.
117 static inline unsigned nd_inc_seq(unsigned seq)
119 static const unsigned next[] = { 0, 2, 3, 1 };
121 return next[seq & 3];
127 struct nd_namespace_common *ndns;
129 unsigned long lbasize;
139 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
140 void wait_nvdimm_bus_probe_idle(struct device *dev);
141 void nd_device_register(struct device *dev);
142 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
143 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
145 ssize_t nd_sector_size_show(unsigned long current_lbasize,
146 const unsigned long *supported, char *buf);
147 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
148 unsigned long *current_lbasize, const unsigned long *supported);
149 int __init nvdimm_init(void);
150 int __init nd_region_init(void);
151 void nvdimm_exit(void);
152 void nd_region_exit(void);
154 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
155 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
156 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
157 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
158 void *buf, size_t len);
159 struct nd_btt *to_nd_btt(struct device *dev);
161 u64 nd_btt_sb_checksum(struct btt_sb *btt_sb);
162 #if IS_ENABLED(CONFIG_BTT)
163 int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
164 bool is_nd_btt(struct device *dev);
165 struct device *nd_btt_create(struct nd_region *nd_region);
167 static inline nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
172 static inline bool is_nd_btt(struct device *dev)
177 static inline struct device *nd_btt_create(struct nd_region *nd_region)
183 struct nd_region *to_nd_region(struct device *dev);
184 int nd_region_to_nstype(struct nd_region *nd_region);
185 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
186 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
187 void nvdimm_bus_lock(struct device *dev);
188 void nvdimm_bus_unlock(struct device *dev);
189 bool is_nvdimm_bus_locked(struct device *dev);
190 void nvdimm_drvdata_release(struct kref *kref);
191 void put_ndd(struct nvdimm_drvdata *ndd);
192 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
193 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
194 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
195 struct nd_label_id *label_id, resource_size_t start,
197 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
198 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
199 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
200 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
201 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
203 int nd_blk_region_init(struct nd_region *nd_region);
204 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
205 #endif /* __ND_H__ */