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 }; 49 50 static inline unsigned long nvdimm_security_flags( 51 struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype) 52 { 53 u64 flags; 54 const u64 state_flags = 1UL << NVDIMM_SECURITY_DISABLED 55 | 1UL << NVDIMM_SECURITY_LOCKED 56 | 1UL << NVDIMM_SECURITY_UNLOCKED 57 | 1UL << NVDIMM_SECURITY_OVERWRITE; 58 59 if (!nvdimm->sec.ops) 60 return 0; 61 62 flags = nvdimm->sec.ops->get_flags(nvdimm, ptype); 63 /* disabled, locked, unlocked, and overwrite are mutually exclusive */ 64 dev_WARN_ONCE(&nvdimm->dev, hweight64(flags & state_flags) > 1, 65 "reported invalid security state: %#llx\n", 66 (unsigned long long) flags); 67 return flags; 68 } 69 int nvdimm_security_freeze(struct nvdimm *nvdimm); 70 #if IS_ENABLED(CONFIG_NVDIMM_KEYS) 71 ssize_t nvdimm_security_store(struct device *dev, const char *buf, size_t len); 72 void nvdimm_security_overwrite_query(struct work_struct *work); 73 #else 74 static inline ssize_t nvdimm_security_store(struct device *dev, 75 const char *buf, size_t len) 76 { 77 return -EOPNOTSUPP; 78 } 79 static inline void nvdimm_security_overwrite_query(struct work_struct *work) 80 { 81 } 82 #endif 83 84 /** 85 * struct blk_alloc_info - tracking info for BLK dpa scanning 86 * @nd_mapping: blk region mapping boundaries 87 * @available: decremented in alias_dpa_busy as aliased PMEM is scanned 88 * @busy: decremented in blk_dpa_busy to account for ranges already 89 * handled by alias_dpa_busy 90 * @res: alias_dpa_busy interprets this a free space range that needs to 91 * be truncated to the valid BLK allocation starting DPA, blk_dpa_busy 92 * treats it as a busy range that needs the aliased PMEM ranges 93 * truncated. 94 */ 95 struct blk_alloc_info { 96 struct nd_mapping *nd_mapping; 97 resource_size_t available, busy; 98 struct resource *res; 99 }; 100 101 bool is_nvdimm(struct device *dev); 102 bool is_nd_pmem(struct device *dev); 103 bool is_nd_volatile(struct device *dev); 104 bool is_nd_blk(struct device *dev); 105 static inline bool is_nd_region(struct device *dev) 106 { 107 return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev); 108 } 109 static inline bool is_memory(struct device *dev) 110 { 111 return is_nd_pmem(dev) || is_nd_volatile(dev); 112 } 113 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev); 114 int __init nvdimm_bus_init(void); 115 void nvdimm_bus_exit(void); 116 void nvdimm_devs_exit(void); 117 struct nd_region; 118 void nd_region_advance_seeds(struct nd_region *nd_region, struct device *dev); 119 void nd_region_create_ns_seed(struct nd_region *nd_region); 120 void nd_region_create_btt_seed(struct nd_region *nd_region); 121 void nd_region_create_pfn_seed(struct nd_region *nd_region); 122 void nd_region_create_dax_seed(struct nd_region *nd_region); 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 void __nd_device_register(struct device *dev); 127 struct nd_label_id; 128 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags); 129 bool nd_is_uuid_unique(struct device *dev, u8 *uuid); 130 struct nd_region; 131 struct nvdimm_drvdata; 132 struct nd_mapping; 133 void nd_mapping_free_labels(struct nd_mapping *nd_mapping); 134 135 int __reserve_free_pmem(struct device *dev, void *data); 136 void release_free_pmem(struct nvdimm_bus *nvdimm_bus, 137 struct nd_mapping *nd_mapping); 138 139 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region, 140 struct nd_mapping *nd_mapping); 141 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region); 142 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region, 143 struct nd_mapping *nd_mapping, resource_size_t *overlap); 144 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region); 145 resource_size_t nd_region_available_dpa(struct nd_region *nd_region); 146 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start, 147 resource_size_t size); 148 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd, 149 struct nd_label_id *label_id); 150 int alias_dpa_busy(struct device *dev, void *data); 151 struct resource *nsblk_add_resource(struct nd_region *nd_region, 152 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk, 153 resource_size_t start); 154 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd); 155 void get_ndd(struct nvdimm_drvdata *ndd); 156 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 157 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 158 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 159 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 160 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 ssize_t nd_namespace_store(struct device *dev, 164 struct nd_namespace_common **_ndns, const char *buf, 165 size_t len); 166 struct nd_pfn *to_nd_pfn_safe(struct device *dev); 167 bool is_nvdimm_bus(struct device *dev); 168 169 #if IS_ENABLED(CONFIG_ND_CLAIM) 170 int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio, 171 resource_size_t size); 172 void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio); 173 #else 174 static inline int devm_nsio_enable(struct device *dev, 175 struct nd_namespace_io *nsio, resource_size_t size) 176 { 177 return -ENXIO; 178 } 179 180 static inline void devm_nsio_disable(struct device *dev, 181 struct nd_namespace_io *nsio) 182 { 183 } 184 #endif 185 186 #ifdef CONFIG_PROVE_LOCKING 187 extern struct class *nd_class; 188 189 enum { 190 LOCK_BUS, 191 LOCK_NDCTL, 192 LOCK_REGION, 193 LOCK_DIMM = LOCK_REGION, 194 LOCK_NAMESPACE, 195 LOCK_CLAIM, 196 }; 197 198 static inline void debug_nvdimm_lock(struct device *dev) 199 { 200 if (is_nd_region(dev)) 201 mutex_lock_nested(&dev->lockdep_mutex, LOCK_REGION); 202 else if (is_nvdimm(dev)) 203 mutex_lock_nested(&dev->lockdep_mutex, LOCK_DIMM); 204 else if (is_nd_btt(dev) || is_nd_pfn(dev) || is_nd_dax(dev)) 205 mutex_lock_nested(&dev->lockdep_mutex, LOCK_CLAIM); 206 else if (dev->parent && (is_nd_region(dev->parent))) 207 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NAMESPACE); 208 else if (is_nvdimm_bus(dev)) 209 mutex_lock_nested(&dev->lockdep_mutex, LOCK_BUS); 210 else if (dev->class && dev->class == nd_class) 211 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NDCTL); 212 else 213 dev_WARN(dev, "unknown lock level\n"); 214 } 215 216 static inline void debug_nvdimm_unlock(struct device *dev) 217 { 218 mutex_unlock(&dev->lockdep_mutex); 219 } 220 221 static inline void nd_device_lock(struct device *dev) 222 { 223 device_lock(dev); 224 debug_nvdimm_lock(dev); 225 } 226 227 static inline void nd_device_unlock(struct device *dev) 228 { 229 debug_nvdimm_unlock(dev); 230 device_unlock(dev); 231 } 232 #else 233 static inline void nd_device_lock(struct device *dev) 234 { 235 device_lock(dev); 236 } 237 238 static inline void nd_device_unlock(struct device *dev) 239 { 240 device_unlock(dev); 241 } 242 243 static inline void debug_nvdimm_lock(struct device *dev) 244 { 245 } 246 247 static inline void debug_nvdimm_unlock(struct device *dev) 248 { 249 } 250 #endif 251 #endif /* __ND_CORE_H__ */ 252