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 DW |
22 | enum { |
23 | SECTOR_SHIFT = 9, | |
24 | }; | |
25 | ||
4d88a97a DW |
26 | struct nvdimm_drvdata { |
27 | struct device *dev; | |
4a826c83 | 28 | int nsindex_size; |
4d88a97a DW |
29 | struct nd_cmd_get_config_size nsarea; |
30 | void *data; | |
4a826c83 DW |
31 | int ns_current, ns_next; |
32 | struct resource dpa; | |
bf9bccc1 | 33 | struct kref kref; |
4d88a97a DW |
34 | }; |
35 | ||
3d88002e DW |
36 | struct nd_region_namespaces { |
37 | int count; | |
38 | int active; | |
39 | }; | |
40 | ||
4a826c83 DW |
41 | static inline struct nd_namespace_index *to_namespace_index( |
42 | struct nvdimm_drvdata *ndd, int i) | |
43 | { | |
44 | if (i < 0) | |
45 | return NULL; | |
46 | ||
47 | return ndd->data + sizeof_namespace_index(ndd) * i; | |
48 | } | |
49 | ||
50 | static inline struct nd_namespace_index *to_current_namespace_index( | |
51 | struct nvdimm_drvdata *ndd) | |
52 | { | |
53 | return to_namespace_index(ndd, ndd->ns_current); | |
54 | } | |
55 | ||
56 | static inline struct nd_namespace_index *to_next_namespace_index( | |
57 | struct nvdimm_drvdata *ndd) | |
58 | { | |
59 | return to_namespace_index(ndd, ndd->ns_next); | |
60 | } | |
61 | ||
62 | #define nd_dbg_dpa(r, d, res, fmt, arg...) \ | |
63 | dev_dbg((r) ? &(r)->dev : (d)->dev, "%s: %.13s: %#llx @ %#llx " fmt, \ | |
64 | (r) ? dev_name((d)->dev) : "", res ? res->name : "null", \ | |
65 | (unsigned long long) (res ? resource_size(res) : 0), \ | |
66 | (unsigned long long) (res ? res->start : 0), ##arg) | |
67 | ||
bf9bccc1 DW |
68 | #define for_each_label(l, label, labels) \ |
69 | for (l = 0; (label = labels ? labels[l] : NULL); l++) | |
70 | ||
71 | #define for_each_dpa_resource(ndd, res) \ | |
72 | for (res = (ndd)->dpa.child; res; res = res->sibling) | |
73 | ||
4a826c83 DW |
74 | #define for_each_dpa_resource_safe(ndd, res, next) \ |
75 | for (res = (ndd)->dpa.child, next = res ? res->sibling : NULL; \ | |
76 | res; res = next, next = next ? next->sibling : NULL) | |
77 | ||
1f7df6f8 DW |
78 | struct nd_region { |
79 | struct device dev; | |
1b40e09a | 80 | struct ida ns_ida; |
8c2f7e86 | 81 | struct ida btt_ida; |
bf9bccc1 | 82 | struct device *ns_seed; |
8c2f7e86 | 83 | struct device *btt_seed; |
1f7df6f8 DW |
84 | u16 ndr_mappings; |
85 | u64 ndr_size; | |
86 | u64 ndr_start; | |
87 | int id; | |
88 | void *provider_data; | |
eaf96153 | 89 | struct nd_interleave_set *nd_set; |
1f7df6f8 DW |
90 | struct nd_mapping mapping[0]; |
91 | }; | |
92 | ||
4a826c83 DW |
93 | /* |
94 | * Lookup next in the repeating sequence of 01, 10, and 11. | |
95 | */ | |
96 | static inline unsigned nd_inc_seq(unsigned seq) | |
97 | { | |
98 | static const unsigned next[] = { 0, 2, 3, 1 }; | |
99 | ||
100 | return next[seq & 3]; | |
101 | } | |
f524bf27 | 102 | |
8c2f7e86 DW |
103 | struct nd_btt { |
104 | struct device dev; | |
105 | struct nd_namespace_common *ndns; | |
106 | unsigned long lbasize; | |
107 | u8 *uuid; | |
108 | int id; | |
109 | }; | |
110 | ||
4d88a97a DW |
111 | enum nd_async_mode { |
112 | ND_SYNC, | |
113 | ND_ASYNC, | |
114 | }; | |
115 | ||
bf9bccc1 | 116 | void wait_nvdimm_bus_probe_idle(struct device *dev); |
4d88a97a DW |
117 | void nd_device_register(struct device *dev); |
118 | void nd_device_unregister(struct device *dev, enum nd_async_mode mode); | |
bf9bccc1 DW |
119 | int nd_uuid_store(struct device *dev, u8 **uuid_out, const char *buf, |
120 | size_t len); | |
1b40e09a DW |
121 | ssize_t nd_sector_size_show(unsigned long current_lbasize, |
122 | const unsigned long *supported, char *buf); | |
123 | ssize_t nd_sector_size_store(struct device *dev, const char *buf, | |
124 | unsigned long *current_lbasize, const unsigned long *supported); | |
4d88a97a | 125 | int __init nvdimm_init(void); |
3d88002e | 126 | int __init nd_region_init(void); |
4d88a97a | 127 | void nvdimm_exit(void); |
3d88002e | 128 | void nd_region_exit(void); |
bf9bccc1 DW |
129 | struct nvdimm; |
130 | struct nvdimm_drvdata *to_ndd(struct nd_mapping *nd_mapping); | |
4d88a97a DW |
131 | int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd); |
132 | int nvdimm_init_config_data(struct nvdimm_drvdata *ndd); | |
f524bf27 DW |
133 | int nvdimm_set_config_data(struct nvdimm_drvdata *ndd, size_t offset, |
134 | void *buf, size_t len); | |
8c2f7e86 DW |
135 | struct nd_btt *to_nd_btt(struct device *dev); |
136 | struct btt_sb; | |
137 | u64 nd_btt_sb_checksum(struct btt_sb *btt_sb); | |
138 | #if IS_ENABLED(CONFIG_BTT) | |
139 | int nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata); | |
140 | bool is_nd_btt(struct device *dev); | |
141 | struct device *nd_btt_create(struct nd_region *nd_region); | |
142 | #else | |
143 | static inline nd_btt_probe(struct nd_namespace_common *ndns, void *drvdata) | |
144 | { | |
145 | return -ENODEV; | |
146 | } | |
147 | ||
148 | static inline bool is_nd_btt(struct device *dev) | |
149 | { | |
150 | return false; | |
151 | } | |
152 | ||
153 | static inline struct device *nd_btt_create(struct nd_region *nd_region) | |
154 | { | |
155 | return NULL; | |
156 | } | |
157 | ||
158 | #endif | |
3d88002e DW |
159 | struct nd_region *to_nd_region(struct device *dev); |
160 | int nd_region_to_nstype(struct nd_region *nd_region); | |
161 | int nd_region_register_namespaces(struct nd_region *nd_region, int *err); | |
bf9bccc1 | 162 | u64 nd_region_interleave_set_cookie(struct nd_region *nd_region); |
3d88002e DW |
163 | void nvdimm_bus_lock(struct device *dev); |
164 | void nvdimm_bus_unlock(struct device *dev); | |
165 | bool is_nvdimm_bus_locked(struct device *dev); | |
bf9bccc1 DW |
166 | void nvdimm_drvdata_release(struct kref *kref); |
167 | void put_ndd(struct nvdimm_drvdata *ndd); | |
4a826c83 DW |
168 | int nd_label_reserve_dpa(struct nvdimm_drvdata *ndd); |
169 | void nvdimm_free_dpa(struct nvdimm_drvdata *ndd, struct resource *res); | |
170 | struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd, | |
171 | struct nd_label_id *label_id, resource_size_t start, | |
172 | resource_size_t n); | |
8c2f7e86 DW |
173 | resource_size_t nvdimm_namespace_capacity(struct nd_namespace_common *ndns); |
174 | struct nd_namespace_common *nvdimm_namespace_common_probe(struct device *dev); | |
4d88a97a | 175 | #endif /* __ND_H__ */ |