xref: /OK3568_Linux_fs/kernel/drivers/dax/bus.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /* Copyright(c) 2016 - 2018 Intel Corporation. All rights reserved. */
3*4882a593Smuzhiyun #ifndef __DAX_BUS_H__
4*4882a593Smuzhiyun #define __DAX_BUS_H__
5*4882a593Smuzhiyun #include <linux/device.h>
6*4882a593Smuzhiyun #include <linux/range.h>
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun struct dev_dax;
9*4882a593Smuzhiyun struct resource;
10*4882a593Smuzhiyun struct dax_device;
11*4882a593Smuzhiyun struct dax_region;
12*4882a593Smuzhiyun void dax_region_put(struct dax_region *dax_region);
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define IORESOURCE_DAX_STATIC (1UL << 0)
15*4882a593Smuzhiyun struct dax_region *alloc_dax_region(struct device *parent, int region_id,
16*4882a593Smuzhiyun 		struct range *range, int target_node, unsigned int align,
17*4882a593Smuzhiyun 		unsigned long flags);
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun enum dev_dax_subsys {
20*4882a593Smuzhiyun 	DEV_DAX_BUS = 0, /* zeroed dev_dax_data picks this by default */
21*4882a593Smuzhiyun 	DEV_DAX_CLASS,
22*4882a593Smuzhiyun };
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun struct dev_dax_data {
25*4882a593Smuzhiyun 	struct dax_region *dax_region;
26*4882a593Smuzhiyun 	struct dev_pagemap *pgmap;
27*4882a593Smuzhiyun 	enum dev_dax_subsys subsys;
28*4882a593Smuzhiyun 	resource_size_t size;
29*4882a593Smuzhiyun 	int id;
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun struct dev_dax *devm_create_dev_dax(struct dev_dax_data *data);
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun /* to be deleted when DEV_DAX_CLASS is removed */
35*4882a593Smuzhiyun struct dev_dax *__dax_pmem_probe(struct device *dev, enum dev_dax_subsys subsys);
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun struct dax_device_driver {
38*4882a593Smuzhiyun 	struct device_driver drv;
39*4882a593Smuzhiyun 	struct list_head ids;
40*4882a593Smuzhiyun 	int match_always;
41*4882a593Smuzhiyun 	int (*probe)(struct dev_dax *dev);
42*4882a593Smuzhiyun 	int (*remove)(struct dev_dax *dev);
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun int __dax_driver_register(struct dax_device_driver *dax_drv,
46*4882a593Smuzhiyun 		struct module *module, const char *mod_name);
47*4882a593Smuzhiyun #define dax_driver_register(driver) \
48*4882a593Smuzhiyun 	__dax_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
49*4882a593Smuzhiyun void dax_driver_unregister(struct dax_device_driver *dax_drv);
50*4882a593Smuzhiyun void kill_dev_dax(struct dev_dax *dev_dax);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_DEV_DAX_PMEM_COMPAT)
53*4882a593Smuzhiyun int dev_dax_probe(struct dev_dax *dev_dax);
54*4882a593Smuzhiyun #endif
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun /*
57*4882a593Smuzhiyun  * While run_dax() is potentially a generic operation that could be
58*4882a593Smuzhiyun  * defined in include/linux/dax.h we don't want to grow any users
59*4882a593Smuzhiyun  * outside of drivers/dax/
60*4882a593Smuzhiyun  */
61*4882a593Smuzhiyun void run_dax(struct dax_device *dax_dev);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #define MODULE_ALIAS_DAX_DEVICE(type) \
64*4882a593Smuzhiyun 	MODULE_ALIAS("dax:t" __stringify(type) "*")
65*4882a593Smuzhiyun #define DAX_DEVICE_MODALIAS_FMT "dax:t%d"
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun #endif /* __DAX_BUS_H__ */
68