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 */
41 /* need to set a limit somewhere, but yes, this is likely overkill */
42 ND_IOCTL_MAX_BUFLEN = SZ_4M,
44 ND_CMD_MAX_ENVELOPE = 256,
47 /* region flag indicating to direct-map persistent memory by default */
48 ND_REGION_PAGEMAP = 0,
50 * Platform ensures entire CPU store data path is flushed to pmem on
53 ND_REGION_PERSIST_CACHE = 1,
55 * Platform provides mechanisms to automatically flush outstanding
56 * write data from memory controler to pmem on system power loss.
59 ND_REGION_PERSIST_MEMCTRL = 2,
61 /* Platform provides asynchronous flush mechanism */
64 /* mark newly adjusted resources as requiring a label update */
65 DPA_RESOURCE_ADJUSTED = 1 << 0,
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;
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);
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;
88 struct device_node *of_node;
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);
98 u32 in_sizes[ND_CMD_MAX_ELEM];
99 int out_sizes[ND_CMD_MAX_ELEM];
102 struct nd_interleave_set {
103 /* v1.1 definition of the interleave-set-cookie algorithm */
105 /* v1.2 definition of the interleave-set-cookie algorithm */
107 /* compatibility with initial buggy Linux implementation */
113 struct nd_mapping_desc {
114 struct nvdimm *nvdimm;
121 struct nd_region_desc {
122 struct resource *res;
123 struct nd_mapping_desc *mapping;
125 const struct attribute_group **attr_groups;
126 struct nd_interleave_set *nd_set;
132 struct device_node *of_node;
133 int (*flush)(struct nd_region *nd_region, struct bio *bio);
137 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
138 size_t size, unsigned long flags);
139 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
140 resource_size_t offset, size_t size)
142 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
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;
156 static inline struct nd_blk_region_desc *to_blk_region_desc(
157 struct nd_region_desc *ndr_desc)
159 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
163 enum nvdimm_security_state {
164 NVDIMM_SECURITY_ERROR = -1,
165 NVDIMM_SECURITY_DISABLED,
166 NVDIMM_SECURITY_UNLOCKED,
167 NVDIMM_SECURITY_LOCKED,
168 NVDIMM_SECURITY_FROZEN,
169 NVDIMM_SECURITY_OVERWRITE,
172 #define NVDIMM_PASSPHRASE_LEN 32
173 #define NVDIMM_KEY_DESC_LEN 22
175 struct nvdimm_key_data {
176 u8 data[NVDIMM_PASSPHRASE_LEN];
179 enum nvdimm_passphrase_type {
184 struct nvdimm_security_ops {
185 enum nvdimm_security_state (*state)(struct nvdimm *nvdimm,
186 enum nvdimm_passphrase_type pass_type);
187 int (*freeze)(struct nvdimm *nvdimm);
188 int (*change_key)(struct nvdimm *nvdimm,
189 const struct nvdimm_key_data *old_data,
190 const struct nvdimm_key_data *new_data,
191 enum nvdimm_passphrase_type pass_type);
192 int (*unlock)(struct nvdimm *nvdimm,
193 const struct nvdimm_key_data *key_data);
194 int (*disable)(struct nvdimm *nvdimm,
195 const struct nvdimm_key_data *key_data);
196 int (*erase)(struct nvdimm *nvdimm,
197 const struct nvdimm_key_data *key_data,
198 enum nvdimm_passphrase_type pass_type);
199 int (*overwrite)(struct nvdimm *nvdimm,
200 const struct nvdimm_key_data *key_data);
201 int (*query_overwrite)(struct nvdimm *nvdimm);
204 void badrange_init(struct badrange *badrange);
205 int badrange_add(struct badrange *badrange, u64 addr, u64 length);
206 void badrange_forget(struct badrange *badrange, phys_addr_t start,
208 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
210 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
211 struct nvdimm_bus_descriptor *nfit_desc);
212 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
213 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
214 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
215 struct nvdimm *to_nvdimm(struct device *dev);
216 struct nd_region *to_nd_region(struct device *dev);
217 struct device *nd_region_dev(struct nd_region *nd_region);
218 struct nd_blk_region *to_nd_blk_region(struct device *dev);
219 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
220 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
221 const char *nvdimm_name(struct nvdimm *nvdimm);
222 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
223 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
224 void *nvdimm_provider_data(struct nvdimm *nvdimm);
225 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
226 void *provider_data, const struct attribute_group **groups,
227 unsigned long flags, unsigned long cmd_mask, int num_flush,
228 struct resource *flush_wpq, const char *dimm_id,
229 const struct nvdimm_security_ops *sec_ops);
230 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
231 void *provider_data, const struct attribute_group **groups,
232 unsigned long flags, unsigned long cmd_mask, int num_flush,
233 struct resource *flush_wpq)
235 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
236 cmd_mask, num_flush, flush_wpq, NULL, NULL);
239 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
240 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
241 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
242 const struct nd_cmd_desc *desc, int idx, void *buf);
243 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
244 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
245 const u32 *out_field, unsigned long remainder);
246 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
247 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
248 struct nd_region_desc *ndr_desc);
249 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
250 struct nd_region_desc *ndr_desc);
251 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
252 struct nd_region_desc *ndr_desc);
253 void *nd_region_provider_data(struct nd_region *nd_region);
254 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
255 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
256 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
257 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
258 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
259 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
260 u64 nd_fletcher64(void *addr, size_t len, bool le);
261 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);
262 int generic_nvdimm_flush(struct nd_region *nd_region);
263 int nvdimm_has_flush(struct nd_region *nd_region);
264 int nvdimm_has_cache(struct nd_region *nd_region);
265 int nvdimm_in_overwrite(struct nvdimm *nvdimm);
266 bool is_nvdimm_sync(struct nd_region *nd_region);
268 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
269 unsigned int buf_len, int *cmd_rc)
271 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
272 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
274 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
277 #ifdef CONFIG_ARCH_HAS_PMEM_API
278 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
279 void arch_wb_cache_pmem(void *addr, size_t size);
280 void arch_invalidate_pmem(void *addr, size_t size);
282 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
283 static inline void arch_wb_cache_pmem(void *addr, size_t size)
286 static inline void arch_invalidate_pmem(void *addr, size_t size)
291 #endif /* __LIBNVDIMM_H__ */