[linux-block.git] / drivers / nvdimm / nd-core.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
 */
#ifndef __ND_CORE_H__
#define __ND_CORE_H__
#include <linux/libnvdimm.h>
#include <linux/device.h>
#include <linux/sizes.h>
#include <linux/mutex.h>
#include <linux/nd.h>
#include "nd.h"

extern struct list_head nvdimm_bus_list;
extern struct mutex nvdimm_bus_list_mutex;
extern int nvdimm_major;
extern struct workqueue_struct *nvdimm_wq;

struct nvdimm_bus {
	struct nvdimm_bus_descriptor *nd_desc;
	wait_queue_head_t wait;
	struct list_head list;
	struct device dev;
	int id, probe_active;
	atomic_t ioctl_active;
	struct list_head mapping_list;
	struct mutex reconfig_mutex;
	struct badrange badrange;
};

struct nvdimm {
	unsigned long flags;
	void *provider_data;
	unsigned long cmd_mask;
	struct device dev;
	atomic_t busy;
	int id, num_flush;
	struct resource *flush_wpq;
	const char *dimm_id;
	struct {
		const struct nvdimm_security_ops *ops;
		unsigned long flags;
		unsigned long ext_flags;
		unsigned int overwrite_tmo;
		struct kernfs_node *overwrite_state;
	} sec;
	struct delayed_work dwork;
	const struct nvdimm_fw_ops *fw_ops;
};

static inline unsigned long nvdimm_security_flags(
		struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype)
{
	u64 flags;
	const u64 state_flags = 1UL << NVDIMM_SECURITY_DISABLED
		| 1UL << NVDIMM_SECURITY_LOCKED
		| 1UL << NVDIMM_SECURITY_UNLOCKED
		| 1UL << NVDIMM_SECURITY_OVERWRITE;

	if (!nvdimm->sec.ops)
		return 0;

	flags = nvdimm->sec.ops->get_flags(nvdimm, ptype);
	/* disabled, locked, unlocked, and overwrite are mutually exclusive */
	dev_WARN_ONCE(&nvdimm->dev, hweight64(flags & state_flags) > 1,
			"reported invalid security state: %#llx\n",
			(unsigned long long) flags);
	return flags;
}
int nvdimm_security_freeze(struct nvdimm *nvdimm);
#if IS_ENABLED(CONFIG_NVDIMM_KEYS)
ssize_t nvdimm_security_store(struct device *dev, const char *buf, size_t len);
void nvdimm_security_overwrite_query(struct work_struct *work);
#else
static inline ssize_t nvdimm_security_store(struct device *dev,
		const char *buf, size_t len)
{
	return -EOPNOTSUPP;
}
static inline void nvdimm_security_overwrite_query(struct work_struct *work)
{
}
#endif

bool is_nvdimm(const struct device *dev);
bool is_nd_pmem(const struct device *dev);
bool is_nd_volatile(const struct device *dev);
static inline bool is_nd_region(const struct device *dev)
{
	return is_nd_pmem(dev) || is_nd_volatile(dev);
}
static inline bool is_memory(const struct device *dev)
{
	return is_nd_pmem(dev) || is_nd_volatile(dev);
}
struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
int __init nvdimm_bus_init(void);
void nvdimm_bus_exit(void);
void nvdimm_devs_exit(void);
struct nd_region;
void nd_region_advance_seeds(struct nd_region *nd_region, struct device *dev);
void nd_region_create_ns_seed(struct nd_region *nd_region);
void nd_region_create_btt_seed(struct nd_region *nd_region);
void nd_region_create_pfn_seed(struct nd_region *nd_region);
void nd_region_create_dax_seed(struct nd_region *nd_region);
int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
void nd_synchronize(void);
void nd_device_register(struct device *dev);
void nd_device_register_sync(struct device *dev);
struct nd_label_id;
char *nd_label_gen_id(struct nd_label_id *label_id, const uuid_t *uuid,
		      u32 flags);
