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,
37 struct list_head list
;
40 struct nvdimm_drvdata
{
43 struct nd_cmd_get_config_size nsarea
;
45 int ns_current
, ns_next
;
50 struct nd_region_namespaces
{
55 static inline struct nd_namespace_index
*to_namespace_index(
56 struct nvdimm_drvdata
*ndd
, int i
)
61 return ndd
->data
+ sizeof_namespace_index(ndd
) * i
;
64 static inline struct nd_namespace_index
*to_current_namespace_index(
65 struct nvdimm_drvdata
*ndd
)
67 return to_namespace_index(ndd
, ndd
->ns_current
);
70 static inline struct nd_namespace_index
*to_next_namespace_index(
71 struct nvdimm_drvdata
*ndd
)
73 return to_namespace_index(ndd
, ndd
->ns_next
);
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)
82 #define for_each_label(l, label, labels) \
83 for (l = 0; (label = labels ? labels[l] : NULL); l++)
85 #define for_each_dpa_resource(ndd, res) \
86 for (res = (ndd)->dpa.child; res; res = res->sibling)
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)
92 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
;
157 enum nd_pfn_mode mode
;
158 struct nd_pfn_sb
*pfn_sb
;
159 struct nd_namespace_common
*ndns
;
167 int nd_integrity_init(struct gendisk
*disk
, unsigned long meta_size
);
168 void wait_nvdimm_bus_probe_idle(struct device
*dev
);
169 void nd_device_register(struct device
*dev
);
170 void nd_device_unregister(struct device
*dev
, enum nd_async_mode mode
);
171 int nd_uuid_store(struct device
*dev
, u8
**uuid_out
, const char *buf
,
173 ssize_t
nd_sector_size_show(unsigned long current_lbasize
,
174 const unsigned long *supported
, char *buf
);
175 ssize_t
nd_sector_size_store(struct device
*dev
, const char *buf
,
176 unsigned long *current_lbasize
, const unsigned long *supported
);
177 int __init
nvdimm_init(void);
178 int __init
nd_region_init(void);
179 void nvdimm_exit(void);
180 void nd_region_exit(void);
182 struct nvdimm_drvdata
*to_ndd(struct nd_mapping
*nd_mapping
);
183 int nvdimm_init_nsarea(struct nvdimm_drvdata
*ndd
);
184 int nvdimm_init_config_data(struct nvdimm_drvdata
*ndd
);
185 int nvdimm_set_config_data(struct nvdimm_drvdata
*ndd
, size_t offset
,
186 void *buf
, size_t len
);
187 struct nd_btt
*to_nd_btt(struct device
*dev
);
190 char reserved
[SZ_4K
- 8];
194 u64
nd_sb_checksum(struct nd_gen_sb
*sb
);
195 #if IS_ENABLED(CONFIG_BTT)
196 int nd_btt_probe(struct nd_namespace_common
*ndns
, void *drvdata
);
197 bool is_nd_btt(struct device
*dev
);
198 struct device
*nd_btt_create(struct nd_region
*nd_region
);
200 static inline int nd_btt_probe(struct nd_namespace_common
*ndns
, void *drvdata
)
205 static inline bool is_nd_btt(struct device
*dev
)
210 static inline struct device
*nd_btt_create(struct nd_region
*nd_region
)
216 struct nd_pfn
*to_nd_pfn(struct device
*dev
);
217 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
218 int nd_pfn_probe(struct nd_namespace_common
*ndns
, void *drvdata
);
219 bool is_nd_pfn(struct device
*dev
);
220 struct device
*nd_pfn_create(struct nd_region
*nd_region
);
221 int nd_pfn_validate(struct nd_pfn
*nd_pfn
);
223 static inline int nd_pfn_probe(struct nd_namespace_common
*ndns
, void *drvdata
)
228 static inline bool is_nd_pfn(struct device
*dev
)
233 static inline struct device
*nd_pfn_create(struct nd_region
*nd_region
)
238 static inline int nd_pfn_validate(struct nd_pfn
*nd_pfn
)
244 struct nd_region
*to_nd_region(struct device
*dev
);
245 int nd_region_to_nstype(struct nd_region
*nd_region
);
246 int nd_region_register_namespaces(struct nd_region
*nd_region
, int *err
);
247 u64
nd_region_interleave_set_cookie(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
,
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
,
265 void nvdimm_namespace_add_poison(struct nd_namespace_common
*ndns
,
266 struct badblocks
*bb
, resource_size_t offset
);
267 int nd_blk_region_init(struct nd_region
*nd_region
);
268 void __nd_iostat_start(struct bio
*bio
, unsigned long *start
);
269 static inline bool nd_iostat_start(struct bio
*bio
, unsigned long *start
)
271 struct gendisk
*disk
= bio
->bi_bdev
->bd_disk
;
273 if (!blk_queue_io_stat(disk
->queue
))
276 __nd_iostat_start(bio
, start
);
279 void nd_iostat_end(struct bio
*bio
, unsigned long start
);
280 resource_size_t
nd_namespace_blk_validate(struct nd_namespace_blk
*nsblk
);
281 const u8
*nd_dev_to_uuid(struct device
*dev
);
282 bool pmem_should_map_pages(struct device
*dev
);
283 #endif /* __ND_H__ */