1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * libnvdimm - Non-volatile-memory Devices Subsystem
4 *
5 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
6 */
7 #ifndef __LIBNVDIMM_H__
8 #define __LIBNVDIMM_H__
9 #include <linux/kernel.h>
10 #include <linux/sizes.h>
11 #include <linux/types.h>
12 #include <linux/uuid.h>
13 #include <linux/spinlock.h>
14 #include <linux/bio.h>
15
16 struct badrange_entry {
17 u64 start;
18 u64 length;
19 struct list_head list;
20 };
21
22 struct badrange {
23 struct list_head list;
24 spinlock_t lock;
25 };
26
27 enum {
28 /* when a dimm supports both PMEM and BLK access a label is required */
29 NDD_ALIASING = 0,
30 /* unarmed memory devices may not persist writes */
31 NDD_UNARMED = 1,
32 /* locked memory devices should not be accessed */
33 NDD_LOCKED = 2,
34 /* memory under security wipes should not be accessed */
35 NDD_SECURITY_OVERWRITE = 3,
36 /* tracking whether or not there is a pending device reference */
37 NDD_WORK_PENDING = 4,
38 /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */
39 NDD_NOBLK = 5,
40
41 /* need to set a limit somewhere, but yes, this is likely overkill */
42 ND_IOCTL_MAX_BUFLEN = SZ_4M,
43 ND_CMD_MAX_ELEM = 5,
44 ND_CMD_MAX_ENVELOPE = 256,
45 ND_MAX_MAPPINGS = 32,
46
47 /* region flag indicating to direct-map persistent memory by default */
48 ND_REGION_PAGEMAP = 0,
49 /*
50 * Platform ensures entire CPU store data path is flushed to pmem on
51 * system power loss.
52 */
53 ND_REGION_PERSIST_CACHE = 1,
54 /*
55 * Platform provides mechanisms to automatically flush outstanding
56 * write data from memory controler to pmem on system power loss.
57 * (ADR)
58 */
59 ND_REGION_PERSIST_MEMCTRL = 2,
60
61 /* Platform provides asynchronous flush mechanism */
62 ND_REGION_ASYNC = 3,
63
64 /* mark newly adjusted resources as requiring a label update */
65 DPA_RESOURCE_ADJUSTED = 1 << 0,
66 };
67
68 extern struct attribute_group nvdimm_bus_attribute_group;
69 extern struct attribute_group nvdimm_attribute_group;
70 extern struct attribute_group nd_device_attribute_group;
71 extern struct attribute_group nd_numa_attribute_group;
72 extern struct attribute_group nd_region_attribute_group;
73 extern struct attribute_group nd_mapping_attribute_group;
74
75 struct nvdimm;
76 struct nvdimm_bus_descriptor;
77 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
78 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
79 unsigned int buf_len, int *cmd_rc);
80
81 struct device_node;
82 struct nvdimm_bus_descriptor {
83 const struct attribute_group **attr_groups;
84 unsigned long bus_dsm_mask;
85 unsigned long cmd_mask;
86 struct module *module;
87 char *provider_name;
88 struct device_node *of_node;
89 ndctl_fn ndctl;
90 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
91 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
92 struct nvdimm *nvdimm, unsigned int cmd, void *data);
93 };
94
95 struct nd_cmd_desc {
96 int in_num;
97 int out_num;
98 u32 in_sizes[ND_CMD_MAX_ELEM];
99 int out_sizes[ND_CMD_MAX_ELEM];
100 };
101
102 struct nd_interleave_set {
103 /* v1.1 definition of the interleave-set-cookie algorithm */
104 u64 cookie1;
105 /* v1.2 definition of the interleave-set-cookie algorithm */
106 u64 cookie2;
107 /* compatibility with initial buggy Linux implementation */
108 u64 altcookie;
109
110 guid_t type_guid;
111 };
112
113 struct nd_mapping_desc {
114 struct nvdimm *nvdimm;
115 u64 start;
116 u64 size;
117 int position;
118 };
119
120 struct nd_region;
121 struct nd_region_desc {
122 struct resource *res;
123 struct nd_mapping_desc *mapping;
124 u16 num_mappings;
125 const struct attribute_group **attr_groups;
126 struct nd_interleave_set *nd_set;
127 void *provider_data;
128 int num_lanes;
129 int numa_node;
130 int target_node;
131 unsigned long flags;
132 struct device_node *of_node;
133 int (*flush)(struct nd_region *nd_region, struct bio *bio);
134 };
135
136 struct device;
137 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
138 size_t size, unsigned long flags);
devm_nvdimm_ioremap(struct device * dev,resource_size_t offset,size_t size)139 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
140 resource_size_t offset, size_t size)
141 {
142 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
143 }
144
145 struct nvdimm_bus;
146 struct module;
147 struct device;
148 struct nd_blk_region;
149 struct nd_blk_region_desc {
150 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
151 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
152 void *iobuf, u64 len, int rw);
153 struct nd_region_desc ndr_desc;
154 };
155
to_blk_region_desc(struct nd_region_desc * ndr_desc)156 static inline struct nd_blk_region_desc *to_blk_region_desc(
157 struct nd_region_desc *ndr_desc)
158 {
159 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
160
161 }
162
163 /*
164 * Note that separate bits for locked + unlocked are defined so that
165 * 'flags == 0' corresponds to an error / not-supported state.
166 */
167 enum nvdimm_security_bits {
168 NVDIMM_SECURITY_DISABLED,
169 NVDIMM_SECURITY_UNLOCKED,
170 NVDIMM_SECURITY_LOCKED,
171 NVDIMM_SECURITY_FROZEN,
172 NVDIMM_SECURITY_OVERWRITE,
173 };
174
175 #define NVDIMM_PASSPHRASE_LEN 32
176 #define NVDIMM_KEY_DESC_LEN 22
177
178 struct nvdimm_key_data {
179 u8 data[NVDIMM_PASSPHRASE_LEN];
180 };
181
182 enum nvdimm_passphrase_type {
183 NVDIMM_USER,
184 NVDIMM_MASTER,
185 };
186
187 struct nvdimm_security_ops {
188 unsigned long (*get_flags)(struct nvdimm *nvdimm,
189 enum nvdimm_passphrase_type pass_type);
190 int (*freeze)(struct nvdimm *nvdimm);
191 int (*change_key)(struct nvdimm *nvdimm,
192 const struct nvdimm_key_data *old_data,
193 const struct nvdimm_key_data *new_data,
194 enum nvdimm_passphrase_type pass_type);
195 int (*unlock)(struct nvdimm *nvdimm,
196 const struct nvdimm_key_data *key_data);
197 int (*disable)(struct nvdimm *nvdimm,
198 const struct nvdimm_key_data *key_data);
199 int (*erase)(struct nvdimm *nvdimm,
200 const struct nvdimm_key_data *key_data,
201 enum nvdimm_passphrase_type pass_type);
202 int (*overwrite)(struct nvdimm *nvdimm,
203 const struct nvdimm_key_data *key_data);
204 int (*query_overwrite)(struct nvdimm *nvdimm);
205 };
206
207 void badrange_init(struct badrange *badrange);
208 int badrange_add(struct badrange *badrange, u64 addr, u64 length);
209 void badrange_forget(struct badrange *badrange, phys_addr_t start,
210 unsigned int len);
211 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
212 u64 length);
213 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
214 struct nvdimm_bus_descriptor *nfit_desc);
215 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
216 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
217 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
218 struct nvdimm *to_nvdimm(struct device *dev);
219 struct nd_region *to_nd_region(struct device *dev);
220 struct device *nd_region_dev(struct nd_region *nd_region);
221 struct nd_blk_region *to_nd_blk_region(struct device *dev);
222 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
223 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
224 const char *nvdimm_name(struct nvdimm *nvdimm);
225 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
226 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
227 void *nvdimm_provider_data(struct nvdimm *nvdimm);
228 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
229 void *provider_data, const struct attribute_group **groups,
230 unsigned long flags, unsigned long cmd_mask, int num_flush,
231 struct resource *flush_wpq, const char *dimm_id,
232 const struct nvdimm_security_ops *sec_ops);
nvdimm_create(struct nvdimm_bus * nvdimm_bus,void * provider_data,const struct attribute_group ** groups,unsigned long flags,unsigned long cmd_mask,int num_flush,struct resource * flush_wpq)233 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
234 void *provider_data, const struct attribute_group **groups,
235 unsigned long flags, unsigned long cmd_mask, int num_flush,
236 struct resource *flush_wpq)
237 {
238 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
239 cmd_mask, num_flush, flush_wpq, NULL, NULL);
240 }
241
242 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
243 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
244 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
245 const struct nd_cmd_desc *desc, int idx, void *buf);
246 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
247 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
248 const u32 *out_field, unsigned long remainder);
249 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
250 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
251 struct nd_region_desc *ndr_desc);
252 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
253 struct nd_region_desc *ndr_desc);
254 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
255 struct nd_region_desc *ndr_desc);
256 void *nd_region_provider_data(struct nd_region *nd_region);
257 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
258 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
259 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
260 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
261 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
262 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
263 u64 nd_fletcher64(void *addr, size_t len, bool le);
264 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);
265 int generic_nvdimm_flush(struct nd_region *nd_region);
266 int nvdimm_has_flush(struct nd_region *nd_region);
267 int nvdimm_has_cache(struct nd_region *nd_region);
268 int nvdimm_in_overwrite(struct nvdimm *nvdimm);
269 bool is_nvdimm_sync(struct nd_region *nd_region);
270
nvdimm_ctl(struct nvdimm * nvdimm,unsigned int cmd,void * buf,unsigned int buf_len,int * cmd_rc)271 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
272 unsigned int buf_len, int *cmd_rc)
273 {
274 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
275 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
276
277 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
278 }
279
280 #ifdef CONFIG_ARCH_HAS_PMEM_API
281 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
282 void arch_wb_cache_pmem(void *addr, size_t size);
283 void arch_invalidate_pmem(void *addr, size_t size);
284 #else
285 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
arch_wb_cache_pmem(void * addr,size_t size)286 static inline void arch_wb_cache_pmem(void *addr, size_t size)
287 {
288 }
arch_invalidate_pmem(void * addr,size_t size)289 static inline void arch_invalidate_pmem(void *addr, size_t size)
290 {
291 }
292 #endif
293
294 #endif /* __LIBNVDIMM_H__ */
295
