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};
74
75struct nd_mapping_desc {
76 struct nvdimm *nvdimm;
77 u64 start;
78 u64 size;
79};
80
81struct nd_region_desc {
82 struct resource *res;
83 struct nd_mapping_desc *mapping;
84 u16 num_mappings;
85 const struct attribute_group **attr_groups;
86 struct nd_interleave_set *nd_set;
87 void *provider_data;
88 int num_lanes;
89 int numa_node;
90 unsigned long flags;
91};
92
93struct device;
94void *devm_nvdimm_memremap(struct device *dev, resource_size_t offset,
95 size_t size, unsigned long flags);
96static inline void __iomem *devm_nvdimm_ioremap(struct device *dev,
97 resource_size_t offset, size_t size)
98{
99 return (void __iomem *) devm_nvdimm_memremap(dev, offset, size, 0);
100}
101
102struct nvdimm_bus;
103struct module;
104struct device;
105struct nd_blk_region;
106struct nd_blk_region_desc {
107 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
108 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
109 void *iobuf, u64 len, int rw);
110 struct nd_region_desc ndr_desc;
111};
112
113static inline struct nd_blk_region_desc *to_blk_region_desc(
114 struct nd_region_desc *ndr_desc)
115{
116 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
117
118}
119
120int nvdimm_bus_add_poison(struct nvdimm_bus *nvdimm_bus, u64 addr, u64 length);
121void nvdimm_clear_from_poison_list(struct nvdimm_bus *nvdimm_bus,
122 phys_addr_t start, unsigned int len);
123struct nvdimm_bus *nvdimm_bus_register(struct device *parent,
124 struct nvdimm_bus_descriptor *nfit_desc);
125void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
126struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
127struct nvdimm *to_nvdimm(struct device *dev);
128struct nd_region *to_nd_region(struct device *dev);
129struct nd_blk_region *to_nd_blk_region(struct device *dev);
130struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
131struct device *to_nvdimm_bus_dev(struct nvdimm_bus *nvdimm_bus);
132const char *nvdimm_name(struct nvdimm *nvdimm);
133struct kobject *nvdimm_kobj(struct nvdimm *nvdimm);
134unsigned long nvdimm_cmd_mask(struct nvdimm *nvdimm);
135void *nvdimm_provider_data(struct nvdimm *nvdimm);
136struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
137 const struct attribute_group **groups, unsigned long flags,
138 unsigned long cmd_mask, int num_flush,
139 struct resource *flush_wpq);
140const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
141const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
142u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
143 const struct nd_cmd_desc *desc, int idx, void *buf);
144u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
145 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
146 const u32 *out_field, unsigned long remainder);
147int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
148struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
149 struct nd_region_desc *ndr_desc);
150struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
151 struct nd_region_desc *ndr_desc);
152struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
153 struct nd_region_desc *ndr_desc);
154void *nd_region_provider_data(struct nd_region *nd_region);
155void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
156void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
157struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
158unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
159void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
160u64 nd_fletcher64(void *addr, size_t len, bool le);
161void nvdimm_flush(struct nd_region *nd_region);
162int nvdimm_has_flush(struct nd_region *nd_region);
163#endif /* __LIBNVDIMM_H__ */