1 /* SPDX-License-Identifier: GPL-2.0-only */ <<
2 /* 1 /*
3 * Copyright(c) 2013-2015 Intel Corporation. A 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.
4 */ 12 */
5 #ifndef __LINUX_ND_H__ 13 #ifndef __LINUX_ND_H__
6 #define __LINUX_ND_H__ 14 #define __LINUX_ND_H__
7 #include <linux/fs.h> 15 #include <linux/fs.h>
8 #include <linux/ndctl.h> 16 #include <linux/ndctl.h>
9 #include <linux/device.h> 17 #include <linux/device.h>
10 #include <linux/badblocks.h> 18 #include <linux/badblocks.h>
11 #include <linux/perf_event.h> <<
12 19
13 enum nvdimm_event { 20 enum nvdimm_event {
14 NVDIMM_REVALIDATE_POISON, 21 NVDIMM_REVALIDATE_POISON,
15 NVDIMM_REVALIDATE_REGION, <<
16 }; 22 };
17 23
18 enum nvdimm_claim_class { 24 enum nvdimm_claim_class {
19 NVDIMM_CCLASS_NONE, 25 NVDIMM_CCLASS_NONE,
20 NVDIMM_CCLASS_BTT, 26 NVDIMM_CCLASS_BTT,
21 NVDIMM_CCLASS_BTT2, 27 NVDIMM_CCLASS_BTT2,
22 NVDIMM_CCLASS_PFN, 28 NVDIMM_CCLASS_PFN,
23 NVDIMM_CCLASS_DAX, 29 NVDIMM_CCLASS_DAX,
24 NVDIMM_CCLASS_UNKNOWN, 30 NVDIMM_CCLASS_UNKNOWN,
25 }; 31 };
26 32
27 #define NVDIMM_EVENT_VAR(_id) event_attr_##_i <<
28 #define NVDIMM_EVENT_PTR(_id) (&event_attr_## <<
29 <<
30 #define NVDIMM_EVENT_ATTR(_name, _id) <<
31 PMU_EVENT_ATTR(_name, NVDIMM_EVENT_VAR <<
32 nvdimm_events_sysfs_sh <<
33 <<
34 /* Event attribute array index */ <<
35 #define NVDIMM_PMU_FORMAT_ATTR 0 <<
36 #define NVDIMM_PMU_EVENT_ATTR 1 <<
37 #define NVDIMM_PMU_CPUMASK_ATTR 2 <<
38 #define NVDIMM_PMU_NULL_ATTR 3 <<
39 <<
40 /** <<
41 * struct nvdimm_pmu - data structure for nvdi <<
42 * @pmu: pmu data structure for nvdimm perform <<
43 * @dev: nvdimm device pointer. <<
44 * @cpu: designated cpu for counter access. <<
45 * @node: node for cpu hotplug notifier link. <<
46 * @cpuhp_state: state for cpu hotplug notific <<
47 * @arch_cpumask: cpumask to get designated cp <<
48 */ <<
49 struct nvdimm_pmu { <<
50 struct pmu pmu; <<
51 struct device *dev; <<
52 int cpu; <<
53 struct hlist_node node; <<
54 enum cpuhp_state cpuhp_state; <<
55 /* cpumask provided by arch/platform s <<
56 struct cpumask arch_cpumask; <<
57 }; <<
58 <<
59 struct platform_device; <<
60 <<
61 #ifdef CONFIG_PERF_EVENTS <<
62 extern ssize_t nvdimm_events_sysfs_show(struct <<
63 struct <<
64 char * <<
65 <<
66 int register_nvdimm_pmu(struct nvdimm_pmu *nvd <<
67 void unregister_nvdimm_pmu(struct nvdimm_pmu * <<
68 <<
69 #else <<
70 static inline int register_nvdimm_pmu(struct n <<
71 { <<
72 return -ENXIO; <<
73 } <<
74 <<
75 static inline void unregister_nvdimm_pmu(struc <<
76 #endif <<
77 <<
78 struct nd_device_driver { 33 struct nd_device_driver {
79 struct device_driver drv; 34 struct device_driver drv;
80 unsigned long type; 35 unsigned long type;
81 int (*probe)(struct device *dev); 36 int (*probe)(struct device *dev);
82 void (*remove)(struct device *dev); !! 37 int (*remove)(struct device *dev);
83 void (*shutdown)(struct device *dev); 38 void (*shutdown)(struct device *dev);
84 void (*notify)(struct device *dev, enu 39 void (*notify)(struct device *dev, enum nvdimm_event event);
85 }; 40 };
86 41
87 #define to_nd_device_driver(__drv) contai !! 42 static inline struct nd_device_driver *to_nd_device_driver(
>> 43 struct device_driver *drv)
>> 44 {
>> 45 return container_of(drv, struct nd_device_driver, drv);
>> 46 };
88 47
89 /** 48 /**
90 * struct nd_namespace_common - core infrastru 49 * struct nd_namespace_common - core infrastructure of a namespace
91 * @force_raw: ignore other personalities for 50 * @force_raw: ignore other personalities for the namespace (e.g. btt)
92 * @dev: device model node 51 * @dev: device model node
93 * @claim: when set a another personality has 52 * @claim: when set a another personality has taken ownership of the namespace
94 * @claim_class: restrict claim type to a give 53 * @claim_class: restrict claim type to a given class
95 * @rw_bytes: access the raw namespace capacit 54 * @rw_bytes: access the raw namespace capacity with byte-aligned transfers
96 */ 55 */
97 struct nd_namespace_common { 56 struct nd_namespace_common {
98 int force_raw; 57 int force_raw;
99 struct device dev; 58 struct device dev;
100 struct device *claim; 59 struct device *claim;
101 enum nvdimm_claim_class claim_class; 60 enum nvdimm_claim_class claim_class;
102 int (*rw_bytes)(struct nd_namespace_co 61 int (*rw_bytes)(struct nd_namespace_common *, resource_size_t offset,
103 void *buf, size_t size 62 void *buf, size_t size, int rw, unsigned long flags);
104 }; 63 };
105 64
106 static inline struct nd_namespace_common *to_n 65 static inline struct nd_namespace_common *to_ndns(struct device *dev)
107 { 66 {
108 return container_of(dev, struct nd_nam 67 return container_of(dev, struct nd_namespace_common, dev);
109 } 68 }
110 69
111 /** 70 /**
112 * struct nd_namespace_io - device representat 71 * struct nd_namespace_io - device representation of a persistent memory range
113 * @dev: namespace device created by the nd re 72 * @dev: namespace device created by the nd region driver
114 * @res: struct resource conversion of a NFIT 73 * @res: struct resource conversion of a NFIT SPA table
115 * @size: cached resource_size(@res) for fast 74 * @size: cached resource_size(@res) for fast path size checks
116 * @addr: virtual address to access the namesp 75 * @addr: virtual address to access the namespace range
117 * @bb: badblocks list for the namespace range 76 * @bb: badblocks list for the namespace range
118 */ 77 */
119 struct nd_namespace_io { 78 struct nd_namespace_io {
120 struct nd_namespace_common common; 79 struct nd_namespace_common common;
121 struct resource res; 80 struct resource res;
122 resource_size_t size; 81 resource_size_t size;
123 void *addr; 82 void *addr;
124 struct badblocks bb; 83 struct badblocks bb;
125 }; 84 };
126 85
127 /** 86 /**
128 * struct nd_namespace_pmem - namespace device 87 * struct nd_namespace_pmem - namespace device for dimm-backed interleaved memory
129 * @nsio: device and system physical address r 88 * @nsio: device and system physical address range to drive
130 * @lbasize: logical sector size for the names 89 * @lbasize: logical sector size for the namespace in block-device-mode
131 * @alt_name: namespace name supplied in the d 90 * @alt_name: namespace name supplied in the dimm label
132 * @uuid: namespace name supplied in the dimm 91 * @uuid: namespace name supplied in the dimm label
133 * @id: ida allocated id 92 * @id: ida allocated id
134 */ 93 */
135 struct nd_namespace_pmem { 94 struct nd_namespace_pmem {
136 struct nd_namespace_io nsio; 95 struct nd_namespace_io nsio;
137 unsigned long lbasize; 96 unsigned long lbasize;
138 char *alt_name; 97 char *alt_name;
139 uuid_t *uuid; !! 98 u8 *uuid;
140 int id; 99 int id;
141 }; 100 };
142 101
>> 102 /**
>> 103 * struct nd_namespace_blk - namespace for dimm-bounded persistent memory
>> 104 * @alt_name: namespace name supplied in the dimm label
>> 105 * @uuid: namespace name supplied in the dimm label
>> 106 * @id: ida allocated id
>> 107 * @lbasize: blk namespaces have a native sector size when btt not present
>> 108 * @size: sum of all the resource ranges allocated to this namespace
>> 109 * @num_resources: number of dpa extents to claim
>> 110 * @res: discontiguous dpa extents for given dimm
>> 111 */
>> 112 struct nd_namespace_blk {
>> 113 struct nd_namespace_common common;
>> 114 char *alt_name;
>> 115 u8 *uuid;
>> 116 int id;
>> 117 unsigned long lbasize;
>> 118 resource_size_t size;
>> 119 int num_resources;
>> 120 struct resource **res;
>> 121 };
>> 122
143 static inline struct nd_namespace_io *to_nd_na 123 static inline struct nd_namespace_io *to_nd_namespace_io(const struct device *dev)
144 { 124 {
145 return container_of(dev, struct nd_nam 125 return container_of(dev, struct nd_namespace_io, common.dev);
146 } 126 }
147 127
148 static inline struct nd_namespace_pmem *to_nd_ 128 static inline struct nd_namespace_pmem *to_nd_namespace_pmem(const struct device *dev)
149 { 129 {
150 struct nd_namespace_io *nsio = to_nd_n 130 struct nd_namespace_io *nsio = to_nd_namespace_io(dev);
151 131
152 return container_of(nsio, struct nd_na 132 return container_of(nsio, struct nd_namespace_pmem, nsio);
153 } 133 }
154 134
>> 135 static inline struct nd_namespace_blk *to_nd_namespace_blk(const struct device *dev)
>> 136 {
>> 137 return container_of(dev, struct nd_namespace_blk, common.dev);
>> 138 }
>> 139
155 /** 140 /**
156 * nvdimm_read_bytes() - synchronously read by 141 * nvdimm_read_bytes() - synchronously read bytes from an nvdimm namespace
157 * @ndns: device to read 142 * @ndns: device to read
158 * @offset: namespace-relative starting offset 143 * @offset: namespace-relative starting offset
159 * @buf: buffer to fill 144 * @buf: buffer to fill
160 * @size: transfer length 145 * @size: transfer length
161 * 146 *
162 * @buf is up-to-date upon return from this ro 147 * @buf is up-to-date upon return from this routine.
163 */ 148 */
164 static inline int nvdimm_read_bytes(struct nd_ 149 static inline int nvdimm_read_bytes(struct nd_namespace_common *ndns,
165 resource_size_t offset, void * 150 resource_size_t offset, void *buf, size_t size,
166 unsigned long flags) 151 unsigned long flags)
167 { 152 {
168 return ndns->rw_bytes(ndns, offset, bu 153 return ndns->rw_bytes(ndns, offset, buf, size, READ, flags);
169 } 154 }
170 155
171 /** 156 /**
172 * nvdimm_write_bytes() - synchronously write 157 * nvdimm_write_bytes() - synchronously write bytes to an nvdimm namespace
173 * @ndns: device to write !! 158 * @ndns: device to read
174 * @offset: namespace-relative starting offset 159 * @offset: namespace-relative starting offset
175 * @buf: buffer to drain 160 * @buf: buffer to drain
176 * @size: transfer length 161 * @size: transfer length
177 * 162 *
178 * NVDIMM Namepaces disks do not implement sec 163 * NVDIMM Namepaces disks do not implement sectors internally. Depending on
179 * the @ndns, the contents of @buf may be in c 164 * the @ndns, the contents of @buf may be in cpu cache, platform buffers,
180 * or on backing memory media upon return from 165 * or on backing memory media upon return from this routine. Flushing
181 * to media is handled internal to the @ndns d 166 * to media is handled internal to the @ndns driver, if at all.
182 */ 167 */
183 static inline int nvdimm_write_bytes(struct nd 168 static inline int nvdimm_write_bytes(struct nd_namespace_common *ndns,
184 resource_size_t offset, void * 169 resource_size_t offset, void *buf, size_t size,
185 unsigned long flags) 170 unsigned long flags)
186 { 171 {
187 return ndns->rw_bytes(ndns, offset, bu 172 return ndns->rw_bytes(ndns, offset, buf, size, WRITE, flags);
188 } 173 }
189 174
190 #define MODULE_ALIAS_ND_DEVICE(type) \ 175 #define MODULE_ALIAS_ND_DEVICE(type) \
191 MODULE_ALIAS("nd:t" __stringify(type) 176 MODULE_ALIAS("nd:t" __stringify(type) "*")
192 #define ND_DEVICE_MODALIAS_FMT "nd:t%d" 177 #define ND_DEVICE_MODALIAS_FMT "nd:t%d"
193 178
194 struct nd_region; 179 struct nd_region;
195 void nvdimm_region_notify(struct nd_region *nd 180 void nvdimm_region_notify(struct nd_region *nd_region, enum nvdimm_event event);
196 int __must_check __nd_driver_register(struct n 181 int __must_check __nd_driver_register(struct nd_device_driver *nd_drv,
197 struct module *module, const c 182 struct module *module, const char *mod_name);
198 static inline void nd_driver_unregister(struct 183 static inline void nd_driver_unregister(struct nd_device_driver *drv)
199 { 184 {
200 driver_unregister(&drv->drv); 185 driver_unregister(&drv->drv);
201 } 186 }
202 #define nd_driver_register(driver) \ 187 #define nd_driver_register(driver) \
203 __nd_driver_register(driver, THIS_MODU 188 __nd_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
204 #define module_nd_driver(driver) \ 189 #define module_nd_driver(driver) \
205 module_driver(driver, nd_driver_regist 190 module_driver(driver, nd_driver_register, nd_driver_unregister)
206 #endif /* __LINUX_ND_H__ */ 191 #endif /* __LINUX_ND_H__ */
207 192
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.