1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * libnvdimm - Non-volatile-memory Devices Subsystem 4 * 5 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. 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 16 struct badrange_entry { 17 u64 start; 18 u64 length; 19 struct list_head list; 20 }; 21 22 struct badrange { 23 struct list_head list; 24 spinlock_t lock; 25 }; 26 27 enum { 28 /* unarmed memory devices may not persist writes */ 29 NDD_UNARMED = 1, 30 /* locked memory devices should not be accessed */ 31 NDD_LOCKED = 2, 32 /* memory under security wipes should not be accessed */ 33 NDD_SECURITY_OVERWRITE = 3, 34 /* tracking whether or not there is a pending device reference */ 35 NDD_WORK_PENDING = 4, 36 /* dimm supports namespace labels */ 37 NDD_LABELING = 6, 38 39 /* need to set a limit somewhere, but yes, this is likely overkill */ 40 ND_IOCTL_MAX_BUFLEN = SZ_4M, 41 ND_CMD_MAX_ELEM = 5, 42 ND_CMD_MAX_ENVELOPE = 256, 43 ND_MAX_MAPPINGS = 32, 44 45 /* region flag indicating to direct-map persistent memory by default */ 46 ND_REGION_PAGEMAP = 0, 47 /* 48 * Platform ensures entire CPU store data path is flushed to pmem on 49 * system power loss. 50 */ 51 ND_REGION_PERSIST_CACHE = 1, 52 /* 53 * Platform provides mechanisms to automatically flush outstanding 54 * write data from memory controler to pmem on system power loss. 55 * (ADR) 56 */ 57 ND_REGION_PERSIST_MEMCTRL = 2, 58 59 /* Platform provides asynchronous flush mechanism */ 60 ND_REGION_ASYNC = 3, 61 62 /* Region was created by CXL subsystem */ 63 ND_REGION_CXL = 4, 64 65 /* mark newly adjusted resources as requiring a label update */ 66 DPA_RESOURCE_ADJUSTED = 1 << 0, 67 }; 68 69 struct nvdimm; 70 struct nvdimm_bus_descriptor; 71 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 72 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 73 unsigned int buf_len, int *cmd_rc); 74 75 struct device_node; 76 struct nvdimm_bus_descriptor { 77 const struct attribute_group **attr_groups; 78 unsigned long cmd_mask; 79 unsigned long dimm_family_mask; 80 unsigned long bus_family_mask; 81 struct module *module; 82 char *provider_name; 83 struct device_node *of_node; 84 ndctl_fn ndctl; 85 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 86 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 87 struct nvdimm *nvdimm, unsigned int cmd, void *data); 88 const struct nvdimm_bus_fw_ops *fw_ops; 89 }; 90 91 struct nd_cmd_desc { 92 int in_num; 93 int out_num; 94 u32 in_sizes[ND_CMD_MAX_ELEM]; 95 int out_sizes[ND_CMD_MAX_ELEM]; 96 }; 97 98 struct nd_interleave_set { 99 /* v1.1 definition of the interleave-set-cookie algorithm */ 100 u64 cookie1; 101 /* v1.2 definition of the interleave-set-cookie algorithm */ 102 u64 cookie2; 103 /* compatibility with initial buggy Linux implementation */ 104 u64 altcookie; 105 106 guid_t type_guid; 107 }; 108 109 struct nd_mapping_desc { 110 struct nvdimm *nvdimm; 111 u64 start; 112 u64 size; 113 int position; 114 }; 115 116 struct nd_region; 117 struct nd_region_desc { 118 struct resource *res; 119 struct nd_mapping_desc *mapping; 120 u16 num_mappings; 121 const struct attribute_group **attr_groups; 122 struct nd_interleave_set *nd_set; 123 void *provider_data; 124 int num_lanes; 125 int numa_node; 126 int target_node; 127 unsigned long flags; 128 int memregion; 129 struct device_node *of_node; 130 int (*flush)(struct nd_region *nd_region, struct bio *bio); 131 }; 132 133 struct device; 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) 138 { 139 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); 140 } 141 142 struct nvdimm_bus; 143 144 /* 145 * Note that separate bits for locked + unlocked are defined so that 146 * 'flags == 0' corresponds to an error / not-supported state. 147 */ 148 enum nvdimm_security_bits { 149 NVDIMM_SECURITY_DISABLED, 150 NVDIMM_SECURITY_UNLOCKED, 151 NVDIMM_SECURITY_LOCKED, 152 NVDIMM_SECURITY_FROZEN, 153 NVDIMM_SECURITY_OVERWRITE, 154 }; 155 156 #define NVDIMM_PASSPHRASE_LEN 32 157 #define NVDIMM_KEY_DESC_LEN 22 158 159 struct nvdimm_key_data { 160 u8 data[NVDIMM_PASSPHRASE_LEN]; 161 }; 162 163 enum nvdimm_passphrase_type { 164 NVDIMM_USER, 165 NVDIMM_MASTER, 166 }; 167 168 struct nvdimm_security_ops { 169 unsigned long (*get_flags)(struct nvdimm *nvdimm, 170 enum nvdimm_passphrase_type pass_type); 171 int (*freeze)(struct nvdimm *nvdimm); 172 int (*change_key)(struct nvdimm *nvdimm, 173 const struct nvdimm_key_data *old_data, 174 const struct nvdimm_key_data *new_data, 175 enum nvdimm_passphrase_type pass_type); 176 int (*unlock)(struct nvdimm *nvdimm, 177 const struct nvdimm_key_data *key_data); 178 int (*disable)(struct nvdimm *nvdimm, 179 const struct nvdimm_key_data *key_data); 180 int (*erase)(struct nvdimm *nvdimm, 181 const struct nvdimm_key_data *key_data, 182 enum nvdimm_passphrase_type pass_type); 183 int (*overwrite)(struct nvdimm *nvdimm, 184 const struct nvdimm_key_data *key_data); 185 int (*query_overwrite)(struct nvdimm *nvdimm); 186 }; 187 188 enum nvdimm_fwa_state { 189 NVDIMM_FWA_INVALID, 190 NVDIMM_FWA_IDLE, 191 NVDIMM_FWA_ARMED, 192 NVDIMM_FWA_BUSY, 193 NVDIMM_FWA_ARM_OVERFLOW, 194 }; 195 196 enum nvdimm_fwa_trigger { 197 NVDIMM_FWA_ARM, 198 NVDIMM_FWA_DISARM, 199 }; 200 201 enum nvdimm_fwa_capability { 202 NVDIMM_FWA_CAP_INVALID, 203 NVDIMM_FWA_CAP_NONE, 204 NVDIMM_FWA_CAP_QUIESCE, 205 NVDIMM_FWA_CAP_LIVE, 206 }; 207 208 enum nvdimm_fwa_result { 209 NVDIMM_FWA_RESULT_INVALID, 210 NVDIMM_FWA_RESULT_NONE, 211 NVDIMM_FWA_RESULT_SUCCESS, 212 NVDIMM_FWA_RESULT_NOTSTAGED, 213 NVDIMM_FWA_RESULT_NEEDRESET, 214 NVDIMM_FWA_RESULT_FAIL, 215 }; 216 217 struct nvdimm_bus_fw_ops { 218 enum nvdimm_fwa_state (*activate_state) 219 (struct nvdimm_bus_descriptor *nd_desc); 220 enum nvdimm_fwa_capability (*capability) 221 (struct nvdimm_bus_descriptor *nd_desc); 222 int (*activate)(struct nvdimm_bus_descriptor *nd_desc); 223 }; 224 225 struct nvdimm_fw_ops { 226 enum nvdimm_fwa_state (*activate_state)(struct nvdimm *nvdimm); 227 enum nvdimm_fwa_result (*activate_result)(struct nvdimm *nvdimm); 228 int (*arm)(struct nvdimm *nvdimm, enum nvdimm_fwa_trigger arg); 229 }; 230 231 void badrange_init(struct badrange *badrange); 232 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 233 void badrange_forget(struct badrange *badrange, phys_addr_t start, 234 unsigned int len); 235 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 236 u64 length); 237 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 238 struct nvdimm_bus_descriptor *nfit_desc); 239 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 240 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 241 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm); 242 struct nvdimm *to_nvdimm(struct device *dev); 243 struct nd_region *to_nd_region(struct device *dev); 244 struct device *nd_region_dev(struct nd_region *nd_region); 245 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 246 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 247 const char *nvdimm_name(struct nvdimm *nvdimm); 248 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 249 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 250 void *nvdimm_provider_data(struct nvdimm *nvdimm); 251 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus, 252 void *provider_data, const struct attribute_group **groups, 253 unsigned long flags, unsigned long cmd_mask, int num_flush, 254 struct resource *flush_wpq, const char *dimm_id, 255 const struct nvdimm_security_ops *sec_ops, 256 const struct nvdimm_fw_ops *fw_ops); 257 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, 258 void *provider_data, const struct attribute_group **groups, 259 unsigned long flags, unsigned long cmd_mask, int num_flush, 260 struct resource *flush_wpq) 261 { 262 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags, 263 cmd_mask, num_flush, flush_wpq, NULL, NULL, NULL); 264 } 265 void nvdimm_delete(struct nvdimm *nvdimm); 266 void nvdimm_region_delete(struct nd_region *nd_region); 267 268 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 269 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 270 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 271 const struct nd_cmd_desc *desc, int idx, void *buf); 272 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 273 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 274 const u32 *out_field, unsigned long remainder); 275 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 276 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 277 struct nd_region_desc *ndr_desc); 278 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 279 struct nd_region_desc *ndr_desc); 280 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 281 struct nd_region_desc *ndr_desc); 282 void *nd_region_provider_data(struct nd_region *nd_region); 283 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 284 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 285 u64 nd_fletcher64(void *addr, size_t len, bool le); 286 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio); 287 int generic_nvdimm_flush(struct nd_region *nd_region); 288 int nvdimm_has_flush(struct nd_region *nd_region); 289 int nvdimm_has_cache(struct nd_region *nd_region); 290 int nvdimm_in_overwrite(struct nvdimm *nvdimm); 291 bool is_nvdimm_sync(struct nd_region *nd_region); 292 293 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf, 294 unsigned int buf_len, int *cmd_rc) 295 { 296 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm); 297 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus); 298 299 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc); 300 } 301 302 #ifdef CONFIG_ARCH_HAS_PMEM_API 303 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 304 void arch_wb_cache_pmem(void *addr, size_t size); 305 void arch_invalidate_pmem(void *addr, size_t size); 306 #else 307 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 308 static inline void arch_wb_cache_pmem(void *addr, size_t size) 309 { 310 } 311 static inline void arch_invalidate_pmem(void *addr, size_t size) 312 { 313 } 314 #endif 315 316 #endif /* __LIBNVDIMM_H__ */ 317