Commit | Line | Data |
---|---|---|
4d88a97a DW |
1 | /* |
2 | * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. | |
3 | * | |
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. | |
7 | * | |
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. | |
12 | */ | |
13 | #ifndef __ND_H__ | |
14 | #define __ND_H__ | |
1f7df6f8 | 15 | #include <linux/libnvdimm.h> |
f0dc089c | 16 | #include <linux/blkdev.h> |
4d88a97a DW |
17 | #include <linux/device.h> |
18 | #include <linux/mutex.h> | |
19 | #include <linux/ndctl.h> | |
bf9bccc1 | 20 | #include <linux/types.h> |
4a826c83 | 21 | #include "label.h" |
4d88a97a | 22 | |
8c2f7e86 | 23 | enum { |
5212e11f VV |
24 | /* |
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 | |
27 | * BTT instance | |
28 | */ | |
29 | ND_MAX_LANES = 256, | |
8c2f7e86 | 30 | SECTOR_SHIFT = 9, |
fcae6957 | 31 | INT_LBASIZE_ALIGNMENT = 64, |
8c2f7e86 DW |
32 | }; |
33 | ||
0caeef63 VV |
34 | struct nd_poison { |
35 | u64 start; | |
36 | u64 length; | |
37 | struct list_head list; | |
38 | }; | |
39 | ||
4d88a97a DW |
40 | struct nvdimm_drvdata { |
41 | struct device *dev; | |
4a826c83 | 42 | int nsindex_size; |
4d88a97a DW |
43 | struct nd_cmd_get_config_size nsarea; |
44 | void *data; | |
4a826c83 DW |
45 | int ns_current, ns_next; |
46 | struct resource dpa; | |
bf9bccc1 | 47 | struct kref kref; |
4d88a97a DW |
48 | }; |
49 | ||
3d88002e DW |
50 | struct nd_region_namespaces { |
51 | int count; | |
52 | int active; | |
53 | }; | |
54 | ||
4a826c83 DW |
55 | static inline struct nd_namespace_index *to_namespace_index( |
56 | struct nvdimm_drvdata *ndd, int i) | |
57 | { | |
58 | if (i < 0) | |
59 | return NULL; | |
60 | ||
61 | return ndd->data + sizeof_namespace_index(ndd) * i; | |
62 | } | |
63 | ||
64 | static inline struct nd_namespace_index *to_current_namespace_index( | |
65 | struct nvdimm_drvdata *ndd) | |
66 | { | |
67 | return to_namespace_index(ndd, ndd->ns_current); | |
68 | } | |
69 | ||
70 | static inline struct nd_namespace_index *to_next_namespace_index( | |
71 | struct nvdimm_drvdata *ndd) | |
72 | { | |
73 | return to_namespace_index(ndd, ndd->ns_next); | |
74 | } | |
75 | ||
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) | |
81 | ||
bf9bccc1 DW |
82 | #define for_each_label(l, label, labels) \ |
83 | for (l = 0; (label = labels ? labels[l] : NULL); l++) | |
84 | ||
85 | #define for_each_dpa_resource(ndd, res) \ | |
86 | for (res = (ndd)->dpa.child; res; res = res->sibling) | |
87 | ||
4a826c83 DW |
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) | |
91 | ||
5212e11f VV |
92 | struct nd_percpu_lane { |
93 | int count; | |
94 | spinlock_t lock; | |
95 | }; | |
96 | ||
1f7df6f8 DW |
97 | struct nd_region { |
98 | struct device dev; | |
1b40e09a | 99 | struct ida ns_ida; |
8c2f7e86 | 100 | struct ida btt_ida; |
e1455744 | 101 | struct ida pfn_ida; |
004f1afb | 102 | unsigned long flags; |
bf9bccc1 | 103 | struct device *ns_seed; |
8c2f7e86 | 104 | struct device *btt_seed; |
e1455744 | 105 | struct device *pfn_seed; |
1f7df6f8 DW |
106 | u16 ndr_mappings; |
107 | u64 ndr_size; | |
108 | u64 ndr_start; | |
41d7a6d6 | 109 | int id, num_lanes, ro, numa_node; |
1f7df6f8 | 110 | void *provider_data; |
eaf96153 | 111 | struct nd_interleave_set *nd_set; |
5212e11f | 112 | struct nd_percpu_lane __percpu *lane; |
1f7df6f8 DW |
113 | struct nd_mapping mapping[0]; |
114 | }; | |
115 | ||
047fc8a1 RZ |
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; | |
123 | }; | |
124 | ||
4a826c83 DW |
125 | /* |
126 | * Lookup next in the repeating sequence of 01, 10, and 11. | |
127 | */ | |
128 | static inline unsigned nd_inc_seq(unsigned seq) | |
129 | { | |
130 | static const unsigned next[] = { 0, 2, 3, 1 }; | |
131 | ||
132 | return next[seq & 3]; | |
133 | } | |
f524bf27 | 134 | |
5212e11f | 135 | struct btt; |
8c2f7e86 DW |
136 | struct nd_btt { |
137 | struct device dev; | |
138 | struct nd_namespace_common *ndns; | |
5212e11f | 139 | struct btt *btt; |
8c2f7e86 DW |
140 | unsigned long lbasize; |
141 | u8 *uuid; | |
142 | int id; | |
143 | }; | |
144 | ||
e1455744 DW |
145 | enum nd_pfn_mode { |
146 | PFN_MODE_NONE, | |
147 | PFN_MODE_RAM, | |
148 | PFN_MODE_PMEM, | |
149 | }; | |
150 | ||
151 | struct nd_pfn { | |
152 | int id; | |
153 | u8 *uuid; | |
154 | struct device dev; | |
315c5625 | 155 | unsigned long align; |
e1455744 DW |
156 | unsigned long npfns; |
157 | enum nd_pfn_mode mode; | |
158 | struct nd_pfn_sb *pfn_sb; | |
159 | struct nd_namespace_common *ndns; | |
160 | }; | |
161 | ||
4d88a97a DW |
162 | enum nd_async_mode { |
163 | ND_SYNC, | |
164 | ND_ASYNC, | |
165 | }; | |
166 | ||
41cd8b70 | 167 | int nd_integrity_init(struct gendisk *disk, unsigned long meta_size); |
bf9bccc1 | 168 | void wait_nvdimm_bus_probe_idle(struct device *dev); |
4d88a97a DW |
169 | void nd_device_register(struct device *dev); |
170 | void nd_device_unregister(struct device *dev, enum nd_async_mode mode); | |
bf9bccc1 DW |
171 | int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, |
172 | size_t len); | |
1b40e09a DW |
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); | |
4d88a97a | 177 | int __init nvdimm_init(void); |
3d88002e | 178 | int __init nd_region_init(void); |
4d88a97a | 179 | void nvdimm_exit(void); |
3d88002e | 180 | void nd_region_exit(void); |
bf9bccc1 DW |
181 | struct nvdimm; |
182 | struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); | |
4d88a97a DW |
183 | int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); |
184 | int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); | |
f524bf27 DW |
185 | int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, |
186 | void *buf, size_t len); | |
8c2f7e86 | 187 | struct nd_btt *to_nd_btt(struct device *dev); |
e1455744 DW |
188 | |
189 | struct nd_gen_sb { | |
190 | char reserved[SZ_4K - 8]; | |
191 | __le64 checksum; | |
192 | }; | |
193 | ||
194 | u64 nd_sb_checksum(struct nd_gen_sb *sb); | |
8c2f7e86 DW |
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); | |
199 | #else | |
f6ef5a2a | 200 | static inline int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata) |
8c2f7e86 DW |
201 | { |
202 | return -ENODEV; | |
203 | } | |
204 | ||
205 | static inline bool is_nd_btt(struct device *dev) | |
206 | { | |
207 | return false; | |
208 | } | |
209 | ||
210 | static inline struct device *nd_btt_create(struct nd_region *nd_region) | |
211 | { | |
212 | return NULL; | |
213 | } | |
e1455744 | 214 | #endif |
8c2f7e86 | 215 | |
e1455744 DW |
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); | |
32ab0a3f | 221 | int nd_pfn_validate(struct nd_pfn *nd_pfn); |
e1455744 DW |
222 | #else |
223 | static inline int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata) | |
224 | { | |
225 | return -ENODEV; | |
226 | } | |
227 | ||
228 | static inline bool is_nd_pfn(struct device *dev) | |
229 | { | |
230 | return false; | |
231 | } | |
232 | ||
233 | static inline struct device *nd_pfn_create(struct nd_region *nd_region) | |
234 | { | |
235 | return NULL; | |
236 | } | |
32ab0a3f DW |
237 | |
238 | static inline int nd_pfn_validate(struct nd_pfn *nd_pfn) | |
239 | { | |
240 | return -ENODEV; | |
241 | } | |
8c2f7e86 | 242 | #endif |
e1455744 | 243 | |
3d88002e DW |
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); | |
bf9bccc1 | 247 | u64 nd_region_interleave_set_cookie(struct nd_region *nd_region); |
3d88002e DW |
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); | |
58138820 | 251 | int nvdimm_revalidate_disk(struct gendisk *disk); |
bf9bccc1 DW |
252 | void nvdimm_drvdata_release(struct kref *kref); |
253 | void put_ndd(struct nvdimm_drvdata *ndd); | |
4a826c83 DW |
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, | |
258 | resource_size_t n); | |
8c2f7e86 DW |
259 | resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); |
260 | struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); | |
5212e11f VV |
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, | |
264 | char *name); | |
b95f5f43 DW |
265 | void nvdimm_namespace_add_poison(struct nd_namespace_common *ndns, |
266 | struct badblocks *bb, resource_size_t offset); | |
047fc8a1 | 267 | int nd_blk_region_init(struct nd_region *nd_region); |
f0dc089c DW |
268 | void __nd_iostat_start(struct bio *bio, unsigned long *start); |
269 | static inline bool nd_iostat_start(struct bio *bio, unsigned long *start) | |
270 | { | |
271 | struct gendisk *disk = bio->bi_bdev->bd_disk; | |
272 | ||
273 | if (!blk_queue_io_stat(disk->queue)) | |
274 | return false; | |
275 | ||
276 | __nd_iostat_start(bio, start); | |
277 | return true; | |
278 | } | |
279 | void nd_iostat_end(struct bio *bio, unsigned long start); | |
047fc8a1 | 280 | resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk); |
6ec68954 | 281 | const u8 *nd_dev_to_uuid(struct device *dev); |
004f1afb | 282 | bool pmem_should_map_pages(struct device *dev); |
4d88a97a | 283 | #endif /* __ND_H__ */ |