[mirror_ubuntu-bionic-kernel.git] / drivers / nvdimm / nd.h

/*
 * 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 __ND_H__
#define __ND_H__
#include <linux/libnvdimm.h>
#include <linux/badblocks.h>
#include <linux/blkdev.h>
#include <linux/device.h>
#include <linux/mutex.h>
#include <linux/ndctl.h>
#include <linux/types.h>
#include <linux/nd.h>
#include "label.h"

enum {
	/*
	 * Limits the maximum number of block apertures a dimm can
	 * support and is an input to the geometry/on-disk-format of a
	 * BTT instance
	 */
	ND_MAX_LANES = 256,
	SECTOR_SHIFT = 9,
	INT_LBASIZE_ALIGNMENT = 64,
	NVDIMM_IO_ATOMIC = 1,
};

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

struct nvdimm_drvdata {
	struct device *dev;
	int nsindex_size, nslabel_size;
	struct nd_cmd_get_config_size nsarea;
	void *data;
	int ns_current, ns_next;
	struct resource dpa;
	struct kref kref;
};

struct nd_region_data {
	int ns_count;
	int ns_active;
	unsigned int hints_shift;
	void __iomem *flush_wpq[0];
};

static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
		int dimm, int hint)
{
	unsigned int num = 1 << ndrd->hints_shift;
	unsigned int mask = num - 1;

	return ndrd->flush_wpq[dimm * num + (hint & mask)];
}

static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
		int hint, void __iomem *flush)
{
	unsigned int num = 1 << ndrd->hints_shift;
	unsigned int mask = num - 1;

	ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
}

static inline struct nd_namespace_index *to_namespace_index(
		struct nvdimm_drvdata *ndd, int i)
{
	if (i < 0)
		return NULL;

	return ndd->data + sizeof_namespace_index(ndd) * i;
}

static inline struct nd_namespace_index *to_current_namespace_index(
		struct nvdimm_drvdata *ndd)
{
	return to_namespace_index(ndd, ndd->ns_current);
}

static inline struct nd_namespace_index *to_next_namespace_index(
		struct nvdimm_drvdata *ndd)
{
	return to_namespace_index(ndd, ndd->ns_next);
}

unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);

#define namespace_label_has(ndd, field) \
	(offsetof(struct nd_namespace_label, field) \
		< sizeof_namespace_label(ndd))

#define nd_dbg_dpa(r, d, res, fmt, arg...) \
	dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
		(r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
		(unsigned long long) (res ? resource_size(res) : 0), \
		(unsigned long long) (res ? res->start : 0), ##arg)

#define for_each_dpa_resource(ndd, res) \
	for (res = (ndd)->dpa.child; res; res = res->sibling)

#define for_each_dpa_resource_safe(ndd, res, next) \
	for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
			res; res = next, next = next ? next->sibling : NULL)

struct nd_percpu_lane {
	int count;
	spinlock_t lock;
};

struct nd_label_ent {
	struct list_head list;
	struct nd_namespace_label *label;
};

enum nd_mapping_lock_class {
	ND_MAPPING_CLASS0,
	ND_MAPPING_UUID_SCAN,
};

