2 * libnvdimm - Non-volatile-memory Devices Subsystem
4 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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.
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.
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>
23 struct badrange_entry {
26 struct list_head list;
30 struct list_head list;
35 /* when a dimm supports both PMEM and BLK access a label is required */
37 /* unarmed memory devices may not persist writes */
39 /* locked memory devices should not be accessed */
42 /* need to set a limit somewhere, but yes, this is likely overkill */
43 ND_IOCTL_MAX_BUFLEN = SZ_4M,
45 ND_CMD_MAX_ENVELOPE = 256,
48 /* region flag indicating to direct-map persistent memory by default */
49 ND_REGION_PAGEMAP = 0,
51 /* mark newly adjusted resources as requiring a label update */
52 DPA_RESOURCE_ADJUSTED = 1 << 0,
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;
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);
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;
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);
83 u32 in_sizes[ND_CMD_MAX_ELEM];
84 int out_sizes[ND_CMD_MAX_ELEM];
87 struct nd_interleave_set {
88 /* v1.1 definition of the interleave-set-cookie algorithm */
90 /* v1.2 definition of the interleave-set-cookie algorithm */
92 /* compatibility with initial buggy Linux implementation */
98 struct nd_mapping_desc {
99 struct nvdimm *nvdimm;
105 struct nd_region_desc {
106 struct resource *res;
107 struct nd_mapping_desc *mapping;
109 const struct attribute_group **attr_groups;
110 struct nd_interleave_set *nd_set;
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)
123 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
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;
137 static inline struct nd_blk_region_desc *to_blk_region_desc(
138 struct nd_region_desc *ndr_desc)
140 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
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,
148 int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
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);
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);
198 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
199 static inline void arch_wb_cache_pmem(void *addr, size_t size)
202 static inline void arch_invalidate_pmem(void *addr, size_t size)
207 #endif /* __LIBNVDIMM_H__ */