2 * libnvdimm - Non-volatile-memory Devices Subsystem
4 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of version 2 of the GNU General Public License as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 #ifndef __LIBNVDIMM_H__
16 #define __LIBNVDIMM_H__
17 #include <linux/kernel.h>
18 #include <linux/sizes.h>
19 #include <linux/types.h>
20 #include <linux/uuid.h>
21 #include <linux/spinlock.h>
23 struct badrange_entry {
26 struct list_head list;
30 struct list_head list;
35 /* when a dimm supports both PMEM and BLK access a label is required */
37 /* unarmed memory devices may not persist writes */
39 /* locked memory devices should not be accessed */
42 /* need to set a limit somewhere, but yes, this is likely overkill */
43 ND_IOCTL_MAX_BUFLEN = SZ_4M,
45 ND_CMD_MAX_ENVELOPE = 256,
48 /* region flag indicating to direct-map persistent memory by default */
49 ND_REGION_PAGEMAP = 0,
51 * Platform ensures entire CPU store data path is flushed to pmem on
54 ND_REGION_PERSIST_CACHE = 1,
56 * Platform provides mechanisms to automatically flush outstanding
57 * write data from memory controler to pmem on system power loss.
60 ND_REGION_PERSIST_MEMCTRL = 2,
62 /* mark newly adjusted resources as requiring a label update */
63 DPA_RESOURCE_ADJUSTED = 1 << 0,
66 extern struct attribute_group nvdimm_bus_attribute_group;
67 extern struct attribute_group nvdimm_attribute_group;
68 extern struct attribute_group nd_device_attribute_group;
69 extern struct attribute_group nd_numa_attribute_group;
70 extern struct attribute_group nd_region_attribute_group;
71 extern struct attribute_group nd_mapping_attribute_group;
74 struct nvdimm_bus_descriptor;
75 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
76 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
77 unsigned int buf_len, int *cmd_rc);
80 struct nvdimm_bus_descriptor {
81 const struct attribute_group **attr_groups;
82 unsigned long bus_dsm_mask;
83 unsigned long cmd_mask;
84 struct module *module;
86 struct device_node *of_node;
88 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
89 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
90 struct nvdimm *nvdimm, unsigned int cmd, void *data);
96 u32 in_sizes[ND_CMD_MAX_ELEM];
97 int out_sizes[ND_CMD_MAX_ELEM];
100 struct nd_interleave_set {
101 /* v1.1 definition of the interleave-set-cookie algorithm */
103 /* v1.2 definition of the interleave-set-cookie algorithm */
105 /* compatibility with initial buggy Linux implementation */
111 struct nd_mapping_desc {
112 struct nvdimm *nvdimm;
118 struct nd_region_desc {
119 struct resource *res;
120 struct nd_mapping_desc *mapping;
122 const struct attribute_group **attr_groups;
123 struct nd_interleave_set *nd_set;
128 struct device_node *of_node;
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);
158 enum nvdimm_security_state {
159 NVDIMM_SECURITY_DISABLED,
160 NVDIMM_SECURITY_UNLOCKED,
161 NVDIMM_SECURITY_LOCKED,
162 NVDIMM_SECURITY_FROZEN,
163 NVDIMM_SECURITY_OVERWRITE,
166 #define NVDIMM_PASSPHRASE_LEN 32
167 #define NVDIMM_KEY_DESC_LEN 22
169 struct nvdimm_key_data {
170 u8 data[NVDIMM_PASSPHRASE_LEN];
173 struct nvdimm_security_ops {
174 enum nvdimm_security_state (*state)(struct nvdimm *nvdimm);
175 int (*freeze)(struct nvdimm *nvdimm);
176 int (*change_key)(struct nvdimm *nvdimm,
177 const struct nvdimm_key_data *old_data,
178 const struct nvdimm_key_data *new_data);
179 int (*unlock)(struct nvdimm *nvdimm,
180 const struct nvdimm_key_data *key_data);
183 void badrange_init(struct badrange *badrange);
184 int badrange_add(struct badrange *badrange, u64 addr, u64 length);
185 void badrange_forget(struct badrange *badrange, phys_addr_t start,
187 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
189 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
190 struct nvdimm_bus_descriptor *nfit_desc);
191 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
192 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
193 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
194 struct nvdimm *to_nvdimm(struct device *dev);
195 struct nd_region *to_nd_region(struct device *dev);
196 struct device *nd_region_dev(struct nd_region *nd_region);
197 struct nd_blk_region *to_nd_blk_region(struct device *dev);
198 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
199 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
200 const char *nvdimm_name(struct nvdimm *nvdimm);
201 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
202 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
203 void *nvdimm_provider_data(struct nvdimm *nvdimm);
204 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
205 void *provider_data, const struct attribute_group **groups,
206 unsigned long flags, unsigned long cmd_mask, int num_flush,
207 struct resource *flush_wpq, const char *dimm_id,
208 const struct nvdimm_security_ops *sec_ops);
209 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
210 void *provider_data, const struct attribute_group **groups,
211 unsigned long flags, unsigned long cmd_mask, int num_flush,
212 struct resource *flush_wpq)
214 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
215 cmd_mask, num_flush, flush_wpq, NULL, NULL);
218 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
219 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
220 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
221 const struct nd_cmd_desc *desc, int idx, void *buf);
222 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
223 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
224 const u32 *out_field, unsigned long remainder);
225 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
226 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
227 struct nd_region_desc *ndr_desc);
228 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
229 struct nd_region_desc *ndr_desc);
230 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
231 struct nd_region_desc *ndr_desc);
232 void *nd_region_provider_data(struct nd_region *nd_region);
233 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
234 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
235 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
236 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
237 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
238 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
239 u64 nd_fletcher64(void *addr, size_t len, bool le);
240 void nvdimm_flush(struct nd_region *nd_region);
241 int nvdimm_has_flush(struct nd_region *nd_region);
242 int nvdimm_has_cache(struct nd_region *nd_region);
244 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
245 unsigned int buf_len, int *cmd_rc)
247 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
248 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
250 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
253 #ifdef CONFIG_ARCH_HAS_PMEM_API
254 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
255 void arch_wb_cache_pmem(void *addr, size_t size);
256 void arch_invalidate_pmem(void *addr, size_t size);
258 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
259 static inline void arch_wb_cache_pmem(void *addr, size_t size)
262 static inline void arch_invalidate_pmem(void *addr, size_t size)
267 #endif /* __LIBNVDIMM_H__ */