[linux-2.6-block.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/sizes.h>
#include <linux/types.h>

enum {
	/* when a dimm supports both PMEM and BLK access a label is required */
	NDD_ALIASING = 1 << 0,

	/* 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;
};

struct nvdimm_bus;
struct device;
struct module;
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 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);
void *nd_region_provider_data(struct nd_region *nd_region);
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);
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__
62232e45 DW	17	#include <linux/sizes.h>
62232e45 DW	18	#include <linux/types.h>
e6dfb2de DW	19
	20	enum {
	21	/* when a dimm supports both PMEM and BLK access a label is required */
	22	NDD_ALIASING = 1 << 0,
62232e45 DW	23
	24	/* need to set a limit somewhere, but yes, this is likely overkill */
	25	ND_IOCTL_MAX_BUFLEN = SZ_4M,
	26	ND_CMD_MAX_ELEM = 4,
	27	ND_CMD_MAX_ENVELOPE = 16,
	28	ND_CMD_ARS_STATUS_MAX = SZ_4K,
1f7df6f8	29	ND_MAX_MAPPINGS = 32,
1b40e09a DW	30
	31	/* mark newly adjusted resources as requiring a label update */
	32	DPA_RESOURCE_ADJUSTED = 1 << 0,
e6dfb2de DW	33	};
e6dfb2de DW	34
45def22c	35	extern struct attribute_group nvdimm_bus_attribute_group;
62232e45	36	extern struct attribute_group nvdimm_attribute_group;
4d88a97a	37	extern struct attribute_group nd_device_attribute_group;
1f7df6f8 DW	38	extern struct attribute_group nd_region_attribute_group;
1f7df6f8 DW	39	extern struct attribute_group nd_mapping_attribute_group;
45def22c	40
b94d5230 DW	41	struct nvdimm;
	42	struct nvdimm_bus_descriptor;
	43	typedef int (ndctl_fn)(struct nvdimm_bus_descriptor nd_desc,
	44	struct nvdimm nvdimm, unsigned int cmd, void buf,
	45	unsigned int buf_len);
	46
bf9bccc1 DW	47	struct nd_namespace_label;
bf9bccc1 DW	48	struct nvdimm_drvdata;
1f7df6f8 DW	49	struct nd_mapping {
1f7df6f8 DW	50	struct nvdimm *nvdimm;
bf9bccc1	51	struct nd_namespace_label **labels;
1f7df6f8 DW	52	u64 start;
1f7df6f8 DW	53	u64 size;
bf9bccc1 DW	54	/*
	55	* @ndd is for private use at region enable / disable time for
	56	* get_ndd() + put_ndd(), all other nd_mapping to ndd
	57	* conversions use to_ndd() which respects enabled state of the
	58	* nvdimm.
	59	*/
	60	struct nvdimm_drvdata *ndd;
1f7df6f8 DW	61	};
1f7df6f8 DW	62
b94d5230	63	struct nvdimm_bus_descriptor {
45def22c	64	const struct attribute_group **attr_groups;
b94d5230 DW	65	unsigned long dsm_mask;
	66	char *provider_name;
	67	ndctl_fn ndctl;
	68	};
	69
62232e45 DW	70	struct nd_cmd_desc {
	71	int in_num;
	72	int out_num;
	73	u32 in_sizes[ND_CMD_MAX_ELEM];
	74	int out_sizes[ND_CMD_MAX_ELEM];
	75	};
	76
eaf96153 DW	77	struct nd_interleave_set {
	78	u64 cookie;
	79	};
	80
1f7df6f8 DW	81	struct nd_region_desc {
	82	struct resource *res;
	83	struct nd_mapping *nd_mapping;
	84	u16 num_mappings;
	85	const struct attribute_group **attr_groups;
eaf96153	86	struct nd_interleave_set *nd_set;
1f7df6f8	87	void *provider_data;
5212e11f	88	int num_lanes;
1f7df6f8 DW	89	};
1f7df6f8 DW	90
62232e45	91	struct nvdimm_bus;
b94d5230	92	struct device;
3d88002e DW	93	struct module;
	94	struct nvdimm_bus __nvdimm_bus_register(struct device parent,
	95	struct nvdimm_bus_descriptor nfit_desc, struct module module);
	96	#define nvdimm_bus_register(parent, desc) \
	97	__nvdimm_bus_register(parent, desc, THIS_MODULE)
b94d5230	98	void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
45def22c	99	struct nvdimm_bus to_nvdimm_bus(struct device dev);
e6dfb2de	100	struct nvdimm to_nvdimm(struct device dev);
1f7df6f8	101	struct nd_region to_nd_region(struct device dev);
45def22c	102	struct nvdimm_bus_descriptor to_nd_desc(struct nvdimm_bus nvdimm_bus);
e6dfb2de DW	103	const char nvdimm_name(struct nvdimm nvdimm);
e6dfb2de DW	104	void nvdimm_provider_data(struct nvdimm nvdimm);
1f7df6f8	105	void nd_region_provider_data(struct nd_region nd_region);
e6dfb2de	106	struct nvdimm nvdimm_create(struct nvdimm_bus nvdimm_bus, void *provider_data,
62232e45 DW	107	const struct attribute_group **groups, unsigned long flags,
	108	unsigned long *dsm_mask);
	109	const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
	110	const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
	111	u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
	112	const struct nd_cmd_desc desc, int idx, void buf);
	113	u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
	114	const struct nd_cmd_desc desc, int idx, const u32 in_field,
	115	const u32 *out_field);
4d88a97a	116	int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
1f7df6f8 DW	117	struct nd_region nvdimm_pmem_region_create(struct nvdimm_bus nvdimm_bus,
	118	struct nd_region_desc *ndr_desc);
	119	struct nd_region nvdimm_blk_region_create(struct nvdimm_bus nvdimm_bus,
	120	struct nd_region_desc *ndr_desc);
	121	struct nd_region nvdimm_volatile_region_create(struct nvdimm_bus nvdimm_bus,
	122	struct nd_region_desc *ndr_desc);
eaf96153	123	u64 nd_fletcher64(void *addr, size_t len, bool le);
b94d5230	124	#endif /* __LIBNVDIMM_H__ */