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_dpa_resource(ndd, res) \ 105 for (res = (ndd)->dpa.child; res; res = res->sibling) 106 107 #define for_each_dpa_resource_safe(ndd, res, next) \ 108 for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \ 109 res; res = next, next = next ? next->sibling : NULL) 110 111 struct nd_percpu_lane { 112 int count; 113 spinlock_t lock; 114 }; 115 116 struct nd_label_ent { 117 struct list_head list; 118 struct nd_namespace_label *label; 119 }; 120 121 enum nd_mapping_lock_class { 122 ND_MAPPING_CLASS0, 123 ND_MAPPING_UUID_SCAN, 124 }; 125 126 struct nd_mapping { 127 struct nvdimm *nvdimm; 128 u64 start; 129 u64 size; 130 struct list_head labels; 131 struct mutex lock; 132 /* 133 * @ndd is for private use at region enable / disable time for 134 * get_ndd() + put_ndd(), all other nd_mapping to ndd 135 * conversions use to_ndd() which respects enabled state of the 136 * nvdimm. 137 */ 138 struct nvdimm_drvdata *ndd; 139 }; 140 141 struct nd_region { 142 struct device dev; 143 struct ida ns_ida; 144 struct ida btt_ida; 145 struct ida pfn_ida; 146 struct ida dax_ida; 147 unsigned long flags; 148 struct device *ns_seed; 149 struct device *btt_seed; 150 struct device *pfn_seed; 151 struct device *dax_seed; 152 u16 ndr_mappings; 153 u64 ndr_size; 154 u64 ndr_start; 155 int id, num_lanes, ro, numa_node; 156 void *provider_data; 157 struct nd_interleave_set *nd_set; 158 struct nd_percpu_lane __percpu *lane; 159 struct nd_mapping mapping[0]; 160 }; 161 162 struct nd_blk_region { 163 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 164 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 165 void *iobuf, u64 len, int rw); 166 void *blk_provider_data; 167 struct nd_region nd_region; 168 }; 169 170 /* 171 * Lookup next in the repeating sequence of 01, 10, and 11. 172 */ 173 static inline unsigned nd_inc_seq(unsigned seq) 174 { 175 static const unsigned next[] = { 0, 2, 3, 1 }; 176 177 return next[seq & 3]; 178 } 179 180 struct btt; 181 struct nd_btt { 182 struct device dev; 183 struct nd_namespace_common *ndns; 184 struct btt *btt; 185 unsigned long lbasize; 186 u64 size; 187 u8 *uuid; 188 int id; 189 }; 190 191 enum nd_pfn_mode { 192 PFN_MODE_NONE, 193 PFN_MODE_RAM, 194 PFN_MODE_PMEM, 195 }; 196 197 struct nd_pfn { 198 int id; 199 u8 *uuid; 200 struct device dev; 201 unsigned long align; 202 unsigned long npfns; 203 enum nd_pfn_mode mode; 204 struct nd_pfn_sb *pfn_sb; 205 struct nd_namespace_common *ndns; 206 }; 207 208 struct nd_dax { 209 struct nd_pfn nd_pfn; 210 }; 211 212 enum nd_async_mode { 213 ND_SYNC, 214 ND_ASYNC, 215 }; 216 217 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size); 218 void wait_nvdimm_bus_probe_idle(struct device *dev); 219 void nd_device_register(struct device *dev); 220 void nd_device_unregister(struct device *dev, enum nd_async_mode mode); 221 void nd_device_notify(struct device *dev, enum nvdimm_event event); 222 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, 223 size_t len); 224 ssize_t nd_sector_size_show(unsigned long current_lbasize, 225 const unsigned long *supported, char *buf); 226 ssize_t nd_sector_size_store(struct device *dev, const char *buf, 227 unsigned long *current_lbasize, const unsigned long *supported); 228 int __init nvdimm_init(void); 229 int __init nd_region_init(void); 230 void nvdimm_exit(void); 231 void nd_region_exit(void); 232 struct nvdimm; 233 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); 234 int nvdimm_check_config_data(struct device *dev); 235 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); 236 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); 237 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, 238 void *buf, size_t len); 239 long nvdimm_clear_poison(struct device *dev, phys_addr_t phys, 240 unsigned int len); 241 void nvdimm_set_aliasing(struct device *dev); 242 struct nd_btt *to_nd_btt(struct device *dev); 243 244 struct nd_gen_sb { 245 char reserved[SZ_4K - 8]; 246 __le64 checksum; 247 }; 248 249 u64 nd_sb_checksum(struct nd_gen_sb *sb); 250 #if IS_ENABLED(CONFIG_BTT) 251 int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns); 252 bool is_nd_btt(struct device *dev); 253 struct device *nd_btt_create(struct nd_region *nd_region); 254 #else 255 static inline int nd_btt_probe(struct device *dev, 256 struct nd_namespace_common *ndns) 257 { 258 return -ENODEV; 259 } 260 261 static inline bool is_nd_btt(struct device *dev) 262 { 263 return false; 264 } 265 266 static inline struct device *nd_btt_create(struct nd_region *nd_region) 267 { 268 return NULL; 269 } 270 #endif 271 272 struct nd_pfn *to_nd_pfn(struct device *dev); 273 #if IS_ENABLED(CONFIG_NVDIMM_PFN) 274 int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns); 275 bool is_nd_pfn(struct device *dev); 276 struct device *nd_pfn_create(struct nd_region *nd_region); 277 struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn, 278 struct nd_namespace_common *ndns); 279 int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig); 280 extern struct attribute_group nd_pfn_attribute_group; 281 #else 282 static inline int nd_pfn_probe(struct device *dev, 283 struct nd_namespace_common *ndns) 284 { 285 return -ENODEV; 286 } 287 288 static inline bool is_nd_pfn(struct device *dev) 289 { 290 return false; 291 } 292 293 static inline struct device *nd_pfn_create(struct nd_region *nd_region) 294 { 295 return NULL; 296 } 297 298 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig) 299 { 300 return -ENODEV; 301 } 302 #endif 303 304 struct nd_dax *to_nd_dax(struct device *dev); 305 #if IS_ENABLED(CONFIG_NVDIMM_DAX) 306 int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns); 307 bool is_nd_dax(struct device *dev); 308 struct device *nd_dax_create(struct nd_region *nd_region); 309 #else 310 static inline int nd_dax_probe(struct device *dev, 311 struct nd_namespace_common *ndns) 312 { 313 return -ENODEV; 314 } 315 316 static inline bool is_nd_dax(struct device *dev) 317 { 318 return false; 319 } 320 321 static inline struct device *nd_dax_create(struct nd_region *nd_region) 322 { 323 return NULL; 324 } 325 #endif 326 327 struct nd_region *to_nd_region(struct device *dev); 328 int nd_region_to_nstype(struct nd_region *nd_region); 329 int nd_region_register_namespaces(struct nd_region *nd_region, int *err); 330 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region); 331 u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region); 332 void nvdimm_bus_lock(struct device *dev); 333 void nvdimm_bus_unlock(struct device *dev); 334 bool is_nvdimm_bus_locked(struct device *dev); 335 int nvdimm_revalidate_disk(struct gendisk *disk); 336 void nvdimm_drvdata_release(struct kref *kref); 337 void put_ndd(struct nvdimm_drvdata *ndd); 338 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd); 339 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res); 340 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, 341 struct nd_label_id *label_id, resource_size_t start, 342 resource_size_t n); 343 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 344 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); 345 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns); 346 int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt); 347 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns, 348 char *name); 349 void nvdimm_badblocks_populate(struct nd_region *nd_region, 350 struct badblocks *bb, const struct resource *res); 351 #if IS_ENABLED(CONFIG_ND_CLAIM) 352 struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 353 struct resource *res, struct vmem_altmap *altmap); 354 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio); 355 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio); 356 #else 357 static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn, 358 struct resource *res, struct vmem_altmap *altmap) 359 { 360 return ERR_PTR(-ENXIO); 361 } 362 static inline int devm_nsio_enable(struct device *dev, 363 struct nd_namespace_io *nsio) 364 { 365 return -ENXIO; 366 } 367 static inline void devm_nsio_disable(struct device *dev, 368 struct nd_namespace_io *nsio) 369 { 370 } 371 #endif 372 int nd_blk_region_init(struct nd_region *nd_region); 373 int nd_region_activate(struct nd_region *nd_region); 374 void __nd_iostat_start(struct bio *bio, unsigned long *start); 375 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start) 376 { 377 struct gendisk *disk = bio->bi_bdev->bd_disk; 378 379 if (!blk_queue_io_stat(disk->queue)) 380 return false; 381 382 *start = jiffies; 383 generic_start_io_acct(bio_data_dir(bio), 384 bio_sectors(bio), &disk->part0); 385 return true; 386 } 387 static inline void nd_iostat_end(struct bio *bio, unsigned long start) 388 { 389 struct gendisk *disk = bio->bi_bdev->bd_disk; 390 391 generic_end_io_acct(bio_data_dir(bio), &disk->part0, start); 392 } 393 static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector, 394 unsigned int len) 395 { 396 if (bb->count) { 397 sector_t first_bad; 398 int num_bad; 399 400 return !!badblocks_check(bb, sector, len / 512, &first_bad, 401 &num_bad); 402 } 403 404 return false; 405 } 406 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk); 407 const u8 *nd_dev_to_uuid(struct device *dev); 408 bool pmem_should_map_pages(struct device *dev); 409 #endif /* __ND_H__ */ 410