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