Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
21enum {
22 /* when a dimm supports both PMEM and BLK access a label is required */
23 NDD_ALIASING = 0,
24 /* unarmed memory devices may not persist writes */
25 NDD_UNARMED = 1,
26 /* locked memory devices should not be accessed */
27 NDD_LOCKED = 2,
28
29 /* need to set a limit somewhere, but yes, this is likely overkill */
30 ND_IOCTL_MAX_BUFLEN = SZ_4M,
31 ND_CMD_MAX_ELEM = 5,
32 ND_CMD_MAX_ENVELOPE = 256,
33 ND_MAX_MAPPINGS = 32,
34
35 /* region flag indicating to direct-map persistent memory by default */
36 ND_REGION_PAGEMAP = 0,
37
38 /* mark newly adjusted resources as requiring a label update */
39 DPA_RESOURCE_ADJUSTED = 1 << 0,
40};
41
42extern struct attribute_group nvdimm_bus_attribute_group;
43extern struct attribute_group nvdimm_attribute_group;
44extern struct attribute_group nd_device_attribute_group;
45extern struct attribute_group nd_numa_attribute_group;
46extern struct attribute_group nd_region_attribute_group;
47extern struct attribute_group nd_mapping_attribute_group;
48
49struct nvdimm;
50struct nvdimm_bus_descriptor;
51typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
52 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
53 unsigned int buf_len, int *cmd_rc);
54
55struct nvdimm_bus_descriptor {
56 const struct attribute_group **attr_groups;
57 unsigned long cmd_mask;
58 struct module *module;
59 char *provider_name;
60 ndctl_fn ndctl;
61 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
62 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
63 struct nvdimm *nvdimm, unsigned int cmd);
64};
65
66struct nd_cmd_desc {
67 int in_num;
68 int out_num;
69 u32 in_sizes[ND_CMD_MAX_ELEM];
70 int out_sizes[ND_CMD_MAX_ELEM];
71};
72
73struct nd_interleave_set {
74 u64 cookie;
75 /* compatibility with initial buggy Linux implementation */
76 u64 altcookie;
77};
78
79struct nd_mapping_desc {
80 struct nvdimm *nvdimm;
81 u64 start;
82 u64 size;
83};
84
85struct nd_region_desc {
86 struct resource *res;
87 struct nd_mapping_desc *mapping;
88 u16 num_mappings;
89 const struct attribute_group **attr_groups;
90 struct nd_interleave_set *nd_set;
91 void *provider_data;
92 int num_lanes;
93 int numa_node;
94 unsigned long flags;
95};
96
97struct device;
98void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
99 size_t size, unsigned long flags);
100static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
101 resource_size_t offset, size_t size)
102{
103 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
104}
105
106struct nvdimm_bus;
107struct module;
108struct device;
109struct nd_blk_region;
110struct nd_blk_region_desc {
111 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
112 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
113 void *iobuf, u64 len, int rw);
114 struct nd_region_desc ndr_desc;
115};
116
117static inline struct nd_blk_region_desc *to_blk_region_desc(
118 struct nd_region_desc *ndr_desc)
119{
120 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
121
122}
123
124int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
125void nvdimm_forget_poison(struct nvdimm_bus *nvdimm_bus,
126 phys_addr_t start, unsigned int len);
127struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
128 struct nvdimm_bus_descriptor *nfit_desc);
129void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
130struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
131struct nvdimm *to_nvdimm(struct device *dev);
132struct nd_region *to_nd_region(struct device *dev);
133struct nd_blk_region *to_nd_blk_region(struct device *dev);
134struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
135struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
136const char *nvdimm_name(struct nvdimm *nvdimm);
137struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
138unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
139void *nvdimm_provider_data(struct nvdimm *nvdimm);
140struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
141 const struct attribute_group **groups, unsigned long flags,
142 unsigned long cmd_mask, int num_flush,
143 struct resource *flush_wpq);
144const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
145const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
146u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
147 const struct nd_cmd_desc *desc, int idx, void *buf);
148u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
149 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
150 const u32 *out_field, unsigned long remainder);
151int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
152struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
153 struct nd_region_desc *ndr_desc);
154struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
155 struct nd_region_desc *ndr_desc);
156struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
157 struct nd_region_desc *ndr_desc);
158void *nd_region_provider_data(struct nd_region *nd_region);
159void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
160void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
161struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
162unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
163void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
164u64 nd_fletcher64(void *addr, size_t len, bool le);
165void nvdimm_flush(struct nd_region *nd_region);
166int nvdimm_has_flush(struct nd_region *nd_region);
167#endif /* __LIBNVDIMM_H__ */