libnvdimm.h 8.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * libnvdimm - Non-volatile-memory Devices Subsystem
 *
 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
#ifndef __LIBNVDIMM_H__
#define __LIBNVDIMM_H__
17
#include <linux/kernel.h>
18 19
#include <linux/sizes.h>
#include <linux/types.h>
20
#include <linux/uuid.h>
21
#include <linux/spinlock.h>
22
#include <linux/bio.h>
23 24 25 26 27 28 29 30 31 32 33

struct badrange_entry {
	u64 start;
	u64 length;
	struct list_head list;
};

struct badrange {
	struct list_head list;
	spinlock_t lock;
};
34 35 36

enum {
	/* when a dimm supports both PMEM and BLK access a label is required */
37
	NDD_ALIASING = 0,
38
	/* unarmed memory devices may not persist writes */
39 40 41
	NDD_UNARMED = 1,
	/* locked memory devices should not be accessed */
	NDD_LOCKED = 2,
42 43 44

	/* need to set a limit somewhere, but yes, this is likely overkill */
	ND_IOCTL_MAX_BUFLEN = SZ_4M,
45
	ND_CMD_MAX_ELEM = 5,
46
	ND_CMD_MAX_ENVELOPE = 256,
47
	ND_MAX_MAPPINGS = 32,
48

49 50
	/* region flag indicating to direct-map persistent memory by default */
	ND_REGION_PAGEMAP = 0,
51 52 53 54 55
	/*
	 * Platform ensures entire CPU store data path is flushed to pmem on
	 * system power loss.
	 */
	ND_REGION_PERSIST_CACHE = 1,
56 57 58 59 60 61
	/*
	 * Platform provides mechanisms to automatically flush outstanding
	 * write data from memory controler to pmem on system power loss.
	 * (ADR)
	 */
	ND_REGION_PERSIST_MEMCTRL = 2,
62

63 64 65
	/* Platform provides asynchronous flush mechanism */
	ND_REGION_ASYNC = 3,

66 67
	/* mark newly adjusted resources as requiring a label update */
	DPA_RESOURCE_ADJUSTED = 1 << 0,
68 69
};

70
extern struct attribute_group nvdimm_bus_attribute_group;
71
extern struct attribute_group nvdimm_attribute_group;
72
extern struct attribute_group nd_device_attribute_group;
73
extern struct attribute_group nd_numa_attribute_group;
74 75
extern struct attribute_group nd_region_attribute_group;
extern struct attribute_group nd_mapping_attribute_group;
76

77 78 79 80
struct nvdimm;
struct nvdimm_bus_descriptor;
typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
		struct nvdimm *nvdimm, unsigned int cmd, void *buf,
81
		unsigned int buf_len, int *cmd_rc);
82

83
struct device_node;
84
struct nvdimm_bus_descriptor {
85
	const struct attribute_group **attr_groups;
86
	unsigned long bus_dsm_mask;
87
	unsigned long cmd_mask;
88
	struct module *module;
89
	char *provider_name;
90
	struct device_node *of_node;
91
	ndctl_fn ndctl;
92
	int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
93
	int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
94
			struct nvdimm *nvdimm, unsigned int cmd, void *data);
95 96
};

97 98 99 100 101 102 103
struct nd_cmd_desc {
	int in_num;
	int out_num;
	u32 in_sizes[ND_CMD_MAX_ELEM];
	int out_sizes[ND_CMD_MAX_ELEM];
};

104
struct nd_interleave_set {
105 106 107 108
	/* v1.1 definition of the interleave-set-cookie algorithm */
	u64 cookie1;
	/* v1.2 definition of the interleave-set-cookie algorithm */
	u64 cookie2;
109 110
	/* compatibility with initial buggy Linux implementation */
	u64 altcookie;
111 112

	guid_t type_guid;
113 114
};

115 116 117 118
struct nd_mapping_desc {
	struct nvdimm *nvdimm;
	u64 start;
	u64 size;
119
	int position;
120 121
};

