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/device.h>
  17 #include <linux/mutex.h>
  18 #include <linux/ndctl.h>
  19 #include <linux/types.h>
  20 #include "label.h"
  21
  22 enum {
  23         /*
  24          * Limits the maximum number of block apertures a dimm can
  25          * support and is an input to the geometry/on-disk-format of a
  26          * BTT instance
  27          */
  28         ND_MAX_LANES = 256,
  29         SECTOR_SHIFT = 9,
  30 };
  31
  32 struct nvdimm_drvdata {
  33         struct device *dev;
  34         int nsindex_size;
  35         struct nd_cmd_get_config_size nsarea;
  36         void *data;
  37         int ns_current, ns_next;
  38         struct resource dpa;
  39         struct kref kref;
  40 };
  41
  42 struct nd_region_namespaces {
  43         int count;
  44         int active;
  45 };
  46
  47 static inline struct nd_namespace_index *to_namespace_index(
  48                 struct nvdimm_drvdata *ndd, int i)
  49 {
  50         if (i < 0)
  51                 return NULL;
  52
  53         return ndd->data + sizeof_namespace_index(ndd) * i;
  54 }
  55
  56 static inline struct nd_namespace_index *to_current_namespace_index(
  57                 struct nvdimm_drvdata *ndd)
  58 {
  59         return to_namespace_index(ndd, ndd->ns_current);
  60 }
  61
  62 static inline struct nd_namespace_index *to_next_namespace_index(
  63                 struct nvdimm_drvdata *ndd)
  64 {
  65         return to_namespace_index(ndd, ndd->ns_next);
  66 }
  67
  68 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
  69         dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
  70                 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
  71                 (unsigned long long) (res ? resource_size(res) : 0), \
  72                 (unsigned long long) (res ? res->start : 0), ##arg)
  73
  74 #define for_each_label(l, label, labels) \
  75         for (l = 0; (label = labels ? labels[l] : NULL); l++)
  76
  77 #define for_each_dpa_resource(ndd, res) \
  78         for (res = (ndd)->dpa.child; res; res = res->sibling)
  79
  80 #define for_each_dpa_resource_safe(ndd, res, next) \
  81         for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
  82                         res; res = next, next = next ? next->sibling : NULL)
  83
  84 struct nd_percpu_lane {
  85         int count;
  86         spinlock_t lock;
  87 };
  88
  89 struct nd_region {
  90         struct device dev;
  91         struct ida ns_ida;
  92         struct ida btt_ida;
  93         struct device *ns_seed;
  94         struct device *btt_seed;
  95         u16 ndr_mappings;
  96         u64 ndr_size;
  97         u64 ndr_start;
  98         int id, num_lanes;
  99         void *provider_data;
 100         struct nd_interleave_set *nd_set;
 101         struct nd_percpu_lane __percpu *lane;
 102         struct nd_mapping mapping[0];
 103 };
 104
 105 /*
 106  * Lookup next in the repeating sequence of 01, 10, and 11.
 107  */
 108 static inline unsigned nd_inc_seq(unsigned seq)
 109 {
 110         static const unsigned next[] = { 0, 2, 3, 1 };
 111
 112         return next[seq & 3];
 113 }
 114
 115 struct btt;
 116 struct nd_btt {
 117         struct device dev;
 118         struct nd_namespace_common *ndns;
 119         struct btt *btt;
 120         unsigned long lbasize;
 121         u8 *uuid;
 122         int id;
 123 };
 124
 125 enum nd_async_mode {
 126         ND_SYNC,
 127         ND_ASYNC,
 128 };
 129
 130 void wait_nvdimm_bus_probe_idle(struct device *dev);
 131 void nd_device_register(struct device *dev);
 132 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
 133 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
 134                 size_t len);
 135 ssize_t nd_sector_size_show(unsigned long current_lbasize,
 136                 const unsigned long *supported, char *buf);
 137 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
 138                 unsigned long *current_lbasize, const unsigned long *supported);
 139 int __init nvdimm_init(void);
 140 int __init nd_region_init(void);
 141 void nvdimm_exit(void);
 142 void nd_region_exit(void);
 143 struct nvdimm;
 144 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
 145 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
 146 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
 147 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
 148                 void *buf, size_t len);
 149 struct nd_btt *to_nd_btt(struct device *dev);
 150 struct btt_sb;
 151 u64 nd_btt_sb_checksum(struct btt_sb *btt_sb);
 152 #if IS_ENABLED(CONFIG_BTT)
 153 int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
 154 bool is_nd_btt(struct device *dev);
 155 struct device *nd_btt_create(struct nd_region *nd_region);
 156 #else
 157 static inline nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
 158 {
 159         return -ENODEV;
 160 }
 161
 162 static inline bool is_nd_btt(struct device *dev)
 163 {
 164         return false;
 165 }
 166
 167 static inline struct device *nd_btt_create(struct nd_region *nd_region)
 168 {
 169         return NULL;
 170 }
 171
 172 #endif
 173 struct nd_region *to_nd_region(struct device *dev);
 174 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
 175 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
 176 int nd_region_to_nstype(struct nd_region *nd_region);
 177 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
 178 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
 179 void nvdimm_bus_lock(struct device *dev);
 180 void nvdimm_bus_unlock(struct device *dev);
 181 bool is_nvdimm_bus_locked(struct device *dev);
 182 void nvdimm_drvdata_release(struct kref *kref);
 183 void put_ndd(struct nvdimm_drvdata *ndd);
 184 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
 185 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
 186 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 187                 struct nd_label_id *label_id, resource_size_t start,
 188                 resource_size_t n);
 189 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
 190 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
 191 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
 192 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
 193 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
 194                 char *name);
 195 #endif /* __ND_H__ */