2 * libnvdimm - Non-volatile-memory Devices Subsystem
4 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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.
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.
15 #ifndef __LIBNVDIMM_H__
16 #define __LIBNVDIMM_H__
17 #include <linux/kernel.h>
18 #include <linux/sizes.h>
19 #include <linux/types.h>
20 #include <linux/uuid.h>
23 /* when a dimm supports both PMEM and BLK access a label is required */
25 /* unarmed memory devices may not persist writes */
27 /* locked memory devices should not be accessed */
30 /* need to set a limit somewhere, but yes, this is likely overkill */
31 ND_IOCTL_MAX_BUFLEN
= SZ_4M
,
33 ND_CMD_MAX_ENVELOPE
= 256,
36 /* region flag indicating to direct-map persistent memory by default */
37 ND_REGION_PAGEMAP
= 0,
39 /* mark newly adjusted resources as requiring a label update */
40 DPA_RESOURCE_ADJUSTED
= 1 << 0,
43 extern struct attribute_group nvdimm_bus_attribute_group
;
44 extern struct attribute_group nvdimm_attribute_group
;
45 extern struct attribute_group nd_device_attribute_group
;
46 extern struct attribute_group nd_numa_attribute_group
;
47 extern struct attribute_group nd_region_attribute_group
;
48 extern struct attribute_group nd_mapping_attribute_group
;
51 struct nvdimm_bus_descriptor
;
52 typedef int (*ndctl_fn
)(struct nvdimm_bus_descriptor
*nd_desc
,
53 struct nvdimm
*nvdimm
, unsigned int cmd
, void *buf
,
54 unsigned int buf_len
, int *cmd_rc
);
56 struct nvdimm_bus_descriptor
{
57 const struct attribute_group
**attr_groups
;
58 unsigned long bus_dsm_mask
;
59 unsigned long cmd_mask
;
60 struct module
*module
;
63 int (*flush_probe
)(struct nvdimm_bus_descriptor
*nd_desc
);
64 int (*clear_to_send
)(struct nvdimm_bus_descriptor
*nd_desc
,
65 struct nvdimm
*nvdimm
, unsigned int cmd
);
71 u32 in_sizes
[ND_CMD_MAX_ELEM
];
72 int out_sizes
[ND_CMD_MAX_ELEM
];
75 struct nd_interleave_set
{
76 /* v1.1 definition of the interleave-set-cookie algorithm */
78 /* v1.2 definition of the interleave-set-cookie algorithm */
80 /* compatibility with initial buggy Linux implementation */
86 struct nd_mapping_desc
{
87 struct nvdimm
*nvdimm
;
93 struct nd_region_desc
{
95 struct nd_mapping_desc
*mapping
;
97 const struct attribute_group
**attr_groups
;
98 struct nd_interleave_set
*nd_set
;
106 void *devm_nvdimm_memremap(struct device
*dev
, resource_size_t offset
,
107 size_t size
, unsigned long flags
);
108 static inline void __iomem
*devm_nvdimm_ioremap(struct device
*dev
,
109 resource_size_t offset
, size_t size
)
111 return (void __iomem
*) devm_nvdimm_memremap(dev
, offset
, size
, 0);
117 struct nd_blk_region
;
118 struct nd_blk_region_desc
{
119 int (*enable
)(struct nvdimm_bus
*nvdimm_bus
, struct device
*dev
);
120 int (*do_io
)(struct nd_blk_region
*ndbr
, resource_size_t dpa
,
121 void *iobuf
, u64 len
, int rw
);
122 struct nd_region_desc ndr_desc
;
125 static inline struct nd_blk_region_desc
*to_blk_region_desc(
126 struct nd_region_desc
*ndr_desc
)
128 return container_of(ndr_desc
, struct nd_blk_region_desc
, ndr_desc
);
132 int nvdimm_bus_add_poison(struct nvdimm_bus
*nvdimm_bus
, u64 addr
, u64 length
);
133 void nvdimm_forget_poison(struct nvdimm_bus
*nvdimm_bus
,
134 phys_addr_t start
, unsigned int len
);
135 struct nvdimm_bus
*nvdimm_bus_register(struct device
*parent
,
136 struct nvdimm_bus_descriptor
*nfit_desc
);
137 void nvdimm_bus_unregister(struct nvdimm_bus
*nvdimm_bus
);
138 struct nvdimm_bus
*to_nvdimm_bus(struct device
*dev
);
139 struct nvdimm
*to_nvdimm(struct device
*dev
);
140 struct nd_region
*to_nd_region(struct device
*dev
);
141 struct nd_blk_region
*to_nd_blk_region(struct device
*dev
);
142 struct nvdimm_bus_descriptor
*to_nd_desc(struct nvdimm_bus
*nvdimm_bus
);
143 struct device
*to_nvdimm_bus_dev(struct nvdimm_bus
*nvdimm_bus
);
144 const char *nvdimm_name(struct nvdimm
*nvdimm
);
145 struct kobject
*nvdimm_kobj(struct nvdimm
*nvdimm
);
146 unsigned long nvdimm_cmd_mask(struct nvdimm
*nvdimm
);
147 void *nvdimm_provider_data(struct nvdimm
*nvdimm
);
148 struct nvdimm
*nvdimm_create(struct nvdimm_bus
*nvdimm_bus
, void *provider_data
,
149 const struct attribute_group
**groups
, unsigned long flags
,
150 unsigned long cmd_mask
, int num_flush
,
151 struct resource
*flush_wpq
);
152 const struct nd_cmd_desc
*nd_cmd_dimm_desc(int cmd
);
153 const struct nd_cmd_desc
*nd_cmd_bus_desc(int cmd
);
154 u32
nd_cmd_in_size(struct nvdimm
*nvdimm
, int cmd
,
155 const struct nd_cmd_desc
*desc
, int idx
, void *buf
);
156 u32
nd_cmd_out_size(struct nvdimm
*nvdimm
, int cmd
,
157 const struct nd_cmd_desc
*desc
, int idx
, const u32
*in_field
,
158 const u32
*out_field
, unsigned long remainder
);
159 int nvdimm_bus_check_dimm_count(struct nvdimm_bus
*nvdimm_bus
, int dimm_count
);
160 struct nd_region
*nvdimm_pmem_region_create(struct nvdimm_bus
*nvdimm_bus
,
161 struct nd_region_desc
*ndr_desc
);
162 struct nd_region
*nvdimm_blk_region_create(struct nvdimm_bus
*nvdimm_bus
,
163 struct nd_region_desc
*ndr_desc
);
164 struct nd_region
*nvdimm_volatile_region_create(struct nvdimm_bus
*nvdimm_bus
,
165 struct nd_region_desc
*ndr_desc
);
166 void *nd_region_provider_data(struct nd_region
*nd_region
);
167 void *nd_blk_region_provider_data(struct nd_blk_region
*ndbr
);
168 void nd_blk_region_set_provider_data(struct nd_blk_region
*ndbr
, void *data
);
169 struct nvdimm
*nd_blk_region_to_dimm(struct nd_blk_region
*ndbr
);
170 unsigned long nd_blk_memremap_flags(struct nd_blk_region
*ndbr
);
171 unsigned int nd_region_acquire_lane(struct nd_region
*nd_region
);
172 void nd_region_release_lane(struct nd_region
*nd_region
, unsigned int lane
);
173 u64
nd_fletcher64(void *addr
, size_t len
, bool le
);
174 void nvdimm_flush(struct nd_region
*nd_region
);
175 int nvdimm_has_flush(struct nd_region
*nd_region
);
176 int nvdimm_has_cache(struct nd_region
*nd_region
);
178 #ifdef CONFIG_ARCH_HAS_PMEM_API
179 #define ARCH_MEMREMAP_PMEM MEMREMAP_WB
180 void arch_wb_cache_pmem(void *addr
, size_t size
);
181 void arch_invalidate_pmem(void *addr
, size_t size
);
183 #define ARCH_MEMREMAP_PMEM MEMREMAP_WT
184 static inline void arch_wb_cache_pmem(void *addr
, size_t size
)
187 static inline void arch_invalidate_pmem(void *addr
, size_t size
)
192 #endif /* __LIBNVDIMM_H__ */