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,
44 struct list_head list
;
47 struct nvdimm_drvdata
{
50 struct nd_cmd_get_config_size nsarea
;
52 int ns_current
, ns_next
;
57 struct nd_region_namespaces
{
62 static inline struct nd_namespace_index
*to_namespace_index(
63 struct nvdimm_drvdata
*ndd
, int i
)
68 return ndd
->data
+ sizeof_namespace_index(ndd
) * i
;
71 static inline struct nd_namespace_index
*to_current_namespace_index(
72 struct nvdimm_drvdata
*ndd
)
74 return to_namespace_index(ndd
, ndd
->ns_current
);
77 static inline struct nd_namespace_index
*to_next_namespace_index(
78 struct nvdimm_drvdata
*ndd
)
80 return to_namespace_index(ndd
, ndd
->ns_next
);
83 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
84 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
85 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
86 (unsigned long long) (res ? resource_size(res) : 0), \
87 (unsigned long long) (res ? res->start : 0), ##arg)
89 #define for_each_label(l, label, labels) \
90 for (l = 0; (label = labels ? labels[l] : NULL); l++)
92 #define for_each_dpa_resource(ndd, res) \
93 for (res = (ndd)->dpa.child; res; res = res->sibling)
95 #define for_each_dpa_resource_safe(ndd, res, next) \
96 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
97 res; res = next, next = next ? next->sibling : NULL)
99 struct nd_percpu_lane
{
110 struct device
*ns_seed
;
111 struct device
*btt_seed
;
112 struct device
*pfn_seed
;
116 int id
, num_lanes
, ro
, numa_node
;
118 struct nd_interleave_set
*nd_set
;
119 struct nd_percpu_lane __percpu
*lane
;
120 struct nd_mapping mapping
[0];
123 struct nd_blk_region
{
124 int (*enable
)(struct nvdimm_bus
*nvdimm_bus
, struct device
*dev
);
125 void (*disable
)(struct nvdimm_bus
*nvdimm_bus
, struct device
*dev
);
126 int (*do_io
)(struct nd_blk_region
*ndbr
, resource_size_t dpa
,
127 void *iobuf
, u64 len
, int rw
);
128 void *blk_provider_data
;
129 struct nd_region nd_region
;
133 * Lookup next in the repeating sequence of 01, 10, and 11.
135 static inline unsigned nd_inc_seq(unsigned seq
)
137 static const unsigned next
[] = { 0, 2, 3, 1 };
139 return next
[seq
& 3];
145 struct nd_namespace_common
*ndns
;
147 unsigned long lbasize
;
163 enum nd_pfn_mode mode
;
164 struct nd_pfn_sb
*pfn_sb
;
165 struct nd_namespace_common
*ndns
;
173 int nd_integrity_init(struct gendisk
*disk
, unsigned long meta_size
);
174 void wait_nvdimm_bus_probe_idle(struct device
*dev
);
175 void nd_device_register(struct device
*dev
);
176 void nd_device_unregister(struct device
*dev
, enum nd_async_mode mode
);
177 int nd_uuid_store(struct device
*dev
, u8
**uuid_out
, const char *buf
,
179 ssize_t
nd_sector_size_show(unsigned long current_lbasize
,
180 const unsigned long *supported
, char *buf
);
181 ssize_t
nd_sector_size_store(struct device
*dev
, const char *buf
,
182 unsigned long *current_lbasize
, const unsigned long *supported
);
183 int __init
nvdimm_init(void);
184 int __init
nd_region_init(void);
185 void nvdimm_exit(void);
186 void nd_region_exit(void);
188 struct nvdimm_drvdata
*to_ndd(struct nd_mapping
*nd_mapping
);
189 int nvdimm_init_nsarea(struct nvdimm_drvdata
*ndd
);
190 int nvdimm_init_config_data(struct nvdimm_drvdata
*ndd
);
191 int nvdimm_set_config_data(struct nvdimm_drvdata
*ndd
, size_t offset
,
192 void *buf
, size_t len
);
193 struct nd_btt
*to_nd_btt(struct device
*dev
);
196 char reserved
[SZ_4K
- 8];
200 u64
nd_sb_checksum(struct nd_gen_sb
*sb
);
201 #if IS_ENABLED(CONFIG_BTT)
202 int nd_btt_probe(struct nd_namespace_common
*ndns
, void *drvdata
);
203 bool is_nd_btt(struct device
*dev
);
204 struct device
*nd_btt_create(struct nd_region
*nd_region
);
206 static inline int nd_btt_probe(struct nd_namespace_common
*ndns
, void *drvdata
)
211 static inline bool is_nd_btt(struct device
*dev
)
216 static inline struct device
*nd_btt_create(struct nd_region
*nd_region
)
222 struct nd_pfn
*to_nd_pfn(struct device
*dev
);
223 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
224 int nd_pfn_probe(struct nd_namespace_common
*ndns
, void *drvdata
);
225 bool is_nd_pfn(struct device
*dev
);
226 struct device
*nd_pfn_create(struct nd_region
*nd_region
);
227 int nd_pfn_validate(struct nd_pfn
*nd_pfn
);
229 static inline int nd_pfn_probe(struct nd_namespace_common
*ndns
, void *drvdata
)
234 static inline bool is_nd_pfn(struct device
*dev
)
239 static inline struct device
*nd_pfn_create(struct nd_region
*nd_region
)
244 static inline int nd_pfn_validate(struct nd_pfn
*nd_pfn
)
250 struct nd_region
*to_nd_region(struct device
*dev
);
251 int nd_region_to_nstype(struct nd_region
*nd_region
);
252 int nd_region_register_namespaces(struct nd_region
*nd_region
, int *err
);
253 u64
nd_region_interleave_set_cookie(struct nd_region
*nd_region
);
254 void nvdimm_bus_lock(struct device
*dev
);
255 void nvdimm_bus_unlock(struct device
*dev
);
256 bool is_nvdimm_bus_locked(struct device
*dev
);
257 int nvdimm_revalidate_disk(struct gendisk
*disk
);
258 void nvdimm_drvdata_release(struct kref
*kref
);
259 void put_ndd(struct nvdimm_drvdata
*ndd
);
260 int nd_label_reserve_dpa(struct nvdimm_drvdata
*ndd
);
261 void nvdimm_free_dpa(struct nvdimm_drvdata
*ndd
, struct resource
*res
);
262 struct resource
*nvdimm_allocate_dpa(struct nvdimm_drvdata
*ndd
,
263 struct nd_label_id
*label_id
, resource_size_t start
,
265 resource_size_t
nvdimm_namespace_capacity(struct nd_namespace_common
*ndns
);
266 struct nd_namespace_common
*nvdimm_namespace_common_probe(struct device
*dev
);
267 int nvdimm_namespace_attach_btt(struct nd_namespace_common
*ndns
);
268 int nvdimm_namespace_detach_btt(struct nd_namespace_common
*ndns
);
269 const char *nvdimm_namespace_disk_name(struct nd_namespace_common
*ndns
,
271 int nd_blk_region_init(struct nd_region
*nd_region
);
272 void __nd_iostat_start(struct bio
*bio
, unsigned long *start
);
273 static inline bool nd_iostat_start(struct bio
*bio
, unsigned long *start
)
275 struct gendisk
*disk
= bio
->bi_bdev
->bd_disk
;
277 if (!blk_queue_io_stat(disk
->queue
))
280 __nd_iostat_start(bio
, start
);
283 void nd_iostat_end(struct bio
*bio
, unsigned long start
);
284 resource_size_t
nd_namespace_blk_validate(struct nd_namespace_blk
*nsblk
);
285 const u8
*nd_dev_to_uuid(struct device
*dev
);
286 bool pmem_should_map_pages(struct device
*dev
);
287 #endif /* __ND_H__ */