struct nd_mapping {
	struct nvdimm *nvdimm;
	u64 start;
	u64 size;
	struct list_head labels;
	struct mutex lock;
	/*
	 * @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 nd_region {
	struct device dev;
	struct ida ns_ida;
	struct ida btt_ida;
	struct ida pfn_ida;
	struct ida dax_ida;
	unsigned long flags;
	struct device *ns_seed;
	struct device *btt_seed;
	struct device *pfn_seed;
	struct device *dax_seed;
	u16 ndr_mappings;
	u64 ndr_size;
	u64 ndr_start;
	int id, num_lanes, ro, numa_node;
	void *provider_data;
	struct kernfs_node *bb_state;
	struct badblocks bb;
	struct nd_interleave_set *nd_set;
	struct nd_percpu_lane __percpu *lane;
	struct nd_mapping mapping[0];
};

struct nd_blk_region {
	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);
	void *blk_provider_data;
	struct nd_region nd_region;
};

/*
 * Lookup next in the repeating sequence of 01, 10, and 11.
 */
static inline unsigned nd_inc_seq(unsigned seq)
{
	static const unsigned next[] = { 0, 2, 3, 1 };

	return next[seq & 3];
}

struct btt;
struct nd_btt {
	struct device dev;
	struct nd_namespace_common *ndns;
	struct btt *btt;
	unsigned long lbasize;
	u64 size;
	u8 *uuid;
	int id;
	int initial_offset;
	u16 version_major;
	u16 version_minor;
};

enum nd_pfn_mode {
	PFN_MODE_NONE,
	PFN_MODE_RAM,
	PFN_MODE_PMEM,
};

struct nd_pfn {
	int id;
	u8 *uuid;
	struct device dev;
	unsigned long align;
	unsigned long npfns;
	enum nd_pfn_mode mode;
	struct nd_pfn_sb *pfn_sb;
	struct nd_namespace_common *ndns;
};

struct nd_dax {
	struct nd_pfn nd_pfn;
};

enum nd_async_mode {
	ND_SYNC,
	ND_ASYNC,
};

int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
void wait_nvdimm_bus_probe_idle(struct device *dev);
void nd_device_register(struct device *dev);
void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
void nd_device_notify(struct device *dev, enum nvdimm_event event);
int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
		size_t len);
ssize_t nd_sector_size_show(unsigned long current_lbasize,
		const unsigned long *supported, char *buf);
ssize_t nd_sector_size_store(struct device *dev, const char *buf,
		unsigned long *current_lbasize, const unsigned long *supported);
int __init nvdimm_init(void);
int __init nd_region_init(void);
int __init nd_label_init(void);
void nvdimm_exit(void);
void nd_region_exit(void);
struct nvdimm;
struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
int nvdimm_check_config_data(struct device *dev);
int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
		void *buf, size_t len);
long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
		unsigned int len);
void nvdimm_set_aliasing(struct device *dev);
void nvdimm_set_locked(struct device *dev);
struct nd_btt *to_nd_btt(struct device *dev);

struct nd_gen_sb {
	char reserved[SZ_4K - 8];
	__le64 checksum;
};

u64 nd_sb_checksum(struct nd_gen_sb *sb);
#if IS_ENABLED(CONFIG_BTT)
int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
bool is_nd_btt(struct device *dev);
struct device *nd_btt_create(struct nd_region *nd_region);
#else
static inline int nd_btt_probe(struct device *dev,
		struct nd_namespace_common *ndns)
{
	return -ENODEV;
}

static inline bool is_nd_btt(struct device *dev)
{
	return false;
}

static inline struct device *nd_btt_create(struct nd_region *nd_region)
{
	return NULL;
}
#endif

struct nd_pfn *to_nd_pfn(struct device *dev);
#if IS_ENABLED(CONFIG_NVDIMM_PFN)
int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
bool is_nd_pfn(struct device *dev);
struct device *nd_pfn_create(struct nd_region *nd_region);
struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
		struct nd_namespace_common *ndns);
int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
extern struct attribute_group nd_pfn_attribute_group;
#else
static inline int nd_pfn_probe(struct device *dev,
		struct nd_namespace_common *ndns)
{
	return -ENODEV;
}

static inline bool is_nd_pfn(struct device *dev)
{
	return false;
}

static inline struct device *nd_pfn_create(struct nd_region *nd_region)
{
	return NULL;
}

static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
{
	return -ENODEV;
}
#endif

struct nd_dax *to_nd_dax(struct device *dev);
#if IS_ENABLED(CONFIG_NVDIMM_DAX)
int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
bool is_nd_dax(struct device *dev);
struct device *nd_dax_create(struct nd_region *nd_region);
#else
static inline int nd_dax_probe(struct device *dev,
		struct nd_namespace_common *ndns)
{
	return -ENODEV;
}

static inline bool is_nd_dax(struct device *dev)
{
	return false;
}

static inline struct device *nd_dax_create(struct nd_region *nd_region)
{
	return NULL;
}
#endif

struct nd_region *to_nd_region(struct device *dev);
int nd_region_to_nstype(struct nd_region *nd_region);
int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
		struct nd_namespace_index *nsindex);
