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 /* mark newly adjusted resources as requiring a label update */ 52 DPA_RESOURCE_ADJUSTED = 1 << 0, 53 }; 54 55 extern struct attribute_group nvdimm_bus_attribute_group; 56 extern struct attribute_group nvdimm_attribute_group; 57 extern struct attribute_group nd_device_attribute_group; 58 extern struct attribute_group nd_numa_attribute_group; 59 extern struct attribute_group nd_region_attribute_group; 60 extern struct attribute_group nd_mapping_attribute_group; 61 62 struct nvdimm; 63 struct nvdimm_bus_descriptor; 64 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 65 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 66 unsigned int buf_len, int *cmd_rc); 67 68 struct nvdimm_bus_descriptor { 69 const struct attribute_group **attr_groups; 70 unsigned long bus_dsm_mask; 71 unsigned long cmd_mask; 72 struct module *module; 73 char *provider_name; 74 ndctl_fn ndctl; 75 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 76 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 77 struct nvdimm *nvdimm, unsigned int cmd); 78 }; 79 80 struct nd_cmd_desc { 81 int in_num; 82 int out_num; 83 u32 in_sizes[ND_CMD_MAX_ELEM]; 84 int out_sizes[ND_CMD_MAX_ELEM]; 85 }; 86 87 struct nd_interleave_set { 88 /* v1.1 definition of the interleave-set-cookie algorithm */ 89 u64 cookie1; 90 /* v1.2 definition of the interleave-set-cookie algorithm */ 91 u64 cookie2; 92 /* compatibility with initial buggy Linux implementation */ 93 u64 altcookie; 94 95 guid_t type_guid; 96 }; 97 98 struct nd_mapping_desc { 99 struct nvdimm *nvdimm; 100 u64 start; 101 u64 size; 102 int position; 103 }; 104 105 struct nd_region_desc { 106 struct resource *res; 107 struct nd_mapping_desc *mapping; 108 u16 num_mappings; 109 const struct attribute_group **attr_groups; 110 struct nd_interleave_set *nd_set; 111 void *provider_data; 112 int num_lanes; 113 int numa_node; 114 unsigned long flags; 115 }; 116 117 struct device; 118 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, 119 size_t size, unsigned long flags); 120 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, 121 resource_size_t offset, size_t size) 122 { 123 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); 124 } 125 126 struct nvdimm_bus; 127 struct module; 128 struct device; 129 struct nd_blk_region; 130 struct nd_blk_region_desc { 131 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 132 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 133 void *iobuf, u64 len, int rw); 134 struct nd_region_desc ndr_desc; 135 }; 136 137 static inline struct nd_blk_region_desc *to_blk_region_desc( 138 struct nd_region_desc *ndr_desc) 139 { 140 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 141 142 } 143 144 void badrange_init(struct badrange *badrange); 145 int badrange_add(struct badrange *badrange, u64 addr, u64 length); 146 void badrange_forget(struct badrange *badrange, phys_addr_t start, 147 unsigned int len); 148 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr, 149 u64 length); 150 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 151 struct nvdimm_bus_descriptor *nfit_desc); 152 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 153 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 154 struct nvdimm *to_nvdimm(struct device *dev); 155 struct nd_region *to_nd_region(struct device *dev); 156 struct nd_blk_region *to_nd_blk_region(struct device *dev); 157 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 158 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 159 const char *nvdimm_name(struct nvdimm *nvdimm); 160 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 161 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 162 void *nvdimm_provider_data(struct nvdimm *nvdimm); 163 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, 164 const struct attribute_group **groups, unsigned long flags, 165 unsigned long cmd_mask, int num_flush, 166 struct resource *flush_wpq); 167 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 168 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 169 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 170 const struct nd_cmd_desc *desc, int idx, void *buf); 171 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 172 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 173 const u32 *out_field, unsigned long remainder); 174 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 175 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 176 struct nd_region_desc *ndr_desc); 177 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 178 struct nd_region_desc *ndr_desc); 179 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 180 struct nd_region_desc *ndr_desc); 181 void *nd_region_provider_data(struct nd_region *nd_region); 182 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 183 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 184 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 185 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 186 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 187 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 188 u64 nd_fletcher64(void *addr, size_t len, bool le); 189 void nvdimm_flush(struct nd_region *nd_region); 190 int nvdimm_has_flush(struct nd_region *nd_region); 191 int nvdimm_has_cache(struct nd_region *nd_region); 192 193 #ifdef CONFIG_ARCH_HAS_PMEM_API 194 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB 195 void arch_wb_cache_pmem(void *addr, size_t size); 196 void arch_invalidate_pmem(void *addr, size_t size); 197 #else 198 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT 199 static inline void arch_wb_cache_pmem(void *addr, size_t size) 200 { 201 } 202 static inline void arch_invalidate_pmem(void *addr, size_t size) 203 { 204 } 205 #endif 206 207 #endif /* __LIBNVDIMM_H__ */ 208