1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * libnvdimm - Non-volatile-memory Devices Subsystem
5 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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>
16 struct badrange_entry {
19 struct list_head list;
23 struct list_head list;
28 /* when a dimm supports both PMEM and BLK access a label is required */
30 /* unarmed memory devices may not persist writes */
32 /* locked memory devices should not be accessed */
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 */
38 /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */
40 /* dimm supports namespace labels */
43 /* need to set a limit somewhere, but yes, this is likely overkill */
44 ND_IOCTL_MAX_BUFLEN = SZ_4M,
46 ND_CMD_MAX_ENVELOPE = 256,
49 /* region flag indicating to direct-map persistent memory by default */
50 ND_REGION_PAGEMAP = 0,
52 * Platform ensures entire CPU store data path is flushed to pmem on
55 ND_REGION_PERSIST_CACHE = 1,
57 * Platform provides mechanisms to automatically flush outstanding
58 * write data from memory controler to pmem on system power loss.
61 ND_REGION_PERSIST_MEMCTRL = 2,
63 /* Platform provides asynchronous flush mechanism */
66 /* mark newly adjusted resources as requiring a label update */
67 DPA_RESOURCE_ADJUSTED = 1 << 0,
71 struct nvdimm_bus_descriptor;
72 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
73 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
74 unsigned int buf_len, int *cmd_rc);
77 struct nvdimm_bus_descriptor {
78 const struct attribute_group **attr_groups;
79 unsigned long bus_dsm_mask;
80 unsigned long cmd_mask;
81 struct module *module;
83 struct device_node *of_node;
85 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
86 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
87 struct nvdimm *nvdimm, unsigned int cmd, void *data);
93 u32 in_sizes[ND_CMD_MAX_ELEM];
94 int out_sizes[ND_CMD_MAX_ELEM];
97 struct nd_interleave_set {
98 /* v1.1 definition of the interleave-set-cookie algorithm */
100 /* v1.2 definition of the interleave-set-cookie algorithm */
102 /* compatibility with initial buggy Linux implementation */
108 struct nd_mapping_desc {
109 struct nvdimm *nvdimm;
116 struct nd_region_desc {
117 struct resource *res;
118 struct nd_mapping_desc *mapping;
120 const struct attribute_group **attr_groups;
121 struct nd_interleave_set *nd_set;
127 struct device_node *of_node;
128 int (*flush)(struct nd_region *nd_region, struct bio *bio);
132 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
133 size_t size, unsigned long flags);
134 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
135 resource_size_t offset, size_t size)
137 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
143 struct nd_blk_region;
144 struct nd_blk_region_desc {
145 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
146 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
147 void *iobuf, u64 len, int rw);
148 struct nd_region_desc ndr_desc;
151 static inline struct nd_blk_region_desc *to_blk_region_desc(
152 struct nd_region_desc *ndr_desc)
154 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
159 * Note that separate bits for locked + unlocked are defined so that
160 * 'flags == 0' corresponds to an error / not-supported state.
162 enum nvdimm_security_bits {
163 NVDIMM_SECURITY_DISABLED,
164 NVDIMM_SECURITY_UNLOCKED,
165 NVDIMM_SECURITY_LOCKED,
166 NVDIMM_SECURITY_FROZEN,
167 NVDIMM_SECURITY_OVERWRITE,
170 #define NVDIMM_PASSPHRASE_LEN 32
171 #define NVDIMM_KEY_DESC_LEN 22
173 struct nvdimm_key_data {
174 u8 data[NVDIMM_PASSPHRASE_LEN];
177 enum nvdimm_passphrase_type {
182 struct nvdimm_security_ops {
183 unsigned long (*get_flags)(struct nvdimm *nvdimm,
184 enum nvdimm_passphrase_type pass_type);
185 int (*freeze)(struct nvdimm *nvdimm);
186 int (*change_key)(struct nvdimm *nvdimm,
187 const struct nvdimm_key_data *old_data,
188 const struct nvdimm_key_data *new_data,
189 enum nvdimm_passphrase_type pass_type);
190 int (*unlock)(struct nvdimm *nvdimm,
191 const struct nvdimm_key_data *key_data);
192 int (*disable)(struct nvdimm *nvdimm,
193 const struct nvdimm_key_data *key_data);
194 int (*erase)(struct nvdimm *nvdimm,
195 const struct nvdimm_key_data *key_data,
196 enum nvdimm_passphrase_type pass_type);
197 int (*overwrite)(struct nvdimm *nvdimm,
198 const struct nvdimm_key_data *key_data);
199 int (*query_overwrite)(struct nvdimm *nvdimm);
202 void badrange_init(struct badrange *badrange);
203 int badrange_add(struct badrange *badrange, u64 addr, u64 length);
204 void badrange_forget(struct badrange *badrange, phys_addr_t start,
206 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
208 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
209 struct nvdimm_bus_descriptor *nfit_desc);
210 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
211 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
212 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
213 struct nvdimm *to_nvdimm(struct device *dev);
214 struct nd_region *to_nd_region(struct device *dev);
215 struct device *nd_region_dev(struct nd_region *nd_region);
216 struct nd_blk_region *to_nd_blk_region(struct device *dev);
217 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
218 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
219 const char *nvdimm_name(struct nvdimm *nvdimm);
220 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
221 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
222 void *nvdimm_provider_data(struct nvdimm *nvdimm);
223 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
224 void *provider_data, const struct attribute_group **groups,
225 unsigned long flags, unsigned long cmd_mask, int num_flush,
226 struct resource *flush_wpq, const char *dimm_id,
227 const struct nvdimm_security_ops *sec_ops);
228 static inline 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)
233 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
234 cmd_mask, num_flush, flush_wpq, NULL, NULL);
237 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
238 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
239 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
240 const struct nd_cmd_desc *desc, int idx, void *buf);
241 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
242 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
243 const u32 *out_field, unsigned long remainder);
244 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
245 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
246 struct nd_region_desc *ndr_desc);
247 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
248 struct nd_region_desc *ndr_desc);
249 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
250 struct nd_region_desc *ndr_desc);
251 void *nd_region_provider_data(struct nd_region *nd_region);
252 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
253 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
254 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
255 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
256 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
257 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
258 u64 nd_fletcher64(void *addr, size_t len, bool le);
259 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);
260 int generic_nvdimm_flush(struct nd_region *nd_region);
261 int nvdimm_has_flush(struct nd_region *nd_region);
262 int nvdimm_has_cache(struct nd_region *nd_region);
263 int nvdimm_in_overwrite(struct nvdimm *nvdimm);
264 bool is_nvdimm_sync(struct nd_region *nd_region);
266 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
267 unsigned int buf_len, int *cmd_rc)
269 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
270 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
272 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
275 #ifdef CONFIG_ARCH_HAS_PMEM_API
276 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
277 void arch_wb_cache_pmem(void *addr, size_t size);
278 void arch_invalidate_pmem(void *addr, size_t size);
280 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
281 static inline void arch_wb_cache_pmem(void *addr, size_t size)
284 static inline void arch_invalidate_pmem(void *addr, size_t size)
289 #endif /* __LIBNVDIMM_H__ */