drivers/nvdimm/nd-core.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_CORE_H__
  14 #define __ND_CORE_H__
  15 #include <linux/libnvdimm.h>
  16 #include <linux/device.h>
  17 #include <linux/sizes.h>
  18 #include <linux/mutex.h>
  19 #include <linux/nd.h>
  20
  21 extern struct list_head nvdimm_bus_list;
  22 extern struct mutex nvdimm_bus_list_mutex;
  23 extern int nvdimm_major;
  24
  25 struct nvdimm_bus {
  26         struct nvdimm_bus_descriptor *nd_desc;
  27         wait_queue_head_t probe_wait;
  28         struct list_head list;
  29         struct device dev;
  30         int id, probe_active;
  31         struct list_head mapping_list;
  32         struct mutex reconfig_mutex;
  33         struct badrange badrange;
  34 };
  35
  36 struct nvdimm {
  37         unsigned long flags;
  38         void *provider_data;
  39         unsigned long cmd_mask;
  40         struct device dev;
  41         atomic_t busy;
  42         int id, num_flush;
  43         struct resource *flush_wpq;
  44         const char *dimm_id;
  45         struct {
  46                 const struct nvdimm_security_ops *ops;
  47                 enum nvdimm_security_state state;
  48         } sec;
  49 };
  50
  51 static inline enum nvdimm_security_state nvdimm_security_state(
  52                 struct nvdimm *nvdimm)
  53 {
  54         if (!nvdimm->sec.ops)
  55                 return -ENXIO;
  56
  57         return nvdimm->sec.ops->state(nvdimm);
  58 }
  59 int nvdimm_security_freeze(struct nvdimm *nvdimm);
  60 #if IS_ENABLED(CONFIG_NVDIMM_KEYS)
  61 int nvdimm_security_disable(struct nvdimm *nvdimm, unsigned int keyid);
  62 int nvdimm_security_update(struct nvdimm *nvdimm, unsigned int keyid,
  63                 unsigned int new_keyid);
  64 int nvdimm_security_erase(struct nvdimm *nvdimm, unsigned int keyid);
  65 #else
  66 static inline int nvdimm_security_disable(struct nvdimm *nvdimm,
  67                 unsigned int keyid)
  68 {
  69         return -EOPNOTSUPP;
  70 }
  71 static inline int nvdimm_security_update(struct nvdimm *nvdimm, unsigned int keyid,
  72                 unsigned int new_keyid)
  73 {
  74         return -EOPNOTSUPP;
  75 }
  76 static inline int nvdimm_security_erase(struct nvdimm *nvdimm, unsigned int keyid)
  77 {
  78         return -EOPNOTSUPP;
  79 }
  80 #endif
  81
  82 /**
  83  * struct blk_alloc_info - tracking info for BLK dpa scanning
  84  * @nd_mapping: blk region mapping boundaries
  85  * @available: decremented in alias_dpa_busy as aliased PMEM is scanned
  86  * @busy: decremented in blk_dpa_busy to account for ranges already
  87  *        handled by alias_dpa_busy
  88  * @res: alias_dpa_busy interprets this a free space range that needs to
  89  *       be truncated to the valid BLK allocation starting DPA, blk_dpa_busy
  90  *       treats it as a busy range that needs the aliased PMEM ranges
  91  *       truncated.
  92  */
  93 struct blk_alloc_info {
  94         struct nd_mapping *nd_mapping;
  95         resource_size_t available, busy;
  96         struct resource *res;
  97 };
  98
  99 bool is_nvdimm(struct device *dev);
 100 bool is_nd_pmem(struct device *dev);
 101 bool is_nd_volatile(struct device *dev);
 102 bool is_nd_blk(struct device *dev);
 103 static inline bool is_nd_region(struct device *dev)
 104 {
 105         return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
 106 }
 107 static inline bool is_memory(struct device *dev)
 108 {
 109         return is_nd_pmem(dev) || is_nd_volatile(dev);
 110 }
 111 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
 112 int __init nvdimm_bus_init(void);
 113 void nvdimm_bus_exit(void);
 114 void nvdimm_devs_exit(void);
 115 void nd_region_devs_exit(void);
 116 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 117 struct nd_region;
 118 void nd_region_create_ns_seed(struct nd_region *nd_region);
 119 void nd_region_create_btt_seed(struct nd_region *nd_region);
 120 void nd_region_create_pfn_seed(struct nd_region *nd_region);
 121 void nd_region_create_dax_seed(struct nd_region *nd_region);
 122 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
 123 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
 124 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
 125 void nd_synchronize(void);
 126 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
 127 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
 128 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
 129 void __nd_device_register(struct device *dev);
 130 int nd_match_dimm(struct device *dev, void *data);
 131 struct nd_label_id;
 132 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
 133 bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
 134 struct nd_region;
 135 struct nvdimm_drvdata;
 136 struct nd_mapping;
 137 void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
 138
 139 int __reserve_free_pmem(struct device *dev, void *data);
 140 void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
 141                        struct nd_mapping *nd_mapping);
 142
 143 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
 144                                            struct nd_mapping *nd_mapping);
 145 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
 146 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
 147                 struct nd_mapping *nd_mapping, resource_size_t *overlap);
 148 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
 149 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
 150 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
 151                 struct nd_label_id *label_id);
 152 int alias_dpa_busy(struct device *dev, void *data);
 153 struct resource *nsblk_add_resource(struct nd_region *nd_region,
 154                 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
 155                 resource_size_t start);
 156 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
 157 void get_ndd(struct nvdimm_drvdata *ndd);
 158 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
 159 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
 160 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
 161 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
 162                 struct nd_namespace_common **_ndns);
 163 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
 164                 struct nd_namespace_common **_ndns);
 165 ssize_t nd_namespace_store(struct device *dev,
 166                 struct nd_namespace_common **_ndns, const char *buf,
 167                 size_t len);
 168 struct nd_pfn *to_nd_pfn_safe(struct device *dev);
 169 #endif /* __ND_CORE_H__ */