[mirror_ubuntu-bionic-kernel.git] / include / linux / libnvdimm.h

/*
 * 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__
#include <linux/kernel.h>
#include <linux/sizes.h>
#include <linux/types.h>
#include <linux/uuid.h>
#include <linux/spinlock.h>

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

struct badrange {
	struct list_head list;
	spinlock_t lock;
};

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

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

	/* region flag indicating to direct-map persistent memory by default */
	ND_REGION_PAGEMAP = 0,
	/*
	 * Platform ensures entire CPU store data path is flushed to pmem on
	 * system power loss.
	 */
	ND_REGION_PERSIST_CACHE = 1,
	/*
	 * Platform provides mechanisms to automatically flush outstanding
	 * write data from memory controler to pmem on system power loss.
	 * (ADR)
	 */
	ND_REGION_PERSIST_MEMCTRL = 2,

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

extern struct attribute_group nvdimm_bus_attribute_group;
extern struct attribute_group nvdimm_attribute_group;
extern struct attribute_group nd_device_attribute_group;
extern struct attribute_group nd_numa_attribute_group;
extern struct attribute_group nd_region_attribute_group;
extern struct attribute_group nd_mapping_attribute_group;

struct nvdimm;
struct nvdimm_bus_descriptor;
typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
		struct nvdimm *nvdimm, unsigned int cmd, void *buf,
		unsigned int buf_len, int *cmd_rc);

struct nvdimm_bus_descriptor {
	const struct attribute_group **attr_groups;
	unsigned long bus_dsm_mask;
	unsigned long cmd_mask;
	struct module *module;
	char *provider_name;
	ndctl_fn ndctl;
	int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
	int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
			struct nvdimm *nvdimm, unsigned int cmd);
};

struct nd_cmd_desc {
	int in_num;
	int out_num;
	u32 in_sizes[ND_CMD_MAX_ELEM];
	int out_sizes[ND_CMD_MAX_ELEM];
};

struct nd_interleave_set {
	/* v1.1 definition of the interleave-set-cookie algorithm */
	u64 cookie1;
	/* v1.2 definition of the interleave-set-cookie algorithm */
	u64 cookie2;
	/* compatibility with initial buggy Linux implementation */
	u64 altcookie;

	guid_t type_guid;
};

struct nd_mapping_desc {
	struct nvdimm *nvdimm;
	u64 start;
	u64 size;
	int position;
};

struct nd_region_desc {
	struct resource *res;
	struct nd_mapping_desc *mapping;
	u16 num_mappings;
	const struct attribute_group **attr_groups;
	struct nd_interleave_set *nd_set;
	void *provider_data;
	int num_lanes;
	int numa_node;
	unsigned long flags;
};

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);
}

struct nvdimm_bus;
struct module;
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);

}

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);
struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
		struct nvdimm_bus_descriptor *nfit_desc);
void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
struct nvdimm *to_nvdimm(struct device *dev);
struct nd_region *to_nd_region(struct device *dev);
struct nd_blk_region *to_nd_blk_region(struct device *dev);
struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
const char *nvdimm_name(struct nvdimm *nvdimm);
struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
void *nvdimm_provider_data(struct nvdimm *nvdimm);
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 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,
		const u32 *out_field, unsigned long remainder);
int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
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);
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);
unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
u64 nd_fletcher64(void *addr, size_t len, bool le);
void nvdimm_flush(struct nd_region *nd_region);
int nvdimm_has_flush(struct nd_region *nd_region);
int nvdimm_has_cache(struct nd_region *nd_region);

#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

