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 22 enum { 23 /* when a dimm supports both PMEM and BLK access a label is required */ 24 NDD_ALIASING = 0, 25 /* unarmed memory devices may not persist writes */ 26 NDD_UNARMED = 1, 27 /* locked memory devices should not be accessed */ 28 NDD_LOCKED = 2, 29 30 /* need to set a limit somewhere, but yes, this is likely overkill */ 31 ND_IOCTL_MAX_BUFLEN = SZ_4M, 32 ND_CMD_MAX_ELEM = 5, 33 ND_CMD_MAX_ENVELOPE = 256, 34 ND_MAX_MAPPINGS = 32, 35 36 /* region flag indicating to direct-map persistent memory by default */ 37 ND_REGION_PAGEMAP = 0, 38 39 /* mark newly adjusted resources as requiring a label update */ 40 DPA_RESOURCE_ADJUSTED = 1 << 0, 41 }; 42 43 extern struct attribute_group nvdimm_bus_attribute_group; 44 extern struct attribute_group nvdimm_attribute_group; 45 extern struct attribute_group nd_device_attribute_group; 46 extern struct attribute_group nd_numa_attribute_group; 47 extern struct attribute_group nd_region_attribute_group; 48 extern struct attribute_group nd_mapping_attribute_group; 49 50 struct nvdimm; 51 struct nvdimm_bus_descriptor; 52 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 53 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 54 unsigned int buf_len, int *cmd_rc); 55 56 struct nvdimm_bus_descriptor { 57 const struct attribute_group **attr_groups; 58 unsigned long bus_dsm_mask; 59 unsigned long cmd_mask; 60 struct module *module; 61 char *provider_name; 62 ndctl_fn ndctl; 63 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); 64 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, 65 struct nvdimm *nvdimm, unsigned int cmd); 66 }; 67 68 struct nd_cmd_desc { 69 int in_num; 70 int out_num; 71 u32 in_sizes[ND_CMD_MAX_ELEM]; 72 int out_sizes[ND_CMD_MAX_ELEM]; 73 }; 74 75 struct nd_interleave_set { 76 /* v1.1 definition of the interleave-set-cookie algorithm */ 77 u64 cookie1; 78 /* v1.2 definition of the interleave-set-cookie algorithm */ 79 u64 cookie2; 80 /* compatibility with initial buggy Linux implementation */ 81 u64 altcookie; 82 83 guid_t type_guid; 84 }; 85 86 struct nd_mapping_desc { 87 struct nvdimm *nvdimm; 88 u64 start; 89 u64 size; 90 }; 91 92 struct nd_region_desc { 93 struct resource *res; 94 struct nd_mapping_desc *mapping; 95 u16 num_mappings; 96 const struct attribute_group **attr_groups; 97 struct nd_interleave_set *nd_set; 98 void *provider_data; 99 int num_lanes; 100 int numa_node; 101 unsigned long flags; 102 }; 103 104 struct device; 105 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, 106 size_t size, unsigned long flags); 107 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, 108 resource_size_t offset, size_t size) 109 { 110 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); 111 } 112 113 struct nvdimm_bus; 114 struct module; 115 struct device; 116 struct nd_blk_region; 117 struct nd_blk_region_desc { 118 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 119 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 120 void *iobuf, u64 len, int rw); 121 struct nd_region_desc ndr_desc; 122 }; 123 124 static inline struct nd_blk_region_desc *to_blk_region_desc( 125 struct nd_region_desc *ndr_desc) 126 { 127 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 128 129 } 130 131 int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length); 132 void nvdimm_forget_poison(struct nvdimm_bus *nvdimm_bus, 133 phys_addr_t start, unsigned int len); 134 struct nvdimm_bus *nvdimm_bus_register(struct device *parent, 135 struct nvdimm_bus_descriptor *nfit_desc); 136 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 137 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 138 struct nvdimm *to_nvdimm(struct device *dev); 139 struct nd_region *to_nd_region(struct device *dev); 140 struct nd_blk_region *to_nd_blk_region(struct device *dev); 141 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 142 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus); 143 const char *nvdimm_name(struct nvdimm *nvdimm); 144 struct kobject *nvdimm_kobj(struct nvdimm *nvdimm); 145 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); 146 void *nvdimm_provider_data(struct nvdimm *nvdimm); 147 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, 148 const struct attribute_group **groups, unsigned long flags, 149 unsigned long cmd_mask, int num_flush, 150 struct resource *flush_wpq); 151 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 152 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 153 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 154 const struct nd_cmd_desc *desc, int idx, void *buf); 155 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 156 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 157 const u32 *out_field, unsigned long remainder); 158 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 159 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 160 struct nd_region_desc *ndr_desc); 161 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 162 struct nd_region_desc *ndr_desc); 163 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 164 struct nd_region_desc *ndr_desc); 165 void *nd_region_provider_data(struct nd_region *nd_region); 166 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 167 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 168 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 169 unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr); 170 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 171 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 172 u64 nd_fletcher64(void *addr, size_t len, bool le); 173 void nvdimm_flush(struct nd_region *nd_region); 174 int nvdimm_has_flush(struct nd_region *nd_region); 175 int nvdimm_has_cache(struct nd_region *nd_region); 176 #endif /* __LIBNVDIMM_H__ */ 177