Merge branch 'clk-next' into v4.3-rc1
[firefly-linux-kernel-4.4.55.git] / drivers / nvdimm / nd.h
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__
15 #include <linux/libnvdimm.h>
16 #include <linux/blkdev.h>
17 #include <linux/device.h>
18 #include <linux/mutex.h>
19 #include <linux/ndctl.h>
20 #include <linux/types.h>
21 #include "label.h"
22
23 enum {
24         /*
25          * Limits the maximum number of block apertures a dimm can
26          * support and is an input to the geometry/on-disk-format of a
27          * BTT instance
28          */
29         ND_MAX_LANES = 256,
30         SECTOR_SHIFT = 9,
31         INT_LBASIZE_ALIGNMENT = 64,
32 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
33         ND_PFN_ALIGN = PAGES_PER_SECTION * PAGE_SIZE,
34         ND_PFN_MASK = ND_PFN_ALIGN - 1,
35 #else
36         ND_PFN_ALIGN = 0,
37         ND_PFN_MASK = 0,
38 #endif
39 };
40
41 struct nvdimm_drvdata {
42         struct device *dev;
43         int nsindex_size;
44         struct nd_cmd_get_config_size nsarea;
45         void *data;
46         int ns_current, ns_next;
47         struct resource dpa;
48         struct kref kref;
49 };
50
51 struct nd_region_namespaces {
52         int count;
53         int active;
54 };
55
56 static inline struct nd_namespace_index *to_namespace_index(
57                 struct nvdimm_drvdata *ndd, int i)
58 {
59         if (i < 0)
60                 return NULL;
61
62         return ndd->data + sizeof_namespace_index(ndd) * i;
63 }
64
65 static inline struct nd_namespace_index *to_current_namespace_index(
66                 struct nvdimm_drvdata *ndd)
67 {
68         return to_namespace_index(ndd, ndd->ns_current);
69 }
70
71 static inline struct nd_namespace_index *to_next_namespace_index(
72                 struct nvdimm_drvdata *ndd)
73 {
74         return to_namespace_index(ndd, ndd->ns_next);
75 }
76
77 #define nd_dbg_dpa(r, d, res, fmt, arg...) \
78         dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
79                 (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
80                 (unsigned long long) (res ? resource_size(res) : 0), \
81                 (unsigned long long) (res ? res->start : 0), ##arg)
82
83 #define for_each_label(l, label, labels) \
84         for (l = 0; (label = labels ? labels[l] : NULL); l++)
85
86 #define for_each_dpa_resource(ndd, res) \
87         for (res = (ndd)->dpa.child; res; res = res->sibling)
88
89 #define for_each_dpa_resource_safe(ndd, res, next) \
90         for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
91                         res; res = next, next = next ? next->sibling : NULL)
92
93 struct nd_percpu_lane {
94         int count;
95         spinlock_t lock;
96 };
97
98 struct nd_region {
99         struct device dev;
100         struct ida ns_ida;
101         struct ida btt_ida;
102         struct ida pfn_ida;
103         unsigned long flags;
104         struct device *ns_seed;
105         struct device *btt_seed;
106         struct device *pfn_seed;
107         u16 ndr_mappings;
108         u64 ndr_size;
109         u64 ndr_start;
110         int id, num_lanes, ro, numa_node;
111         void *provider_data;
112         struct nd_interleave_set *nd_set;
113         struct nd_percpu_lane __percpu *lane;
114         struct nd_mapping mapping[0];
115 };
116
117 struct nd_blk_region {
118         int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
119         void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
120         int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
121                         void *iobuf, u64 len, int rw);
122         void *blk_provider_data;
123         struct nd_region nd_region;
124 };
125
126 /*
127  * Lookup next in the repeating sequence of 01, 10, and 11.
128  */
129 static inline unsigned nd_inc_seq(unsigned seq)
130 {
131         static const unsigned next[] = { 0, 2, 3, 1 };
132
133         return next[seq & 3];
134 }
135
136 struct btt;
137 struct nd_btt {
138         struct device dev;
139         struct nd_namespace_common *ndns;
140         struct btt *btt;
141         unsigned long lbasize;
142         u8 *uuid;
143         int id;
144 };
145
146 enum nd_pfn_mode {
147         PFN_MODE_NONE,
148         PFN_MODE_RAM,
149         PFN_MODE_PMEM,
150 };
151
152 struct nd_pfn {
153         int id;
154         u8 *uuid;
155         struct device dev;
156         unsigned long npfns;
157         enum nd_pfn_mode mode;
158         struct nd_pfn_sb *pfn_sb;
159         struct nd_namespace_common *ndns;
160 };
161
162 enum nd_async_mode {
163         ND_SYNC,
164         ND_ASYNC,
165 };
166
167 int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
168 void wait_nvdimm_bus_probe_idle(struct device *dev);
169 void nd_device_register(struct device *dev);
170 void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
171 int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
172                 size_t len);
173 ssize_t nd_sector_size_show(unsigned long current_lbasize,
174                 const unsigned long *supported, char *buf);
175 ssize_t nd_sector_size_store(struct device *dev, const char *buf,
176                 unsigned long *current_lbasize, const unsigned long *supported);
177 int __init nvdimm_init(void);
178 int __init nd_region_init(void);
179 void nvdimm_exit(void);
180 void nd_region_exit(void);
181 struct nvdimm;
182 struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
183 int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
184 int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
185 int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
186                 void *buf, size_t len);
187 struct nd_btt *to_nd_btt(struct device *dev);
188
189 struct nd_gen_sb {
190         char reserved[SZ_4K - 8];
191         __le64 checksum;
192 };
193
194 u64 nd_sb_checksum(struct nd_gen_sb *sb);
195 #if IS_ENABLED(CONFIG_BTT)
196 int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata);
197 bool is_nd_btt(struct device *dev);
198 struct device *nd_btt_create(struct nd_region *nd_region);
199 #else
200 static inline int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata)
201 {
202         return -ENODEV;
203 }
204
205 static inline bool is_nd_btt(struct device *dev)
206 {
207         return false;
208 }
209
210 static inline struct device *nd_btt_create(struct nd_region *nd_region)
211 {
212         return NULL;
213 }
214 #endif
215
216 struct nd_pfn *to_nd_pfn(struct device *dev);
217 #if IS_ENABLED(CONFIG_NVDIMM_PFN)
218 int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata);
219 bool is_nd_pfn(struct device *dev);
220 struct device *nd_pfn_create(struct nd_region *nd_region);
221 int nd_pfn_validate(struct nd_pfn *nd_pfn);
222 #else
223 static inline int nd_pfn_probe(struct nd_namespace_common *ndns, void *drvdata)
224 {
225         return -ENODEV;
226 }
227
228 static inline bool is_nd_pfn(struct device *dev)
229 {
230         return false;
231 }
232
233 static inline struct device *nd_pfn_create(struct nd_region *nd_region)
234 {
235         return NULL;
236 }
237
238 static inline int nd_pfn_validate(struct nd_pfn *nd_pfn)
239 {
240         return -ENODEV;
241 }
242 #endif
243
244 struct nd_region *to_nd_region(struct device *dev);
245 int nd_region_to_nstype(struct nd_region *nd_region);
246 int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
247 u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
248 void nvdimm_bus_lock(struct device *dev);
249 void nvdimm_bus_unlock(struct device *dev);
250 bool is_nvdimm_bus_locked(struct device *dev);
251 int nvdimm_revalidate_disk(struct gendisk *disk);
252 void nvdimm_drvdata_release(struct kref *kref);
253 void put_ndd(struct nvdimm_drvdata *ndd);
254 int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
255 void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
256 struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
257                 struct nd_label_id *label_id, resource_size_t start,
258                 resource_size_t n);
259 resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
260 struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
261 int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
262 int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns);
263 const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
264                 char *name);
265 int nd_blk_region_init(struct nd_region *nd_region);
266 void __nd_iostat_start(struct bio *bio, unsigned long *start);
267 static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
268 {
269         struct gendisk *disk = bio->bi_bdev->bd_disk;
270
271         if (!blk_queue_io_stat(disk->queue))
272                 return false;
273
274         __nd_iostat_start(bio, start);
275         return true;
276 }
277 void nd_iostat_end(struct bio *bio, unsigned long start);
278 resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
279 const u8 *nd_dev_to_uuid(struct device *dev);
280 bool pmem_should_map_pages(struct device *dev);
281 #endif /* __ND_H__ */