u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
void nvdimm_bus_lock(struct device *dev);
void nvdimm_bus_unlock(struct device *dev);
bool is_nvdimm_bus_locked(struct device *dev);
int nvdimm_revalidate_disk(struct gendisk *disk);
void nvdimm_drvdata_release(struct kref *kref);
void put_ndd(struct nvdimm_drvdata *ndd);
int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
		struct nd_label_id *label_id, resource_size_t start,
		resource_size_t n);
resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
		char *name);
unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
void nvdimm_badblocks_populate(struct nd_region *nd_region,
		struct badblocks *bb, const struct resource *res);
#if IS_ENABLED(CONFIG_ND_CLAIM)
struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
		struct resource *res, struct vmem_altmap *altmap);
int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
#else
static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
		struct resource *res, struct vmem_altmap *altmap)
{
	return ERR_PTR(-ENXIO);
}
static inline int devm_nsio_enable(struct device *dev,
		struct nd_namespace_io *nsio)
{
	return -ENXIO;
}
static inline void devm_nsio_disable(struct device *dev,
		struct nd_namespace_io *nsio)
{
}
#endif
int nd_blk_region_init(struct nd_region *nd_region);
int nd_region_activate(struct nd_region *nd_region);
void __nd_iostat_start(struct bio *bio, unsigned long *start);
static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
{
	struct gendisk *disk = bio->bi_disk;

	if (!blk_queue_io_stat(disk->queue))
		return false;

	*start = jiffies;
	generic_start_io_acct(disk->queue, bio_data_dir(bio),
			      bio_sectors(bio), &disk->part0);
	return true;
}
static inline void nd_iostat_end(struct bio *bio, unsigned long start)
{
	struct gendisk *disk = bio->bi_disk;

	generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0,
				start);
}
static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
		unsigned int len)
{
	if (bb->count) {
		sector_t first_bad;
		int num_bad;

		return !!badblocks_check(bb, sector, len / 512, &first_bad,
				&num_bad);
	}

	return false;
}
resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
const u8 *nd_dev_to_uuid(struct device *dev);
bool pmem_should_map_pages(struct device *dev);
#endif /* __ND_H__ */
Commit	Line	Data
4d88a97a DW	1	/*
	2	* Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of version 2 of the GNU General Public License as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but
	9	* WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	11	* General Public License for more details.
	12	*/
	13	#ifndef __ND_H__
	14	#define __ND_H__
1f7df6f8	15	#include <linux/libnvdimm.h>
200c79da	16	#include <linux/badblocks.h>
f0dc089c	17	#include <linux/blkdev.h>
4d88a97a DW	18	#include <linux/device.h>
	19	#include <linux/mutex.h>
	20	#include <linux/ndctl.h>
bf9bccc1	21	#include <linux/types.h>
71999466	22	#include <linux/nd.h>
4a826c83	23	#include "label.h"
4d88a97a	24
8c2f7e86	25	enum {
5212e11f VV	26	/*
	27	* Limits the maximum number of block apertures a dimm can
	28	* support and is an input to the geometry/on-disk-format of a
	29	* BTT instance
	30	*/
	31	ND_MAX_LANES = 256,
8c2f7e86	32	SECTOR_SHIFT = 9,
fcae6957	33	INT_LBASIZE_ALIGNMENT = 64,
3ae3d67b	34	NVDIMM_IO_ATOMIC = 1,
8c2f7e86 DW	35	};
8c2f7e86 DW	36
0caeef63 VV	37	struct nd_poison {
	38	u64 start;
	39	u64 length;
	40	struct list_head list;
	41	};
	42