bool nd_is_uuid_unique(struct device *dev, uuid_t *uuid);
struct nd_region;
struct nvdimm_drvdata;
struct nd_mapping;
void nd_mapping_free_labels(struct nd_mapping *nd_mapping);

int __reserve_free_pmem(struct device *dev, void *data);
void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
		       struct nd_mapping *nd_mapping);

resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
					   struct nd_mapping *nd_mapping);
resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
				      struct nd_mapping *nd_mapping);
resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
		struct nd_label_id *label_id);
int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
void get_ndd(struct nvdimm_drvdata *ndd);
resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
		struct nd_namespace_common **_ndns);
ssize_t nd_namespace_store(struct device *dev,
		struct nd_namespace_common **_ndns, const char *buf,
		size_t len);
struct nd_pfn *to_nd_pfn_safe(struct device *dev);
bool is_nvdimm_bus(struct device *dev);

#if IS_ENABLED(CONFIG_ND_CLAIM)
int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio,
		resource_size_t size);
void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
#else
static inline int devm_nsio_enable(struct device *dev,
		struct nd_namespace_io *nsio, resource_size_t size)
{
	return -ENXIO;
}

static inline void devm_nsio_disable(struct device *dev,
		struct nd_namespace_io *nsio)
{
}
#endif
#endif /* __ND_CORE_H__ */
Commit	Line	Data
	1	/* SPDX-License-Identifier: GPL-2.0-only */
	2	/*
	3	* Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
	4	*/
	5	#ifndef __ND_CORE_H__
	6	#define __ND_CORE_H__
	7	#include <linux/libnvdimm.h>
	8	#include <linux/device.h>
	9	#include <linux/sizes.h>
	10	#include <linux/mutex.h>
	11	#include <linux/nd.h>
	12	#include "nd.h"
	13
	14	extern struct list_head nvdimm_bus_list;
	15	extern struct mutex nvdimm_bus_list_mutex;
	16	extern int nvdimm_major;
	17	extern struct workqueue_struct *nvdimm_wq;
	18
	19	struct nvdimm_bus {
	20	struct nvdimm_bus_descriptor *nd_desc;
	21	wait_queue_head_t wait;
	22	struct list_head list;
	23	struct device dev;
	24	int id, probe_active;
	25	atomic_t ioctl_active;
	26	struct list_head mapping_list;
	27	struct mutex reconfig_mutex;
	28	struct badrange badrange;
	29	};
	30
	31	struct nvdimm {
	32	unsigned long flags;
	33	void *provider_data;
	34	unsigned long cmd_mask;
	35	struct device dev;
	36	atomic_t busy;
	37	int id, num_flush;
	38	struct resource *flush_wpq;
	39	const char *dimm_id;
	40	struct {
	41	const struct nvdimm_security_ops *ops;
	42	unsigned long flags;
	43	unsigned long ext_flags;
	44	unsigned int overwrite_tmo;
	45	struct kernfs_node *overwrite_state;
	46	} sec;
	47	struct delayed_work dwork;
	48	const struct nvdimm_fw_ops *fw_ops;
	49	};
	50
	51	static inline unsigned long nvdimm_security_flags(
	52	struct nvdimm *nvdimm, enum nvdimm_passphrase_type ptype)
	53	{
	54	u64 flags;
	55	const u64 state_flags = 1UL << NVDIMM_SECURITY_DISABLED
	56	\| 1UL << NVDIMM_SECURITY_LOCKED
	57	\| 1UL << NVDIMM_SECURITY_UNLOCKED
	58	\| 1UL << NVDIMM_SECURITY_OVERWRITE;
	59
	60	if (!nvdimm->sec.ops)
	61	return 0;
	62
	63	flags = nvdimm->sec.ops->get_flags(nvdimm, ptype);
	64	/* disabled, locked, unlocked, and overwrite are mutually exclusive */
	65	dev_WARN_ONCE(&nvdimm->dev, hweight64(flags & state_flags) > 1,
	66	"reported invalid security state: %#llx\n",
	67	(unsigned long long) flags);
	68	return flags;
	69	}
	70	int nvdimm_security_freeze(struct nvdimm *nvdimm);
	71	#if IS_ENABLED(CONFIG_NVDIMM_KEYS)
	72	ssize_t nvdimm_security_store(struct device dev, const char buf, size_t len);
	73	void nvdimm_security_overwrite_query(struct work_struct *work);
	74	#else
	75	static inline ssize_t nvdimm_security_store(struct device *dev,
	76	const char *buf, size_t len)
	77	{
	78	return -EOPNOTSUPP;
	79	}
	80	static inline void nvdimm_security_overwrite_query(struct work_struct *work)
	81	{
	82	}
	83	#endif
	84
	85	bool is_nvdimm(const struct device *dev);
	86	bool is_nd_pmem(const struct device *dev);
	87	bool is_nd_volatile(const struct device *dev);
	88	static inline bool is_nd_region(const struct device *dev)
	89	{
	90	return is_nd_pmem(dev) \|\| is_nd_volatile(dev);
	91	}
	92	static inline bool is_memory(const struct device *dev)
	93	{
	94	return is_nd_pmem(dev) \|\| is_nd_volatile(dev);
	95	}
	96	struct nvdimm_bus walk_to_nvdimm_bus(struct device nd_dev);
	97	int __init nvdimm_bus_init(void);
	98	void nvdimm_bus_exit(void);
	99	void nvdimm_devs_exit(void);
	100	struct nd_region;
	101	void nd_region_advance_seeds(struct nd_region nd_region, struct device dev);
	102	void nd_region_create_ns_seed(struct nd_region *nd_region);
	103	void nd_region_create_btt_seed(struct nd_region *nd_region);
	104	void nd_region_create_pfn_seed(struct nd_region *nd_region);
	105	void nd_region_create_dax_seed(struct nd_region *nd_region);
	106	int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
	107	void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
	108	void nd_synchronize(void);
	109	void nd_device_register(struct device *dev);
	110	void nd_device_register_sync(struct device *dev);
	111	struct nd_label_id;
	112	char nd_label_gen_id(struct nd_label_id label_id, const uuid_t *uuid,
	113	u32 flags);
	114	bool nd_is_uuid_unique(struct device dev, uuid_t uuid);
	115	struct nd_region;
	116	struct nvdimm_drvdata;
	117	struct nd_mapping;
	118	void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
	119
	120	int __reserve_free_pmem(struct device dev, void data);
	121	void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
	122	struct nd_mapping *nd_mapping);
	123
	124	resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
	125	struct nd_mapping *nd_mapping);
	126	resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
	127	resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
	128	struct nd_mapping *nd_mapping);
	129	resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
	130	resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
	131	struct nd_label_id *label_id);
	132	int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
	133	void get_ndd(struct nvdimm_drvdata *ndd);
	134	resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
	135	void nd_detach_ndns(struct device dev, struct nd_namespace_common *_ndns);
	136	void __nd_detach_ndns(struct device dev, struct nd_namespace_common *_ndns);
	137	bool __nd_attach_ndns(struct device dev, struct nd_namespace_common attach,
	138	struct nd_namespace_common **_ndns);
	139	ssize_t nd_namespace_store(struct device *dev,
	140	struct nd_namespace_common *_ndns, const char buf,
	141	size_t len);
	142	struct nd_pfn to_nd_pfn_safe(struct device dev);
	143	bool is_nvdimm_bus(struct device *dev);
	144
	145	#if IS_ENABLED(CONFIG_ND_CLAIM)
	146	int devm_nsio_enable(struct device dev, struct nd_namespace_io nsio,
	147	resource_size_t size);
	148	void devm_nsio_disable(struct device dev, struct nd_namespace_io nsio);
	149	#else
	150	static inline int devm_nsio_enable(struct device *dev,
	151	struct nd_namespace_io *nsio, resource_size_t size)
	152	{
	153	return -ENXIO;
	154	}
	155
	156	static inline void devm_nsio_disable(struct device *dev,
	157	struct nd_namespace_io *nsio)
	158	{
	159	}
	160	#endif
	161	#endif /* __ND_CORE_H__ */