Commit | Line | Data |
---|---|---|
4d88a97a DW |
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__ | |
1f7df6f8 | 15 | #include <linux/libnvdimm.h> |
4d88a97a DW |
16 | #include <linux/device.h> |
17 | #include <linux/mutex.h> | |
18 | #include <linux/ndctl.h> | |
bf9bccc1 | 19 | #include <linux/types.h> |
4a826c83 | 20 | #include "label.h" |
4d88a97a | 21 | |
8c2f7e86 | 22 | enum { |
5212e11f VV |
23 | /* |
24 | * Limits the maximum number of block apertures a dimm can | |
25 | * support and is an input to the geometry/on-disk-format of a | |
26 | * BTT instance | |
27 | */ | |
28 | ND_MAX_LANES = 256, | |
8c2f7e86 DW |
29 | SECTOR_SHIFT = 9, |
30 | }; | |
31 | ||
4d88a97a DW |
32 | struct nvdimm_drvdata { |
33 | struct device *dev; | |
4a826c83 | 34 | int nsindex_size; |
4d88a97a DW |
35 | struct nd_cmd_get_config_size nsarea; |
36 | void *data; | |
4a826c83 DW |
37 | int ns_current, ns_next; |
38 | struct resource dpa; | |
bf9bccc1 | 39 | struct kref kref; |
4d88a97a DW |
40 | }; |
41 | ||
3d88002e DW |
42 | struct nd_region_namespaces { |
43 | int count; | |
44 | int active; | |
45 | }; | |
46 | ||
4a826c83 DW |
47 | static inline struct nd_namespace_index *to_namespace_index( |
48 | struct nvdimm_drvdata *ndd, int i) | |
49 | { | |
50 | if (i < 0) | |
51 | return NULL; | |
52 | ||
53 | return ndd->data + sizeof_namespace_index(ndd) * i; | |
54 | } | |
55 | ||
56 | static inline struct nd_namespace_index *to_current_namespace_index( | |
57 | struct nvdimm_drvdata *ndd) | |
58 | { | |
59 | return to_namespace_index(ndd, ndd->ns_current); | |
60 | } | |
61 | ||
62 | static inline struct nd_namespace_index *to_next_namespace_index( | |
63 | struct nvdimm_drvdata *ndd) | |
64 | { | |
65 | return to_namespace_index(ndd, ndd->ns_next); | |
66 | } | |
67 | ||
68 | #define nd_dbg_dpa(r, d, res, fmt, arg...) \ | |
69 | dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \ | |
70 | (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \ | |
71 | (unsigned long long) (res ? resource_size(res) : 0), \ | |
72 | (unsigned long long) (res ? res->start : 0), ##arg) | |
73 | ||
bf9bccc1 DW |
74 | #define for_each_label(l, label, labels) \ |
75 | for (l = 0; (label = labels ? labels[l] : NULL); l++) | |
76 | ||
77 | #define for_each_dpa_resource(ndd, res) \ | |
78 | for (res = (ndd)->dpa.child; res; res = res->sibling) | |
79 | ||
4a826c83 DW |
80 | #define for_each_dpa_resource_safe(ndd, res, next) \ |
81 | for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \ | |
82 | res; res = next, next = next ? next->sibling : NULL) | |
83 | ||
5212e11f VV |
84 | struct nd_percpu_lane { |
85 | int count; | |
86 | spinlock_t lock; | |
87 | }; | |
88 | ||
1f7df6f8 DW |
89 | struct nd_region { |
90 | struct device dev; | |
1b40e09a | 91 | struct ida ns_ida; |
8c2f7e86 | 92 | struct ida btt_ida; |
bf9bccc1 | 93 | struct device *ns_seed; |
8c2f7e86 | 94 | struct device *btt_seed; |
1f7df6f8 DW |
95 | u16 ndr_mappings; |
96 | u64 ndr_size; | |
97 | u64 ndr_start; | |
5212e11f | 98 | int id, num_lanes; |
1f7df6f8 | 99 | void *provider_data; |
eaf96153 | 100 | struct nd_interleave_set *nd_set; |
5212e11f | 101 | struct nd_percpu_lane __percpu *lane; |
1f7df6f8 DW |
102 | struct nd_mapping mapping[0]; |
103 | }; | |
104 | ||
047fc8a1 RZ |
105 | struct nd_blk_region { |
106 | int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); | |
107 | void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); | |
108 | int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, | |
109 | void *iobuf, u64 len, int rw); | |
110 | void *blk_provider_data; | |
111 | struct nd_region nd_region; | |
112 | }; | |
113 | ||
4a826c83 DW |
114 | /* |
115 | * Lookup next in the repeating sequence of 01, 10, and 11. | |
116 | */ | |
117 | static inline unsigned nd_inc_seq(unsigned seq) | |
118 | { | |
119 | static const unsigned next[] = { 0, 2, 3, 1 }; | |
120 | ||
121 | return next[seq & 3]; | |
122 | } | |
f524bf27 | 123 | |
5212e11f | 124 | struct btt; |
8c2f7e86 DW |
125 | struct nd_btt { |
126 | struct device dev; | |
127 | struct nd_namespace_common *ndns; | |
5212e11f | 128 | struct btt *btt; |
8c2f7e86 DW |
129 | unsigned long lbasize; |
130 | u8 *uuid; | |
131 | int id; | |
132 | }; | |
133 | ||
4d88a97a DW |
134 | enum nd_async_mode { |
135 | ND_SYNC, | |
136 | ND_ASYNC, | |
137 | }; | |
138 | ||
41cd8b70 | 139 | int nd_integrity_init(struct gendisk *disk, unsigned long meta_size); |
bf9bccc1 | 140 | void wait_nvdimm_bus_probe_idle(struct device *dev); |
4d88a97a DW |
141 | void nd_device_register(struct device *dev); |
142 | void nd_device_unregister(struct device *dev, enum nd_async_mode mode); | |
bf9bccc1 DW |
143 | int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, |
144 | size_t len); | |
1b40e09a DW |
145 | ssize_t nd_sector_size_show(unsigned long current_lbasize, |
146 | const unsigned long *supported, char *buf); | |
147 | ssize_t nd_sector_size_store(struct device *dev, const char *buf, | |
148 | unsigned long *current_lbasize, const unsigned long *supported); | |
4d88a97a | 149 | int __init nvdimm_init(void); |
3d88002e | 150 | int __init nd_region_init(void); |
4d88a97a | 151 | void nvdimm_exit(void); |
3d88002e | 152 | void nd_region_exit(void); |
bf9bccc1 DW |
153 | struct nvdimm; |
154 | struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); | |
4d88a97a DW |
155 | int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); |
156 | int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); | |
f524bf27 DW |
157 | int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, |
158 | void *buf, size_t len); | |
8c2f7e86 DW |
159 | struct nd_btt *to_nd_btt(struct device *dev); |
160 | struct btt_sb; | |
161 | u64 nd_btt_sb_checksum(struct btt_sb *btt_sb); | |
162 | #if IS_ENABLED(CONFIG_BTT) | |
163 | int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata); | |
164 | bool is_nd_btt(struct device *dev); | |
165 | struct device *nd_btt_create(struct nd_region *nd_region); | |
166 | #else | |
167 | static inline nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata) | |
168 | { | |
169 | return -ENODEV; | |
170 | } | |
171 | ||
172 | static inline bool is_nd_btt(struct device *dev) | |
173 | { | |
174 | return false; | |
175 | } | |
176 | ||
177 | static inline struct device *nd_btt_create(struct nd_region *nd_region) | |
178 | { | |
179 | return NULL; | |
180 | } | |
181 | ||
182 | #endif | |
3d88002e DW |
183 | struct nd_region *to_nd_region(struct device *dev); |
184 | int nd_region_to_nstype(struct nd_region *nd_region); | |
185 | int nd_region_register_namespaces(struct nd_region *nd_region, int *err); | |
bf9bccc1 | 186 | u64 nd_region_interleave_set_cookie(struct nd_region *nd_region); |
3d88002e DW |
187 | void nvdimm_bus_lock(struct device *dev); |
188 | void nvdimm_bus_unlock(struct device *dev); | |
189 | bool is_nvdimm_bus_locked(struct device *dev); | |
bf9bccc1 DW |
190 | void nvdimm_drvdata_release(struct kref *kref); |
191 | void put_ndd(struct nvdimm_drvdata *ndd); | |
4a826c83 DW |
192 | int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd); |
193 | void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res); | |
194 | struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, | |
195 | struct nd_label_id *label_id, resource_size_t start, | |
196 | resource_size_t n); | |
8c2f7e86 DW |
197 | resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); |
198 | struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); | |
5212e11f VV |
199 | int nvdimm_namespace_attach_btt(struct nd_namespace_common *ndns); |
200 | int nvdimm_namespace_detach_btt(struct nd_namespace_common *ndns); | |
201 | const char *nvdimm_namespace_disk_name(struct nd_namespace_common *ndns, | |
202 | char *name); | |
047fc8a1 RZ |
203 | int nd_blk_region_init(struct nd_region *nd_region); |
204 | resource_size_t nd_namespace_blk_validate(struct nd_namespace_blk *nsblk); | |
4d88a97a | 205 | #endif /* __ND_H__ */ |