#endif /* __LIBNVDIMM_H__ */
Commit	Line	Data
b94d5230 DW	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__
047fc8a1	17	#include <linux/kernel.h>
62232e45 DW	18	#include <linux/sizes.h>
62232e45 DW	19	#include <linux/types.h>
faec6f8a	20	#include <linux/uuid.h>
aa9ad44a DJ	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	};
e6dfb2de DW	33
	34	enum {
	35	/* when a dimm supports both PMEM and BLK access a label is required */
8f078b38	36	NDD_ALIASING = 0,
58138820	37	/* unarmed memory devices may not persist writes */
8f078b38 DW	38	NDD_UNARMED = 1,
	39	/* locked memory devices should not be accessed */
	40	NDD_LOCKED = 2,
62232e45 DW	41
	42	/* need to set a limit somewhere, but yes, this is likely overkill */
	43	ND_IOCTL_MAX_BUFLEN = SZ_4M,
4577b066	44	ND_CMD_MAX_ELEM = 5,
40abf9be	45	ND_CMD_MAX_ENVELOPE = 256,
1f7df6f8	46	ND_MAX_MAPPINGS = 32,
1b40e09a	47
004f1afb DW	48	/* region flag indicating to direct-map persistent memory by default */
004f1afb DW	49	ND_REGION_PAGEMAP = 0,
f2c90535 DJ	50	/*
	51	* Platform ensures entire CPU store data path is flushed to pmem on
	52	* system power loss.
	53	*/
	54	ND_REGION_PERSIST_CACHE = 1,
a4806568 DJ	55	/*
	56	* Platform provides mechanisms to automatically flush outstanding
	57	* write data from memory controler to pmem on system power loss.
	58	* (ADR)
	59	*/
	60	ND_REGION_PERSIST_MEMCTRL = 2,
004f1afb	61
1b40e09a DW	62	/* mark newly adjusted resources as requiring a label update */
1b40e09a DW	63	DPA_RESOURCE_ADJUSTED = 1 << 0,
e6dfb2de DW	64	};
e6dfb2de DW	65
45def22c	66	extern struct attribute_group nvdimm_bus_attribute_group;
62232e45	67	extern struct attribute_group nvdimm_attribute_group;
4d88a97a	68	extern struct attribute_group nd_device_attribute_group;
74ae66c3	69	extern struct attribute_group nd_numa_attribute_group;
1f7df6f8 DW	70	extern struct attribute_group nd_region_attribute_group;
1f7df6f8 DW	71	extern struct attribute_group nd_mapping_attribute_group;
45def22c	72
b94d5230 DW	73	struct nvdimm;
	74	struct nvdimm_bus_descriptor;
	75	typedef int (ndctl_fn)(struct nvdimm_bus_descriptor nd_desc,
	76	struct nvdimm nvdimm, unsigned int cmd, void buf,
aef25338	77	unsigned int buf_len, int *cmd_rc);
b94d5230 DW	78
b94d5230 DW	79	struct nvdimm_bus_descriptor {
45def22c	80	const struct attribute_group **attr_groups;
7db5bb33	81	unsigned long bus_dsm_mask;
e3654eca	82	unsigned long cmd_mask;
bc9775d8	83	struct module *module;
b94d5230 DW	84	char *provider_name;
b94d5230 DW	85	ndctl_fn ndctl;
7ae0fa43	86	int (flush_probe)(struct nvdimm_bus_descriptor nd_desc);
87bf572e DW	87	int (clear_to_send)(struct nvdimm_bus_descriptor nd_desc,
87bf572e DW	88	struct nvdimm *nvdimm, unsigned int cmd);
b94d5230 DW	89	};
b94d5230 DW	90
62232e45 DW	91	struct nd_cmd_desc {
	92	int in_num;
	93	int out_num;
	94	u32 in_sizes[ND_CMD_MAX_ELEM];
	95	int out_sizes[ND_CMD_MAX_ELEM];
	96	};
	97
eaf96153	98	struct nd_interleave_set {
c12c48ce DW	99	/* v1.1 definition of the interleave-set-cookie algorithm */
	100	u64 cookie1;
	101	/* v1.2 definition of the interleave-set-cookie algorithm */
	102	u64 cookie2;
86ef58a4 DW	103	/* compatibility with initial buggy Linux implementation */
86ef58a4 DW	104	u64 altcookie;
faec6f8a DW	105
faec6f8a DW	106	guid_t type_guid;
eaf96153 DW	107	};
eaf96153 DW	108
44c462eb DW	109	struct nd_mapping_desc {
	110	struct nvdimm *nvdimm;
	111	u64 start;
	112	u64 size;
401c0a19	113	int position;
44c462eb DW	114	};
44c462eb DW	115
1f7df6f8 DW	116	struct nd_region_desc {
1f7df6f8 DW	117	struct resource *res;
44c462eb	118	struct nd_mapping_desc *mapping;
1f7df6f8 DW	119	u16 num_mappings;
1f7df6f8 DW	120	const struct attribute_group **attr_groups;
eaf96153	121	struct nd_interleave_set *nd_set;
1f7df6f8	122	void *provider_data;
5212e11f	123	int num_lanes;
41d7a6d6	124	int numa_node;
004f1afb	125	unsigned long flags;
1f7df6f8 DW	126	};
1f7df6f8 DW	127
29b9aa0a DW	128	struct device;
	129	void devm_nvdimm_memremap(struct device dev, resource_size_t offset,
	130	size_t size, unsigned long flags);
	131	static inline void __iomem devm_nvdimm_ioremap(struct device dev,
	132	resource_size_t offset, size_t size)
	133	{
	134	return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
	135	}
	136
