Something went wrong. Try again.
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332/* SPDX-License-Identifier: GPL-2.0-only *//* * libnvdimm - Non-volatile-memory Devices Subsystem * * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. */#ifndef __LIBNVDIMM_H__#define __LIBNVDIMM_H__
#include <linux/io.h>#include <linux/sizes.h>#include <linux/spinlock.h>#include <linux/types.h>#include <linux/uuid.h>
struct badrange_entry { u64 start; u64 length; struct list_head list;};
struct badrange { struct list_head list; spinlock_t lock;};
enum { /* unarmed memory devices may not persist writes */ NDD_UNARMED = 1, /* locked memory devices should not be accessed */ NDD_LOCKED = 2, /* memory under security wipes should not be accessed */ NDD_SECURITY_OVERWRITE = 3, /* tracking whether or not there is a pending device reference */ NDD_WORK_PENDING = 4, /* dimm supports namespace labels */ NDD_LABELING = 6, /* * dimm contents have changed requiring invalidation of CPU caches prior * to activation of a region that includes this device */ NDD_INCOHERENT = 7,
/* dimm provider wants synchronous registration by __nvdimm_create() */ NDD_REGISTER_SYNC = 8,
/* need to set a limit somewhere, but yes, this is likely overkill */ ND_IOCTL_MAX_BUFLEN = SZ_4M, ND_CMD_MAX_ELEM = 5, ND_CMD_MAX_ENVELOPE = 256, ND_MAX_MAPPINGS = 32,
/* region flag indicating to direct-map persistent memory by default */ ND_REGION_PAGEMAP = 0, /* * Platform ensures entire CPU store data path is flushed to pmem on * system power loss. */ ND_REGION_PERSIST_CACHE = 1, /* * Platform provides mechanisms to automatically flush outstanding * write data from memory controler to pmem on system power loss. * (ADR) */ ND_REGION_PERSIST_MEMCTRL = 2,
/* Platform provides asynchronous flush mechanism */ ND_REGION_ASYNC = 3,
/* Region was created by CXL subsystem */ ND_REGION_CXL = 4,
/* mark newly adjusted resources as requiring a label update */ DPA_RESOURCE_ADJUSTED = 1 << 0,};
struct nvdimm;struct nvdimm_bus_descriptor;typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm, unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc);
struct attribute_group;struct device_node;struct module;struct nvdimm_bus_descriptor { const struct attribute_group **attr_groups; unsigned long cmd_mask; unsigned long dimm_family_mask; unsigned long bus_family_mask; struct module *module; char *provider_name; struct device_node *of_node; ndctl_fn ndctl; int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm, unsigned int cmd, void *data); const struct nvdimm_bus_fw_ops *fw_ops;};
struct nd_cmd_desc { int in_num; int out_num; u32 in_sizes[ND_CMD_MAX_ELEM]; int out_sizes[ND_CMD_MAX_ELEM];};
struct nd_interleave_set { /* v1.1 definition of the interleave-set-cookie algorithm */ u64 cookie1; /* v1.2 definition of the interleave-set-cookie algorithm */ u64 cookie2; /* compatibility with initial buggy Linux implementation */ u64 altcookie;
guid_t type_guid;};
struct nd_mapping_desc { struct nvdimm *nvdimm; u64 start; u64 size; int position;};
struct bio;struct resource;struct nd_region;struct nd_region_desc { struct resource *res; struct nd_mapping_desc *mapping; u16 num_mappings; const struct attribute_group **attr_groups; struct nd_interleave_set *nd_set; void *provider_data; int num_lanes; int numa_node; int target_node; unsigned long flags; int memregion; struct device_node *of_node; int (*flush)(struct nd_region *nd_region, struct bio *bio);};
struct device;void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, size_t size, unsigned long flags);static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, resource_size_t offset, size_t size){ return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);}
/* * Note that separate bits for locked + unlocked are defined so that * 'flags == 0' corresponds to an error / not-supported state. */enum nvdimm_security_bits { NVDIMM_SECURITY_DISABLED, NVDIMM_SECURITY_UNLOCKED, NVDIMM_SECURITY_LOCKED, NVDIMM_SECURITY_FROZEN, NVDIMM_SECURITY_OVERWRITE,};
#define NVDIMM_PASSPHRASE_LEN 32#define NVDIMM_KEY_DESC_LEN 22
struct nvdimm_key_data { u8 data[NVDIMM_PASSPHRASE_LEN];};
enum nvdimm_passphrase_type { NVDIMM_USER, NVDIMM_MASTER,};
struct nvdimm_security_ops { unsigned long (*get_flags)(struct nvdimm *nvdimm, enum nvdimm_passphrase_type pass_type); int (*freeze)(struct nvdimm *nvdimm); int (*change_key)(struct nvdimm *nvdimm, const struct nvdimm_key_data *old_data, const struct nvdimm_key_data *new_data, enum nvdimm_passphrase_type pass_type); int (*unlock)(struct nvdimm *nvdimm, const struct nvdimm_key_data *key_data); int (*disable)(struct nvdimm *nvdimm, const struct nvdimm_key_data *key_data); int (*erase)(struct nvdimm *nvdimm, const struct nvdimm_key_data *key_data, enum nvdimm_passphrase_type pass_type); int (*overwrite)(struct nvdimm *nvdimm, const struct nvdimm_key_data *key_data); int (*query_overwrite)(struct nvdimm *nvdimm); int (*disable_master)(struct nvdimm *nvdimm, const struct nvdimm_key_data *key_data);};
enum nvdimm_fwa_state { NVDIMM_FWA_INVALID, NVDIMM_FWA_IDLE, NVDIMM_FWA_ARMED, NVDIMM_FWA_BUSY, NVDIMM_FWA_ARM_OVERFLOW,};
enum nvdimm_fwa_trigger { NVDIMM_FWA_ARM, NVDIMM_FWA_DISARM,};
enum nvdimm_fwa_capability { NVDIMM_FWA_CAP_INVALID, NVDIMM_FWA_CAP_NONE, NVDIMM_FWA_CAP_QUIESCE, NVDIMM_FWA_CAP_LIVE,};
enum nvdimm_fwa_result { NVDIMM_FWA_RESULT_INVALID, NVDIMM_FWA_RESULT_NONE, NVDIMM_FWA_RESULT_SUCCESS, NVDIMM_FWA_RESULT_NOTSTAGED, NVDIMM_FWA_RESULT_NEEDRESET, NVDIMM_FWA_RESULT_FAIL,};
struct nvdimm_bus_fw_ops { enum nvdimm_fwa_state (*activate_state) (struct nvdimm_bus_descriptor *nd_desc); enum nvdimm_fwa_capability (*capability) (struct nvdimm_bus_descriptor *nd_desc); int (*activate)(struct nvdimm_bus_descriptor *nd_desc);};
struct nvdimm_fw_ops { enum nvdimm_fwa_state (*activate_state)(struct nvdimm *nvdimm); enum nvdimm_fwa_result (*activate_result)(struct nvdimm *nvdimm); int (*arm)(struct nvdimm *nvdimm, enum nvdimm_fwa_trigger arg);};
struct kobject;struct nvdimm_bus;
void badrange_init(struct badrange *badrange);int badrange_add(struct badrange *badrange, u64 addr, u64 length);void badrange_forget(struct badrange *badrange, phys_addr_t start, unsigned int len);int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);struct nvdimm_bus *nvdimm_bus_register(struct device *parent, struct nvdimm_bus_descriptor *nfit_desc);void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);struct nvdimm_bus *to_nvdimm_bus(struct device *dev);struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm);struct nvdimm *to_nvdimm(struct device *dev);struct nd_region *to_nd_region(struct device *dev);struct device *nd_region_dev(struct nd_region *nd_region);struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);const char *nvdimm_name(struct nvdimm *nvdimm);struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);void *nvdimm_provider_data(struct nvdimm *nvdimm);struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, const struct attribute_group **groups, unsigned long flags, unsigned long cmd_mask, int num_flush, struct resource *flush_wpq, const char *dimm_id, const struct nvdimm_security_ops *sec_ops, const struct nvdimm_fw_ops *fw_ops);static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, const struct attribute_group **groups, unsigned long flags, unsigned long cmd_mask, int num_flush, struct resource *flush_wpq){ return __nvdimm_create(nvdimm_bus, provider_data, groups, flags, cmd_mask, num_flush, flush_wpq, NULL, NULL, NULL);}void nvdimm_delete(struct nvdimm *nvdimm);void nvdimm_region_delete(struct nd_region *nd_region);
const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, const struct nd_cmd_desc *desc, int idx, void *buf);u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, const struct nd_cmd_desc *desc, int idx, const u32 *in_field, const u32 *out_field, unsigned long remainder);int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, struct nd_region_desc *ndr_desc);struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, struct nd_region_desc *ndr_desc);struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, struct nd_region_desc *ndr_desc);void *nd_region_provider_data(struct nd_region *nd_region);unsigned int nd_region_acquire_lane(struct nd_region *nd_region);void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);u64 nd_fletcher64(void *addr, size_t len, bool le);int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);int generic_nvdimm_flush(struct nd_region *nd_region);int nvdimm_has_flush(struct nd_region *nd_region);int nvdimm_has_cache(struct nd_region *nd_region);int nvdimm_in_overwrite(struct nvdimm *nvdimm);bool is_nvdimm_sync(struct nd_region *nd_region);
static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc){ struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm); struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus);
return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc);}
#ifdef CONFIG_ARCH_HAS_PMEM_API#define ARCH_MEMREMAP_PMEM MEMREMAP_WBvoid arch_wb_cache_pmem(void *addr, size_t size);void arch_invalidate_pmem(void *addr, size_t size);#else#define ARCH_MEMREMAP_PMEM MEMREMAP_WTstatic inline void arch_wb_cache_pmem(void *addr, size_t size){}static inline void arch_invalidate_pmem(void *addr, size_t size){}#endif
#endif /* __LIBNVDIMM_H__ */