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