]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/libnvdimm.h
libnvdimm, nfit: remove nfit_spa_map() infrastructure
[mirror_ubuntu-artful-kernel.git] / include / linux / libnvdimm.h
CommitLineData
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
21enum {
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 40extern struct attribute_group nvdimm_bus_attribute_group;
62232e45 41extern struct attribute_group nvdimm_attribute_group;
4d88a97a 42extern struct attribute_group nd_device_attribute_group;
74ae66c3 43extern struct attribute_group nd_numa_attribute_group;
1f7df6f8
DW
44extern struct attribute_group nd_region_attribute_group;
45extern struct attribute_group nd_mapping_attribute_group;
45def22c 46
b94d5230
DW
47struct nvdimm;
48struct nvdimm_bus_descriptor;
49typedef 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
53struct nd_namespace_label;
54struct nvdimm_drvdata;
1f7df6f8
DW
55struct nd_mapping {
56 struct nvdimm *nvdimm;
bf9bccc1 57 struct nd_namespace_label **labels;
1f7df6f8
DW
58 u64 start;
59 u64 size;
bf9bccc1
DW
60 /*
61 * @ndd is for private use at region enable / disable time for
62 * get_ndd() + put_ndd(), all other nd_mapping to ndd
63 * conversions use to_ndd() which respects enabled state of the
64 * nvdimm.
65 */
66 struct nvdimm_drvdata *ndd;
1f7df6f8
DW
67};
68
b94d5230 69struct nvdimm_bus_descriptor {
45def22c 70 const struct attribute_group **attr_groups;
e3654eca 71 unsigned long cmd_mask;
b94d5230
DW
72 char *provider_name;
73 ndctl_fn ndctl;
7ae0fa43 74 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
87bf572e
DW
75 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
76 struct nvdimm *nvdimm, unsigned int cmd);
b94d5230
DW
77};
78
62232e45
DW
79struct nd_cmd_desc {
80 int in_num;
81 int out_num;
82 u32 in_sizes[ND_CMD_MAX_ELEM];
83 int out_sizes[ND_CMD_MAX_ELEM];
84};
85
eaf96153
DW
86struct nd_interleave_set {
87 u64 cookie;
88};
89
1f7df6f8
DW
90struct nd_region_desc {
91 struct resource *res;
92 struct nd_mapping *nd_mapping;
93 u16 num_mappings;
94 const struct attribute_group **attr_groups;
eaf96153 95 struct nd_interleave_set *nd_set;
1f7df6f8 96 void *provider_data;
5212e11f 97 int num_lanes;
41d7a6d6 98 int numa_node;
004f1afb 99 unsigned long flags;
1f7df6f8
DW
100};
101
29b9aa0a
DW
102struct device;
103void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
104 size_t size, unsigned long flags);
105static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
106 resource_size_t offset, size_t size)
107{
108 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
109}
110
62232e45 111struct nvdimm_bus;
3d88002e 112struct module;
047fc8a1
RZ
113struct device;
114struct nd_blk_region;
115struct nd_blk_region_desc {
116 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
047fc8a1
RZ
117 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
118 void *iobuf, u64 len, int rw);
119 struct nd_region_desc ndr_desc;
120};
121
122static inline struct nd_blk_region_desc *to_blk_region_desc(
123 struct nd_region_desc *ndr_desc)
124{
125 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
126
127}
128
0caeef63 129int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
3d88002e
DW
130struct nvdimm_bus *__nvdimm_bus_register(struct device *parent,
131 struct nvdimm_bus_descriptor *nfit_desc, struct module *module);
132#define nvdimm_bus_register(parent, desc) \
133 __nvdimm_bus_register(parent, desc, THIS_MODULE)
b94d5230 134void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
45def22c 135struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
e6dfb2de 136struct nvdimm *to_nvdimm(struct device *dev);
1f7df6f8 137struct nd_region *to_nd_region(struct device *dev);
047fc8a1 138struct nd_blk_region *to_nd_blk_region(struct device *dev);
45def22c 139struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
e6dfb2de 140const char *nvdimm_name(struct nvdimm *nvdimm);
e3654eca 141unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
e6dfb2de
DW
142void *nvdimm_provider_data(struct nvdimm *nvdimm);
143struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
62232e45 144 const struct attribute_group **groups, unsigned long flags,
e3654eca 145 unsigned long cmd_mask);
62232e45
DW
146const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
147const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
148u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
149 const struct nd_cmd_desc *desc, int idx, void *buf);
150u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
151 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
152 const u32 *out_field);
4d88a97a 153int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
1f7df6f8
DW
154struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
155 struct nd_region_desc *ndr_desc);
156struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
157 struct nd_region_desc *ndr_desc);
158struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
159 struct nd_region_desc *ndr_desc);
047fc8a1
RZ
160void *nd_region_provider_data(struct nd_region *nd_region);
161void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
162void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
163struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
164unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
165void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
eaf96153 166u64 nd_fletcher64(void *addr, size_t len, bool le);
b94d5230 167#endif /* __LIBNVDIMM_H__ */