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/blkdev.h>
  17 #include <linux/device.h>
  18 #include <linux/mutex.h>
  19 #include <linux/ndctl.h>
  20 #include <linux/types.h>
  21 #include "label.h"
  22
  23 enum {
  24         /*
  25          * Limits the maximum number of block apertures a dimm can
  26          * support and is an input to the geometry/on-disk-format of a
  27          * BTT instance
  28          */
  29         ND_MAX_LANES = 256,
  30         SECTOR_SHIFT = 9,
  31         INT_LBASIZE_ALIGNMENT = 64,
  32 };
  33
  34 struct nvdimm_drvdata {
  35         struct device *dev;
  36         int nsindex_size;
  37         struct nd_cmd_get_config_size nsarea;
  38         void *data;
  39         int ns_current, ns_next;
  40         struct resource dpa;
  41         struct kref kref;
  42 };
  43
  44 struct nd_region_namespaces {
  45         int count;
  46         int active;
  47 };
  48
  49 static inline struct nd_namespace_index *to_namespace_index(
  50                 struct nvdimm_drvdata *ndd, int i)
  51 {
  52         if (i < 0)
  53                 return NULL;
  54
  55         return ndd->data + sizeof_namespace_index(ndd) * i;
  56 }
  57
  58 static inline struct nd_namespace_index *to_current_namespace_index(
  59                 struct nvdimm_drvdata *ndd)
  60 {
  61         return to_namespace_index(ndd, ndd->ns_current);
  62 }
  63
  64 static inline struct nd_namespace_index *to_next_namespace_index(
  65                 struct nvdimm_drvdata *ndd)
  66 {
  67         return to_namespace_index(ndd, ndd->ns_next);
  68 }
  69
  70 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
  71         dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
  72                 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
  73                 (unsigned long long) (res ? resource_size(res) : 0), \
  74                 (unsigned long long) (res ? res->start : 0), ##arg)
  75
  76 #define for_each_label(l, label, labels) \
  77         for (l = 0; (label = labels ? labels[l] : NULL); l++)
  78
  79 #define for_each_dpa_resource(ndd, res) \
  80         for (res = (ndd)->dpa.child; res; res = res->sibling)
  81
  82 #define for_each_dpa_resource_safe(ndd, res, next) \
  83         for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
  84                         res; res = next, next = next ? next->sibling : NULL)
  85
  86 struct nd_percpu_lane {
  87         int count;
  88         spinlock_t lock;
  89 };
  90
  91 struct nd_region {
  92         struct device dev;
  93         struct ida ns_ida;
  94         struct ida btt_ida;
  95         struct ida pfn_ida;
  96         unsigned long flags;
  97         struct device *ns_seed;
  98         struct device *btt_seed;
  99         struct device *pfn_seed;
 100         u16 ndr_mappings;
 101         u64 ndr_size;
 102         u64 ndr_start;
 103         int id, num_lanes, ro, numa_node;
 104         void *provider_data;
 105         struct nd_interleave_set *nd_set;
 106         struct nd_percpu_lane __percpu *lane;
 107         struct nd_mapping mapping[0];
 108 };
 109
 110 struct nd_blk_region {
 111         int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 112         void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 113         int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 114                         void *iobuf, u64 len, int rw);
 115         void *blk_provider_data;
 116         struct nd_region nd_region;
 117 };
 118
 119 /*
 120  * Lookup next in the repeating sequence of 01, 10, and 11.
 121  */
 122 static inline unsigned nd_inc_seq(unsigned seq)
 123 {
 124         static const unsigned next[] = { 0, 2, 3, 1 };
 125
 126         return next[seq & 3];
 127 }
 128
 129 struct btt;
 130 struct nd_btt {
 131         struct device dev;
 132         struct nd_namespace_common *ndns;
 133         struct btt *btt;
 134         unsigned long lbasize;
 135         u8 *uuid;
 136         int id;
 137 };
 138
 139 enum nd_pfn_mode {
 140         PFN_MODE_NONE,
 141         PFN_MODE_RAM,
 142         PFN_MODE_PMEM,
 143 };
 144
 145 struct nd_pfn {
 146         int id;
 147         u8 *uuid;
 148         struct device dev;
 149         unsigned long align;
 150         unsigned long npfns;
 151         enum nd_pfn_mode mode;
 152         struct nd_pfn_sb *pfn_sb;
 153         struct nd_namespace_common *ndns;
 154 };
 155
 156 enum nd_async_mode {
 157         ND_SYNC,
 158         ND_ASYNC,
 159 };
 160
 161 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
 162 void wait_nvdimm_bus_probe_idle(struct device *dev);
 163 void nd_device_register(struct device *dev);
 164 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
 165 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
 166                 size_t len);
 167 ssize_t nd_sector_size_show(unsigned long current_lbasize,
 168                 const unsigned long *supported, char *buf);
 169 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
 170                 unsigned long *current_lbasize, const unsigned long *supported);
 171 int __init nvdimm_init(void);
 172 int __init nd_region_init(void);
 173 void nvdimm_exit(void);
 174 void nd_region_exit(void);
 175 struct nvdimm;
 176 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
 177 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
 178 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
 179 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
 180                 void *buf, size_t len);
 181 struct nd_btt *to_nd_btt(struct device *dev);
 182
 183 struct nd_gen_sb {
 184         char reserved[SZ_4K - 8];
 185         __le64 checksum;
 186 };
 187
 188 u64 nd_sb_checksum(struct nd_gen_sb *sb);
 189 #if IS_ENABLED(CONFIG_BTT)
 190 int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
 191 bool is_nd_btt(struct device *dev);
 192 struct device *nd_btt_create(struct nd_region *nd_region);
 193 #else
 194 static inline int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
 195 {
 196         return -ENODEV;
 197 }
 198
 199 static inline bool is_nd_btt(struct device *dev)
 200 {
 201         return false;
 202 }
 203
 204 static inline struct device *nd_btt_create(struct nd_region *nd_region)
 205 {
 206         return NULL;
 207 }
 208 #endif
 209
 210 struct nd_pfn *to_nd_pfn(struct device *dev);
 211 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
 212 int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata);
 213 bool is_nd_pfn(struct device *dev);
 214 struct device *nd_pfn_create(struct nd_region *nd_region);
 215 int nd_pfn_validate(struct nd_pfn *nd_pfn);
 216 #else
 217 static inline int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata)
 218 {
 219         return -ENODEV;
 220 }
 221
 222 static inline bool is_nd_pfn(struct device *dev)
 223 {
 224         return false;
 225 }
 226
 227 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
 228 {
 229         return NULL;
 230 }
 231
 232 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn)
 233 {
 234         return -ENODEV;
 235 }
 236 #endif
 237
 238 struct nd_region *to_nd_region(struct device *dev);
 239 int nd_region_to_nstype(struct nd_region *nd_region);
 240 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
 241 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
 242 void nvdimm_bus_lock(struct device *dev);
 243 void nvdimm_bus_unlock(struct device *dev);
 244 bool is_nvdimm_bus_locked(struct device *dev);
 245 int nvdimm_revalidate_disk(struct gendisk *disk);
 246 void nvdimm_drvdata_release(struct kref *kref);
 247 void put_ndd(struct nvdimm_drvdata *ndd);
 248 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
 249 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
 250 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 251                 struct nd_label_id *label_id, resource_size_t start,
 252                 resource_size_t n);
 253 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
 254 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
 255 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
 256 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
 257 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
 258                 char *name);
 259 int nd_blk_region_init(struct nd_region *nd_region);
 260 void __nd_iostat_start(struct bio *bio, unsigned long *start);
 261 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
 262 {
 263         struct gendisk *disk = bio->bi_bdev->bd_disk;
 264
 265         if (!blk_queue_io_stat(disk->queue))
 266                 return false;
 267
 268         __nd_iostat_start(bio, start);
 269         return true;
 270 }
 271 void nd_iostat_end(struct bio *bio, unsigned long start);
 272 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
 273 const u8 *nd_dev_to_uuid(struct device *dev);
 274 bool pmem_should_map_pages(struct device *dev);
 275 #endif /* __ND_H__ */