15b497af4SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
24d88a97aSDan Williams /*
34d88a97aSDan Williams * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
44d88a97aSDan Williams */
54d88a97aSDan Williams #ifndef __LINUX_ND_H__
64d88a97aSDan Williams #define __LINUX_ND_H__
78c2f7e86SDan Williams #include <linux/fs.h>
84d88a97aSDan Williams #include <linux/ndctl.h>
94d88a97aSDan Williams #include <linux/device.h>
10200c79daSDan Williams #include <linux/badblocks.h>
119a61d083SKajol Jain #include <linux/perf_event.h>
124d88a97aSDan Williams
1371999466SDan Williams enum nvdimm_event {
1471999466SDan Williams NVDIMM_REVALIDATE_POISON,
152361db89SDan Williams NVDIMM_REVALIDATE_REGION,
1671999466SDan Williams };
1771999466SDan Williams
18b3fde74eSDan Williams enum nvdimm_claim_class {
19b3fde74eSDan Williams NVDIMM_CCLASS_NONE,
20b3fde74eSDan Williams NVDIMM_CCLASS_BTT,
2114e49454SVishal Verma NVDIMM_CCLASS_BTT2,
22b3fde74eSDan Williams NVDIMM_CCLASS_PFN,
23b3fde74eSDan Williams NVDIMM_CCLASS_DAX,
24b3fde74eSDan Williams NVDIMM_CCLASS_UNKNOWN,
25b3fde74eSDan Williams };
26b3fde74eSDan Williams
270fab1ba6SKajol Jain #define NVDIMM_EVENT_VAR(_id) event_attr_##_id
280fab1ba6SKajol Jain #define NVDIMM_EVENT_PTR(_id) (&event_attr_##_id.attr.attr)
290fab1ba6SKajol Jain
300fab1ba6SKajol Jain #define NVDIMM_EVENT_ATTR(_name, _id) \
310fab1ba6SKajol Jain PMU_EVENT_ATTR(_name, NVDIMM_EVENT_VAR(_id), _id, \
320fab1ba6SKajol Jain nvdimm_events_sysfs_show)
330fab1ba6SKajol Jain
340fab1ba6SKajol Jain /* Event attribute array index */
350fab1ba6SKajol Jain #define NVDIMM_PMU_FORMAT_ATTR 0
360fab1ba6SKajol Jain #define NVDIMM_PMU_EVENT_ATTR 1
370fab1ba6SKajol Jain #define NVDIMM_PMU_CPUMASK_ATTR 2
380fab1ba6SKajol Jain #define NVDIMM_PMU_NULL_ATTR 3
390fab1ba6SKajol Jain
409a61d083SKajol Jain /**
419a61d083SKajol Jain * struct nvdimm_pmu - data structure for nvdimm perf driver
429a61d083SKajol Jain * @pmu: pmu data structure for nvdimm performance stats.
439a61d083SKajol Jain * @dev: nvdimm device pointer.
449a61d083SKajol Jain * @cpu: designated cpu for counter access.
459a61d083SKajol Jain * @node: node for cpu hotplug notifier link.
469a61d083SKajol Jain * @cpuhp_state: state for cpu hotplug notification.
479a61d083SKajol Jain * @arch_cpumask: cpumask to get designated cpu for counter access.
489a61d083SKajol Jain */
499a61d083SKajol Jain struct nvdimm_pmu {
509a61d083SKajol Jain struct pmu pmu;
519a61d083SKajol Jain struct device *dev;
529a61d083SKajol Jain int cpu;
539a61d083SKajol Jain struct hlist_node node;
549a61d083SKajol Jain enum cpuhp_state cpuhp_state;
559a61d083SKajol Jain /* cpumask provided by arch/platform specific code */
569a61d083SKajol Jain struct cpumask arch_cpumask;
579a61d083SKajol Jain };
589a61d083SKajol Jain
59*de7a9e94SKajol Jain struct platform_device;
60*de7a9e94SKajol Jain
61*de7a9e94SKajol Jain #ifdef CONFIG_PERF_EVENTS
620fab1ba6SKajol Jain extern ssize_t nvdimm_events_sysfs_show(struct device *dev,
630fab1ba6SKajol Jain struct device_attribute *attr,
640fab1ba6SKajol Jain char *page);
650fab1ba6SKajol Jain
660fab1ba6SKajol Jain int register_nvdimm_pmu(struct nvdimm_pmu *nvdimm, struct platform_device *pdev);
670fab1ba6SKajol Jain void unregister_nvdimm_pmu(struct nvdimm_pmu *nd_pmu);
68*de7a9e94SKajol Jain
69*de7a9e94SKajol Jain #else
register_nvdimm_pmu(struct nvdimm_pmu * nvdimm,struct platform_device * pdev)70*de7a9e94SKajol Jain static inline int register_nvdimm_pmu(struct nvdimm_pmu *nvdimm, struct platform_device *pdev)
71*de7a9e94SKajol Jain {
72*de7a9e94SKajol Jain return -ENXIO;
73*de7a9e94SKajol Jain }
74*de7a9e94SKajol Jain
unregister_nvdimm_pmu(struct nvdimm_pmu * nd_pmu)75*de7a9e94SKajol Jain static inline void unregister_nvdimm_pmu(struct nvdimm_pmu *nd_pmu) { }
76*de7a9e94SKajol Jain #endif
770fab1ba6SKajol Jain
784d88a97aSDan Williams struct nd_device_driver {
794d88a97aSDan Williams struct device_driver drv;
804d88a97aSDan Williams unsigned long type;
814d88a97aSDan Williams int (*probe)(struct device *dev);
821f975074SUwe Kleine-König void (*remove)(struct device *dev);
83476f848aSDan Williams void (*shutdown)(struct device *dev);
8471999466SDan Williams void (*notify)(struct device *dev, enum nvdimm_event event);
854d88a97aSDan Williams };
864d88a97aSDan Williams
to_nd_device_driver(struct device_driver * drv)874d88a97aSDan Williams static inline struct nd_device_driver *to_nd_device_driver(
884d88a97aSDan Williams struct device_driver *drv)
894d88a97aSDan Williams {
904d88a97aSDan Williams return container_of(drv, struct nd_device_driver, drv);
913d88002eSDan Williams };
923d88002eSDan Williams
93bf9bccc1SDan Williams /**
948c2f7e86SDan Williams * struct nd_namespace_common - core infrastructure of a namespace
958c2f7e86SDan Williams * @force_raw: ignore other personalities for the namespace (e.g. btt)
968c2f7e86SDan Williams * @dev: device model node
978c2f7e86SDan Williams * @claim: when set a another personality has taken ownership of the namespace
98b3fde74eSDan Williams * @claim_class: restrict claim type to a given class
998c2f7e86SDan Williams * @rw_bytes: access the raw namespace capacity with byte-aligned transfers
1008c2f7e86SDan Williams */
1018c2f7e86SDan Williams struct nd_namespace_common {
1028c2f7e86SDan Williams int force_raw;
1038c2f7e86SDan Williams struct device dev;
1048c2f7e86SDan Williams struct device *claim;
105b3fde74eSDan Williams enum nvdimm_claim_class claim_class;
1068c2f7e86SDan Williams int (*rw_bytes)(struct nd_namespace_common *, resource_size_t offset,
1073ae3d67bSVishal Verma void *buf, size_t size, int rw, unsigned long flags);
1088c2f7e86SDan Williams };
1098c2f7e86SDan Williams
to_ndns(struct device * dev)1108c2f7e86SDan Williams static inline struct nd_namespace_common *to_ndns(struct device *dev)
1118c2f7e86SDan Williams {
1128c2f7e86SDan Williams return container_of(dev, struct nd_namespace_common, dev);
1138c2f7e86SDan Williams }
1148c2f7e86SDan Williams
1158c2f7e86SDan Williams /**
116200c79daSDan Williams * struct nd_namespace_io - device representation of a persistent memory range
117bf9bccc1SDan Williams * @dev: namespace device created by the nd region driver
118bf9bccc1SDan Williams * @res: struct resource conversion of a NFIT SPA table
119200c79daSDan Williams * @size: cached resource_size(@res) for fast path size checks
120200c79daSDan Williams * @addr: virtual address to access the namespace range
121200c79daSDan Williams * @bb: badblocks list for the namespace range
122bf9bccc1SDan Williams */
1233d88002eSDan Williams struct nd_namespace_io {
1248c2f7e86SDan Williams struct nd_namespace_common common;
1253d88002eSDan Williams struct resource res;
126200c79daSDan Williams resource_size_t size;
1277a9eb206SDan Williams void *addr;
128200c79daSDan Williams struct badblocks bb;
1293d88002eSDan Williams };
1303d88002eSDan Williams
131bf9bccc1SDan Williams /**
132bf9bccc1SDan Williams * struct nd_namespace_pmem - namespace device for dimm-backed interleaved memory
133bf9bccc1SDan Williams * @nsio: device and system physical address range to drive
134f979b13cSDan Williams * @lbasize: logical sector size for the namespace in block-device-mode
135bf9bccc1SDan Williams * @alt_name: namespace name supplied in the dimm label
136bf9bccc1SDan Williams * @uuid: namespace name supplied in the dimm label
1370e3b0d12SDan Williams * @id: ida allocated id
138bf9bccc1SDan Williams */
139bf9bccc1SDan Williams struct nd_namespace_pmem {
140bf9bccc1SDan Williams struct nd_namespace_io nsio;
141f979b13cSDan Williams unsigned long lbasize;
142bf9bccc1SDan Williams char *alt_name;
143d1c6e08eSDan Williams uuid_t *uuid;
1440e3b0d12SDan Williams int id;
145bf9bccc1SDan Williams };
146bf9bccc1SDan Williams
to_nd_namespace_io(const struct device * dev)1476ff3e912SDan Williams static inline struct nd_namespace_io *to_nd_namespace_io(const struct device *dev)
1483d88002eSDan Williams {
1498c2f7e86SDan Williams return container_of(dev, struct nd_namespace_io, common.dev);
1504d88a97aSDan Williams }
1514d88a97aSDan Williams
to_nd_namespace_pmem(const struct device * dev)1526ff3e912SDan Williams static inline struct nd_namespace_pmem *to_nd_namespace_pmem(const struct device *dev)
153bf9bccc1SDan Williams {
154bf9bccc1SDan Williams struct nd_namespace_io *nsio = to_nd_namespace_io(dev);
155bf9bccc1SDan Williams
156bf9bccc1SDan Williams return container_of(nsio, struct nd_namespace_pmem, nsio);
157bf9bccc1SDan Williams }
158bf9bccc1SDan Williams
1598c2f7e86SDan Williams /**
1608c2f7e86SDan Williams * nvdimm_read_bytes() - synchronously read bytes from an nvdimm namespace
1618c2f7e86SDan Williams * @ndns: device to read
1628c2f7e86SDan Williams * @offset: namespace-relative starting offset
1638c2f7e86SDan Williams * @buf: buffer to fill
1648c2f7e86SDan Williams * @size: transfer length
1658c2f7e86SDan Williams *
1668c2f7e86SDan Williams * @buf is up-to-date upon return from this routine.
1678c2f7e86SDan Williams */
nvdimm_read_bytes(struct nd_namespace_common * ndns,resource_size_t offset,void * buf,size_t size,unsigned long flags)1688c2f7e86SDan Williams static inline int nvdimm_read_bytes(struct nd_namespace_common *ndns,
1693ae3d67bSVishal Verma resource_size_t offset, void *buf, size_t size,
1703ae3d67bSVishal Verma unsigned long flags)
1718c2f7e86SDan Williams {
1723ae3d67bSVishal Verma return ndns->rw_bytes(ndns, offset, buf, size, READ, flags);
1738c2f7e86SDan Williams }
1748c2f7e86SDan Williams
1758c2f7e86SDan Williams /**
1768c2f7e86SDan Williams * nvdimm_write_bytes() - synchronously write bytes to an nvdimm namespace
1772f474149SIra Weiny * @ndns: device to write
1788c2f7e86SDan Williams * @offset: namespace-relative starting offset
1798c2f7e86SDan Williams * @buf: buffer to drain
1808c2f7e86SDan Williams * @size: transfer length
1818c2f7e86SDan Williams *
1828c2f7e86SDan Williams * NVDIMM Namepaces disks do not implement sectors internally. Depending on
1838c2f7e86SDan Williams * the @ndns, the contents of @buf may be in cpu cache, platform buffers,
1848c2f7e86SDan Williams * or on backing memory media upon return from this routine. Flushing
1858c2f7e86SDan Williams * to media is handled internal to the @ndns driver, if at all.
1868c2f7e86SDan Williams */
nvdimm_write_bytes(struct nd_namespace_common * ndns,resource_size_t offset,void * buf,size_t size,unsigned long flags)1878c2f7e86SDan Williams static inline int nvdimm_write_bytes(struct nd_namespace_common *ndns,
1883ae3d67bSVishal Verma resource_size_t offset, void *buf, size_t size,
1893ae3d67bSVishal Verma unsigned long flags)
1908c2f7e86SDan Williams {
1913ae3d67bSVishal Verma return ndns->rw_bytes(ndns, offset, buf, size, WRITE, flags);
1921b40e09aSDan Williams }
1931b40e09aSDan Williams
1944d88a97aSDan Williams #define MODULE_ALIAS_ND_DEVICE(type) \
1954d88a97aSDan Williams MODULE_ALIAS("nd:t" __stringify(type) "*")
1964d88a97aSDan Williams #define ND_DEVICE_MODALIAS_FMT "nd:t%d"
1974d88a97aSDan Williams
19871999466SDan Williams struct nd_region;
19971999466SDan Williams void nvdimm_region_notify(struct nd_region *nd_region, enum nvdimm_event event);
2004d88a97aSDan Williams int __must_check __nd_driver_register(struct nd_device_driver *nd_drv,
2014d88a97aSDan Williams struct module *module, const char *mod_name);
nd_driver_unregister(struct nd_device_driver * drv)20271cfdd0bSJohannes Thumshirn static inline void nd_driver_unregister(struct nd_device_driver *drv)
20371cfdd0bSJohannes Thumshirn {
20471cfdd0bSJohannes Thumshirn driver_unregister(&drv->drv);
20571cfdd0bSJohannes Thumshirn }
2064d88a97aSDan Williams #define nd_driver_register(driver) \
2074d88a97aSDan Williams __nd_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
20871cfdd0bSJohannes Thumshirn #define module_nd_driver(driver) \
20971cfdd0bSJohannes Thumshirn module_driver(driver, nd_driver_register, nd_driver_unregister)
2104d88a97aSDan Williams #endif /* __LINUX_ND_H__ */
211