drivers/nvdimm/nd-core.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
   4  */
   5 #ifndef __ND_CORE_H__
   6 #define __ND_CORE_H__
   7 #include <linux/libnvdimm.h>
   8 #include <linux/device.h>
   9 #include <linux/sizes.h>
  10 #include <linux/mutex.h>
  11 #include <linux/nd.h>
  12 #include "nd.h"
  13
  14 extern struct list_head nvdimm_bus_list;
  15 extern struct mutex nvdimm_bus_list_mutex;
  16 extern int nvdimm_major;
  17 extern struct workqueue_struct *nvdimm_wq;
  18
  19 struct nvdimm_bus {
  20         struct nvdimm_bus_descriptor *nd_desc;
  21         wait_queue_head_t wait;
  22         struct list_head list;
  23         struct device dev;
  24         int id, probe_active;
  25         atomic_t ioctl_active;
  26         struct list_head mapping_list;
  27         struct mutex reconfig_mutex;
  28         struct badrange badrange;
  29 };
  30
  31 struct nvdimm {
  32         unsigned long flags;
  33         void *provider_data;
  34         unsigned long cmd_mask;
  35         struct device dev;
  36         atomic_t busy;
  37         int id, num_flush;
  38         struct resource *flush_wpq;
  39         const char *dimm_id;
  40         struct {
  41                 const struct nvdimm_security_ops *ops;
  42                 unsigned long flags;
  43                 unsigned long ext_flags;
  44                 unsigned int overwrite_tmo;
  45                 struct kernfs_node *overwrite_state;
  46         } sec;
  47         struct delayed_work dwork;
  48         const struct nvdimm_fw_ops *fw_ops;
  49 };
  50
  51 static inline unsigned long nvdimm_security_flags(
  52                 struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype)
  53 {
  54         u64 flags;
  55         const u64 state_flags = 1UL << NVDIMM_SECURITY_DISABLED
  56                 | 1UL << NVDIMM_SECURITY_LOCKED
  57                 | 1UL << NVDIMM_SECURITY_UNLOCKED
  58                 | 1UL << NVDIMM_SECURITY_OVERWRITE;
  59
  60         if (!nvdimm->sec.ops)
  61                 return 0;
  62
  63         flags = nvdimm->sec.ops->get_flags(nvdimm, ptype);
  64         /* disabled, locked, unlocked, and overwrite are mutually exclusive */
  65         dev_WARN_ONCE(&nvdimm->dev, hweight64(flags & state_flags) > 1,
  66                         "reported invalid security state: %#llx\n",
  67                         (unsigned long long) flags);
  68         return flags;
  69 }
  70 int nvdimm_security_freeze(struct nvdimm *nvdimm);
  71 #if IS_ENABLED(CONFIG_NVDIMM_KEYS)
  72 ssize_t nvdimm_security_store(struct device *dev, const char *buf, size_t len);
  73 void nvdimm_security_overwrite_query(struct work_struct *work);
  74 #else
  75 static inline ssize_t nvdimm_security_store(struct device *dev,
  76                 const char *buf, size_t len)
  77 {
  78         return -EOPNOTSUPP;
  79 }
  80 static inline void nvdimm_security_overwrite_query(struct work_struct *work)
  81 {
  82 }
  83 #endif
  84
  85 /**
  86  * struct blk_alloc_info - tracking info for BLK dpa scanning
  87  * @nd_mapping: blk region mapping boundaries
  88  * @available: decremented in alias_dpa_busy as aliased PMEM is scanned
  89  * @busy: decremented in blk_dpa_busy to account for ranges already
  90  *        handled by alias_dpa_busy
  91  * @res: alias_dpa_busy interprets this a free space range that needs to
  92  *       be truncated to the valid BLK allocation starting DPA, blk_dpa_busy
  93  *       treats it as a busy range that needs the aliased PMEM ranges
  94  *       truncated.
  95  */
  96 struct blk_alloc_info {
  97         struct nd_mapping *nd_mapping;
  98         resource_size_t available, busy;
  99         struct resource *res;
 100 };
 101
 102 bool is_nvdimm(struct device *dev);
 103 bool is_nd_pmem(struct device *dev);
 104 bool is_nd_volatile(struct device *dev);
 105 bool is_nd_blk(struct device *dev);
 106 static inline bool is_nd_region(struct device *dev)
 107 {
 108         return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
 109 }
 110 static inline bool is_memory(struct device *dev)
 111 {
 112         return is_nd_pmem(dev) || is_nd_volatile(dev);
 113 }
 114 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
 115 int __init nvdimm_bus_init(void);
 116 void nvdimm_bus_exit(void);
 117 void nvdimm_devs_exit(void);
 118 struct nd_region;
 119 void nd_region_advance_seeds(struct nd_region *nd_region, struct device *dev);
 120 void nd_region_create_ns_seed(struct nd_region *nd_region);
 121 void nd_region_create_btt_seed(struct nd_region *nd_region);
 122 void nd_region_create_pfn_seed(struct nd_region *nd_region);
 123 void nd_region_create_dax_seed(struct nd_region *nd_region);
 124 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
 125 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
 126 void nd_synchronize(void);
 127 void __nd_device_register(struct device *dev);
 128 struct nd_label_id;
 129 char *nd_label_gen_id(struct nd_label_id *label_id, const uuid_t *uuid,
 130                       u32 flags);
 131 bool nd_is_uuid_unique(struct device *dev, uuid_t *uuid);
 132 struct nd_region;
 133 struct nvdimm_drvdata;
 134 struct nd_mapping;
 135 void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
 136
 137 int __reserve_free_pmem(struct device *dev, void *data);
 138 void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
 139                        struct nd_mapping *nd_mapping);
 140
 141 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
 142                                            struct nd_mapping *nd_mapping);
 143 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
 144 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
 145                 struct nd_mapping *nd_mapping, resource_size_t *overlap);
 146 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
 147 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
 148 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start,
 149                 resource_size_t size);
 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 bool is_nvdimm_bus(struct device *dev);
 170
 171 #if IS_ENABLED(CONFIG_ND_CLAIM)
 172 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio,
 173                 resource_size_t size);
 174 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
 175 #else
 176 static inline int devm_nsio_enable(struct device *dev,
 177                 struct nd_namespace_io *nsio, resource_size_t size)
 178 {
 179         return -ENXIO;
 180 }
 181
 182 static inline void devm_nsio_disable(struct device *dev,
 183                 struct nd_namespace_io *nsio)
 184 {
 185 }
 186 #endif
 187
 188 #ifdef CONFIG_PROVE_NVDIMM_LOCKING
 189 extern struct class *nd_class;
 190
 191 enum {
 192         LOCK_BUS,
 193         LOCK_NDCTL,
 194         LOCK_REGION,
 195         LOCK_DIMM = LOCK_REGION,
 196         LOCK_NAMESPACE,
 197         LOCK_CLAIM,
 198 };
 199
 200 static inline void debug_nvdimm_lock(struct device *dev)
 201 {
 202         if (is_nd_region(dev))
 203                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_REGION);
 204         else if (is_nvdimm(dev))
 205                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_DIMM);
 206         else if (is_nd_btt(dev) || is_nd_pfn(dev) || is_nd_dax(dev))
 207                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_CLAIM);
 208         else if (dev->parent && (is_nd_region(dev->parent)))
 209                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NAMESPACE);
 210         else if (is_nvdimm_bus(dev))
 211                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_BUS);
 212         else if (dev->class && dev->class == nd_class)
 213                 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NDCTL);
 214         else
 215                 dev_WARN(dev, "unknown lock level\n");
 216 }
 217
 218 static inline void debug_nvdimm_unlock(struct device *dev)
 219 {
 220         mutex_unlock(&dev->lockdep_mutex);
 221 }
 222
 223 static inline void nd_device_lock(struct device *dev)
 224 {
 225         device_lock(dev);
 226         debug_nvdimm_lock(dev);
 227 }
 228
 229 static inline void nd_device_unlock(struct device *dev)
 230 {
 231         debug_nvdimm_unlock(dev);
 232         device_unlock(dev);
 233 }
 234 #else
 235 static inline void nd_device_lock(struct device *dev)
 236 {
 237         device_lock(dev);
 238 }
 239
 240 static inline void nd_device_unlock(struct device *dev)
 241 {
 242         device_unlock(dev);
 243 }
 244
 245 static inline void debug_nvdimm_lock(struct device *dev)
 246 {
 247 }
 248
 249 static inline void debug_nvdimm_unlock(struct device *dev)
 250 {
 251 }
 252 #endif
 253 #endif /* __ND_CORE_H__ */