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__ 15 #include <linux/libnvdimm.h> 16 #include <linux/badblocks.h> 17 #include <linux/blkdev.h> 18 #include <linux/device.h> 19 #include <linux/mutex.h> 20 #include <linux/ndctl.h> 21 #include <linux/types.h> 22 #include <linux/nd.h> 23 #include "label.h" 24 25 enum { 26 /* 27 * Limits the maximum number of block apertures a dimm can 28 * support and is an input to the geometry/on-disk-format of a 29 * BTT instance 30 */ 31 ND_MAX_LANES = 256, 32 SECTOR_SHIFT = 9, 33 INT_LBASIZE_ALIGNMENT = 64, 34 }; 35 36 struct nd_poison { 37 u64 start; 38 u64 length; 39 struct list_head list; 40 }; 41 42 struct nvdimm_drvdata { 43 struct device *dev; 44 int nsindex_size; 45 struct nd_cmd_get_config_size nsarea; 46 void *data; 47 int ns_current, ns_next; 48 struct resource dpa; 49 struct kref kref; 50 }; 51 52 struct nd_region_data { 53 int ns_count; 54 int ns_active; 55 unsigned int hints_shift; 56 void __iomem *flush_wpq[0]; 57 }; 58 59 static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd, 60 int dimm, int hint) 61 { 62 unsigned int num = 1 << ndrd->hints_shift; 63 unsigned int mask = num - 1; 64 65 return ndrd->flush_wpq[dimm * num + (hint & mask)]; 66 } 67 68 static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm, 69 int hint, void __iomem *flush) 70 { 71 unsigned int num = 1 << ndrd->hints_shift; 72 unsigned int mask = num - 1; 73 74 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush; 75 } 76 77 static inline struct nd_namespace_index *to_namespace_index( 78 struct nvdimm_drvdata *ndd, int i) 79 { 80 if (i < 0) 81 return NULL; 82 83 return ndd->data + sizeof_namespace_index(ndd) * i; 84 } 85 86 static inline struct nd_namespace_index *to_current_namespace_index( 87 struct nvdimm_drvdata *ndd) 88 { 89 return to_namespace_index(ndd, ndd->ns_current); 90 } 91 92 static inline struct nd_namespace_index *to_next_namespace_index( 93 struct nvdimm_drvdata *ndd) 94 { 95 return to_namespace_index(ndd, ndd->ns_next); 96 } 97 98 #define nd_dbg_dpa(r, d, res, fmt, arg...) \ 99 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \ 100 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \ 101 (unsigned long long) (res ? resource_size(res) : 0), \ 102 (unsigned long long) (res ? res->start : 0), ##arg) 103 104 #define for_each_label(l, label, labels) \ 105 for (l = 0; (label = labels ? labels[l] : NULL); l++) 106 107 #define for_each_dpa_resource(ndd, res) \ 108 for (res = (ndd)->dpa.child; res; res = res->sibling) 109 110 #define for_each_dpa_resource_safe(ndd, res, next) \ 111 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \ 112 res; res = next, next = next ? next->sibling : NULL) 113 114 struct nd_percpu_lane { 115 int count; 116 spinlock_t lock; 117 }; 118 119 struct nd_region { 120 struct device dev; 121 struct ida ns_ida; 122 struct ida btt_ida; 123 struct ida pfn_ida; 124 struct ida dax_ida; 125 unsigned long flags; 126 struct device *ns_seed; 127 struct device *btt_seed; 128 struct device *pfn_seed; 129 struct device *dax_seed; 130 u16 ndr_mappings; 131 u64 ndr_size; 132 u64 ndr_start; 133 int id, num_lanes, ro, numa_node; 134 void *provider_data; 135 struct nd_interleave_set *nd_set; 136 struct nd_percpu_lane __percpu *lane; 137 struct nd_mapping mapping[0]; 138 }; 139 140 struct nd_blk_region { 141 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 142 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 143 void *iobuf, u64 len, int rw); 144 void *blk_provider_data; 145 struct nd_region nd_region; 146 }; 147 148 /* 149 * Lookup next in the repeating sequence of 01, 10, and 11. 150 */ 151 static inline unsigned nd_inc_seq(unsigned seq) 152 { 153 static const unsigned next[] = { 0, 2, 3, 1 }; 154 155 return next[seq & 3]; 156 } 157 158 struct btt; 159 struct nd_btt { 160 struct device dev; 161 struct nd_namespace_common *ndns; 162 struct btt *btt; 163 unsigned long lbasize; 164 u64 size; 165 u8 *uuid; 166 int id; 167 }; 168 169 enum nd_pfn_mode { 170 PFN_MODE_NONE, 171 PFN_MODE_RAM, 172 PFN_MODE_PMEM, 173 }; 174 175 struct nd_pfn { 176 int id; 177 u8 *uuid; 178 struct device dev; 179 unsigned long align; 180 unsigned long npfns; 181 enum nd_pfn_mode mode; 182 struct nd_pfn_sb *pfn_sb; 183 struct nd_namespace_common *ndns; 184 }; 185 186 struct nd_dax { 187 struct nd_pfn nd_pfn; 188 }; 189 190 enum nd_async_mode { 191 ND_SYNC, 192 ND_ASYNC, 193 }; 194 195 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size); 196 void wait_nvdimm_bus_probe_idle(struct device *dev); 197 void nd_device_register(struct device *dev); 198 void nd_device_unregister(struct device *dev, enum nd_async_mode mode); 199 void nd_device_notify(struct device *dev, enum nvdimm_event event); 200 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, 201 size_t len); 202 ssize_t nd_sector_size_show(unsigned long current_lbasize, 203 const unsigned long *supported, char *buf); 204 ssize_t nd_sector_size_store(struct device *dev, const char *buf, 205 unsigned long *current_lbasize, const unsigned long *supported); 206 int __init nvdimm_init(void); 207 int __init nd_region_init(void); 208 void nvdimm_exit(void); 209 void nd_region_exit(void); 210 struct nvdimm; 211 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); 212 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); 213 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); 214 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, 215 void *buf, size_t len); 216 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys, 217 unsigned int len); 218 struct nd_btt *to_nd_btt(struct device *dev); 219 220 struct nd_gen_sb { 221 char reserved[SZ_4K - 8]; 222 __le64 checksum; 223 }; 224 225 u64 nd_sb_checksum(struct nd_gen_sb *sb); 226 #if IS_ENABLED(CONFIG_BTT) 227 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns); 228 bool is_nd_btt(struct device *dev); 229 struct device *nd_btt_create(struct nd_region *nd_region); 230 #else 231 static inline int nd_btt_probe(struct device *dev, 232 struct nd_namespace_common *ndns) 233 { 234 return -ENODEV; 235 } 236 237 static inline bool is_nd_btt(struct device *dev) 238 { 239 return false; 240 } 241 242 static inline struct device *nd_btt_create(struct nd_region *nd_region) 243 { 244 return NULL; 245 } 246 #endif 247 248 struct nd_pfn *to_nd_pfn(struct device *dev); 249 #if IS_ENABLED(CONFIG_NVDIMM_PFN) 250 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns); 251 bool is_nd_pfn(struct device *dev); 252 struct device *nd_pfn_create(struct nd_region *nd_region); 253 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn, 254 struct nd_namespace_common *ndns); 255 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig); 256 extern struct attribute_group nd_pfn_attribute_group; 257 #else 258 static inline int nd_pfn_probe(struct device *dev, 259 struct nd_namespace_common *ndns) 260 { 261 return -ENODEV; 262 } 263 264 static inline bool is_nd_pfn(struct device *dev) 265 { 266 return false; 267 } 268 269 static inline struct device *nd_pfn_create(struct nd_region *nd_region) 270 { 271 return NULL; 272 } 273 274 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig) 275 { 276 return -ENODEV; 277 } 278 #endif 279 280 struct nd_dax *to_nd_dax(struct device *dev); 281 #if IS_ENABLED(CONFIG_NVDIMM_DAX) 282 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns); 283 bool is_nd_dax(struct device *dev); 284 struct device *nd_dax_create(struct nd_region *nd_region); 285 #else 286 static inline int nd_dax_probe(struct device *dev, 287 struct nd_namespace_common *ndns) 288 { 289 return -ENODEV; 290 } 291 292 static inline bool is_nd_dax(struct device *dev) 293 { 294 return false; 295 } 296 297 static inline struct device *nd_dax_create(struct nd_region *nd_region) 298 { 299 return NULL; 300 } 301 #endif 302 303 struct nd_region *to_nd_region(struct device *dev); 304 int nd_region_to_nstype(struct nd_region *nd_region); 305 int nd_region_register_namespaces(struct nd_region *nd_region, int *err); 306 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region); 307 void nvdimm_bus_lock(struct device *dev); 308 void nvdimm_bus_unlock(struct device *dev); 309 bool is_nvdimm_bus_locked(struct device *dev); 310 int nvdimm_revalidate_disk(struct gendisk *disk); 311 void nvdimm_drvdata_release(struct kref *kref); 312 void put_ndd(struct nvdimm_drvdata *ndd); 313 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd); 314 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res); 315 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, 316 struct nd_label_id *label_id, resource_size_t start, 317 resource_size_t n); 318 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 319 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); 320 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns); 321 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt); 322 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns, 323 char *name); 324 void nvdimm_badblocks_populate(struct nd_region *nd_region, 325 struct badblocks *bb, const struct resource *res); 326 #if IS_ENABLED(CONFIG_ND_CLAIM) 327 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 328 struct resource *res, struct vmem_altmap *altmap); 329 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio); 330 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio); 331 #else 332 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 333 struct resource *res, struct vmem_altmap *altmap) 334 { 335 return ERR_PTR(-ENXIO); 336 } 337 static inline int devm_nsio_enable(struct device *dev, 338 struct nd_namespace_io *nsio) 339 { 340 return -ENXIO; 341 } 342 static inline void devm_nsio_disable(struct device *dev, 343 struct nd_namespace_io *nsio) 344 { 345 } 346 #endif 347 int nd_blk_region_init(struct nd_region *nd_region); 348 int nd_region_activate(struct nd_region *nd_region); 349 void __nd_iostat_start(struct bio *bio, unsigned long *start); 350 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start) 351 { 352 struct gendisk *disk = bio->bi_bdev->bd_disk; 353 354 if (!blk_queue_io_stat(disk->queue)) 355 return false; 356 357 __nd_iostat_start(bio, start); 358 return true; 359 } 360 void nd_iostat_end(struct bio *bio, unsigned long start); 361 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector, 362 unsigned int len) 363 { 364 if (bb->count) { 365 sector_t first_bad; 366 int num_bad; 367 368 return !!badblocks_check(bb, sector, len / 512, &first_bad, 369 &num_bad); 370 } 371 372 return false; 373 } 374 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk); 375 const u8 *nd_dev_to_uuid(struct device *dev); 376 bool pmem_should_map_pages(struct device *dev); 377 #endif /* __ND_H__ */ 378