1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
7 #include <linux/libnvdimm.h>
8 #include <linux/device.h>
9 #include <linux/sizes.h>
10 #include <linux/mutex.h>
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;
20 struct nvdimm_bus_descriptor *nd_desc;
21 wait_queue_head_t wait;
22 struct list_head list;
25 atomic_t ioctl_active;
26 struct list_head mapping_list;
27 struct mutex reconfig_mutex;
28 struct badrange badrange;
34 unsigned long cmd_mask;
38 struct resource *flush_wpq;
41 const struct nvdimm_security_ops *ops;
43 unsigned long ext_flags;
44 unsigned int overwrite_tmo;
45 struct kernfs_node *overwrite_state;
47 struct delayed_work dwork;
50 static inline unsigned long nvdimm_security_flags(
51 struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype)
54 const u64 state_flags = 1UL << NVDIMM_SECURITY_DISABLED
55 | 1UL << NVDIMM_SECURITY_LOCKED
56 | 1UL << NVDIMM_SECURITY_UNLOCKED
57 | 1UL << NVDIMM_SECURITY_OVERWRITE;
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);
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);
74 static inline ssize_t nvdimm_security_store(struct device *dev,
75 const char *buf, size_t len)
79 static inline void nvdimm_security_overwrite_query(struct work_struct *work)
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
95 struct blk_alloc_info {
96 struct nd_mapping *nd_mapping;
97 resource_size_t available, busy;
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)
107 return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
109 static inline bool is_memory(struct device *dev)
111 return is_nd_pmem(dev) || is_nd_volatile(dev);
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);
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 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);
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);
135 struct nvdimm_drvdata;
137 void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
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);
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 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start,
151 resource_size_t size);
152 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
153 struct nd_label_id *label_id);
154 int alias_dpa_busy(struct device *dev, void *data);
155 struct resource *nsblk_add_resource(struct nd_region *nd_region,
156 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
157 resource_size_t start);
158 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
159 void get_ndd(struct nvdimm_drvdata *ndd);
160 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
161 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
162 void __nd_detach_ndns(struct device *dev, 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 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
166 struct nd_namespace_common **_ndns);
167 ssize_t nd_namespace_store(struct device *dev,
168 struct nd_namespace_common **_ndns, const char *buf,
170 struct nd_pfn *to_nd_pfn_safe(struct device *dev);
171 bool is_nvdimm_bus(struct device *dev);
173 #ifdef CONFIG_PROVE_LOCKING
174 extern struct class *nd_class;
180 LOCK_DIMM = LOCK_REGION,
185 static inline void debug_nvdimm_lock(struct device *dev)
187 if (is_nd_region(dev))
188 mutex_lock_nested(&dev->lockdep_mutex, LOCK_REGION);
189 else if (is_nvdimm(dev))
190 mutex_lock_nested(&dev->lockdep_mutex, LOCK_DIMM);
191 else if (is_nd_btt(dev) || is_nd_pfn(dev) || is_nd_dax(dev))
192 mutex_lock_nested(&dev->lockdep_mutex, LOCK_CLAIM);
193 else if (dev->parent && (is_nd_region(dev->parent)))
194 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NAMESPACE);
195 else if (is_nvdimm_bus(dev))
196 mutex_lock_nested(&dev->lockdep_mutex, LOCK_BUS);
197 else if (dev->class && dev->class == nd_class)
198 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NDCTL);
200 dev_WARN(dev, "unknown lock level\n");
203 static inline void debug_nvdimm_unlock(struct device *dev)
205 mutex_unlock(&dev->lockdep_mutex);
208 static inline void nd_device_lock(struct device *dev)
211 debug_nvdimm_lock(dev);
214 static inline void nd_device_unlock(struct device *dev)
216 debug_nvdimm_unlock(dev);
220 static inline void nd_device_lock(struct device *dev)
225 static inline void nd_device_unlock(struct device *dev)
230 static inline void debug_nvdimm_lock(struct device *dev)
234 static inline void debug_nvdimm_unlock(struct device *dev)
238 #endif /* __ND_CORE_H__ */