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 42 /* need to set a limit somewhere, but yes, this is likely overkill */ 43 ND_IOCTL_MAX_BUFLEN = SZ_4M, 44 ND_CMD_MAX_ELEM = 5, 45 ND_CMD_MAX_ENVELOPE = 256, 46 ND_MAX_MAPPINGS = 32, 47 48 /* region flag indicating to direct-map persistent memory by default */ 49 ND_REGION_PAGEMAP = 0, 50 /* 51 * Platform ensures entire CPU store data path is flushed to pmem on 52 * system power loss. 53 */ 54 ND_REGION_PERSIST_CACHE = 1, 55 /* 56 * Platform provides mechanisms to automatically flush outstanding 57 * write data from memory controler to pmem on system power loss. 58 * (ADR) 59 */ 60 ND_REGION_PERSIST_MEMCTRL = 2, 61 62 /* mark newly adjusted resources as requiring a label update */ 63 DPA_RESOURCE_ADJUSTED = 1 << 0, 64 }; 65 66 extern struct attribute_group nvdimm_bus_attribute_group; 67 extern struct attribute_group nvdimm_attribute_group; 68 extern struct attribute_group nd_device_attribute_group; 69 extern struct attribute_group nd_numa_attribute_group; 70 extern struct attribute_group nd_region_attribute_group; 71 extern struct attribute_group nd_mapping_attribute_group; 72 73 struct nvdimm; 74 struct nvdimm_bus_descriptor; 75 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 76 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 77 unsigned int buf_len, int *cmd_rc); 78 79 struct device_node; 80 struct nvdimm_bus_descriptor { 81 const struct attribute_group **attr_groups; 82 unsigned long bus_dsm_mask; 83 unsigned long cmd_mask; 84 struct module *module; 85 char *provider_name; 86 struct device_node *of_node; 87 ndctl_fn ndctl; 88 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 89 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 90 struct nvdimm *nvdimm, unsigned int cmd); 91 }; 92 93 struct nd_cmd_desc { 94 int in_num; 95 int out_num; 96 u32 in_sizes[ND_CMD_MAX_ELEM]; 97 int out_sizes[ND_CMD_MAX_ELEM]; 98 }; 99 100 struct nd_interleave_set { 101 /* v1.1 definition of the interleave-set-cookie algorithm */ 102 u64 cookie1; 103 /* v1.2 definition of the interleave-set-cookie algorithm */ 104 u64 cookie2; 105 /* compatibility with initial buggy Linux implementation */ 106 u64 altcookie; 107 108 guid_t type_guid; 109 }; 110 111 struct nd_mapping_desc { 112 struct nvdimm *nvdimm; 113 u64 start; 114 u64 size; 115 int position; 116 }; 117 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 unsigned long flags; 128 struct device_node *of_node; 129 }; 130 131 struct device; 132 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, 133 size_t size, unsigned long flags); 134 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, 135 resource_size_t offset, size_t size) 136 { 137 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); 138 } 139 140 struct nvdimm_bus; 141 struct module; 142 struct device; 143 struct nd_blk_region; 144 struct nd_blk_region_desc { 145 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 146 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 147 void *iobuf, u64 len, int rw); 148 struct nd_region_desc ndr_desc; 149 }; 150 151 static inline struct nd_blk_region_desc *to_blk_region_desc( 152 struct nd_region_desc *ndr_desc) 153 { 154 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 155 156 } 157 158 void badrange_init(struct badrange *badrange); 159 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 160 void badrange_forget(struct badrange *badrange, phys_addr_t start, 161 unsigned int len); 162 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 163 u64 length); 164 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 165 struct nvdimm_bus_descriptor *nfit_desc); 166 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 167 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 168 struct nvdimm *to_nvdimm(struct device *dev); 169 struct nd_region *to_nd_region(struct device *dev); 170 struct device *nd_region_dev(struct nd_region *nd_region); 171 struct nd_blk_region *to_nd_blk_region(struct device *dev); 172 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 173 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 174 const char *nvdimm_name(struct nvdimm *nvdimm); 175 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 176 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 177 void *nvdimm_provider_data(struct nvdimm *nvdimm); 178 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, 179 const struct attribute_group **groups, unsigned long flags, 180 unsigned long cmd_mask, int num_flush, 181 struct resource *flush_wpq); 182 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 183 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 184 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 185 const struct nd_cmd_desc *desc, int idx, void *buf); 186 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 187 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 188 const u32 *out_field, unsigned long remainder); 189 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 190 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 191 struct nd_region_desc *ndr_desc); 192 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 193 struct nd_region_desc *ndr_desc); 194 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 195 struct nd_region_desc *ndr_desc); 196 void *nd_region_provider_data(struct nd_region *nd_region); 197 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 198 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 199 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 200 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 201 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 202 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 203 u64 nd_fletcher64(void *addr, size_t len, bool le); 204 void nvdimm_flush(struct nd_region *nd_region); 205 int nvdimm_has_flush(struct nd_region *nd_region); 206 int nvdimm_has_cache(struct nd_region *nd_region); 207 208 #ifdef CONFIG_ARCH_HAS_PMEM_API 209 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 210 void arch_wb_cache_pmem(void *addr, size_t size); 211 void arch_invalidate_pmem(void *addr, size_t size); 212 #else 213 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 214 static inline void arch_wb_cache_pmem(void *addr, size_t size) 215 { 216 } 217 static inline void arch_invalidate_pmem(void *addr, size_t size) 218 { 219 } 220 #endif 221 222 #endif /* __LIBNVDIMM_H__ */ 223