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 struct nvdimm_drvdata {
  23         struct device *dev;
  24         int nsindex_size;
  25         struct nd_cmd_get_config_size nsarea;
  26         void *data;
  27         int ns_current, ns_next;
  28         struct resource dpa;
  29         struct kref kref;
  30 };
  31
  32 struct nd_region_namespaces {
  33         int count;
  34         int active;
  35 };
  36
  37 static inline struct nd_namespace_index *to_namespace_index(
  38                 struct nvdimm_drvdata *ndd, int i)
  39 {
  40         if (i < 0)
  41                 return NULL;
  42
  43         return ndd->data + sizeof_namespace_index(ndd) * i;
  44 }
  45
  46 static inline struct nd_namespace_index *to_current_namespace_index(
  47                 struct nvdimm_drvdata *ndd)
  48 {
  49         return to_namespace_index(ndd, ndd->ns_current);
  50 }
  51
  52 static inline struct nd_namespace_index *to_next_namespace_index(
  53                 struct nvdimm_drvdata *ndd)
  54 {
  55         return to_namespace_index(ndd, ndd->ns_next);
  56 }
  57
  58 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
  59         dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
  60                 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
  61                 (unsigned long long) (res ? resource_size(res) : 0), \
  62                 (unsigned long long) (res ? res->start : 0), ##arg)
  63
  64 #define for_each_label(l, label, labels) \
  65         for (l = 0; (label = labels ? labels[l] : NULL); l++)
  66
  67 #define for_each_dpa_resource(ndd, res) \
  68         for (res = (ndd)->dpa.child; res; res = res->sibling)
  69
  70 #define for_each_dpa_resource_safe(ndd, res, next) \
  71         for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
  72                         res; res = next, next = next ? next->sibling : NULL)
  73
  74 struct nd_region {
  75         struct device dev;
  76         struct device *ns_seed;
  77         u16 ndr_mappings;
  78         u64 ndr_size;
  79         u64 ndr_start;
  80         int id;
  81         void *provider_data;
  82         struct nd_interleave_set *nd_set;
  83         struct nd_mapping mapping[0];
  84 };
  85
  86 /*
  87  * Lookup next in the repeating sequence of 01, 10, and 11.
  88  */
  89 static inline unsigned nd_inc_seq(unsigned seq)
  90 {
  91         static const unsigned next[] = { 0, 2, 3, 1 };
  92
  93         return next[seq & 3];
  94 }
  95 enum nd_async_mode {
  96         ND_SYNC,
  97         ND_ASYNC,
  98 };
  99
 100 void wait_nvdimm_bus_probe_idle(struct device *dev);
 101 void nd_device_register(struct device *dev);
 102 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
 103 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
 104                 size_t len);
 105 int __init nvdimm_init(void);
 106 int __init nd_region_init(void);
 107 void nvdimm_exit(void);
 108 void nd_region_exit(void);
 109 struct nvdimm;
 110 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
 111 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
 112 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
 113 struct nd_region *to_nd_region(struct device *dev);
 114 int nd_region_to_nstype(struct nd_region *nd_region);
 115 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
 116 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
 117 void nvdimm_bus_lock(struct device *dev);
 118 void nvdimm_bus_unlock(struct device *dev);
 119 bool is_nvdimm_bus_locked(struct device *dev);
 120 void nvdimm_drvdata_release(struct kref *kref);
 121 void put_ndd(struct nvdimm_drvdata *ndd);
 122 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
 123 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
 124 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
 125                 struct nd_label_id *label_id, resource_size_t start,
 126                 resource_size_t n);
 127 #endif /* __ND_H__ */