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_mapping_attribute_group; 71 72 struct nvdimm; 73 struct nvdimm_bus_descriptor; 74 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 75 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 76 unsigned int buf_len, int *cmd_rc); 77 78 struct device_node; 79 struct nvdimm_bus_descriptor { 80 const struct attribute_group **attr_groups; 81 unsigned long bus_dsm_mask; 82 unsigned long cmd_mask; 83 struct module *module; 84 char *provider_name; 85 struct device_node *of_node; 86 ndctl_fn ndctl; 87 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 88 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 89 struct nvdimm *nvdimm, unsigned int cmd, void *data); 90 }; 91 92 struct nd_cmd_desc { 93 int in_num; 94 int out_num; 95 u32 in_sizes[ND_CMD_MAX_ELEM]; 96 int out_sizes[ND_CMD_MAX_ELEM]; 97 }; 98 99 struct nd_interleave_set { 100 /* v1.1 definition of the interleave-set-cookie algorithm */ 101 u64 cookie1; 102 /* v1.2 definition of the interleave-set-cookie algorithm */ 103 u64 cookie2; 104 /* compatibility with initial buggy Linux implementation */ 105 u64 altcookie; 106 107 guid_t type_guid; 108 }; 109 110 struct nd_mapping_desc { 111 struct nvdimm *nvdimm; 112 u64 start; 113 u64 size; 114 int position; 115 }; 116 117 struct nd_region; 118 struct nd_region_desc { 119 struct resource *res; 120 struct nd_mapping_desc *mapping; 121 u16 num_mappings; 122 const struct attribute_group **attr_groups; 123 struct nd_interleave_set *nd_set; 124 void *provider_data; 125 int num_lanes; 126 int numa_node; 127 int target_node; 128 unsigned long flags; 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 struct module; 144 struct device; 145 struct nd_blk_region; 146 struct nd_blk_region_desc { 147 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 148 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 149 void *iobuf, u64 len, int rw); 150 struct nd_region_desc ndr_desc; 151 }; 152 153 static inline struct nd_blk_region_desc *to_blk_region_desc( 154 struct nd_region_desc *ndr_desc) 155 { 156 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 157 158 } 159 160 /* 161 * Note that separate bits for locked + unlocked are defined so that 162 * 'flags == 0' corresponds to an error / not-supported state. 163 */ 164 enum nvdimm_security_bits { 165 NVDIMM_SECURITY_DISABLED, 166 NVDIMM_SECURITY_UNLOCKED, 167 NVDIMM_SECURITY_LOCKED, 168 NVDIMM_SECURITY_FROZEN, 169 NVDIMM_SECURITY_OVERWRITE, 170 }; 171 172 #define NVDIMM_PASSPHRASE_LEN 32 173 #define NVDIMM_KEY_DESC_LEN 22 174 175 struct nvdimm_key_data { 176 u8 data[NVDIMM_PASSPHRASE_LEN]; 177 }; 178 179 enum nvdimm_passphrase_type { 180 NVDIMM_USER, 181 NVDIMM_MASTER, 182 }; 183 184 struct nvdimm_security_ops { 185 unsigned long (*get_flags)(struct nvdimm *nvdimm, 186 enum nvdimm_passphrase_type pass_type); 187 int (*freeze)(struct nvdimm *nvdimm); 188 int (*change_key)(struct nvdimm *nvdimm, 189 const struct nvdimm_key_data *old_data, 190 const struct nvdimm_key_data *new_data, 191 enum nvdimm_passphrase_type pass_type); 192 int (*unlock)(struct nvdimm *nvdimm, 193 const struct nvdimm_key_data *key_data); 194 int (*disable)(struct nvdimm *nvdimm, 195 const struct nvdimm_key_data *key_data); 196 int (*erase)(struct nvdimm *nvdimm, 197 const struct nvdimm_key_data *key_data, 198 enum nvdimm_passphrase_type pass_type); 199 int (*overwrite)(struct nvdimm *nvdimm, 200 const struct nvdimm_key_data *key_data); 201 int (*query_overwrite)(struct nvdimm *nvdimm); 202 }; 203 204 void badrange_init(struct badrange *badrange); 205 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 206 void badrange_forget(struct badrange *badrange, phys_addr_t start, 207 unsigned int len); 208 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 209 u64 length); 210 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 211 struct nvdimm_bus_descriptor *nfit_desc); 212 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 213 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 214 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm); 215 struct nvdimm *to_nvdimm(struct device *dev); 216 struct nd_region *to_nd_region(struct device *dev); 217 struct device *nd_region_dev(struct nd_region *nd_region); 218 struct nd_blk_region *to_nd_blk_region(struct device *dev); 219 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 220 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 221 const char *nvdimm_name(struct nvdimm *nvdimm); 222 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 223 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 224 void *nvdimm_provider_data(struct nvdimm *nvdimm); 225 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus, 226 void *provider_data, const struct attribute_group **groups, 227 unsigned long flags, unsigned long cmd_mask, int num_flush, 228 struct resource *flush_wpq, const char *dimm_id, 229 const struct nvdimm_security_ops *sec_ops); 230 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, 231 void *provider_data, const struct attribute_group **groups, 232 unsigned long flags, unsigned long cmd_mask, int num_flush, 233 struct resource *flush_wpq) 234 { 235 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags, 236 cmd_mask, num_flush, flush_wpq, NULL, NULL); 237 } 238 239 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 240 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 241 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 242 const struct nd_cmd_desc *desc, int idx, void *buf); 243 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 244 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 245 const u32 *out_field, unsigned long remainder); 246 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 247 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 248 struct nd_region_desc *ndr_desc); 249 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 250 struct nd_region_desc *ndr_desc); 251 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 252 struct nd_region_desc *ndr_desc); 253 void *nd_region_provider_data(struct nd_region *nd_region); 254 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 255 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 256 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 257 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 258 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 259 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 260 u64 nd_fletcher64(void *addr, size_t len, bool le); 261 int nvdimm_flush(struct nd_region *nd_region, struct bio *bio); 262 int generic_nvdimm_flush(struct nd_region *nd_region); 263 int nvdimm_has_flush(struct nd_region *nd_region); 264 int nvdimm_has_cache(struct nd_region *nd_region); 265 int nvdimm_in_overwrite(struct nvdimm *nvdimm); 266 bool is_nvdimm_sync(struct nd_region *nd_region); 267 268 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf, 269 unsigned int buf_len, int *cmd_rc) 270 { 271 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm); 272 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus); 273 274 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc); 275 } 276 277 #ifdef CONFIG_ARCH_HAS_PMEM_API 278 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 279 void arch_wb_cache_pmem(void *addr, size_t size); 280 void arch_invalidate_pmem(void *addr, size_t size); 281 #else 282 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 283 static inline void arch_wb_cache_pmem(void *addr, size_t size) 284 { 285 } 286 static inline void arch_invalidate_pmem(void *addr, size_t size) 287 { 288 } 289 #endif 290 291 #endif /* __LIBNVDIMM_H__ */ 292