Commit | Line | Data |
---|---|---|
b94d5230 DW |
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__ | |
047fc8a1 | 17 | #include <linux/kernel.h> |
62232e45 DW |
18 | #include <linux/sizes.h> |
19 | #include <linux/types.h> | |
e6dfb2de DW |
20 | |
21 | enum { | |
22 | /* when a dimm supports both PMEM and BLK access a label is required */ | |
23 | NDD_ALIASING = 1 << 0, | |
58138820 DW |
24 | /* unarmed memory devices may not persist writes */ |
25 | NDD_UNARMED = 1 << 1, | |
62232e45 DW |
26 | |
27 | /* need to set a limit somewhere, but yes, this is likely overkill */ | |
28 | ND_IOCTL_MAX_BUFLEN = SZ_4M, | |
4577b066 | 29 | ND_CMD_MAX_ELEM = 5, |
40abf9be | 30 | ND_CMD_MAX_ENVELOPE = 256, |
1f7df6f8 | 31 | ND_MAX_MAPPINGS = 32, |
1b40e09a | 32 | |
004f1afb DW |
33 | /* region flag indicating to direct-map persistent memory by default */ |
34 | ND_REGION_PAGEMAP = 0, | |
35 | ||
1b40e09a DW |
36 | /* mark newly adjusted resources as requiring a label update */ |
37 | DPA_RESOURCE_ADJUSTED = 1 << 0, | |
e6dfb2de DW |
38 | }; |
39 | ||
45def22c | 40 | extern struct attribute_group nvdimm_bus_attribute_group; |
62232e45 | 41 | extern struct attribute_group nvdimm_attribute_group; |
4d88a97a | 42 | extern struct attribute_group nd_device_attribute_group; |
74ae66c3 | 43 | extern struct attribute_group nd_numa_attribute_group; |
1f7df6f8 DW |
44 | extern struct attribute_group nd_region_attribute_group; |
45 | extern struct attribute_group nd_mapping_attribute_group; | |
45def22c | 46 | |
b94d5230 DW |
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, | |
aef25338 | 51 | unsigned int buf_len, int *cmd_rc); |
b94d5230 | 52 | |
bf9bccc1 DW |
53 | struct nd_namespace_label; |
54 | struct nvdimm_drvdata; | |
e5ae3b25 | 55 | |
1f7df6f8 DW |
56 | struct nd_mapping { |
57 | struct nvdimm *nvdimm; | |
bf9bccc1 | 58 | struct nd_namespace_label **labels; |
1f7df6f8 DW |
59 | u64 start; |
60 | u64 size; | |
bf9bccc1 DW |
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; | |
1f7df6f8 DW |
68 | }; |
69 | ||
b94d5230 | 70 | struct nvdimm_bus_descriptor { |
45def22c | 71 | const struct attribute_group **attr_groups; |
e3654eca | 72 | unsigned long cmd_mask; |
b94d5230 DW |
73 | char *provider_name; |
74 | ndctl_fn ndctl; | |
7ae0fa43 | 75 | int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc); |
87bf572e DW |
76 | int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc, |
77 | struct nvdimm *nvdimm, unsigned int cmd); | |
b94d5230 DW |
78 | }; |
79 | ||
62232e45 DW |
80 | struct nd_cmd_desc { |
81 | int in_num; | |
82 | int out_num; | |
83 | u32 in_sizes[ND_CMD_MAX_ELEM]; | |
84 | int out_sizes[ND_CMD_MAX_ELEM]; | |
85 | }; | |
86 | ||
eaf96153 DW |
87 | struct nd_interleave_set { |
88 | u64 cookie; | |
89 | }; | |
90 | ||
1f7df6f8 DW |
91 | struct nd_region_desc { |
92 | struct resource *res; | |
93 | struct nd_mapping *nd_mapping; | |
94 | u16 num_mappings; | |
95 | const struct attribute_group **attr_groups; | |
eaf96153 | 96 | struct nd_interleave_set *nd_set; |
1f7df6f8 | 97 | void *provider_data; |
5212e11f | 98 | int num_lanes; |
41d7a6d6 | 99 | int numa_node; |
004f1afb | 100 | unsigned long flags; |
1f7df6f8 DW |
101 | }; |
102 | ||
29b9aa0a DW |
103 | struct device; |
104 | void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset, | |
105 | size_t size, unsigned long flags); | |
106 | static inline void __iomem *devm_nvdimm_ioremap(struct device *dev, | |
107 | resource_size_t offset, size_t size) | |
108 | { | |
109 | return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0); | |
110 | } | |
111 | ||
62232e45 | 112 | struct nvdimm_bus; |
3d88002e | 113 | struct module; |
047fc8a1 RZ |
114 | struct device; |
115 | struct nd_blk_region; | |
116 | struct nd_blk_region_desc { | |
117 | int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev); | |
047fc8a1 RZ |
118 | int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, |
119 | void *iobuf, u64 len, int rw); | |
120 | struct nd_region_desc ndr_desc; | |
121 | }; | |
122 | ||
123 | static inline struct nd_blk_region_desc *to_blk_region_desc( | |
124 | struct nd_region_desc *ndr_desc) | |
125 | { | |
126 | return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc); | |
127 | ||
128 | } | |
129 | ||
0caeef63 | 130 | int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length); |
3d88002e DW |
131 | struct nvdimm_bus *__nvdimm_bus_register(struct device *parent, |
132 | struct nvdimm_bus_descriptor *nfit_desc, struct module *module); | |
133 | #define nvdimm_bus_register(parent, desc) \ | |
134 | __nvdimm_bus_register(parent, desc, THIS_MODULE) | |
b94d5230 | 135 | void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); |
45def22c | 136 | struct nvdimm_bus *to_nvdimm_bus(struct device *dev); |
e6dfb2de | 137 | struct nvdimm *to_nvdimm(struct device *dev); |
1f7df6f8 | 138 | struct nd_region *to_nd_region(struct device *dev); |
047fc8a1 | 139 | struct nd_blk_region *to_nd_blk_region(struct device *dev); |
45def22c | 140 | struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); |
e6dfb2de | 141 | const char *nvdimm_name(struct nvdimm *nvdimm); |
e3654eca | 142 | unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm); |
e6dfb2de DW |
143 | void *nvdimm_provider_data(struct nvdimm *nvdimm); |
144 | struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, | |
62232e45 | 145 | const struct attribute_group **groups, unsigned long flags, |
e5ae3b25 DW |
146 | unsigned long cmd_mask, int num_flush, |
147 | struct resource *flush_wpq); | |
62232e45 DW |
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); | |
4d88a97a | 155 | int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); |
1f7df6f8 DW |
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); | |
047fc8a1 RZ |
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); | |
eaf96153 | 168 | u64 nd_fletcher64(void *addr, size_t len, bool le); |
f284a4f2 DW |
169 | void nvdimm_flush(struct nd_region *nd_region); |
170 | int nvdimm_has_flush(struct nd_region *nd_region); | |
b94d5230 | 171 | #endif /* __LIBNVDIMM_H__ */ |