[mirror_ubuntu-artful-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/device.h>
#include <linux/mutex.h>
#include <linux/ndctl.h>
#include <linux/types.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,
};

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

struct nd_region_namespaces {
	int count;
	int active;
};

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

#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_label(l, label, labels) \
	for (l = 0; (label = labels ? labels[l] : NULL); l++)

#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_region {
	struct device dev;
	struct ida ns_ida;
	struct ida btt_ida;
	struct device *ns_seed;
	struct device *btt_seed;
	u16 ndr_mappings;
	u64 ndr_size;
	u64 ndr_start;
	int id, num_lanes;
	void *provider_data;
	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);
	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);
	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;
	u8 *uuid;
	int id;
};

enum nd_async_mode {
	ND_SYNC,
	ND_ASYNC,
};

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);
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);
void nvdimm_exit(void);
void nd_region_exit(void);
struct nvdimm;
struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
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);
struct nd_btt *to_nd_btt(struct device *dev);
struct btt_sb;
u64 nd_btt_sb_checksum(struct btt_sb *btt_sb);
#if IS_ENABLED(CONFIG_BTT)
int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
bool is_nd_btt(struct device *dev);
struct device *nd_btt_create(struct nd_region *nd_region);
#else
static inline nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
{
	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_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);
void nvdimm_bus_lock(struct device *dev);
void nvdimm_bus_unlock(struct device *dev);
bool is_nvdimm_bus_locked(struct device *dev);
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_namespace_common *ndns);
const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
		char *name);
int nd_blk_region_init(struct nd_region *nd_region);
resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
#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>
4d88a97a DW	16	#include <linux/device.h>
	17	#include <linux/mutex.h>
	18	#include <linux/ndctl.h>
bf9bccc1	19	#include <linux/types.h>
4a826c83	20	#include "label.h"
4d88a97a	21
8c2f7e86	22	enum {
5212e11f VV	23	/*
	24	* Limits the maximum number of block apertures a dimm can
	25	* support and is an input to the geometry/on-disk-format of a
	26	* BTT instance
	27	*/
	28	ND_MAX_LANES = 256,
8c2f7e86 DW	29	SECTOR_SHIFT = 9,
	30	};
	31
4d88a97a DW	32	struct nvdimm_drvdata {
4d88a97a DW	33	struct device *dev;
4a826c83	34	int nsindex_size;
4d88a97a DW	35	struct nd_cmd_get_config_size nsarea;
4d88a97a DW	36	void *data;
4a826c83 DW	37	int ns_current, ns_next;
4a826c83 DW	38	struct resource dpa;
bf9bccc1	39	struct kref kref;
4d88a97a DW	40	};
4d88a97a DW	41
3d88002e DW	42	struct nd_region_namespaces {
	43	int count;
	44	int active;
	45	};
	46
4a826c83 DW	47	static inline struct nd_namespace_index *to_namespace_index(
	48	struct nvdimm_drvdata *ndd, int i)
	49	{
	50	if (i < 0)
	51	return NULL;
	52
	53	return ndd->data + sizeof_namespace_index(ndd) * i;
	54	}
	55
	56	static inline struct nd_namespace_index *to_current_namespace_index(
	57	struct nvdimm_drvdata *ndd)
	58	{
	59	return to_namespace_index(ndd, ndd->ns_current);
	60	}
	61
	62	static inline struct nd_namespace_index *to_next_namespace_index(
	63	struct nvdimm_drvdata *ndd)
	64	{
	65	return to_namespace_index(ndd, ndd->ns_next);
	66	}
	67
	68	#define nd_dbg_dpa(r, d, res, fmt, arg...) \
	69	dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
	70	(r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
	71	(unsigned long long) (res ? resource_size(res) : 0), \
	72	(unsigned long long) (res ? res->start : 0), ##arg)
	73
bf9bccc1 DW	74	#define for_each_label(l, label, labels) \
	75	for (l = 0; (label = labels ? labels[l] : NULL); l++)
	76
	77	#define for_each_dpa_resource(ndd, res) \
	78	for (res = (ndd)->dpa.child; res; res = res->sibling)
	79
4a826c83 DW	80	#define for_each_dpa_resource_safe(ndd, res, next) \
	81	for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
	82	res; res = next, next = next ? next->sibling : NULL)
	83
5212e11f VV	84	struct nd_percpu_lane {
	85	int count;
	86	spinlock_t lock;
	87	};
	88
1f7df6f8 DW	89	struct nd_region {
1f7df6f8 DW	90	struct device dev;
1b40e09a	91	struct ida ns_ida;
8c2f7e86	92	struct ida btt_ida;
bf9bccc1	93	struct device *ns_seed;
8c2f7e86	94	struct device *btt_seed;
1f7df6f8 DW	95	u16 ndr_mappings;
	96	u64 ndr_size;
	97	u64 ndr_start;
5212e11f	98	int id, num_lanes;
1f7df6f8	99	void *provider_data;
eaf96153	100	struct nd_interleave_set *nd_set;
5212e11f	101	struct nd_percpu_lane __percpu *lane;
1f7df6f8 DW	102	struct nd_mapping mapping[0];
	103	};
	104
