drivers/nvdimm/nd.h

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