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
nvdimm_security_flags(struct nvdimm * nvdimm,enum nvdimm_passphrase_type ptype)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
nvdimm_security_store(struct device * dev,const char * buf,size_t len)74 static inline ssize_t nvdimm_security_store(struct device *dev,
75 const char *buf, size_t len)
76 {
77 return -EOPNOTSUPP;
78 }
nvdimm_security_overwrite_query(struct work_struct * work)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);
is_nd_region(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 }
is_memory(struct device * dev)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 void nd_region_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 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
128 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
129 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
130 void __nd_device_register(struct device *dev);
131 int nd_match_dimm(struct device *dev, void *data);
132 struct nd_label_id;
133 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
134 bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
135 struct nd_region;
136 struct nvdimm_drvdata;
137 struct nd_mapping;
138 void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
139
140 int __reserve_free_pmem(struct device *dev, void *data);
141 void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
142 struct nd_mapping *nd_mapping);
143
144 resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
145 struct nd_mapping *nd_mapping);
146 resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
147 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
148 struct nd_mapping *nd_mapping, resource_size_t *overlap);
149 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
150 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
151 int nd_region_conflict(struct nd_region *nd_region, resource_size_t start,
152 resource_size_t size);
153 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
154 struct nd_label_id *label_id);
155 int alias_dpa_busy(struct device *dev, void *data);
156 struct resource *nsblk_add_resource(struct nd_region *nd_region,
157 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
158 resource_size_t start);
159 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
160 void get_ndd(struct nvdimm_drvdata *ndd);
161 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
162 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
163 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
164 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
165 struct nd_namespace_common **_ndns);
166 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
167 struct nd_namespace_common **_ndns);
168 ssize_t nd_namespace_store(struct device *dev,
169 struct nd_namespace_common **_ndns, const char *buf,
170 size_t len);
171 struct nd_pfn *to_nd_pfn_safe(struct device *dev);
172 bool is_nvdimm_bus(struct device *dev);
173
174 #ifdef CONFIG_PROVE_LOCKING
175 extern struct class *nd_class;
176
177 enum {
178 LOCK_BUS,
179 LOCK_NDCTL,
180 LOCK_REGION,
181 LOCK_DIMM = LOCK_REGION,
182 LOCK_NAMESPACE,
183 LOCK_CLAIM,
184 };
185
debug_nvdimm_lock(struct device * dev)186 static inline void debug_nvdimm_lock(struct device *dev)
187 {
188 if (is_nd_region(dev))
189 mutex_lock_nested(&dev->lockdep_mutex, LOCK_REGION);
190 else if (is_nvdimm(dev))
191 mutex_lock_nested(&dev->lockdep_mutex, LOCK_DIMM);
192 else if (is_nd_btt(dev) || is_nd_pfn(dev) || is_nd_dax(dev))
193 mutex_lock_nested(&dev->lockdep_mutex, LOCK_CLAIM);
194 else if (dev->parent && (is_nd_region(dev->parent)))
195 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NAMESPACE);
196 else if (is_nvdimm_bus(dev))
197 mutex_lock_nested(&dev->lockdep_mutex, LOCK_BUS);
198 else if (dev->class && dev->class == nd_class)
199 mutex_lock_nested(&dev->lockdep_mutex, LOCK_NDCTL);
200 else
201 dev_WARN(dev, "unknown lock level\n");
202 }
203
debug_nvdimm_unlock(struct device * dev)204 static inline void debug_nvdimm_unlock(struct device *dev)
205 {
206 mutex_unlock(&dev->lockdep_mutex);
207 }
208
nd_device_lock(struct device * dev)209 static inline void nd_device_lock(struct device *dev)
210 {
211 device_lock(dev);
212 debug_nvdimm_lock(dev);
213 }
214
nd_device_unlock(struct device * dev)215 static inline void nd_device_unlock(struct device *dev)
216 {
217 debug_nvdimm_unlock(dev);
218 device_unlock(dev);
219 }
220 #else
nd_device_lock(struct device * dev)221 static inline void nd_device_lock(struct device *dev)
222 {
223 device_lock(dev);
224 }
225
nd_device_unlock(struct device * dev)226 static inline void nd_device_unlock(struct device *dev)
227 {
228 device_unlock(dev);
229 }
230
debug_nvdimm_lock(struct device * dev)231 static inline void debug_nvdimm_lock(struct device *dev)
232 {
233 }
234
debug_nvdimm_unlock(struct device * dev)235 static inline void debug_nvdimm_unlock(struct device *dev)
236 {
237 }
238 #endif
239 #endif /* __ND_CORE_H__ */
240
