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