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 enum nvdimm_security_state state; 43 enum nvdimm_security_state ext_state; 44 unsigned int overwrite_tmo; 45 struct kernfs_node *overwrite_state; 46 } sec; 47 struct delayed_work dwork; 48 }; 49 50 static inline enum nvdimm_security_state nvdimm_security_state( 51 struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype) 52 { 53 if (!nvdimm->sec.ops) 54 return -ENXIO; 55 56 return nvdimm->sec.ops->state(nvdimm, ptype); 57 } 58 int nvdimm_security_freeze(struct nvdimm *nvdimm); 59 #if IS_ENABLED(CONFIG_NVDIMM_KEYS) 60 int nvdimm_security_disable(struct nvdimm *nvdimm, unsigned int keyid); 61 int nvdimm_security_update(struct nvdimm *nvdimm, unsigned int keyid, 62 unsigned int new_keyid, 63 enum nvdimm_passphrase_type pass_type); 64 int nvdimm_security_erase(struct nvdimm *nvdimm, unsigned int keyid, 65 enum nvdimm_passphrase_type pass_type); 66 int nvdimm_security_overwrite(struct nvdimm *nvdimm, unsigned int keyid); 67 void nvdimm_security_overwrite_query(struct work_struct *work); 68 #else 69 static inline int nvdimm_security_disable(struct nvdimm *nvdimm, 70 unsigned int keyid) 71 { 72 return -EOPNOTSUPP; 73 } 74 static inline int nvdimm_security_update(struct nvdimm *nvdimm, 75 unsigned int keyid, 76 unsigned int new_keyid, 77 enum nvdimm_passphrase_type pass_type) 78 { 79 return -EOPNOTSUPP; 80 } 81 static inline int nvdimm_security_erase(struct nvdimm *nvdimm, 82 unsigned int keyid, 83 enum nvdimm_passphrase_type pass_type) 84 { 85 return -EOPNOTSUPP; 86 } 87 static inline int nvdimm_security_overwrite(struct nvdimm *nvdimm, 88 unsigned int keyid) 89 { 90 return -EOPNOTSUPP; 91 } 92 static inline void nvdimm_security_overwrite_query(struct work_struct *work) 93 { 94 } 95 #endif 96 97 /** 98 * struct blk_alloc_info - tracking info for BLK dpa scanning 99 * @nd_mapping: blk region mapping boundaries 100 * @available: decremented in alias_dpa_busy as aliased PMEM is scanned 101 * @busy: decremented in blk_dpa_busy to account for ranges already 102 * handled by alias_dpa_busy 103 * @res: alias_dpa_busy interprets this a free space range that needs to 104 * be truncated to the valid BLK allocation starting DPA, blk_dpa_busy 105 * treats it as a busy range that needs the aliased PMEM ranges 106 * truncated. 107 */ 108 struct blk_alloc_info { 109 struct nd_mapping *nd_mapping; 110 resource_size_t available, busy; 111 struct resource *res; 112 }; 113 114 bool is_nvdimm(struct device *dev); 115 bool is_nd_pmem(struct device *dev); 116 bool is_nd_volatile(struct device *dev); 117 bool is_nd_blk(struct device *dev); 118 static inline bool is_nd_region(struct device *dev) 119 { 120 return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev); 121 } 122 static inline bool is_memory(struct device *dev) 123 { 124 return is_nd_pmem(dev) || is_nd_volatile(dev); 125 } 126 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev); 127 int __init nvdimm_bus_init(void); 128 void nvdimm_bus_exit(void); 129 void nvdimm_devs_exit(void); 130 void nd_region_devs_exit(void); 131 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev); 132 struct nd_region; 133 void nd_region_create_ns_seed(struct nd_region *nd_region); 134 void nd_region_create_btt_seed(struct nd_region *nd_region); 135 void nd_region_create_pfn_seed(struct nd_region *nd_region); 136 void nd_region_create_dax_seed(struct nd_region *nd_region); 137 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev); 138 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus); 139 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus); 140 void nd_synchronize(void); 141 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus); 142 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus); 143 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus); 144 void __nd_device_register(struct device *dev); 145 int nd_match_dimm(struct device *dev, void *data); 146 struct nd_label_id; 147 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags); 148 bool nd_is_uuid_unique(struct device *dev, u8 *uuid); 149 struct nd_region; 150 struct nvdimm_drvdata; 151 struct nd_mapping; 152 void nd_mapping_free_labels(struct nd_mapping *nd_mapping); 153 154 int __reserve_free_pmem(struct device *dev, void *data); 155 void release_free_pmem(struct nvdimm_bus *nvdimm_bus, 156 struct nd_mapping *nd_mapping); 157 158 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region, 159 struct nd_mapping *nd_mapping); 160 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region); 161 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region, 162 struct nd_mapping *nd_mapping, resource_size_t *overlap); 163 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region); 164 resource_size_t nd_region_available_dpa(struct nd_region *nd_region); 165 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start, 166 resource_size_t size); 167 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd, 168 struct nd_label_id *label_id); 169 int alias_dpa_busy(struct device *dev, void *data); 170 struct resource *nsblk_add_resource(struct nd_region *nd_region, 171 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk, 172 resource_size_t start); 173 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd); 174 void get_ndd(struct nvdimm_drvdata *ndd); 175 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns); 176 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 177 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns); 178 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 179 struct nd_namespace_common **_ndns); 180 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach, 181 struct nd_namespace_common **_ndns); 182 ssize_t nd_namespace_store(struct device *dev, 183 struct nd_namespace_common **_ndns, const char *buf, 184 size_t len); 185 struct nd_pfn *to_nd_pfn_safe(struct device *dev); 186 bool is_nvdimm_bus(struct device *dev); 187 188 #ifdef CONFIG_PROVE_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__ */ 254