nfit, libnvdimm: clarify "commands" vs "_DSMs"
[cascardo/linux.git] / drivers / nvdimm / nd-core.h
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_CORE_H__
14 #define __ND_CORE_H__
15 #include <linux/libnvdimm.h>
16 #include <linux/device.h>
17 #include <linux/libnvdimm.h>
18 #include <linux/sizes.h>
19 #include <linux/mutex.h>
20 #include <linux/nd.h>
21
22 extern struct list_head nvdimm_bus_list;
23 extern struct mutex nvdimm_bus_list_mutex;
24 extern int nvdimm_major;
25
26 struct nvdimm_bus {
27         struct nvdimm_bus_descriptor *nd_desc;
28         wait_queue_head_t probe_wait;
29         struct module *module;
30         struct list_head list;
31         struct device dev;
32         int id, probe_active;
33         struct list_head poison_list;
34         struct mutex reconfig_mutex;
35 };
36
37 struct nvdimm {
38         unsigned long flags;
39         void *provider_data;
40         unsigned long cmd_mask;
41         struct device dev;
42         atomic_t busy;
43         int id;
44 };
45
46 bool is_nvdimm(struct device *dev);
47 bool is_nd_pmem(struct device *dev);
48 bool is_nd_blk(struct device *dev);
49 struct nvdimm_bus *walk_to_nvdimm_bus(struct device *nd_dev);
50 int __init nvdimm_bus_init(void);
51 void nvdimm_bus_exit(void);
52 void nd_region_probe_success(struct nvdimm_bus *nvdimm_bus, struct device *dev);
53 struct nd_region;
54 void nd_region_create_blk_seed(struct nd_region *nd_region);
55 void nd_region_create_btt_seed(struct nd_region *nd_region);
56 void nd_region_create_pfn_seed(struct nd_region *nd_region);
57 void nd_region_disable(struct nvdimm_bus *nvdimm_bus, struct device *dev);
58 int nvdimm_bus_create_ndctl(struct nvdimm_bus *nvdimm_bus);
59 void nvdimm_bus_destroy_ndctl(struct nvdimm_bus *nvdimm_bus);
60 void nd_synchronize(void);
61 int nvdimm_bus_register_dimms(struct nvdimm_bus *nvdimm_bus);
62 int nvdimm_bus_register_regions(struct nvdimm_bus *nvdimm_bus);
63 int nvdimm_bus_init_interleave_sets(struct nvdimm_bus *nvdimm_bus);
64 void __nd_device_register(struct device *dev);
65 int nd_match_dimm(struct device *dev, void *data);
66 struct nd_label_id;
67 char *nd_label_gen_id(struct nd_label_id *label_id, u8 *uuid, u32 flags);
68 bool nd_is_uuid_unique(struct device *dev, u8 *uuid);
69 struct nd_region;
70 struct nvdimm_drvdata;
71 struct nd_mapping;
72 resource_size_t nd_pmem_available_dpa(struct nd_region *nd_region,
73                 struct nd_mapping *nd_mapping, resource_size_t *overlap);
74 resource_size_t nd_blk_available_dpa(struct nd_mapping *nd_mapping);
75 resource_size_t nd_region_available_dpa(struct nd_region *nd_region);
76 resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
77                 struct nd_label_id *label_id);
78 struct nd_mapping;
79 struct resource *nsblk_add_resource(struct nd_region *nd_region,
80                 struct nvdimm_drvdata *ndd, struct nd_namespace_blk *nsblk,
81                 resource_size_t start);
82 int nvdimm_num_label_slots(struct nvdimm_drvdata *ndd);
83 void get_ndd(struct nvdimm_drvdata *ndd);
84 resource_size_t __nvdimm_namespace_capacity(struct nd_namespace_common *ndns);
85 void nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
86 void __nd_detach_ndns(struct device *dev, struct nd_namespace_common **_ndns);
87 bool nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
88                 struct nd_namespace_common **_ndns);
89 bool __nd_attach_ndns(struct device *dev, struct nd_namespace_common *attach,
90                 struct nd_namespace_common **_ndns);
91 ssize_t nd_namespace_store(struct device *dev,
92                 struct nd_namespace_common **_ndns, const char *buf,
93                 size_t len);
94 #endif /* __ND_CORE_H__ */