4d88a97a DW	43	struct nvdimm_drvdata {
4d88a97a DW	44	struct device *dev;
564e871a	45	int nsindex_size, nslabel_size;
4d88a97a DW	46	struct nd_cmd_get_config_size nsarea;
4d88a97a DW	47	void *data;
4a826c83 DW	48	int ns_current, ns_next;
4a826c83 DW	49	struct resource dpa;
bf9bccc1	50	struct kref kref;
4d88a97a DW	51	};
4d88a97a DW	52
e5ae3b25 DW	53	struct nd_region_data {
	54	int ns_count;
	55	int ns_active;
595c7307 DW	56	unsigned int hints_shift;
595c7307 DW	57	void __iomem *flush_wpq[0];
3d88002e DW	58	};
3d88002e DW	59
595c7307 DW	60	static inline void __iomem ndrd_get_flush_wpq(struct nd_region_data ndrd,
	61	int dimm, int hint)
	62	{
	63	unsigned int num = 1 << ndrd->hints_shift;
	64	unsigned int mask = num - 1;
	65
	66	return ndrd->flush_wpq[dimm * num + (hint & mask)];
	67	}
	68
	69	static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
	70	int hint, void __iomem *flush)
	71	{
	72	unsigned int num = 1 << ndrd->hints_shift;
	73	unsigned int mask = num - 1;
	74
	75	ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
	76	}
	77
4a826c83 DW	78	static inline struct nd_namespace_index *to_namespace_index(
	79	struct nvdimm_drvdata *ndd, int i)
	80	{
	81	if (i < 0)
	82	return NULL;
	83
	84	return ndd->data + sizeof_namespace_index(ndd) * i;
	85	}
	86
	87	static inline struct nd_namespace_index *to_current_namespace_index(
	88	struct nvdimm_drvdata *ndd)
	89	{
	90	return to_namespace_index(ndd, ndd->ns_current);
	91	}
	92
	93	static inline struct nd_namespace_index *to_next_namespace_index(
	94	struct nvdimm_drvdata *ndd)
	95	{
	96	return to_namespace_index(ndd, ndd->ns_next);
	97	}
	98
564e871a DW	99	unsigned sizeof_namespace_label(struct nvdimm_drvdata *ndd);
	100
	101	#define namespace_label_has(ndd, field) \
	102	(offsetof(struct nd_namespace_label, field) \
	103	< sizeof_namespace_label(ndd))
	104
4a826c83 DW	105	#define nd_dbg_dpa(r, d, res, fmt, arg...) \
	106	dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
	107	(r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
	108	(unsigned long long) (res ? resource_size(res) : 0), \
	109	(unsigned long long) (res ? res->start : 0), ##arg)
	110
bf9bccc1 DW	111	#define for_each_dpa_resource(ndd, res) \
	112	for (res = (ndd)->dpa.child; res; res = res->sibling)
	113
4a826c83 DW	114	#define for_each_dpa_resource_safe(ndd, res, next) \
	115	for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
	116	res; res = next, next = next ? next->sibling : NULL)
	117
5212e11f VV	118	struct nd_percpu_lane {
	119	int count;
	120	spinlock_t lock;
	121	};
	122
ae8219f1 DW	123	struct nd_label_ent {
	124	struct list_head list;
	125	struct nd_namespace_label *label;
	126	};
	127
	128	enum nd_mapping_lock_class {
	129	ND_MAPPING_CLASS0,
	130	ND_MAPPING_UUID_SCAN,
	131	};
	132
44c462eb DW	133	struct nd_mapping {
44c462eb DW	134	struct nvdimm *nvdimm;
44c462eb DW	135	u64 start;
44c462eb DW	136	u64 size;
ae8219f1 DW	137	struct list_head labels;
ae8219f1 DW	138	struct mutex lock;
44c462eb DW	139	/*
	140	* @ndd is for private use at region enable / disable time for
	141	* get_ndd() + put_ndd(), all other nd_mapping to ndd
	142	* conversions use to_ndd() which respects enabled state of the
	143	* nvdimm.
	144	*/
	145	struct nvdimm_drvdata *ndd;
	146	};
	147
1f7df6f8 DW	148	struct nd_region {
1f7df6f8 DW	149	struct device dev;
1b40e09a	150	struct ida ns_ida;
8c2f7e86	151	struct ida btt_ida;
e1455744	152	struct ida pfn_ida;
cd03412a	153	struct ida dax_ida;
004f1afb	154	unsigned long flags;
bf9bccc1	155	struct device *ns_seed;
8c2f7e86	156	struct device *btt_seed;
e1455744	157	struct device *pfn_seed;
cd03412a	158	struct device *dax_seed;
1f7df6f8 DW	159	u16 ndr_mappings;
	160	u64 ndr_size;
	161	u64 ndr_start;
41d7a6d6	162	int id, num_lanes, ro, numa_node;
1f7df6f8	163	void *provider_data;
975750a9	164	struct kernfs_node *bb_state;
6a6bef90	165	struct badblocks bb;
eaf96153	166	struct nd_interleave_set *nd_set;
5212e11f	167	struct nd_percpu_lane __percpu *lane;
1f7df6f8 DW	168	struct nd_mapping mapping[0];
	169	};
	170
