source: src/linux/universal/linux-4.9/drivers/nvdimm/nd.h @ 31662

Last change on this file since 31662 was 31662, checked in by brainslayer, 6 weeks ago

use new squashfs in all kernels

File size: 10.7 KB
Line 
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/badblocks.h>
17#include <linux/blkdev.h>
18#include <linux/device.h>
19#include <linux/mutex.h>
20#include <linux/ndctl.h>
21#include <linux/types.h>
22#include <linux/nd.h>
23#include "label.h"
24
25enum {
26        /*
27         * Limits the maximum number of block apertures a dimm can
28         * support and is an input to the geometry/on-disk-format of a
29         * BTT instance
30         */
31        ND_MAX_LANES = 256,
32        SECTOR_SHIFT = 9,
33        INT_LBASIZE_ALIGNMENT = 64,
34};
35
36struct nd_poison {
37        u64 start;
38        u64 length;
39        struct list_head list;
40};
41
42struct nvdimm_drvdata {
43        struct device *dev;
44        int nsindex_size;
45        struct nd_cmd_get_config_size nsarea;
46        void *data;
47        int ns_current, ns_next;
48        struct resource dpa;
49        struct kref kref;
50};
51
52struct nd_region_data {
53        int ns_count;
54        int ns_active;
55        unsigned int hints_shift;
56        void __iomem *flush_wpq[0];
57};
58
59static inline void __iomem *ndrd_get_flush_wpq(struct nd_region_data *ndrd,
60                int dimm, int hint)
61{
62        unsigned int num = 1 << ndrd->hints_shift;
63        unsigned int mask = num - 1;
64
65        return ndrd->flush_wpq[dimm * num + (hint & mask)];
66}
67
68static inline void ndrd_set_flush_wpq(struct nd_region_data *ndrd, int dimm,
69                int hint, void __iomem *flush)
70{
71        unsigned int num = 1 << ndrd->hints_shift;
72        unsigned int mask = num - 1;
73
74        ndrd->flush_wpq[dimm * num + (hint & mask)] = flush;
75}
76
77static inline struct nd_namespace_index *to_namespace_index(
78                struct nvdimm_drvdata *ndd, int i)
79{
80        if (i < 0)
81                return NULL;
82
83        return ndd->data + sizeof_namespace_index(ndd) * i;
84}
85
86static inline struct nd_namespace_index *to_current_namespace_index(
87                struct nvdimm_drvdata *ndd)
88{
89        return to_namespace_index(ndd, ndd->ns_current);
90}
91
92static inline struct nd_namespace_index *to_next_namespace_index(
93                struct nvdimm_drvdata *ndd)
94{
95        return to_namespace_index(ndd, ndd->ns_next);
96}
97
98#define nd_dbg_dpa(r, d, res, fmt, arg...) \
99        dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \
100                (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \
101                (unsigned long long) (res ? resource_size(res) : 0), \
102                (unsigned long long) (res ? res->start : 0), ##arg)
103
104#define for_each_dpa_resource(ndd, res) \
105        for (res = (ndd)->dpa.child; res; res = res->sibling)
106
107#define for_each_dpa_resource_safe(ndd, res, next) \
108        for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \
109                        res; res = next, next = next ? next->sibling : NULL)
110
111struct nd_percpu_lane {
112        int count;
113        spinlock_t lock;
114};
115
116struct nd_label_ent {
117        struct list_head list;
118        struct nd_namespace_label *label;
119};
120
121enum nd_mapping_lock_class {
122        ND_MAPPING_CLASS0,
123        ND_MAPPING_UUID_SCAN,
124};
125
126struct nd_mapping {
127        struct nvdimm *nvdimm;
128        u64 start;
129        u64 size;
130        struct list_head labels;
131        struct mutex lock;
132        /*
133         * @ndd is for private use at region enable / disable time for
134         * get_ndd() + put_ndd(), all other nd_mapping to ndd
135         * conversions use to_ndd() which respects enabled state of the
136         * nvdimm.
137         */
138        struct nvdimm_drvdata *ndd;
139};
140
141struct nd_region {
142        struct device dev;
143        struct ida ns_ida;
144        struct ida btt_ida;
145        struct ida pfn_ida;
146        struct ida dax_ida;
147        unsigned long flags;
148        struct device *ns_seed;
149        struct device *btt_seed;
150        struct device *pfn_seed;
151        struct device *dax_seed;
152        u16 ndr_mappings;
153        u64 ndr_size;
154        u64 ndr_start;
155        int id, num_lanes, ro, numa_node;
156        void *provider_data;
157        struct nd_interleave_set *nd_set;
158        struct nd_percpu_lane __percpu *lane;
159        struct nd_mapping mapping[0];
160};
161
162struct nd_blk_region {
163        int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
164        int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
165                        void *iobuf, u64 len, int rw);
166        void *blk_provider_data;
167        struct nd_region nd_region;
168};
169
170/*
171 * Lookup next in the repeating sequence of 01, 10, and 11.
172 */
173static inline unsigned nd_inc_seq(unsigned seq)
174{
175        static const unsigned next[] = { 0, 2, 3, 1 };
176
177        return next[seq & 3];
178}
179
180struct btt;
181struct nd_btt {
182        struct device dev;
183        struct nd_namespace_common *ndns;
184        struct btt *btt;
185        unsigned long lbasize;
186        u64 size;
187        u8 *uuid;
188        int id;
189};
190
191enum nd_pfn_mode {
192        PFN_MODE_NONE,
193        PFN_MODE_RAM,
194        PFN_MODE_PMEM,
195};
196
197struct nd_pfn {
198        int id;
199        u8 *uuid;
200        struct device dev;
201        unsigned long align;
202        unsigned long npfns;
203        enum nd_pfn_mode mode;
204        struct nd_pfn_sb *pfn_sb;
205        struct nd_namespace_common *ndns;
206};
207
208struct nd_dax {
209        struct nd_pfn nd_pfn;
210};
211
212enum nd_async_mode {
213        ND_SYNC,
214        ND_ASYNC,
215};
216
217int nd_integrity_init(struct gendisk *disk, unsigned long meta_size);
218void wait_nvdimm_bus_probe_idle(struct device *dev);
219void nd_device_register(struct device *dev);
220void nd_device_unregister(struct device *dev, enum nd_async_mode mode);
221void nd_device_notify(struct device *dev, enum nvdimm_event event);
222int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf,
223                size_t len);
224ssize_t nd_sector_size_show(unsigned long current_lbasize,
225                const unsigned long *supported, char *buf);
226ssize_t nd_sector_size_store(struct device *dev, const char *buf,
227                unsigned long *current_lbasize, const unsigned long *supported);
228int __init nvdimm_init(void);
229int __init nd_region_init(void);
230void nvdimm_exit(void);
231void nd_region_exit(void);
232struct nvdimm;
233struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping);
234int nvdimm_check_config_data(struct device *dev);
235int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd);
236int nvdimm_init_config_data(struct nvdimm_drvdata *ndd);
237int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset,
238                void *buf, size_t len);
239long nvdimm_clear_poison(struct device *dev, phys_addr_t phys,
240                unsigned int len);
241struct nd_btt *to_nd_btt(struct device *dev);
242
243struct nd_gen_sb {
244        char reserved[SZ_4K - 8];
245        __le64 checksum;
246};
247
248u64 nd_sb_checksum(struct nd_gen_sb *sb);
249#if IS_ENABLED(CONFIG_BTT)
250int nd_btt_probe(struct device *dev, struct nd_namespace_common *ndns);
251bool is_nd_btt(struct device *dev);
252struct device *nd_btt_create(struct nd_region *nd_region);
253#else
254static inline int nd_btt_probe(struct device *dev,
255                struct nd_namespace_common *ndns)
256{
257        return -ENODEV;
258}
259
260static inline bool is_nd_btt(struct device *dev)
261{
262        return false;
263}
264
265static inline struct device *nd_btt_create(struct nd_region *nd_region)
266{
267        return NULL;
268}
269#endif
270
271struct nd_pfn *to_nd_pfn(struct device *dev);
272#if IS_ENABLED(CONFIG_NVDIMM_PFN)
273int nd_pfn_probe(struct device *dev, struct nd_namespace_common *ndns);
274bool is_nd_pfn(struct device *dev);
275struct device *nd_pfn_create(struct nd_region *nd_region);
276struct device *nd_pfn_devinit(struct nd_pfn *nd_pfn,
277                struct nd_namespace_common *ndns);
278int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig);
279extern struct attribute_group nd_pfn_attribute_group;
280#else
281static inline int nd_pfn_probe(struct device *dev,
282                struct nd_namespace_common *ndns)
283{
284        return -ENODEV;
285}
286
287static inline bool is_nd_pfn(struct device *dev)
288{
289        return false;
290}
291
292static inline struct device *nd_pfn_create(struct nd_region *nd_region)
293{
294        return NULL;
295}
296
297static inline int nd_pfn_validate(struct nd_pfn *nd_pfn, const char *sig)
298{
299        return -ENODEV;
300}
301#endif
302
303struct nd_dax *to_nd_dax(struct device *dev);
304#if IS_ENABLED(CONFIG_NVDIMM_DAX)
305int nd_dax_probe(struct device *dev, struct nd_namespace_common *ndns);
306bool is_nd_dax(struct device *dev);
307struct device *nd_dax_create(struct nd_region *nd_region);
308#else
309static inline int nd_dax_probe(struct device *dev,
310                struct nd_namespace_common *ndns)
311{
312        return -ENODEV;
313}
314
315static inline bool is_nd_dax(struct device *dev)
316{
317        return false;
318}
319
320static inline struct device *nd_dax_create(struct nd_region *nd_region)
321{
322        return NULL;
323}
324#endif
325
326struct nd_region *to_nd_region(struct device *dev);
327int nd_region_to_nstype(struct nd_region *nd_region);
328int nd_region_register_namespaces(struct nd_region *nd_region, int *err);
329u64 nd_region_interleave_set_cookie(struct nd_region *nd_region);
330u64 nd_region_interleave_set_altcookie(struct nd_region *nd_region);
331void nvdimm_bus_lock(struct device *dev);
332void nvdimm_bus_unlock(struct device *dev);
333bool is_nvdimm_bus_locked(struct device *dev);
334int nvdimm_revalidate_disk(struct gendisk *disk);
335void nvdimm_drvdata_release(struct kref *kref);
336void put_ndd(struct nvdimm_drvdata *ndd);
337int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd);
338void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res);
339struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
340                struct nd_label_id *label_id, resource_size_t start,
341                resource_size_t n);
342resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
343struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev);
344int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns);
345int nvdimm_namespace_detach_btt(struct nd_btt *nd_btt);
346const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns,
347                char *name);
348void nvdimm_badblocks_populate(struct nd_region *nd_region,
349                struct badblocks *bb, const struct resource *res);
350#if IS_ENABLED(CONFIG_ND_CLAIM)
351struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
352                struct resource *res, struct vmem_altmap *altmap);
353int devm_nsio_enable(struct device *dev, struct nd_namespace_io *nsio);
354void devm_nsio_disable(struct device *dev, struct nd_namespace_io *nsio);
355#else
356static inline struct vmem_altmap *nvdimm_setup_pfn(struct nd_pfn *nd_pfn,
357                struct resource *res, struct vmem_altmap *altmap)
358{
359        return ERR_PTR(-ENXIO);
360}
361static inline int devm_nsio_enable(struct device *dev,
362                struct nd_namespace_io *nsio)
363{
364        return -ENXIO;
365}
366static inline void devm_nsio_disable(struct device *dev,
367                struct nd_namespace_io *nsio)
368{
369}
370#endif
371int nd_blk_region_init(struct nd_region *nd_region);
372int nd_region_activate(struct nd_region *nd_region);
373void __nd_iostat_start(struct bio *bio, unsigned long *start);
374static inline bool nd_iostat_start(struct bio *bio, unsigned long *start)
375{
376        struct gendisk *disk = bio->bi_bdev->bd_disk;
377
378        if (!blk_queue_io_stat(disk->queue))
379                return false;
380
381        __nd_iostat_start(bio, start);
382        return true;
383}
384void nd_iostat_end(struct bio *bio, unsigned long start);
385static inline bool is_bad_pmem(struct badblocks *bb, sector_t sector,
386                unsigned int len)
387{
388        if (bb->count) {
389                sector_t first_bad;
390                int num_bad;
391
392                return !!badblocks_check(bb, sector, len / 512, &first_bad,
393                                &num_bad);
394        }
395
396        return false;
397}
398resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk);
399const u8 *nd_dev_to_uuid(struct device *dev);
400bool pmem_should_map_pages(struct device *dev);
401#endif /* __ND_H__ */
Note: See TracBrowser for help on using the repository browser.