122
struct nd_region;
123 124
struct nd_region_desc {
	struct resource *res;
125
	struct nd_mapping_desc *mapping;
126 127
	u16 num_mappings;
	const struct attribute_group **attr_groups;
128
	struct nd_interleave_set *nd_set;
129
	void *provider_data;
V
Vishal Verma 已提交
130
	int num_lanes;
131
	int numa_node;
132
	int target_node;
133
	unsigned long flags;
134
	struct device_node *of_node;
135
	int (*flush)(struct nd_region *nd_region, struct bio *bio);
136 137
};

138 139 140 141 142 143 144 145 146
struct device;
void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
		size_t size, unsigned long flags);
static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
		resource_size_t offset, size_t size)
{
	return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
}

147
struct nvdimm_bus;
148
struct module;
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
struct device;
struct nd_blk_region;
struct nd_blk_region_desc {
	int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
	int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
			void *iobuf, u64 len, int rw);
	struct nd_region_desc ndr_desc;
};

static inline struct nd_blk_region_desc *to_blk_region_desc(
		struct nd_region_desc *ndr_desc)
{
	return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);

}

165 166 167 168 169 170
void badrange_init(struct badrange *badrange);
int badrange_add(struct badrange *badrange, u64 addr, u64 length);
void badrange_forget(struct badrange *badrange, phys_addr_t start,
		unsigned int len);
int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
		u64 length);
171 172
struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
		struct nvdimm_bus_descriptor *nfit_desc);
173
void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
174
struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
175
struct nvdimm *to_nvdimm(struct device *dev);
176
struct nd_region *to_nd_region(struct device *dev);
177
struct device *nd_region_dev(struct nd_region *nd_region);
178
struct nd_blk_region *to_nd_blk_region(struct device *dev);
179
struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
180
struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
181
const char *nvdimm_name(struct nvdimm *nvdimm);
182
struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
183
unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
184
void *nvdimm_provider_data(struct nvdimm *nvdimm);
185 186 187 188 189 190 191 192 193 194 195 196 197
struct nvdimm *__nvdimm_create(struct nvdimm_bus *nvdimm_bus,
		void *provider_data, const struct attribute_group **groups,
		unsigned long flags, unsigned long cmd_mask, int num_flush,
		struct resource *flush_wpq, const char *dimm_id);
static inline struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus,
		void *provider_data, const struct attribute_group **groups,
		unsigned long flags, unsigned long cmd_mask, int num_flush,
		struct resource *flush_wpq)
{
	return __nvdimm_create(nvdimm_bus, provider_data, groups, flags,
			cmd_mask, num_flush, flush_wpq, NULL);
}

198 199 200 201 202 203
const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
		const struct nd_cmd_desc *desc, int idx, void *buf);
u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
		const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
204
		const u32 *out_field, unsigned long remainder);
205
int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
206 207 208 209 210 211
struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
		struct nd_region_desc *ndr_desc);
struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
		struct nd_region_desc *ndr_desc);
struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
		struct nd_region_desc *ndr_desc);
212 213 214 215
void *nd_region_provider_data(struct nd_region *nd_region);
void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
216
unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
217 218
unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
219
u64 nd_fletcher64(void *addr, size_t len, bool le);
220 221
int nvdimm_flush(struct nd_region *nd_region, struct bio *bio);
int generic_nvdimm_flush(struct nd_region *nd_region);
222
int nvdimm_has_flush(struct nd_region *nd_region);
223
int nvdimm_has_cache(struct nd_region *nd_region);
P
Pankaj Gupta 已提交
224
bool is_nvdimm_sync(struct nd_region *nd_region);
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

#ifdef CONFIG_ARCH_HAS_PMEM_API
#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
void arch_wb_cache_pmem(void *addr, size_t size);
void arch_invalidate_pmem(void *addr, size_t size);
#else
#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
static inline void arch_wb_cache_pmem(void *addr, size_t size)
{
}
static inline void arch_invalidate_pmem(void *addr, size_t size)
{
}
#endif

240
#endif /* __LIBNVDIMM_H__ */