047fc8a1 RZ	171	struct nd_blk_region {
047fc8a1 RZ	172	int (enable)(struct nvdimm_bus nvdimm_bus, struct device *dev);
047fc8a1 RZ	173	int (do_io)(struct nd_blk_region ndbr, resource_size_t dpa,
	174	void *iobuf, u64 len, int rw);
	175	void *blk_provider_data;
	176	struct nd_region nd_region;
	177	};
	178
4a826c83 DW	179	/*
	180	* Lookup next in the repeating sequence of 01, 10, and 11.
	181	*/
	182	static inline unsigned nd_inc_seq(unsigned seq)
	183	{
	184	static const unsigned next[] = { 0, 2, 3, 1 };
	185
	186	return next[seq & 3];
	187	}
f524bf27	188
5212e11f	189	struct btt;
8c2f7e86 DW	190	struct nd_btt {
	191	struct device dev;
	192	struct nd_namespace_common *ndns;
5212e11f	193	struct btt *btt;
8c2f7e86	194	unsigned long lbasize;
abe8b4e3	195	u64 size;
8c2f7e86 DW	196	u8 *uuid;
8c2f7e86 DW	197	int id;
14e49454 VV	198	int initial_offset;
	199	u16 version_major;
	200	u16 version_minor;
8c2f7e86 DW	201	};
8c2f7e86 DW	202
e1455744 DW	203	enum nd_pfn_mode {
	204	PFN_MODE_NONE,
	205	PFN_MODE_RAM,
	206	PFN_MODE_PMEM,
	207	};
	208
	209	struct nd_pfn {
	210	int id;
	211	u8 *uuid;
	212	struct device dev;
315c5625	213	unsigned long align;
e1455744 DW	214	unsigned long npfns;
	215	enum nd_pfn_mode mode;
	216	struct nd_pfn_sb *pfn_sb;
	217	struct nd_namespace_common *ndns;
	218	};
	219
cd03412a DW	220	struct nd_dax {
	221	struct nd_pfn nd_pfn;
	222	};
	223
4d88a97a DW	224	enum nd_async_mode {
	225	ND_SYNC,
	226	ND_ASYNC,
	227	};
	228
41cd8b70	229	int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
bf9bccc1	230	void wait_nvdimm_bus_probe_idle(struct device *dev);
4d88a97a DW	231	void nd_device_register(struct device *dev);
4d88a97a DW	232	void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
71999466	233	void nd_device_notify(struct device *dev, enum nvdimm_event event);
bf9bccc1 DW	234	int nd_uuid_store(struct device dev, u8 uuid_out, const char buf,
bf9bccc1 DW	235	size_t len);
1b40e09a DW	236	ssize_t nd_sector_size_show(unsigned long current_lbasize,
	237	const unsigned long supported, char buf);
	238	ssize_t nd_sector_size_store(struct device dev, const char buf,
	239	unsigned long current_lbasize, const unsigned long supported);
4d88a97a	240	int __init nvdimm_init(void);
3d88002e	241	int __init nd_region_init(void);
b3fde74e	242	int __init nd_label_init(void);
4d88a97a	243	void nvdimm_exit(void);
3d88002e	244	void nd_region_exit(void);
bf9bccc1 DW	245	struct nvdimm;
bf9bccc1 DW	246	struct nvdimm_drvdata to_ndd(struct nd_mapping nd_mapping);
aee65987	247	int nvdimm_check_config_data(struct device *dev);
4d88a97a DW	248	int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
4d88a97a DW	249	int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
f524bf27 DW	250	int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
f524bf27 DW	251	void *buf, size_t len);
59e64739 DW	252	long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
59e64739 DW	253	unsigned int len);
42237e39	254	void nvdimm_set_aliasing(struct device *dev);
8f078b38	255	void nvdimm_set_locked(struct device *dev);
8c2f7e86	256	struct nd_btt to_nd_btt(struct device dev);
e1455744 DW	257
	258	struct nd_gen_sb {
	259	char reserved[SZ_4K - 8];
	260	__le64 checksum;
	261	};
	262
	263	u64 nd_sb_checksum(struct nd_gen_sb *sb);
