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 cmd_mask
;
80 unsigned long dimm_family_mask
;
81 unsigned long bus_family_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
);
89 const struct nvdimm_bus_fw_ops
*fw_ops
;
95 u32 in_sizes
[ND_CMD_MAX_ELEM
];
96 int out_sizes
[ND_CMD_MAX_ELEM
];
99 struct nd_interleave_set
{
100 /* v1.1 definition of the interleave-set-cookie algorithm */
102 /* v1.2 definition of the interleave-set-cookie algorithm */
104 /* compatibility with initial buggy Linux implementation */
110 struct nd_mapping_desc
{
111 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
;
129 struct device_node
*of_node
;
130 int (*flush
)(struct nd_region
*nd_region
, struct bio
*bio
);
134 void *devm_nvdimm_memremap(struct device
*dev
, resource_size_t offset
,
135 size_t size
, unsigned long flags
);
136 static inline void __iomem
*devm_nvdimm_ioremap(struct device
*dev
,
137 resource_size_t offset
, size_t size
)
139 return (void __iomem
*) devm_nvdimm_memremap(dev
, offset
, size
, 0);
144 struct nd_blk_region
;
145 struct nd_blk_region_desc
{
146 int (*enable
)(struct nvdimm_bus
*nvdimm_bus
, struct device
*dev
);
147 int (*do_io
)(struct nd_blk_region
*ndbr
, resource_size_t dpa
,
148 void *iobuf
, u64 len
, int rw
);
149 struct nd_region_desc ndr_desc
;
152 static inline struct nd_blk_region_desc
*to_blk_region_desc(
153 struct nd_region_desc
*ndr_desc
)
155 return container_of(ndr_desc
, struct nd_blk_region_desc
, ndr_desc
);
160 * Note that separate bits for locked + unlocked are defined so that
161 * 'flags == 0' corresponds to an error / not-supported state.
163 enum nvdimm_security_bits
{
164 NVDIMM_SECURITY_DISABLED
,
165 NVDIMM_SECURITY_UNLOCKED
,
166 NVDIMM_SECURITY_LOCKED
,
167 NVDIMM_SECURITY_FROZEN
,
168 NVDIMM_SECURITY_OVERWRITE
,
171 #define NVDIMM_PASSPHRASE_LEN 32
172 #define NVDIMM_KEY_DESC_LEN 22
174 struct nvdimm_key_data
{
175 u8 data
[NVDIMM_PASSPHRASE_LEN
];
178 enum nvdimm_passphrase_type
{
183 struct nvdimm_security_ops
{
184 unsigned long (*get_flags
)(struct nvdimm
*nvdimm
,
185 enum nvdimm_passphrase_type pass_type
);
186 int (*freeze
)(struct nvdimm
*nvdimm
);
187 int (*change_key
)(struct nvdimm
*nvdimm
,
188 const struct nvdimm_key_data
*old_data
,
189 const struct nvdimm_key_data
*new_data
,
190 enum nvdimm_passphrase_type pass_type
);
191 int (*unlock
)(struct nvdimm
*nvdimm
,
192 const struct nvdimm_key_data
*key_data
);
193 int (*disable
)(struct nvdimm
*nvdimm
,
194 const struct nvdimm_key_data
*key_data
);
195 int (*erase
)(struct nvdimm
*nvdimm
,
196 const struct nvdimm_key_data
*key_data
,
197 enum nvdimm_passphrase_type pass_type
);
198 int (*overwrite
)(struct nvdimm
*nvdimm
,
199 const struct nvdimm_key_data
*key_data
);
200 int (*query_overwrite
)(struct nvdimm
*nvdimm
);
203 enum nvdimm_fwa_state
{
208 NVDIMM_FWA_ARM_OVERFLOW
,
211 enum nvdimm_fwa_trigger
{
216 enum nvdimm_fwa_capability
{
217 NVDIMM_FWA_CAP_INVALID
,
219 NVDIMM_FWA_CAP_QUIESCE
,
223 enum nvdimm_fwa_result
{
224 NVDIMM_FWA_RESULT_INVALID
,
225 NVDIMM_FWA_RESULT_NONE
,
226 NVDIMM_FWA_RESULT_SUCCESS
,
227 NVDIMM_FWA_RESULT_NOTSTAGED
,
228 NVDIMM_FWA_RESULT_NEEDRESET
,
229 NVDIMM_FWA_RESULT_FAIL
,
232 struct nvdimm_bus_fw_ops
{
233 enum nvdimm_fwa_state (*activate_state
)
234 (struct nvdimm_bus_descriptor
*nd_desc
);
235 enum nvdimm_fwa_capability (*capability
)
236 (struct nvdimm_bus_descriptor
*nd_desc
);
237 int (*activate
)(struct nvdimm_bus_descriptor
*nd_desc
);
240 struct nvdimm_fw_ops
{
241 enum nvdimm_fwa_state (*activate_state
)(struct nvdimm
*nvdimm
);
242 enum nvdimm_fwa_result (*activate_result
)(struct nvdimm
*nvdimm
);
243 int (*arm
)(struct nvdimm
*nvdimm
, enum nvdimm_fwa_trigger arg
);
246 void badrange_init(struct badrange
*badrange
);
247 int badrange_add(struct badrange
*badrange
, u64 addr
, u64 length
);
248 void badrange_forget(struct badrange
*badrange
, phys_addr_t start
,
250 int nvdimm_bus_add_badrange(struct nvdimm_bus
*nvdimm_bus
, u64 addr
,
252 struct nvdimm_bus
*nvdimm_bus_register(struct device
*parent
,
253 struct nvdimm_bus_descriptor
*nfit_desc
);
254 void nvdimm_bus_unregister(struct nvdimm_bus
*nvdimm_bus
);
255 struct nvdimm_bus
*to_nvdimm_bus(struct device
*dev
);
256 struct nvdimm_bus
*nvdimm_to_bus(struct nvdimm
*nvdimm
);
257 struct nvdimm
*to_nvdimm(struct device
*dev
);
258 struct nd_region
*to_nd_region(struct device
*dev
);
259 struct device
*nd_region_dev(struct nd_region
*nd_region
);
260 struct nd_blk_region
*to_nd_blk_region(struct device
*dev
);
261 struct nvdimm_bus_descriptor
*to_nd_desc(struct nvdimm_bus
*nvdimm_bus
);
262 struct device
*to_nvdimm_bus_dev(struct nvdimm_bus
*nvdimm_bus
);
263 const char *nvdimm_name(struct nvdimm
*nvdimm
);
264 struct kobject
*nvdimm_kobj(struct nvdimm
*nvdimm
);
265 unsigned long nvdimm_cmd_mask(struct nvdimm
*nvdimm
);
266 void *nvdimm_provider_data(struct nvdimm
*nvdimm
);
267 struct nvdimm
*__nvdimm_create(struct nvdimm_bus
*nvdimm_bus
,
268 void *provider_data
, const struct attribute_group
**groups
,
269 unsigned long flags
, unsigned long cmd_mask
, int num_flush
,
270 struct resource
*flush_wpq
, const char *dimm_id
,
271 const struct nvdimm_security_ops
*sec_ops
,
272 const struct nvdimm_fw_ops
*fw_ops
);
273 static inline struct nvdimm
*nvdimm_create(struct nvdimm_bus
*nvdimm_bus
,
274 void *provider_data
, const struct attribute_group
**groups
,
275 unsigned long flags
, unsigned long cmd_mask
, int num_flush
,
276 struct resource
*flush_wpq
)
278 return __nvdimm_create(nvdimm_bus
, provider_data
, groups
, flags
,
279 cmd_mask
, num_flush
, flush_wpq
, NULL
, NULL
, NULL
);
281 void nvdimm_delete(struct nvdimm
*nvdimm
);
283 const struct nd_cmd_desc
*nd_cmd_dimm_desc(int cmd
);
284 const struct nd_cmd_desc
*nd_cmd_bus_desc(int cmd
);
285 u32
nd_cmd_in_size(struct nvdimm
*nvdimm
, int cmd
,
286 const struct nd_cmd_desc
*desc
, int idx
, void *buf
);
287 u32
nd_cmd_out_size(struct nvdimm
*nvdimm
, int cmd
,
288 const struct nd_cmd_desc
*desc
, int idx
, const u32
*in_field
,
289 const u32
*out_field
, unsigned long remainder
);
290 int nvdimm_bus_check_dimm_count(struct nvdimm_bus
*nvdimm_bus
, int dimm_count
);
291 struct nd_region
*nvdimm_pmem_region_create(struct nvdimm_bus
*nvdimm_bus
,
292 struct nd_region_desc
*ndr_desc
);
293 struct nd_region
*nvdimm_blk_region_create(struct nvdimm_bus
*nvdimm_bus
,
294 struct nd_region_desc
*ndr_desc
);
295 struct nd_region
*nvdimm_volatile_region_create(struct nvdimm_bus
*nvdimm_bus
,
296 struct nd_region_desc
*ndr_desc
);
297 void *nd_region_provider_data(struct nd_region
*nd_region
);
298 void *nd_blk_region_provider_data(struct nd_blk_region
*ndbr
);
299 void nd_blk_region_set_provider_data(struct nd_blk_region
*ndbr
, void *data
);
300 struct nvdimm
*nd_blk_region_to_dimm(struct nd_blk_region
*ndbr
);
301 unsigned long nd_blk_memremap_flags(struct nd_blk_region
*ndbr
);
302 unsigned int nd_region_acquire_lane(struct nd_region
*nd_region
);
303 void nd_region_release_lane(struct nd_region
*nd_region
, unsigned int lane
);
304 u64
nd_fletcher64(void *addr
, size_t len
, bool le
);
305 int nvdimm_flush(struct nd_region
*nd_region
, struct bio
*bio
);
306 int generic_nvdimm_flush(struct nd_region
*nd_region
);
307 int nvdimm_has_flush(struct nd_region
*nd_region
);
308 int nvdimm_has_cache(struct nd_region
*nd_region
);
309 int nvdimm_in_overwrite(struct nvdimm
*nvdimm
);
310 bool is_nvdimm_sync(struct nd_region
*nd_region
);
312 static inline int nvdimm_ctl(struct nvdimm
*nvdimm
, unsigned int cmd
, void *buf
,
313 unsigned int buf_len
, int *cmd_rc
)
315 struct nvdimm_bus
*nvdimm_bus
= nvdimm_to_bus(nvdimm
);
316 struct nvdimm_bus_descriptor
*nd_desc
= to_nd_desc(nvdimm_bus
);
318 return nd_desc
->ndctl(nd_desc
, nvdimm
, cmd
, buf
, buf_len
, cmd_rc
);
321 #ifdef CONFIG_ARCH_HAS_PMEM_API
322 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
323 void arch_wb_cache_pmem(void *addr
, size_t size
);
324 void arch_invalidate_pmem(void *addr
, size_t size
);
326 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
327 static inline void arch_wb_cache_pmem(void *addr
, size_t size
)
330 static inline void arch_invalidate_pmem(void *addr
, size_t size
)
335 #endif /* __LIBNVDIMM_H__ */