62232e45	137	struct nvdimm_bus;
3d88002e	138	struct module;
047fc8a1 RZ	139	struct device;
	140	struct nd_blk_region;
	141	struct nd_blk_region_desc {
	142	int (enable)(struct nvdimm_bus nvdimm_bus, struct device *dev);
047fc8a1 RZ	143	int (do_io)(struct nd_blk_region ndbr, resource_size_t dpa,
	144	void *iobuf, u64 len, int rw);
	145	struct nd_region_desc ndr_desc;
	146	};
	147
	148	static inline struct nd_blk_region_desc *to_blk_region_desc(
	149	struct nd_region_desc *ndr_desc)
	150	{
	151	return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
	152
	153	}
	154
aa9ad44a DJ	155	void badrange_init(struct badrange *badrange);
	156	int badrange_add(struct badrange *badrange, u64 addr, u64 length);
	157	void badrange_forget(struct badrange *badrange, phys_addr_t start,
	158	unsigned int len);
	159	int nvdimm_bus_add_badrange(struct nvdimm_bus *nvdimm_bus, u64 addr,
	160	u64 length);
bc9775d8 DW	161	struct nvdimm_bus nvdimm_bus_register(struct device parent,
bc9775d8 DW	162	struct nvdimm_bus_descriptor *nfit_desc);
b94d5230	163	void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
45def22c	164	struct nvdimm_bus to_nvdimm_bus(struct device dev);
e6dfb2de	165	struct nvdimm to_nvdimm(struct device dev);
1f7df6f8	166	struct nd_region to_nd_region(struct device dev);
047fc8a1	167	struct nd_blk_region to_nd_blk_region(struct device dev);
45def22c	168	struct nvdimm_bus_descriptor to_nd_desc(struct nvdimm_bus nvdimm_bus);
37b137ff	169	struct device to_nvdimm_bus_dev(struct nvdimm_bus nvdimm_bus);
e6dfb2de	170	const char nvdimm_name(struct nvdimm nvdimm);
ba9c8dd3	171	struct kobject nvdimm_kobj(struct nvdimm nvdimm);
e3654eca	172	unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
e6dfb2de DW	173	void nvdimm_provider_data(struct nvdimm nvdimm);
e6dfb2de DW	174	struct nvdimm nvdimm_create(struct nvdimm_bus nvdimm_bus, void *provider_data,
62232e45	175	const struct attribute_group **groups, unsigned long flags,
e5ae3b25 DW	176	unsigned long cmd_mask, int num_flush,
e5ae3b25 DW	177	struct resource *flush_wpq);
62232e45 DW	178	const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
	179	const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
	180	u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
	181	const struct nd_cmd_desc desc, int idx, void buf);
	182	u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
	183	const struct nd_cmd_desc desc, int idx, const u32 in_field,
efda1b5d	184	const u32 *out_field, unsigned long remainder);
4d88a97a	185	int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
1f7df6f8 DW	186	struct nd_region nvdimm_pmem_region_create(struct nvdimm_bus nvdimm_bus,
	187	struct nd_region_desc *ndr_desc);
	188	struct nd_region nvdimm_blk_region_create(struct nvdimm_bus nvdimm_bus,
	189	struct nd_region_desc *ndr_desc);
	190	struct nd_region nvdimm_volatile_region_create(struct nvdimm_bus nvdimm_bus,
	191	struct nd_region_desc *ndr_desc);
047fc8a1 RZ	192	void nd_region_provider_data(struct nd_region nd_region);
	193	void nd_blk_region_provider_data(struct nd_blk_region ndbr);
	194	void nd_blk_region_set_provider_data(struct nd_blk_region ndbr, void data);
	195	struct nvdimm nd_blk_region_to_dimm(struct nd_blk_region ndbr);
ca6a4657	196	unsigned long nd_blk_memremap_flags(struct nd_blk_region *ndbr);
047fc8a1 RZ	197	unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
047fc8a1 RZ	198	void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
eaf96153	199	u64 nd_fletcher64(void *addr, size_t len, bool le);
f284a4f2 DW	200	void nvdimm_flush(struct nd_region *nd_region);
f284a4f2 DW	201	int nvdimm_has_flush(struct nd_region *nd_region);
0b277961	202	int nvdimm_has_cache(struct nd_region *nd_region);
5deb67f7 RM	203
	204	#ifdef CONFIG_ARCH_HAS_PMEM_API
	205	#define ARCH_MEMREMAP_PMEM MEMREMAP_WB
	206	void arch_wb_cache_pmem(void *addr, size_t size);
	207	void arch_invalidate_pmem(void *addr, size_t size);
	208	#else
	209	#define ARCH_MEMREMAP_PMEM MEMREMAP_WT
	210	static inline void arch_wb_cache_pmem(void *addr, size_t size)
	211	{
	212	}
	213	static inline void arch_invalidate_pmem(void *addr, size_t size)
	214	{
	215	}
	216	#endif
	217
b94d5230	218	#endif /* __LIBNVDIMM_H__ */