047fc8a1 RZ	105	struct nd_blk_region {
	106	int (enable)(struct nvdimm_bus nvdimm_bus, struct device *dev);
	107	void (disable)(struct nvdimm_bus nvdimm_bus, struct device *dev);
	108	int (do_io)(struct nd_blk_region ndbr, resource_size_t dpa,
	109	void *iobuf, u64 len, int rw);
	110	void *blk_provider_data;
	111	struct nd_region nd_region;
	112	};
	113
4a826c83 DW	114	/*
	115	* Lookup next in the repeating sequence of 01, 10, and 11.
	116	*/
	117	static inline unsigned nd_inc_seq(unsigned seq)
	118	{
	119	static const unsigned next[] = { 0, 2, 3, 1 };
	120
	121	return next[seq & 3];
	122	}
f524bf27	123
5212e11f	124	struct btt;
8c2f7e86 DW	125	struct nd_btt {
	126	struct device dev;
	127	struct nd_namespace_common *ndns;
5212e11f	128	struct btt *btt;
8c2f7e86 DW	129	unsigned long lbasize;
	130	u8 *uuid;
	131	int id;
	132	};
	133
4d88a97a DW	134	enum nd_async_mode {
	135	ND_SYNC,
	136	ND_ASYNC,
	137	};
	138
bf9bccc1	139	void wait_nvdimm_bus_probe_idle(struct device *dev);
4d88a97a DW	140	void nd_device_register(struct device *dev);
4d88a97a DW	141	void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
bf9bccc1 DW	142	int nd_uuid_store(struct device dev, u8 uuid_out, const char buf,
bf9bccc1 DW	143	size_t len);
1b40e09a DW	144	ssize_t nd_sector_size_show(unsigned long current_lbasize,
	145	const unsigned long supported, char buf);
	146	ssize_t nd_sector_size_store(struct device dev, const char buf,
	147	unsigned long current_lbasize, const unsigned long supported);
4d88a97a	148	int __init nvdimm_init(void);
3d88002e	149	int __init nd_region_init(void);
4d88a97a	150	void nvdimm_exit(void);
3d88002e	151	void nd_region_exit(void);
bf9bccc1 DW	152	struct nvdimm;
bf9bccc1 DW	153	struct nvdimm_drvdata to_ndd(struct nd_mapping nd_mapping);
4d88a97a DW	154	int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
4d88a97a DW	155	int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
f524bf27 DW	156	int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
f524bf27 DW	157	void *buf, size_t len);
8c2f7e86 DW	158	struct nd_btt to_nd_btt(struct device dev);
	159	struct btt_sb;
	160	u64 nd_btt_sb_checksum(struct btt_sb *btt_sb);
	161	#if IS_ENABLED(CONFIG_BTT)
	162	int nd_btt_probe(struct nd_namespace_common ndns, void drvdata);
	163	bool is_nd_btt(struct device *dev);
	164	struct device nd_btt_create(struct nd_region nd_region);
	165	#else
	166	static inline nd_btt_probe(struct nd_namespace_common ndns, void drvdata)
	167	{
	168	return -ENODEV;
	169	}
	170
	171	static inline bool is_nd_btt(struct device *dev)
	172	{
	173	return false;
	174	}
	175
	176	static inline struct device nd_btt_create(struct nd_region nd_region)
	177	{
	178	return NULL;
	179	}
	180
	181	#endif
3d88002e DW	182	struct nd_region to_nd_region(struct device dev);
	183	int nd_region_to_nstype(struct nd_region *nd_region);
	184	int nd_region_register_namespaces(struct nd_region nd_region, int err);
bf9bccc1	185	u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
3d88002e DW	186	void nvdimm_bus_lock(struct device *dev);
	187	void nvdimm_bus_unlock(struct device *dev);
	188	bool is_nvdimm_bus_locked(struct device *dev);
bf9bccc1 DW	189	void nvdimm_drvdata_release(struct kref *kref);
bf9bccc1 DW	190	void put_ndd(struct nvdimm_drvdata *ndd);
4a826c83 DW	191	int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
	192	void nvdimm_free_dpa(struct nvdimm_drvdata ndd, struct resource res);
	193	struct resource nvdimm_allocate_dpa(struct nvdimm_drvdata ndd,
	194	struct nd_label_id *label_id, resource_size_t start,
	195	resource_size_t n);
8c2f7e86 DW	196	resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
8c2f7e86 DW	197	struct nd_namespace_common nvdimm_namespace_common_probe(struct device dev);
5212e11f VV	198	int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
	199	int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
	200	const char nvdimm_namespace_disk_name(struct nd_namespace_common ndns,
	201	char *name);
047fc8a1 RZ	202	int nd_blk_region_init(struct nd_region *nd_region);
047fc8a1 RZ	203	resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
4d88a97a	204	#endif /* __ND_H__ */