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 = 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
40extern struct attribute_group nvdimm_bus_attribute_group;
41extern struct attribute_group nvdimm_attribute_group;
42extern struct attribute_group nd_device_attribute_group;
43extern struct attribute_group nd_numa_attribute_group;
44extern struct attribute_group nd_region_attribute_group;
45extern struct attribute_group nd_mapping_attribute_group;
46
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,
51 unsigned int buf_len, int *cmd_rc);
52
53struct nvdimm_bus_descriptor {
54 const struct attribute_group **attr_groups;
55 unsigned long cmd_mask;
56 struct module *module;
57 char *provider_name;
58 ndctl_fn ndctl;
59 int (*flush_probe)(struct nvdimm_bus_descriptor *nd_desc);
60 int (*clear_to_send)(struct nvdimm_bus_descriptor *nd_desc,
61 struct nvdimm *nvdimm, unsigned int cmd);
62};
63
64struct nd_cmd_desc {
65 int in_num;
66 int out_num;
67 u32 in_sizes[ND_CMD_MAX_ELEM];
68 int out_sizes[ND_CMD_MAX_ELEM];
69};
70
71struct nd_interleave_set {
72 u64 cookie;
73 /* compatibility with initial buggy Linux implementation */
74 u64 altcookie;
75};
76
77struct nd_mapping_desc {
78 struct nvdimm *nvdimm;
79 u64 start;
80 u64 size;
81};
82
83struct nd_region_desc {
84 struct resource *res;
85 struct nd_mapping_desc *mapping;
86 u16 num_mappings;
87 const struct attribute_group **attr_groups;
88 struct nd_interleave_set *nd_set;
89 void *provider_data;
90 int num_lanes;
91 int numa_node;
92 unsigned long flags;
93};
94
95struct device;
96void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
97 size_t size, unsigned long flags);
98static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
99 resource_size_t offset, size_t size)
100{
101 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
102}
103
104struct nvdimm_bus;
105struct module;
106struct device;
107struct nd_blk_region;
108struct nd_blk_region_desc {
109 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
110 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
111 void *iobuf, u64 len, int rw);
112 struct nd_region_desc ndr_desc;
113};
114
115static inline struct nd_blk_region_desc *to_blk_region_desc(
116 struct nd_region_desc *ndr_desc)
117{
118 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
119
120}
121
122int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
123void nvdimm_clear_from_poison_list(struct nvdimm_bus *nvdimm_bus,
124 phys_addr_t start, unsigned int len);
125struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
126 struct nvdimm_bus_descriptor *nfit_desc);
127void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
128struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
129struct nvdimm *to_nvdimm(struct device *dev);
130struct nd_region *to_nd_region(struct device *dev);
131struct nd_blk_region *to_nd_blk_region(struct device *dev);
132struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
133struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
134const char *nvdimm_name(struct nvdimm *nvdimm);
135struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
136unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
137void *nvdimm_provider_data(struct nvdimm *nvdimm);
138struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
139 const struct attribute_group **groups, unsigned long flags,
140 unsigned long cmd_mask, int num_flush,
141 struct resource *flush_wpq);
142const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
143const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
144u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
145 const struct nd_cmd_desc *desc, int idx, void *buf);
146u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
147 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
148 const u32 *out_field, unsigned long remainder);
149int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
150struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
151 struct nd_region_desc *ndr_desc);
152struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
153 struct nd_region_desc *ndr_desc);
154struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
155 struct nd_region_desc *ndr_desc);
156void *nd_region_provider_data(struct nd_region *nd_region);
157void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
158void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
159struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
160unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
161void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
162u64 nd_fletcher64(void *addr, size_t len, bool le);
163void nvdimm_flush(struct nd_region *nd_region);
164int nvdimm_has_flush(struct nd_region *nd_region);
165#endif /* __LIBNVDIMM_H__ */