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
 14extern struct list_head nvdimm_bus_list;
 15extern struct mutex nvdimm_bus_list_mutex;
 16extern int nvdimm_major;
 17extern struct workqueue_struct *nvdimm_wq;
 18
 19struct 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
 31struct 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
 51static 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}
 70int nvdimm_security_freeze(struct nvdimm *nvdimm);
 71#if IS_ENABLED(CONFIG_NVDIMM_KEYS)
 72ssize_t nvdimm_security_store(struct device *dev, const char *buf, size_t len);
 73void nvdimm_security_overwrite_query(struct work_struct *work);
 74#else
 75static inline ssize_t nvdimm_security_store(struct device *dev,
 76		const char *buf, size_t len)
 77{
 78	return -EOPNOTSUPP;
 79}
 80static inline void nvdimm_security_overwrite_query(struct work_struct *work)
 81{
 82}
 83#endif
 84
 85/**
 86 * struct blk_alloc_info - tracking info for BLK dpa scanning
 87 * @nd_mapping: blk region mapping boundaries
 88 * @available: decremented in alias_dpa_busy as aliased PMEM is scanned
 89 * @busy: decremented in blk_dpa_busy to account for ranges already
 90 * 	  handled by alias_dpa_busy
 91 * @res: alias_dpa_busy interprets this a free space range that needs to
 92 * 	 be truncated to the valid BLK allocation starting DPA, blk_dpa_busy
 93 * 	 treats it as a busy range that needs the aliased PMEM ranges
 94 * 	 truncated.
 95 */
 96struct blk_alloc_info {
 97	struct nd_mapping *nd_mapping;
 98	resource_size_t available, busy;
 99	struct resource *res;
100};
101
102bool is_nvdimm(struct device *dev);
103bool is_nd_pmem(struct device *dev);
104bool is_nd_volatile(struct device *dev);
105bool is_nd_blk(struct device *dev);
106static inline bool is_nd_region(struct device *dev)
107{
108	return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
109}
110static inline bool is_memory(struct device *dev)
111{
112	return is_nd_pmem(dev) || is_nd_volatile(dev);
113}
114struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
115int __init nvdimm_bus_init(void);
116void nvdimm_bus_exit(void);
117void nvdimm_devs_exit(void);
118struct nd_region;
119void nd_region_advance_seeds(struct nd_region *nd_region, struct device *dev);
120void nd_region_create_ns_seed(struct nd_region *nd_region);
121void nd_region_create_btt_seed(struct nd_region *nd_region);
122void nd_region_create_pfn_seed(struct nd_region *nd_region);
123void nd_region_create_dax_seed(struct nd_region *nd_region);
124int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
125void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
126void nd_synchronize(void);
127void __nd_device_register(struct device *dev);
128struct nd_label_id;
129char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
130bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
131struct nd_region;
132struct nvdimm_drvdata;
133struct nd_mapping;
134void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
135
136int __reserve_free_pmem(struct device *dev, void *data);
137void release_free_pmem(struct nvdimm_bus *nvdimm_bus,
138		       struct nd_mapping *nd_mapping);
139
140resource_size_t nd_pmem_max_contiguous_dpa(struct nd_region *nd_region,
141					   struct nd_mapping *nd_mapping);
142resource_size_t nd_region_allocatable_dpa(struct nd_region *nd_region);
143resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
144		struct nd_mapping *nd_mapping, resource_size_t *overlap);
145resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
146resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
147int nd_region_conflict(struct nd_region *nd_region, resource_size_t start,
148		resource_size_t size);
149resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
150		struct nd_label_id *label_id);
151int alias_dpa_busy(struct device *dev, void *data);
152struct resource *nsblk_add_resource(struct nd_region *nd_region,
153		struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
154		resource_size_t start);
155int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
156void get_ndd(struct nvdimm_drvdata *ndd);
157resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
158void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
159void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
160bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
161		struct nd_namespace_common **_ndns);
162bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
163		struct nd_namespace_common **_ndns);
164ssize_t nd_namespace_store(struct device *dev,
165		struct nd_namespace_common **_ndns, const char *buf,
166		size_t len);
167struct nd_pfn *to_nd_pfn_safe(struct device *dev);
168bool is_nvdimm_bus(struct device *dev);
169
170#if IS_ENABLED(CONFIG_ND_CLAIM)
171int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio,
172		resource_size_t size);
173void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
174#else
175static inline int devm_nsio_enable(struct device *dev,
176		struct nd_namespace_io *nsio, resource_size_t size)
177{
178	return -ENXIO;
179}
180
181static inline void devm_nsio_disable(struct device *dev,
182		struct nd_namespace_io *nsio)
183{
184}
185#endif
186
187#ifdef CONFIG_PROVE_LOCKING
188extern struct class *nd_class;
189
190enum {
191	LOCK_BUS,
192	LOCK_NDCTL,
193	LOCK_REGION,
194	LOCK_DIMM = LOCK_REGION,
195	LOCK_NAMESPACE,
196	LOCK_CLAIM,
197};
198
199static inline void debug_nvdimm_lock(struct device *dev)
200{
201	if (is_nd_region(dev))
202		mutex_lock_nested(&dev->lockdep_mutex, LOCK_REGION);
203	else if (is_nvdimm(dev))
204		mutex_lock_nested(&dev->lockdep_mutex, LOCK_DIMM);
205	else if (is_nd_btt(dev) || is_nd_pfn(dev) || is_nd_dax(dev))
206		mutex_lock_nested(&dev->lockdep_mutex, LOCK_CLAIM);
207	else if (dev->parent && (is_nd_region(dev->parent)))
208		mutex_lock_nested(&dev->lockdep_mutex, LOCK_NAMESPACE);
209	else if (is_nvdimm_bus(dev))
210		mutex_lock_nested(&dev->lockdep_mutex, LOCK_BUS);
211	else if (dev->class && dev->class == nd_class)
212		mutex_lock_nested(&dev->lockdep_mutex, LOCK_NDCTL);
213	else
214		dev_WARN(dev, "unknown lock level\n");
215}
216
217static inline void debug_nvdimm_unlock(struct device *dev)
218{
219	mutex_unlock(&dev->lockdep_mutex);
220}
221
222static inline void nd_device_lock(struct device *dev)
223{
224	device_lock(dev);
225	debug_nvdimm_lock(dev);
226}
227
228static inline void nd_device_unlock(struct device *dev)
229{
230	debug_nvdimm_unlock(dev);
231	device_unlock(dev);
232}
233#else
234static inline void nd_device_lock(struct device *dev)
235{
236	device_lock(dev);
237}
238
239static inline void nd_device_unlock(struct device *dev)
240{
241	device_unlock(dev);
242}
243
244static inline void debug_nvdimm_lock(struct device *dev)
245{
246}
247
248static inline void debug_nvdimm_unlock(struct device *dev)
249{
250}
251#endif
252#endif /* __ND_CORE_H__ */