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 /* when a dimm supports both PMEM and BLK access a label is required */ 29 NDD_ALIASING = 0, 30 /* unarmed memory devices may not persist writes */ 31 NDD_UNARMED = 1, 32 /* locked memory devices should not be accessed */ 33 NDD_LOCKED = 2, 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 */ 37 NDD_WORK_PENDING = 4, 38 /* ignore / filter NSLABEL_FLAG_LOCAL for this DIMM, i.e. no aliasing */ 39 NDD_NOBLK = 5, 40 41 /* need to set a limit somewhere, but yes, this is likely overkill */ 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 /* region flag indicating to direct-map persistent memory by default */ 48 ND_REGION_PAGEMAP = 0, 49 /* 50 * Platform ensures entire CPU store data path is flushed to pmem on 51 * system power loss. 52 */ 53 ND_REGION_PERSIST_CACHE = 1, 54 /* 55 * Platform provides mechanisms to automatically flush outstanding 56 * write data from memory controler to pmem on system power loss. 57 * (ADR) 58 */ 59 ND_REGION_PERSIST_MEMCTRL = 2, 60 61 /* Platform provides asynchronous flush mechanism */ 62 ND_REGION_ASYNC = 3, 63 64 /* mark newly adjusted resources as requiring a label update */ 65 DPA_RESOURCE_ADJUSTED = 1 << 0, 66 }; 67 68 extern struct attribute_group nvdimm_bus_attribute_group; 69 extern struct attribute_group nvdimm_attribute_group; 70 extern struct attribute_group nd_numa_attribute_group; 71 extern struct attribute_group nd_region_attribute_group; 72 extern struct attribute_group nd_mapping_attribute_group; 73 74 struct nvdimm; 75 struct nvdimm_bus_descriptor; 76 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 77 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 78 unsigned int buf_len, int *cmd_rc); 79 80 struct device_node; 81 struct nvdimm_bus_descriptor { 82 const struct attribute_group **attr_groups; 83 unsigned long bus_dsm_mask; 84 unsigned long cmd_mask; 85 struct module *module; 86 char *provider_name; 87 struct device_node *of_node; 88 ndctl_fn ndctl; 89 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 90 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 91 struct nvdimm *nvdimm, unsigned int cmd, void *data); 92 }; 93 94 struct nd_cmd_desc { 95 int in_num; 96 int out_num; 97 u32 in_sizes[ND_CMD_MAX_ELEM]; 98 int out_sizes[ND_CMD_MAX_ELEM]; 99 }; 100 101 struct nd_interleave_set { 102 /* v1.1 definition of the interleave-set-cookie algorithm */ 103 u64 cookie1; 104 /* v1.2 definition of the interleave-set-cookie algorithm */ 105 u64 cookie2; 106 /* compatibility with initial buggy Linux implementation */ 107 u64 altcookie; 108 109 guid_t type_guid; 110 }; 111 112 struct nd_mapping_desc { 113 struct nvdimm *nvdimm; 114 u64 start; 115 u64 size; 116 int position; 117 }; 118 119 struct nd_region; 120 struct nd_region_desc { 121 struct resource *res; 122 struct nd_mapping_desc *mapping; 123 u16 num_mappings; 124 const struct attribute_group **attr_groups; 125 struct nd_interleave_set *nd_set; 126 void *provider_data; 127 int num_lanes; 128 int numa_node; 129 int target_node; 130 unsigned long flags; 131 struct device_node *of_node; 132 int (*flush)(struct nd_region *nd_region, struct bio *bio); 133 }; 134 135 struct device; 136 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, 137 size_t size, unsigned long flags); 138 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, 139 resource_size_t offset, size_t size) 140 { 141 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); 142 } 143 144 struct nvdimm_bus; 145 struct module; 146 struct device; 147 struct nd_blk_region; 148 struct nd_blk_region_desc { 149 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 150 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 151 void *iobuf, u64 len, int rw); 152 struct nd_region_desc ndr_desc; 153 }; 154 155 static inline struct nd_blk_region_desc *to_blk_region_desc( 156 struct nd_region_desc *ndr_desc) 157 { 158 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 159 160 } 161 162 /* 163 * Note that separate bits for locked + unlocked are defined so that 164 * 'flags == 0' corresponds to an error / not-supported state. 165 */ 166 enum nvdimm_security_bits { 167 NVDIMM_SECURITY_DISABLED, 168 NVDIMM_SECURITY_UNLOCKED, 169 NVDIMM_SECURITY_LOCKED, 170 NVDIMM_SECURITY_FROZEN, 171 NVDIMM_SECURITY_OVERWRITE, 172 }; 173 174 #define NVDIMM_PASSPHRASE_LEN 32 175 #define NVDIMM_KEY_DESC_LEN 22 176 177 struct nvdimm_key_data { 178 u8 data[NVDIMM_PASSPHRASE_LEN]; 179 }; 180 181 enum nvdimm_passphrase_type { 182 NVDIMM_USER, 183 NVDIMM_MASTER, 184 }; 185 186 struct nvdimm_security_ops { 187 unsigned long (*get_flags)(struct nvdimm *nvdimm, 188 enum nvdimm_passphrase_type pass_type); 189 int (*freeze)(struct nvdimm *nvdimm); 190 int (*change_key)(struct nvdimm *nvdimm, 191 const struct nvdimm_key_data *old_data, 192 const struct nvdimm_key_data *new_data, 193 enum nvdimm_passphrase_type pass_type); 194 int (*unlock)(struct nvdimm *nvdimm, 195 const struct nvdimm_key_data *key_data); 196 int (*disable)(struct nvdimm *nvdimm, 197 const struct nvdimm_key_data *key_data); 198 int (*erase)(struct nvdimm *nvdimm, 199 const struct nvdimm_key_data *key_data, 200 enum nvdimm_passphrase_type pass_type); 201 int (*overwrite)(struct nvdimm *nvdimm, 202 const struct nvdimm_key_data *key_data); 203 int (*query_overwrite)(struct nvdimm *nvdimm); 204 }; 205 206 void badrange_init(struct badrange *badrange); 207 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 208 void badrange_forget(struct badrange *badrange, phys_addr_t start, 209 unsigned int len); 210 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 211 u64 length); 212 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 213 struct nvdimm_bus_descriptor *nfit_desc); 214 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 215 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 216 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm); 217 struct nvdimm *to_nvdimm(struct device *dev); 218 struct nd_region *to_nd_region(struct device *dev); 219 struct device *nd_region_dev(struct nd_region *nd_region); 220 struct nd_blk_region *to_nd_blk_region(struct device *dev); 221 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 222 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 223 const char *nvdimm_name(struct nvdimm *nvdimm); 224 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 225 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 226 void *nvdimm_provider_data(struct nvdimm *nvdimm); 227 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus, 228 void *provider_data, const struct attribute_group **groups, 229 unsigned long flags, unsigned long cmd_mask, int num_flush, 230 struct resource *flush_wpq, const char *dimm_id, 231 const struct nvdimm_security_ops *sec_ops); 232 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, 233 void *provider_data, const struct attribute_group **groups, 234 unsigned long flags, unsigned long cmd_mask, int num_flush, 235 struct resource *flush_wpq) 236 { 237 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags, 238 cmd_mask, num_flush, flush_wpq, NULL, NULL); 239 } 240 241 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 242 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 243 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 244 const struct nd_cmd_desc *desc, int idx, void *buf); 245 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 246 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 247 const u32 *out_field, unsigned long remainder); 248 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 249 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 250 struct nd_region_desc *ndr_desc); 251 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 252 struct nd_region_desc *ndr_desc); 253 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 254 struct nd_region_desc *ndr_desc); 255 void *nd_region_provider_data(struct nd_region *nd_region); 256 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 257 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 258 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 259 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 260 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 261 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 262 u64 nd_fletcher64(void *addr, size_t len, bool le); 263 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio); 264 int generic_nvdimm_flush(struct nd_region *nd_region); 265 int nvdimm_has_flush(struct nd_region *nd_region); 266 int nvdimm_has_cache(struct nd_region *nd_region); 267 int nvdimm_in_overwrite(struct nvdimm *nvdimm); 268 bool is_nvdimm_sync(struct nd_region *nd_region); 269 270 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf, 271 unsigned int buf_len, int *cmd_rc) 272 { 273 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm); 274 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus); 275 276 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc); 277 } 278 279 #ifdef CONFIG_ARCH_HAS_PMEM_API 280 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 281 void arch_wb_cache_pmem(void *addr, size_t size); 282 void arch_invalidate_pmem(void *addr, size_t size); 283 #else 284 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 285 static inline void arch_wb_cache_pmem(void *addr, size_t size) 286 { 287 } 288 static inline void arch_invalidate_pmem(void *addr, size_t size) 289 { 290 } 291 #endif 292 293 #endif /* __LIBNVDIMM_H__ */ 294