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 NVDIMM_IO_ATOMIC = 1, 35 }; 36 37 struct nd_poison { 38 u64 start; 39 u64 length; 40 struct list_head list; 41 }; 42 43 struct nvdimm_drvdata { 44 struct device *dev; 45 int nslabel_size; 46 struct nd_cmd_get_config_size nsarea; 47 void *data; 48 int ns_current, ns_next; 49 struct resource dpa; 50 struct kref kref; 51 }; 52 53 struct nd_region_data { 54 int ns_count; 55 int ns_active; 56 unsigned int hints_shift; 57 void __iomem *flush_wpq[0]; 58 }; 59 60 static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd, 61 int dimm, int hint) 62 { 63 unsigned int num = 1 << ndrd->hints_shift; 64 unsigned int mask = num - 1; 65 66 return ndrd->flush_wpq[dimm * num + (hint & mask)]; 67 } 68 69 static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm, 70 int hint, void __iomem *flush) 71 { 72 unsigned int num = 1 << ndrd->hints_shift; 73 unsigned int mask = num - 1; 74 75 ndrd->flush_wpq[dimm * num + (hint & mask)] = flush; 76 } 77 78 static inline struct nd_namespace_index *to_namespace_index( 79 struct nvdimm_drvdata *ndd, int i) 80 { 81 if (i < 0) 82 return NULL; 83 84 return ndd->data + sizeof_namespace_index(ndd) * i; 85 } 86 87 static inline struct nd_namespace_index *to_current_namespace_index( 88 struct nvdimm_drvdata *ndd) 89 { 90 return to_namespace_index(ndd, ndd->ns_current); 91 } 92 93 static inline struct nd_namespace_index *to_next_namespace_index( 94 struct nvdimm_drvdata *ndd) 95 { 96 return to_namespace_index(ndd, ndd->ns_next); 97 } 98 99 unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd); 100 101 #define namespace_label_has(ndd, field) \ 102 (offsetof(struct nd_namespace_label, field) \ 103 < sizeof_namespace_label(ndd)) 104 105 #define nd_dbg_dpa(r, d, res, fmt, arg...) \ 106 dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \ 107 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \ 108 (unsigned long long) (res ? resource_size(res) : 0), \ 109 (unsigned long long) (res ? res->start : 0), ##arg) 110 111 #define for_each_dpa_resource(ndd, res) \ 112 for (res = (ndd)->dpa.child; res; res = res->sibling) 113 114 #define for_each_dpa_resource_safe(ndd, res, next) \ 115 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \ 116 res; res = next, next = next ? next->sibling : NULL) 117 118 struct nd_percpu_lane { 119 int count; 120 spinlock_t lock; 121 }; 122 123 struct nd_label_ent { 124 struct list_head list; 125 struct nd_namespace_label *label; 126 }; 127 128 enum nd_mapping_lock_class { 129 ND_MAPPING_CLASS0, 130 ND_MAPPING_UUID_SCAN, 131 }; 132 133 struct nd_mapping { 134 struct nvdimm *nvdimm; 135 u64 start; 136 u64 size; 137 int position; 138 struct list_head labels; 139 struct mutex lock; 140 /* 141 * @ndd is for private use at region enable / disable time for 142 * get_ndd() + put_ndd(), all other nd_mapping to ndd 143 * conversions use to_ndd() which respects enabled state of the 144 * nvdimm. 145 */ 146 struct nvdimm_drvdata *ndd; 147 }; 148 149 struct nd_region { 150 struct device dev; 151 struct ida ns_ida; 152 struct ida btt_ida; 153 struct ida pfn_ida; 154 struct ida dax_ida; 155 unsigned long flags; 156 struct device *ns_seed; 157 struct device *btt_seed; 158 struct device *pfn_seed; 159 struct device *dax_seed; 160 u16 ndr_mappings; 161 u64 ndr_size; 162 u64 ndr_start; 163 int id, num_lanes, ro, numa_node; 164 void *provider_data; 165 struct kernfs_node *bb_state; 166 struct badblocks bb; 167 struct nd_interleave_set *nd_set; 168 struct nd_percpu_lane __percpu *lane; 169 struct nd_mapping mapping[0]; 170 }; 171 172 struct nd_blk_region { 173 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 174 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 175 void *iobuf, u64 len, int rw); 176 void *blk_provider_data; 177 struct nd_region nd_region; 178 }; 179 180 /* 181 * Lookup next in the repeating sequence of 01, 10, and 11. 182 */ 183 static inline unsigned nd_inc_seq(unsigned seq) 184 { 185 static const unsigned next[] = { 0, 2, 3, 1 }; 186 187 return next[seq & 3]; 188 } 189 190 struct btt; 191 struct nd_btt { 192 struct device dev; 193 struct nd_namespace_common *ndns; 194 struct btt *btt; 195 unsigned long lbasize; 196 u64 size; 197 u8 *uuid; 198 int id; 199 int initial_offset; 200 u16 version_major; 201 u16 version_minor; 202 }; 203 204 enum nd_pfn_mode { 205 PFN_MODE_NONE, 206 PFN_MODE_RAM, 207 PFN_MODE_PMEM, 208 }; 209 210 struct nd_pfn { 211 int id; 212 u8 *uuid; 213 struct device dev; 214 unsigned long align; 215 unsigned long npfns; 216 enum nd_pfn_mode mode; 217 struct nd_pfn_sb *pfn_sb; 218 struct nd_namespace_common *ndns; 219 }; 220 221 struct nd_dax { 222 struct nd_pfn nd_pfn; 223 }; 224 225 enum nd_async_mode { 226 ND_SYNC, 227 ND_ASYNC, 228 }; 229 230 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size); 231 void wait_nvdimm_bus_probe_idle(struct device *dev); 232 void nd_device_register(struct device *dev); 233 void nd_device_unregister(struct device *dev, enum nd_async_mode mode); 234 void nd_device_notify(struct device *dev, enum nvdimm_event event); 235 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, 236 size_t len); 237 ssize_t nd_size_select_show(unsigned long current_size, 238 const unsigned long *supported, char *buf); 239 ssize_t nd_size_select_store(struct device *dev, const char *buf, 240 unsigned long *current_size, const unsigned long *supported); 241 int __init nvdimm_init(void); 242 int __init nd_region_init(void); 243 int __init nd_label_init(void); 244 void nvdimm_exit(void); 245 void nd_region_exit(void); 246 struct nvdimm; 247 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); 248 int nvdimm_check_config_data(struct device *dev); 249 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); 250 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); 251 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, 252 void *buf, size_t len); 253 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys, 254 unsigned int len); 255 void nvdimm_set_aliasing(struct device *dev); 256 void nvdimm_set_locked(struct device *dev); 257 struct nd_btt *to_nd_btt(struct device *dev); 258 259 struct nd_gen_sb { 260 char reserved[SZ_4K - 8]; 261 __le64 checksum; 262 }; 263 264 u64 nd_sb_checksum(struct nd_gen_sb *sb); 265 #if IS_ENABLED(CONFIG_BTT) 266 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns); 267 bool is_nd_btt(struct device *dev); 268 struct device *nd_btt_create(struct nd_region *nd_region); 269 #else 270 static inline int nd_btt_probe(struct device *dev, 271 struct nd_namespace_common *ndns) 272 { 273 return -ENODEV; 274 } 275 276 static inline bool is_nd_btt(struct device *dev) 277 { 278 return false; 279 } 280 281 static inline struct device *nd_btt_create(struct nd_region *nd_region) 282 { 283 return NULL; 284 } 285 #endif 286 287 struct nd_pfn *to_nd_pfn(struct device *dev); 288 #if IS_ENABLED(CONFIG_NVDIMM_PFN) 289 290 #ifdef CONFIG_TRANSPARENT_HUGEPAGE 291 #define PFN_DEFAULT_ALIGNMENT HPAGE_PMD_SIZE 292 #else 293 #define PFN_DEFAULT_ALIGNMENT PAGE_SIZE 294 #endif 295 296 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns); 297 bool is_nd_pfn(struct device *dev); 298 struct device *nd_pfn_create(struct nd_region *nd_region); 299 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn, 300 struct nd_namespace_common *ndns); 301 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig); 302 extern struct attribute_group nd_pfn_attribute_group; 303 #else 304 static inline int nd_pfn_probe(struct device *dev, 305 struct nd_namespace_common *ndns) 306 { 307 return -ENODEV; 308 } 309 310 static inline bool is_nd_pfn(struct device *dev) 311 { 312 return false; 313 } 314 315 static inline struct device *nd_pfn_create(struct nd_region *nd_region) 316 { 317 return NULL; 318 } 319 320 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig) 321 { 322 return -ENODEV; 323 } 324 #endif 325 326 struct nd_dax *to_nd_dax(struct device *dev); 327 #if IS_ENABLED(CONFIG_NVDIMM_DAX) 328 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns); 329 bool is_nd_dax(struct device *dev); 330 struct device *nd_dax_create(struct nd_region *nd_region); 331 #else 332 static inline int nd_dax_probe(struct device *dev, 333 struct nd_namespace_common *ndns) 334 { 335 return -ENODEV; 336 } 337 338 static inline bool is_nd_dax(struct device *dev) 339 { 340 return false; 341 } 342 343 static inline struct device *nd_dax_create(struct nd_region *nd_region) 344 { 345 return NULL; 346 } 347 #endif 348 349 struct nd_region *to_nd_region(struct device *dev); 350 int nd_region_to_nstype(struct nd_region *nd_region); 351 int nd_region_register_namespaces(struct nd_region *nd_region, int *err); 352 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region, 353 struct nd_namespace_index *nsindex); 354 u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region); 355 void nvdimm_bus_lock(struct device *dev); 356 void nvdimm_bus_unlock(struct device *dev); 357 bool is_nvdimm_bus_locked(struct device *dev); 358 int nvdimm_revalidate_disk(struct gendisk *disk); 359 void nvdimm_drvdata_release(struct kref *kref); 360 void put_ndd(struct nvdimm_drvdata *ndd); 361 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd); 362 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res); 363 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, 364 struct nd_label_id *label_id, resource_size_t start, 365 resource_size_t n); 366 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 367 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); 368 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns); 369 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt); 370 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns, 371 char *name); 372 unsigned int pmem_sector_size(struct nd_namespace_common *ndns); 373 void nvdimm_badblocks_populate(struct nd_region *nd_region, 374 struct badblocks *bb, const struct resource *res); 375 #if IS_ENABLED(CONFIG_ND_CLAIM) 376 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 377 struct resource *res, struct vmem_altmap *altmap); 378 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio); 379 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio); 380 #else 381 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 382 struct resource *res, struct vmem_altmap *altmap) 383 { 384 return ERR_PTR(-ENXIO); 385 } 386 static inline int devm_nsio_enable(struct device *dev, 387 struct nd_namespace_io *nsio) 388 { 389 return -ENXIO; 390 } 391 static inline void devm_nsio_disable(struct device *dev, 392 struct nd_namespace_io *nsio) 393 { 394 } 395 #endif 396 int nd_blk_region_init(struct nd_region *nd_region); 397 int nd_region_activate(struct nd_region *nd_region); 398 void __nd_iostat_start(struct bio *bio, unsigned long *start); 399 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start) 400 { 401 struct gendisk *disk = bio->bi_disk; 402 403 if (!blk_queue_io_stat(disk->queue)) 404 return false; 405 406 *start = jiffies; 407 generic_start_io_acct(disk->queue, bio_data_dir(bio), 408 bio_sectors(bio), &disk->part0); 409 return true; 410 } 411 static inline void nd_iostat_end(struct bio *bio, unsigned long start) 412 { 413 struct gendisk *disk = bio->bi_disk; 414 415 generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0, 416 start); 417 } 418 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector, 419 unsigned int len) 420 { 421 if (bb->count) { 422 sector_t first_bad; 423 int num_bad; 424 425 return !!badblocks_check(bb, sector, len / 512, &first_bad, 426 &num_bad); 427 } 428 429 return false; 430 } 431 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk); 432 const u8 *nd_dev_to_uuid(struct device *dev); 433 bool pmem_should_map_pages(struct device *dev); 434 #endif /* __ND_H__ */ 435