1
2
3
4
5
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
16struct badrange_entry {
17 u64 start;
18 u64 length;
19 struct list_head list;
20};
21
22struct badrange {
23 struct list_head list;
24 spinlock_t lock;
25};
26
27enum {
28
29 NDD_ALIASING = 0,
30
31 NDD_UNARMED = 1,
32
33 NDD_LOCKED = 2,
34
35 NDD_SECURITY_OVERWRITE = 3,
36
37 NDD_WORK_PENDING = 4,
38
39 NDD_NOBLK = 5,
40
41
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
48 ND_REGION_PAGEMAP = 0,
49
50
51
52
53 ND_REGION_PERSIST_CACHE = 1,
54
55
56
57
58
59 ND_REGION_PERSIST_MEMCTRL = 2,
60
61
62 ND_REGION_ASYNC = 3,
63
64
65 DPA_RESOURCE_ADJUSTED = 1 << 0,
66};
67
68extern struct attribute_group nvdimm_bus_attribute_group;
69extern struct attribute_group nvdimm_attribute_group;
70extern struct attribute_group nd_device_attribute_group;
71extern struct attribute_group nd_numa_attribute_group;
72extern struct attribute_group nd_region_attribute_group;
73extern struct attribute_group nd_mapping_attribute_group;
74
75struct nvdimm;
76struct nvdimm_bus_descriptor;
77typedef 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
81struct device_node;
82struct 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
95struct 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
102struct nd_interleave_set {
103
104 u64 cookie1;
105
106 u64 cookie2;
107
108 u64 altcookie;
109
110 guid_t type_guid;
111};
112
113struct nd_mapping_desc {
114 struct nvdimm *nvdimm;
115 u64 start;
116 u64 size;
117 int position;
118};
119
120struct nd_region;
121struct 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
136struct device;
137void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
138 size_t size, unsigned long flags);
139static 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
145struct nvdimm_bus;
146struct module;
147struct device;
148struct nd_blk_region;
149struct 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
156static 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
163enum 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,
170};
171
172#define NVDIMM_PASSPHRASE_LEN 32
173#define NVDIMM_KEY_DESC_LEN 22
174
175struct nvdimm_key_data {
176 u8 data[NVDIMM_PASSPHRASE_LEN];
177};
178
179enum nvdimm_passphrase_type {
180 NVDIMM_USER,
181 NVDIMM_MASTER,
182};
183
184struct 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);
202};
203
204void badrange_init(struct badrange *badrange);
205int badrange_add(struct badrange *badrange, u64 addr, u64 length);
206void badrange_forget(struct badrange *badrange, phys_addr_t start,
207 unsigned int len);
208int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
209 u64 length);
210struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
211 struct nvdimm_bus_descriptor *nfit_desc);
212void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
213struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
214struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);
215struct nvdimm *to_nvdimm(struct device *dev);
216struct nd_region *to_nd_region(struct device *dev);
217struct device *nd_region_dev(struct nd_region *nd_region);
218struct nd_blk_region *to_nd_blk_region(struct device *dev);
219struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
220struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
221const char *nvdimm_name(struct nvdimm *nvdimm);
222struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
223unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
224void *nvdimm_provider_data(struct nvdimm *nvdimm);
225struct 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);
230static 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)
234{
235 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
236 cmd_mask, num_flush, flush_wpq, NULL, NULL);
237}
238
239const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
240const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
241u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
242 const struct nd_cmd_desc *desc, int idx, void *buf);
243u32 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);
246int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
247struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
248 struct nd_region_desc *ndr_desc);
249struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
250 struct nd_region_desc *ndr_desc);
251struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
252 struct nd_region_desc *ndr_desc);
253void *nd_region_provider_data(struct nd_region *nd_region);
254void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
255void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
256struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
257unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
258unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
259void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
260u64 nd_fletcher64(void *addr, size_t len, bool le);
261int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);
262int generic_nvdimm_flush(struct nd_region *nd_region);
263int nvdimm_has_flush(struct nd_region *nd_region);
264int nvdimm_has_cache(struct nd_region *nd_region);
265int nvdimm_in_overwrite(struct nvdimm *nvdimm);
266bool is_nvdimm_sync(struct nd_region *nd_region);
267
268static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf,
269 unsigned int buf_len, int *cmd_rc)
270{
271 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm);
272 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
273
274 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);
275}
276
277#ifdef CONFIG_ARCH_HAS_PMEM_API
278#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
279void arch_wb_cache_pmem(void *addr, size_t size);
280void arch_invalidate_pmem(void *addr, size_t size);
281#else
282#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
283static inline void arch_wb_cache_pmem(void *addr, size_t size)
284{
285}
286static inline void arch_invalidate_pmem(void *addr, size_t size)
287{
288}
289#endif
290
291#endif
292