1 /* 2 * libnvdimm - Non-volatile-memory Devices Subsystem 3 * 4 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of version 2 of the GNU General Public License as 8 * published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but 11 * WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 * General Public License for more details. 14 */ 15 #ifndef __LIBNVDIMM_H__ 16 #define __LIBNVDIMM_H__ 17 #include <linux/kernel.h> 18 #include <linux/sizes.h> 19 #include <linux/types.h> 20 #include <linux/uuid.h> 21 #include <linux/spinlock.h> 22 23 struct badrange_entry { 24 u64 start; 25 u64 length; 26 struct list_head list; 27 }; 28 29 struct badrange { 30 struct list_head list; 31 spinlock_t lock; 32 }; 33 34 enum { 35 /* when a dimm supports both PMEM and BLK access a label is required */ 36 NDD_ALIASING = 0, 37 /* unarmed memory devices may not persist writes */ 38 NDD_UNARMED = 1, 39 /* locked memory devices should not be accessed */ 40 NDD_LOCKED = 2, 41 /* memory under security wipes should not be accessed */ 42 NDD_SECURITY_OVERWRITE = 3, 43 /* tracking whether or not there is a pending device reference */ 44 NDD_WORK_PENDING = 4, 45 46 /* need to set a limit somewhere, but yes, this is likely overkill */ 47 ND_IOCTL_MAX_BUFLEN = SZ_4M, 48 ND_CMD_MAX_ELEM = 5, 49 ND_CMD_MAX_ENVELOPE = 256, 50 ND_MAX_MAPPINGS = 32, 51 52 /* region flag indicating to direct-map persistent memory by default */ 53 ND_REGION_PAGEMAP = 0, 54 /* 55 * Platform ensures entire CPU store data path is flushed to pmem on 56 * system power loss. 57 */ 58 ND_REGION_PERSIST_CACHE = 1, 59 /* 60 * Platform provides mechanisms to automatically flush outstanding 61 * write data from memory controler to pmem on system power loss. 62 * (ADR) 63 */ 64 ND_REGION_PERSIST_MEMCTRL = 2, 65 66 /* mark newly adjusted resources as requiring a label update */ 67 DPA_RESOURCE_ADJUSTED = 1 << 0, 68 }; 69 70 extern struct attribute_group nvdimm_bus_attribute_group; 71 extern struct attribute_group nvdimm_attribute_group; 72 extern struct attribute_group nd_device_attribute_group; 73 extern struct attribute_group nd_numa_attribute_group; 74 extern struct attribute_group nd_region_attribute_group; 75 extern struct attribute_group nd_mapping_attribute_group; 76 77 struct nvdimm; 78 struct nvdimm_bus_descriptor; 79 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 80 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 81 unsigned int buf_len, int *cmd_rc); 82 83 struct device_node; 84 struct nvdimm_bus_descriptor { 85 const struct attribute_group **attr_groups; 86 unsigned long bus_dsm_mask; 87 unsigned long cmd_mask; 88 struct module *module; 89 char *provider_name; 90 struct device_node *of_node; 91 ndctl_fn ndctl; 92 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 93 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 94 struct nvdimm *nvdimm, unsigned int cmd, void *data); 95 }; 96 97 struct nd_cmd_desc { 98 int in_num; 99 int out_num; 100 u32 in_sizes[ND_CMD_MAX_ELEM]; 101 int out_sizes[ND_CMD_MAX_ELEM]; 102 }; 103 104 struct nd_interleave_set { 105 /* v1.1 definition of the interleave-set-cookie algorithm */ 106 u64 cookie1; 107 /* v1.2 definition of the interleave-set-cookie algorithm */ 108 u64 cookie2; 109 /* compatibility with initial buggy Linux implementation */ 110 u64 altcookie; 111 112 guid_t type_guid; 113 }; 114 115 struct nd_mapping_desc { 116 struct nvdimm *nvdimm; 117 u64 start; 118 u64 size; 119 int position; 120 }; 121 122 struct nd_region_desc { 123 struct resource *res; 124 struct nd_mapping_desc *mapping; 125 u16 num_mappings; 126 const struct attribute_group **attr_groups; 127 struct nd_interleave_set *nd_set; 128 void *provider_data; 129 int num_lanes; 130 int numa_node; 131 unsigned long flags; 132 struct device_node *of_node; 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 enum nvdimm_security_state { 163 NVDIMM_SECURITY_ERROR = -1, 164 NVDIMM_SECURITY_DISABLED, 165 NVDIMM_SECURITY_UNLOCKED, 166 NVDIMM_SECURITY_LOCKED, 167 NVDIMM_SECURITY_FROZEN, 168 NVDIMM_SECURITY_OVERWRITE, 169 }; 170 171 #define NVDIMM_PASSPHRASE_LEN 32 172 #define NVDIMM_KEY_DESC_LEN 22 173 174 struct nvdimm_key_data { 175 u8 data[NVDIMM_PASSPHRASE_LEN]; 176 }; 177 178 enum nvdimm_passphrase_type { 179 NVDIMM_USER, 180 NVDIMM_MASTER, 181 }; 182 183 struct nvdimm_security_ops { 184 enum nvdimm_security_state (*state)(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); 201 }; 202 203 void badrange_init(struct badrange *badrange); 204 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 205 void badrange_forget(struct badrange *badrange, phys_addr_t start, 206 unsigned int len); 207 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 208 u64 length); 209 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 210 struct nvdimm_bus_descriptor *nfit_desc); 211 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 212 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 213 struct nvdimm_bus *nvdimm_to_bus(struct nvdimm *nvdimm); 214 struct nvdimm *to_nvdimm(struct device *dev); 215 struct nd_region *to_nd_region(struct device *dev); 216 struct device *nd_region_dev(struct nd_region *nd_region); 217 struct nd_blk_region *to_nd_blk_region(struct device *dev); 218 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 219 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 220 const char *nvdimm_name(struct nvdimm *nvdimm); 221 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 222 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 223 void *nvdimm_provider_data(struct nvdimm *nvdimm); 224 struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus, 225 void *provider_data, const struct attribute_group **groups, 226 unsigned long flags, unsigned long cmd_mask, int num_flush, 227 struct resource *flush_wpq, const char *dimm_id, 228 const struct nvdimm_security_ops *sec_ops); 229 static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, 230 void *provider_data, const struct attribute_group **groups, 231 unsigned long flags, unsigned long cmd_mask, int num_flush, 232 struct resource *flush_wpq) 233 { 234 return __nvdimm_create(nvdimm_bus, provider_data, groups, flags, 235 cmd_mask, num_flush, flush_wpq, NULL, NULL); 236 } 237 238 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 239 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 240 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 241 const struct nd_cmd_desc *desc, int idx, void *buf); 242 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 243 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 244 const u32 *out_field, unsigned long remainder); 245 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 246 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 247 struct nd_region_desc *ndr_desc); 248 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 249 struct nd_region_desc *ndr_desc); 250 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 251 struct nd_region_desc *ndr_desc); 252 void *nd_region_provider_data(struct nd_region *nd_region); 253 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 254 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 255 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 256 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 257 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 258 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 259 u64 nd_fletcher64(void *addr, size_t len, bool le); 260 void nvdimm_flush(struct nd_region *nd_region); 261 int nvdimm_has_flush(struct nd_region *nd_region); 262 int nvdimm_has_cache(struct nd_region *nd_region); 263 int nvdimm_in_overwrite(struct nvdimm *nvdimm); 264 265 static inline int nvdimm_ctl(struct nvdimm *nvdimm, unsigned int cmd, void *buf, 266 unsigned int buf_len, int *cmd_rc) 267 { 268 struct nvdimm_bus *nvdimm_bus = nvdimm_to_bus(nvdimm); 269 struct nvdimm_bus_descriptor *nd_desc = to_nd_desc(nvdimm_bus); 270 271 return nd_desc->ndctl(nd_desc, nvdimm, cmd, buf, buf_len, cmd_rc); 272 } 273 274 #ifdef CONFIG_ARCH_HAS_PMEM_API 275 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 276 void arch_wb_cache_pmem(void *addr, size_t size); 277 void arch_invalidate_pmem(void *addr, size_t size); 278 #else 279 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 280 static inline void arch_wb_cache_pmem(void *addr, size_t size) 281 { 282 } 283 static inline void arch_invalidate_pmem(void *addr, size_t size) 284 { 285 } 286 #endif 287 288 #endif /* __LIBNVDIMM_H__ */ 289