[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>

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

	/* need to set a limit somewhere, but yes, this is likely overkill */
	ND_IOCTL_MAX_BUFLEN = SZ_4M,
	ND_CMD_MAX_ELEM = 4,
	ND_CMD_MAX_ENVELOPE = 16,
	ND_CMD_ARS_STATUS_MAX = SZ_4K,
	ND_MAX_MAPPINGS = 32,

	/* 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_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);

struct nd_namespace_label;
struct nvdimm_drvdata;
struct nd_mapping {
	struct nvdimm *nvdimm;
	struct nd_namespace_label **labels;
	u64 start;
	u64 size;
	/*
	 * @ndd is for private use at region enable / disable time for
	 * get_ndd() + put_ndd(), all other nd_mapping to ndd
	 * conversions use to_ndd() which respects enabled state of the
	 * nvdimm.
	 */
	struct nvdimm_drvdata *ndd;
};

struct nvdimm_bus_descriptor {
	const struct attribute_group **attr_groups;
	unsigned long dsm_mask;
	char *provider_name;
	ndctl_fn ndctl;
};

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 {
	u64 cookie;
};

struct nd_region_desc {
	struct resource *res;
	struct nd_mapping *nd_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;
};

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);
	void (*disable)(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);

}

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