xref: /openbmc/linux/drivers/nvdimm/nd-core.h (revision 2359ccdd)
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_CORE_H__
14 #define __ND_CORE_H__
15 #include <linux/libnvdimm.h>
16 #include <linux/device.h>
17 #include <linux/libnvdimm.h>
18 #include <linux/sizes.h>
19 #include <linux/mutex.h>
20 #include <linux/nd.h>
21 
22 extern struct list_head nvdimm_bus_list;
23 extern struct mutex nvdimm_bus_list_mutex;
24 extern int nvdimm_major;
25 
26 struct nvdimm_bus {
27 	struct nvdimm_bus_descriptor *nd_desc;
28 	wait_queue_head_t probe_wait;
29 	struct list_head list;
30 	struct device dev;
31 	int id, probe_active;
32 	struct list_head mapping_list;
33 	struct mutex reconfig_mutex;
34 	struct badrange badrange;
35 };
36 
37 struct nvdimm {
38 	unsigned long flags;
39 	void *provider_data;
40 	unsigned long cmd_mask;
41 	struct device dev;
42 	atomic_t busy;
43 	int id, num_flush;
44 	struct resource *flush_wpq;
45 };
46 
47 /**
48  * struct blk_alloc_info - tracking info for BLK dpa scanning
49  * @nd_mapping: blk region mapping boundaries
50  * @available: decremented in alias_dpa_busy as aliased PMEM is scanned
51  * @busy: decremented in blk_dpa_busy to account for ranges already
52  * 	  handled by alias_dpa_busy
53  * @res: alias_dpa_busy interprets this a free space range that needs to
54  * 	 be truncated to the valid BLK allocation starting DPA, blk_dpa_busy
55  * 	 treats it as a busy range that needs the aliased PMEM ranges
56  * 	 truncated.
57  */
58 struct blk_alloc_info {
59 	struct nd_mapping *nd_mapping;
60 	resource_size_t available, busy;
61 	struct resource *res;
62 };
63 
64 bool is_nvdimm(struct device *dev);
65 bool is_nd_pmem(struct device *dev);
66 bool is_nd_volatile(struct device *dev);
67 bool is_nd_blk(struct device *dev);
68 static inline bool is_nd_region(struct device *dev)
69 {
70 	return is_nd_pmem(dev) || is_nd_blk(dev) || is_nd_volatile(dev);
71 }
72 static inline bool is_memory(struct device *dev)
73 {
74 	return is_nd_pmem(dev) || is_nd_volatile(dev);
75 }
76 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
77 int __init nvdimm_bus_init(void);
78 void nvdimm_bus_exit(void);
79 void nvdimm_devs_exit(void);
80 void nd_region_devs_exit(void);
81 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
82 struct nd_region;
83 void nd_region_create_ns_seed(struct nd_region *nd_region);
84 void nd_region_create_btt_seed(struct nd_region *nd_region);
85 void nd_region_create_pfn_seed(struct nd_region *nd_region);
86 void nd_region_create_dax_seed(struct nd_region *nd_region);
87 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
88 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
89 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
90 void nd_synchronize(void);
91 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
92 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
93 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
94 void __nd_device_register(struct device *dev);
95 int nd_match_dimm(struct device *dev, void *data);
96 struct nd_label_id;
97 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
98 bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
99 struct nd_region;
100 struct nvdimm_drvdata;
101 struct nd_mapping;
102 void nd_mapping_free_labels(struct nd_mapping *nd_mapping);
103 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
104 		struct nd_mapping *nd_mapping, resource_size_t *overlap);
105 resource_size_t nd_blk_available_dpa(struct nd_region *nd_region);
106 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
107 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
108 		struct nd_label_id *label_id);
109 int alias_dpa_busy(struct device *dev, void *data);
110 struct resource *nsblk_add_resource(struct nd_region *nd_region,
111 		struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
112 		resource_size_t start);
113 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
114 void get_ndd(struct nvdimm_drvdata *ndd);
115 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
116 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
117 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
118 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
119 		struct nd_namespace_common **_ndns);
120 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
121 		struct nd_namespace_common **_ndns);
122 ssize_t nd_namespace_store(struct device *dev,
123 		struct nd_namespace_common **_ndns, const char *buf,
124 		size_t len);
125 struct nd_pfn *to_nd_pfn_safe(struct device *dev);
126 #endif /* __ND_CORE_H__ */
127