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 21 enum { 22 /* when a dimm supports both PMEM and BLK access a label is required */ 23 NDD_ALIASING = 1 << 0, 24 /* unarmed memory devices may not persist writes */ 25 NDD_UNARMED = 1 << 1, 26 27 /* need to set a limit somewhere, but yes, this is likely overkill */ 28 ND_IOCTL_MAX_BUFLEN = SZ_4M, 29 ND_CMD_MAX_ELEM = 4, 30 ND_CMD_MAX_ENVELOPE = 16, 31 ND_CMD_ARS_STATUS_MAX = SZ_4K, 32 ND_MAX_MAPPINGS = 32, 33 34 /* region flag indicating to direct-map persistent memory by default */ 35 ND_REGION_PAGEMAP = 0, 36 37 /* mark newly adjusted resources as requiring a label update */ 38 DPA_RESOURCE_ADJUSTED = 1 << 0, 39 }; 40 41 extern struct attribute_group nvdimm_bus_attribute_group; 42 extern struct attribute_group nvdimm_attribute_group; 43 extern struct attribute_group nd_device_attribute_group; 44 extern struct attribute_group nd_numa_attribute_group; 45 extern struct attribute_group nd_region_attribute_group; 46 extern struct attribute_group nd_mapping_attribute_group; 47 48 struct nvdimm; 49 struct nvdimm_bus_descriptor; 50 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, 51 struct nvdimm *nvdimm, unsigned int cmd, void *buf, 52 unsigned int buf_len); 53 54 struct nd_namespace_label; 55 struct nvdimm_drvdata; 56 struct nd_mapping { 57 struct nvdimm *nvdimm; 58 struct nd_namespace_label **labels; 59 u64 start; 60 u64 size; 61 /* 62 * @ndd is for private use at region enable / disable time for 63 * get_ndd() + put_ndd(), all other nd_mapping to ndd 64 * conversions use to_ndd() which respects enabled state of the 65 * nvdimm. 66 */ 67 struct nvdimm_drvdata *ndd; 68 }; 69 70 struct nvdimm_bus_descriptor { 71 const struct attribute_group **attr_groups; 72 unsigned long dsm_mask; 73 char *provider_name; 74 ndctl_fn ndctl; 75 }; 76 77 struct nd_cmd_desc { 78 int in_num; 79 int out_num; 80 u32 in_sizes[ND_CMD_MAX_ELEM]; 81 int out_sizes[ND_CMD_MAX_ELEM]; 82 }; 83 84 struct nd_interleave_set { 85 u64 cookie; 86 }; 87 88 struct nd_region_desc { 89 struct resource *res; 90 struct nd_mapping *nd_mapping; 91 u16 num_mappings; 92 const struct attribute_group **attr_groups; 93 struct nd_interleave_set *nd_set; 94 void *provider_data; 95 int num_lanes; 96 int numa_node; 97 unsigned long flags; 98 }; 99 100 struct nvdimm_bus; 101 struct module; 102 struct device; 103 struct nd_blk_region; 104 struct nd_blk_region_desc { 105 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 106 void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); 107 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 108 void *iobuf, u64 len, int rw); 109 struct nd_region_desc ndr_desc; 110 }; 111 112 static inline struct nd_blk_region_desc *to_blk_region_desc( 113 struct nd_region_desc *ndr_desc) 114 { 115 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); 116 117 } 118 119 int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length); 120 struct nvdimm_bus *__nvdimm_bus_register(struct device *parent, 121 struct nvdimm_bus_descriptor *nfit_desc, struct module *module); 122 #define nvdimm_bus_register(parent, desc) \ 123 __nvdimm_bus_register(parent, desc, THIS_MODULE) 124 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); 125 struct nvdimm_bus *to_nvdimm_bus(struct device *dev); 126 struct nvdimm *to_nvdimm(struct device *dev); 127 struct nd_region *to_nd_region(struct device *dev); 128 struct nd_blk_region *to_nd_blk_region(struct device *dev); 129 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); 130 const char *nvdimm_name(struct nvdimm *nvdimm); 131 void *nvdimm_provider_data(struct nvdimm *nvdimm); 132 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, 133 const struct attribute_group **groups, unsigned long flags, 134 unsigned long *dsm_mask); 135 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); 136 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); 137 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, 138 const struct nd_cmd_desc *desc, int idx, void *buf); 139 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, 140 const struct nd_cmd_desc *desc, int idx, const u32 *in_field, 141 const u32 *out_field); 142 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); 143 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, 144 struct nd_region_desc *ndr_desc); 145 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, 146 struct nd_region_desc *ndr_desc); 147 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, 148 struct nd_region_desc *ndr_desc); 149 void *nd_region_provider_data(struct nd_region *nd_region); 150 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr); 151 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data); 152 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr); 153 unsigned int nd_region_acquire_lane(struct nd_region *nd_region); 154 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane); 155 u64 nd_fletcher64(void *addr, size_t len, bool le); 156 #endif /* __LIBNVDIMM_H__ */ 157