8c2f7e86	264	#if IS_ENABLED(CONFIG_BTT)
200c79da	265	int nd_btt_probe(struct device dev, struct nd_namespace_common ndns);
8c2f7e86 DW	266	bool is_nd_btt(struct device *dev);
	267	struct device nd_btt_create(struct nd_region nd_region);
	268	#else
e32bc729	269	static inline int nd_btt_probe(struct device *dev,
200c79da	270	struct nd_namespace_common *ndns)
8c2f7e86 DW	271	{
	272	return -ENODEV;
	273	}
	274
	275	static inline bool is_nd_btt(struct device *dev)
	276	{
	277	return false;
	278	}
	279
	280	static inline struct device nd_btt_create(struct nd_region nd_region)
	281	{
	282	return NULL;
	283	}
e1455744	284	#endif
8c2f7e86	285
e1455744 DW	286	struct nd_pfn to_nd_pfn(struct device dev);
e1455744 DW	287	#if IS_ENABLED(CONFIG_NVDIMM_PFN)
200c79da	288	int nd_pfn_probe(struct device dev, struct nd_namespace_common ndns);
e1455744 DW	289	bool is_nd_pfn(struct device *dev);
e1455744 DW	290	struct device nd_pfn_create(struct nd_region nd_region);
cd03412a DW	291	struct device nd_pfn_devinit(struct nd_pfn nd_pfn,
cd03412a DW	292	struct nd_namespace_common *ndns);
c5ed9268	293	int nd_pfn_validate(struct nd_pfn nd_pfn, const char sig);
cd03412a	294	extern struct attribute_group nd_pfn_attribute_group;
e1455744	295	#else
200c79da DW	296	static inline int nd_pfn_probe(struct device *dev,
200c79da DW	297	struct nd_namespace_common *ndns)
e1455744 DW	298	{
	299	return -ENODEV;
	300	}
	301
	302	static inline bool is_nd_pfn(struct device *dev)
	303	{
	304	return false;
	305	}
	306
	307	static inline struct device nd_pfn_create(struct nd_region nd_region)
	308	{
	309	return NULL;
	310	}
32ab0a3f	311
c5ed9268	312	static inline int nd_pfn_validate(struct nd_pfn nd_pfn, const char sig)
32ab0a3f DW	313	{
	314	return -ENODEV;
	315	}
8c2f7e86	316	#endif
e1455744	317
cd03412a DW	318	struct nd_dax to_nd_dax(struct device dev);
cd03412a DW	319	#if IS_ENABLED(CONFIG_NVDIMM_DAX)
c5ed9268	320	int nd_dax_probe(struct device dev, struct nd_namespace_common ndns);
cd03412a DW	321	bool is_nd_dax(struct device *dev);
	322	struct device nd_dax_create(struct nd_region nd_region);
	323	#else
c5ed9268 DW	324	static inline int nd_dax_probe(struct device *dev,
	325	struct nd_namespace_common *ndns)
	326	{
	327	return -ENODEV;
	328	}
	329
cd03412a DW	330	static inline bool is_nd_dax(struct device *dev)
	331	{
	332	return false;
	333	}
	334
	335	static inline struct device nd_dax_create(struct nd_region nd_region)
	336	{
	337	return NULL;
	338	}
	339	#endif
	340
3d88002e DW	341	struct nd_region to_nd_region(struct device dev);
	342	int nd_region_to_nstype(struct nd_region *nd_region);
	343	int nd_region_register_namespaces(struct nd_region nd_region, int err);
c12c48ce DW	344	u64 nd_region_interleave_set_cookie(struct nd_region *nd_region,
c12c48ce DW	345	struct nd_namespace_index *nsindex);
86ef58a4	346	u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
3d88002e DW	347	void nvdimm_bus_lock(struct device *dev);
	348	void nvdimm_bus_unlock(struct device *dev);
	349	bool is_nvdimm_bus_locked(struct device *dev);
