mm: split gfp_mask and mapping flags into separate fields
[cascardo/linux.git] / include / linux / libnvdimm.h
1 /*
2  * libnvdimm - Non-volatile-memory Devices Subsystem
3  *
4  * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of version 2 of the GNU General Public License as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  */
15 #ifndef __LIBNVDIMM_H__
16 #define __LIBNVDIMM_H__
17 #include <linux/kernel.h>
18 #include <linux/sizes.h>
19 #include <linux/types.h>
20
21 enum {
22         /* when a dimm supports both PMEM and BLK access a label is required */
23         NDD_ALIASING = 1 << 0,
24         /* unarmed memory devices may not persist writes */
25         NDD_UNARMED = 1 << 1,
26
27         /* need to set a limit somewhere, but yes, this is likely overkill */
28         ND_IOCTL_MAX_BUFLEN = SZ_4M,
29         ND_CMD_MAX_ELEM = 5,
30         ND_CMD_MAX_ENVELOPE = 256,
31         ND_MAX_MAPPINGS = 32,
32
33         /* region flag indicating to direct-map persistent memory by default */
34         ND_REGION_PAGEMAP = 0,
35
36         /* mark newly adjusted resources as requiring a label update */
37         DPA_RESOURCE_ADJUSTED = 1 << 0,
38 };
39
40 extern struct attribute_group nvdimm_bus_attribute_group;
41 extern struct attribute_group nvdimm_attribute_group;
42 extern struct attribute_group nd_device_attribute_group;
43 extern struct attribute_group nd_numa_attribute_group;
44 extern struct attribute_group nd_region_attribute_group;
45 extern struct attribute_group nd_mapping_attribute_group;
46
47 struct nvdimm;
48 struct nvdimm_bus_descriptor;
49 typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
50                 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
51                 unsigned int buf_len, int *cmd_rc);
52
53 struct nd_namespace_label;
54 struct nvdimm_drvdata;
55
56 struct nd_mapping {
57         struct nvdimm *nvdimm;
58         struct nd_namespace_label **labels;
59         u64 start;
60         u64 size;
61         /*
62          * @ndd is for private use at region enable / disable time for
63          * get_ndd() + put_ndd(), all other nd_mapping to ndd
64          * conversions use to_ndd() which respects enabled state of the
65          * nvdimm.
66          */
67         struct nvdimm_drvdata *ndd;
68 };
69
70 struct nvdimm_bus_descriptor {
71         const struct attribute_group **attr_groups;
72         unsigned long cmd_mask;
73         struct module *module;
74         char *provider_name;
75         ndctl_fn ndctl;
76         int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
77         int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
78                         struct nvdimm *nvdimm, unsigned int cmd);
79 };
80
81 struct nd_cmd_desc {
82         int in_num;
83         int out_num;
84         u32 in_sizes[ND_CMD_MAX_ELEM];
85         int out_sizes[ND_CMD_MAX_ELEM];
86 };
87
88 struct nd_interleave_set {
89         u64 cookie;
90 };
91
92 struct nd_region_desc {
93         struct resource *res;
94         struct nd_mapping *nd_mapping;
95         u16 num_mappings;
96         const struct attribute_group **attr_groups;
97         struct nd_interleave_set *nd_set;
98         void *provider_data;
99         int num_lanes;
100         int numa_node;
101         unsigned long flags;
102 };
103
104 struct device;
105 void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
106                 size_t size, unsigned long flags);
107 static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
108                 resource_size_t offset, size_t size)
109 {
110         return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
111 }
112
113 struct nvdimm_bus;
114 struct module;
115 struct device;
116 struct nd_blk_region;
117 struct nd_blk_region_desc {
118         int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
119         int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
120                         void *iobuf, u64 len, int rw);
121         struct nd_region_desc ndr_desc;
122 };
123
124 static inline struct nd_blk_region_desc *to_blk_region_desc(
125                 struct nd_region_desc *ndr_desc)
126 {
127         return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
128
129 }
130
131 int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
132 struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
133                 struct nvdimm_bus_descriptor *nfit_desc);
134 void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
135 struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
136 struct nvdimm *to_nvdimm(struct device *dev);
137 struct nd_region *to_nd_region(struct device *dev);
138 struct nd_blk_region *to_nd_blk_region(struct device *dev);
139 struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
140 struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
141 const char *nvdimm_name(struct nvdimm *nvdimm);
142 unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
143 void *nvdimm_provider_data(struct nvdimm *nvdimm);
144 struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
145                 const struct attribute_group **groups, unsigned long flags,
146                 unsigned long cmd_mask, int num_flush,
147                 struct resource *flush_wpq);
148 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
149 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
150 u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
151                 const struct nd_cmd_desc *desc, int idx, void *buf);
152 u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
153                 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
154                 const u32 *out_field);
155 int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
156 struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
157                 struct nd_region_desc *ndr_desc);
158 struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
159                 struct nd_region_desc *ndr_desc);
160 struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
161                 struct nd_region_desc *ndr_desc);
162 void *nd_region_provider_data(struct nd_region *nd_region);
163 void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
164 void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
165 struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
166 unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
167 void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
168 u64 nd_fletcher64(void *addr, size_t len, bool le);
169 void nvdimm_flush(struct nd_region *nd_region);
170 int nvdimm_has_flush(struct nd_region *nd_region);
171 #endif /* __LIBNVDIMM_H__ */