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>
15 struct badrange_entry
{
18 struct list_head list
;
22 struct list_head list
;
27 /* when a dimm supports both PMEM and BLK access a label is required */
29 /* unarmed memory devices may not persist writes */
31 /* locked memory devices should not be accessed */
33 /* memory under security wipes should not be accessed */
34 NDD_SECURITY_OVERWRITE
= 3,
35 /* tracking whether or not there is a pending device reference */
37 /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */
40 /* need to set a limit somewhere, but yes, this is likely overkill */
41 ND_IOCTL_MAX_BUFLEN
= SZ_4M
,
43 ND_CMD_MAX_ENVELOPE
= 256,
46 /* region flag indicating to direct-map persistent memory by default */
47 ND_REGION_PAGEMAP
= 0,
49 * Platform ensures entire CPU store data path is flushed to pmem on
52 ND_REGION_PERSIST_CACHE
= 1,
54 * Platform provides mechanisms to automatically flush outstanding
55 * write data from memory controler to pmem on system power loss.
58 ND_REGION_PERSIST_MEMCTRL
= 2,
60 /* mark newly adjusted resources as requiring a label update */
61 DPA_RESOURCE_ADJUSTED
= 1 << 0,
64 extern struct attribute_group nvdimm_bus_attribute_group
;
65 extern struct attribute_group nvdimm_attribute_group
;
66 extern struct attribute_group nd_device_attribute_group
;
67 extern struct attribute_group nd_numa_attribute_group
;
68 extern struct attribute_group nd_region_attribute_group
;
69 extern struct attribute_group nd_mapping_attribute_group
;
72 struct nvdimm_bus_descriptor
;
73 typedef int (*ndctl_fn
)(struct nvdimm_bus_descriptor
*nd_desc
,
74 struct nvdimm
*nvdimm
, unsigned int cmd
, void *buf
,
75 unsigned int buf_len
, int *cmd_rc
);
78 struct nvdimm_bus_descriptor
{
79 const struct attribute_group
**attr_groups
;
80 unsigned long bus_dsm_mask
;
81 unsigned long cmd_mask
;
82 struct module
*module
;
84 struct device_node
*of_node
;
86 int (*flush_probe
)(struct nvdimm_bus_descriptor
*nd_desc
);
87 int (*clear_to_send
)(struct nvdimm_bus_descriptor
*nd_desc
,
88 struct nvdimm
*nvdimm
, unsigned int cmd
, void *data
);
94 u32 in_sizes
[ND_CMD_MAX_ELEM
];
95 int out_sizes
[ND_CMD_MAX_ELEM
];
98 struct nd_interleave_set
{
99 /* v1.1 definition of the interleave-set-cookie algorithm */
101 /* v1.2 definition of the interleave-set-cookie algorithm */
103 /* compatibility with initial buggy Linux implementation */
109 struct nd_mapping_desc
{
110 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
;
131 void *devm_nvdimm_memremap(struct device
*dev
, resource_size_t offset
,
132 size_t size
, unsigned long flags
);
133 static inline void __iomem
*devm_nvdimm_ioremap(struct device
*dev
,
134 resource_size_t offset
, size_t size
)
136 return (void __iomem
*) devm_nvdimm_memremap(dev
, offset
, size
, 0);
142 struct nd_blk_region
;
143 struct nd_blk_region_desc
{
144 int (*enable
)(struct nvdimm_bus
*nvdimm_bus
, struct device
*dev
);
145 int (*do_io
)(struct nd_blk_region
*ndbr
, resource_size_t dpa
,
146 void *iobuf
, u64 len
, int rw
);
147 struct nd_region_desc ndr_desc
;
150 static inline struct nd_blk_region_desc
*to_blk_region_desc(
151 struct nd_region_desc
*ndr_desc
)
153 return container_of(ndr_desc
, struct nd_blk_region_desc
, ndr_desc
);
157 enum nvdimm_security_state
{
158 NVDIMM_SECURITY_ERROR
= -1,
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 enum nvdimm_passphrase_type
{
178 struct nvdimm_security_ops
{
179 enum nvdimm_security_state (*state
)(struct nvdimm
*nvdimm
,
180 enum nvdimm_passphrase_type pass_type
);
181 int (*freeze
)(struct nvdimm
*nvdimm
);
182 int (*change_key
)(struct nvdimm
*nvdimm
,
183 const struct nvdimm_key_data
*old_data
,
184 const struct nvdimm_key_data
*new_data
,
185 enum nvdimm_passphrase_type pass_type
);
186 int (*unlock
)(struct nvdimm
*nvdimm
,
187 const struct nvdimm_key_data
*key_data
);
188 int (*disable
)(struct nvdimm
*nvdimm
,
189 const struct nvdimm_key_data
*key_data
);
190 int (*erase
)(struct nvdimm
*nvdimm
,
191 const struct nvdimm_key_data
*key_data
,
192 enum nvdimm_passphrase_type pass_type
);
193 int (*overwrite
)(struct nvdimm
*nvdimm
,
194 const struct nvdimm_key_data
*key_data
);
195 int (*query_overwrite
)(struct nvdimm
*nvdimm
);
198 void badrange_init(struct badrange
*badrange
);
199 int badrange_add(struct badrange
*badrange
, u64 addr
, u64 length
);
200 void badrange_forget(struct badrange
*badrange
, phys_addr_t start
,
202 int nvdimm_bus_add_badrange(struct nvdimm_bus
*nvdimm_bus
, u64 addr
,
204 struct nvdimm_bus
*nvdimm_bus_register(struct device
*parent
,
205 struct nvdimm_bus_descriptor
*nfit_desc
);
206 void nvdimm_bus_unregister(struct nvdimm_bus
*nvdimm_bus
);
207 struct nvdimm_bus
*to_nvdimm_bus(struct device
*dev
);
208 struct nvdimm_bus
*nvdimm_to_bus(struct nvdimm
*nvdimm
);
209 struct nvdimm
*to_nvdimm(struct device
*dev
);
210 struct nd_region
*to_nd_region(struct device
*dev
);
211 struct device
*nd_region_dev(struct nd_region
*nd_region
);
212 struct nd_blk_region
*to_nd_blk_region(struct device
*dev
);
213 struct nvdimm_bus_descriptor
*to_nd_desc(struct nvdimm_bus
*nvdimm_bus
);
214 struct device
*to_nvdimm_bus_dev(struct nvdimm_bus
*nvdimm_bus
);
215 const char *nvdimm_name(struct nvdimm
*nvdimm
);
216 struct kobject
*nvdimm_kobj(struct nvdimm
*nvdimm
);
217 unsigned long nvdimm_cmd_mask(struct nvdimm
*nvdimm
);
218 void *nvdimm_provider_data(struct nvdimm
*nvdimm
);
219 struct nvdimm
*__nvdimm_create(struct nvdimm_bus
*nvdimm_bus
,
220 void *provider_data
, const struct attribute_group
**groups
,
221 unsigned long flags
, unsigned long cmd_mask
, int num_flush
,
222 struct resource
*flush_wpq
, const char *dimm_id
,
223 const struct nvdimm_security_ops
*sec_ops
);
224 static inline struct nvdimm
*nvdimm_create(struct nvdimm_bus
*nvdimm_bus
,
225 void *provider_data
, const struct attribute_group
**groups
,
226 unsigned long flags
, unsigned long cmd_mask
, int num_flush
,
227 struct resource
*flush_wpq
)
229 return __nvdimm_create(nvdimm_bus
, provider_data
, groups
, flags
,
230 cmd_mask
, num_flush
, flush_wpq
, NULL
, NULL
);
233 const struct nd_cmd_desc
*nd_cmd_dimm_desc(int cmd
);
234 const struct nd_cmd_desc
*nd_cmd_bus_desc(int cmd
);
235 u32
nd_cmd_in_size(struct nvdimm
*nvdimm
, int cmd
,
236 const struct nd_cmd_desc
*desc
, int idx
, void *buf
);
237 u32
nd_cmd_out_size(struct nvdimm
*nvdimm
, int cmd
,
238 const struct nd_cmd_desc
*desc
, int idx
, const u32
*in_field
,
239 const u32
*out_field
, unsigned long remainder
);
240 int nvdimm_bus_check_dimm_count(struct nvdimm_bus
*nvdimm_bus
, int dimm_count
);
241 struct nd_region
*nvdimm_pmem_region_create(struct nvdimm_bus
*nvdimm_bus
,
242 struct nd_region_desc
*ndr_desc
);
243 struct nd_region
*nvdimm_blk_region_create(struct nvdimm_bus
*nvdimm_bus
,
244 struct nd_region_desc
*ndr_desc
);
245 struct nd_region
*nvdimm_volatile_region_create(struct nvdimm_bus
*nvdimm_bus
,
246 struct nd_region_desc
*ndr_desc
);
247 void *nd_region_provider_data(struct nd_region
*nd_region
);
248 void *nd_blk_region_provider_data(struct nd_blk_region
*ndbr
);
249 void nd_blk_region_set_provider_data(struct nd_blk_region
*ndbr
, void *data
);
250 struct nvdimm
*nd_blk_region_to_dimm(struct nd_blk_region
*ndbr
);
251 unsigned long nd_blk_memremap_flags(struct nd_blk_region
*ndbr
);
252 unsigned int nd_region_acquire_lane(struct nd_region
*nd_region
);
253 void nd_region_release_lane(struct nd_region
*nd_region
, unsigned int lane
);
254 u64
nd_fletcher64(void *addr
, size_t len
, bool le
);
255 void nvdimm_flush(struct nd_region
*nd_region
);
256 int nvdimm_has_flush(struct nd_region
*nd_region
);
257 int nvdimm_has_cache(struct nd_region
*nd_region
);
258 int nvdimm_in_overwrite(struct nvdimm
*nvdimm
);
260 static inline int nvdimm_ctl(struct nvdimm
*nvdimm
, unsigned int cmd
, void *buf
,
261 unsigned int buf_len
, int *cmd_rc
)
263 struct nvdimm_bus
*nvdimm_bus
= nvdimm_to_bus(nvdimm
);
264 struct nvdimm_bus_descriptor
*nd_desc
= to_nd_desc(nvdimm_bus
);
266 return nd_desc
->ndctl(nd_desc
, nvdimm
, cmd
, buf
, buf_len
, cmd_rc
);
269 #ifdef CONFIG_ARCH_HAS_PMEM_API
270 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
271 void arch_wb_cache_pmem(void *addr
, size_t size
);
272 void arch_invalidate_pmem(void *addr
, size_t size
);
274 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
275 static inline void arch_wb_cache_pmem(void *addr
, size_t size
)
278 static inline void arch_invalidate_pmem(void *addr
, size_t size
)
283 #endif /* __LIBNVDIMM_H__ */