58138820	350	int nvdimm_revalidate_disk(struct gendisk *disk);
bf9bccc1 DW	351	void nvdimm_drvdata_release(struct kref *kref);
bf9bccc1 DW	352	void put_ndd(struct nvdimm_drvdata *ndd);
4a826c83 DW	353	int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
	354	void nvdimm_free_dpa(struct nvdimm_drvdata ndd, struct resource res);
	355	struct resource nvdimm_allocate_dpa(struct nvdimm_drvdata ndd,
	356	struct nd_label_id *label_id, resource_size_t start,
	357	resource_size_t n);
8c2f7e86 DW	358	resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
8c2f7e86 DW	359	struct nd_namespace_common nvdimm_namespace_common_probe(struct device dev);
5212e11f	360	int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
298f2bc5	361	int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
5212e11f VV	362	const char nvdimm_namespace_disk_name(struct nd_namespace_common ndns,
5212e11f VV	363	char *name);
f979b13c	364	unsigned int pmem_sector_size(struct nd_namespace_common *ndns);
a3901802 DW	365	void nvdimm_badblocks_populate(struct nd_region *nd_region,
a3901802 DW	366	struct badblocks bb, const struct resource res);
200c79da	367	#if IS_ENABLED(CONFIG_ND_CLAIM)
ac515c08 DW	368	struct vmem_altmap nvdimm_setup_pfn(struct nd_pfn nd_pfn,
ac515c08 DW	369	struct resource res, struct vmem_altmap altmap);
200c79da DW	370	int devm_nsio_enable(struct device dev, struct nd_namespace_io nsio);
	371	void devm_nsio_disable(struct device dev, struct nd_namespace_io nsio);
	372	#else
ac515c08 DW	373	static inline struct vmem_altmap nvdimm_setup_pfn(struct nd_pfn nd_pfn,
	374	struct resource res, struct vmem_altmap altmap)
	375	{
	376	return ERR_PTR(-ENXIO);
	377	}
200c79da DW	378	static inline int devm_nsio_enable(struct device *dev,
	379	struct nd_namespace_io *nsio)
	380	{
	381	return -ENXIO;
	382	}
	383	static inline void devm_nsio_disable(struct device *dev,
	384	struct nd_namespace_io *nsio)
	385	{
	386	}
	387	#endif
047fc8a1	388	int nd_blk_region_init(struct nd_region *nd_region);
e5ae3b25	389	int nd_region_activate(struct nd_region *nd_region);
f0dc089c DW	390	void __nd_iostat_start(struct bio bio, unsigned long start);
	391	static inline bool nd_iostat_start(struct bio bio, unsigned long start)
	392	{
74d46992	393	struct gendisk *disk = bio->bi_disk;
f0dc089c DW	394
	395	if (!blk_queue_io_stat(disk->queue))
	396	return false;
	397
8d7c22ac	398	*start = jiffies;
d62e26b3	399	generic_start_io_acct(disk->queue, bio_data_dir(bio),
8d7c22ac	400	bio_sectors(bio), &disk->part0);
f0dc089c DW	401	return true;
f0dc089c DW	402	}
8d7c22ac TK	403	static inline void nd_iostat_end(struct bio *bio, unsigned long start)
8d7c22ac TK	404	{
74d46992	405	struct gendisk *disk = bio->bi_disk;
8d7c22ac	406
d62e26b3 JA	407	generic_end_io_acct(disk->queue, bio_data_dir(bio), &disk->part0,
d62e26b3 JA	408	start);
8d7c22ac	409	}
200c79da DW	410	static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
	411	unsigned int len)
	412	{
	413	if (bb->count) {
	414	sector_t first_bad;
	415	int num_bad;
	416
	417	return !!badblocks_check(bb, sector, len / 512, &first_bad,
	418	&num_bad);
	419	}
	420
	421	return false;
	422	}
047fc8a1	423	resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
6ec68954	424	const u8 nd_dev_to_uuid(struct device dev);
004f1afb	425	bool pmem_should_map_pages(struct device *dev);
4d88a97a	426	#endif /* __ND_H__ */