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 = 4,
30 ND_CMD_MAX_ENVELOPE = 16,
31 ND_CMD_ARS_STATUS_MAX = SZ_4K,
32 ND_MAX_MAPPINGS = 32,
33
34 /* mark newly adjusted resources as requiring a label update */
35 DPA_RESOURCE_ADJUSTED = 1 << 0,
36};
37
38extern struct attribute_group nvdimm_bus_attribute_group;
39extern struct attribute_group nvdimm_attribute_group;
40extern struct attribute_group nd_device_attribute_group;
41extern struct attribute_group nd_numa_attribute_group;
42extern struct attribute_group nd_region_attribute_group;
43extern struct attribute_group nd_mapping_attribute_group;
44
45struct nvdimm;
46struct nvdimm_bus_descriptor;
47typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc,
48 struct nvdimm *nvdimm, unsigned int cmd, void *buf,
49 unsigned int buf_len);
50
51struct nd_namespace_label;
52struct nvdimm_drvdata;
53struct nd_mapping {
54 struct nvdimm *nvdimm;
55 struct nd_namespace_label **labels;
56 u64 start;
57 u64 size;
58 /*
59 * @ndd is for private use at region enable / disable time for
60 * get_ndd() + put_ndd(), all other nd_mapping to ndd
61 * conversions use to_ndd() which respects enabled state of the
62 * nvdimm.
63 */
64 struct nvdimm_drvdata *ndd;
65};
66
67struct nvdimm_bus_descriptor {
68 const struct attribute_group **attr_groups;
69 unsigned long dsm_mask;
70 char *provider_name;
71 ndctl_fn ndctl;
72};
73
74struct nd_cmd_desc {
75 int in_num;
76 int out_num;
77 u32 in_sizes[ND_CMD_MAX_ELEM];
78 int out_sizes[ND_CMD_MAX_ELEM];
79};
80
81struct nd_interleave_set {
82 u64 cookie;
83};
84
85struct nd_region_desc {
86 struct resource *res;
87 struct nd_mapping *nd_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};
95
96struct nvdimm_bus;
97struct module;
98struct device;
99struct nd_blk_region;
100struct nd_blk_region_desc {
101 int (*enable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
102 void (*disable)(struct nvdimm_bus *nvdimm_bus, struct device *dev);
103 int (*do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
104 void *iobuf, u64 len, int rw);
105 struct nd_region_desc ndr_desc;
106};
107
108static inline struct nd_blk_region_desc *to_blk_region_desc(
109 struct nd_region_desc *ndr_desc)
110{
111 return container_of(ndr_desc, struct nd_blk_region_desc, ndr_desc);
112
113}
114
115struct nvdimm_bus *__nvdimm_bus_register(struct device *parent,
116 struct nvdimm_bus_descriptor *nfit_desc, struct module *module);
117#define nvdimm_bus_register(parent, desc) \
118 __nvdimm_bus_register(parent, desc, THIS_MODULE)
119void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus);
120struct nvdimm_bus *to_nvdimm_bus(struct device *dev);
121struct nvdimm *to_nvdimm(struct device *dev);
122struct nd_region *to_nd_region(struct device *dev);
123struct nd_blk_region *to_nd_blk_region(struct device *dev);
124struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus);
125const char *nvdimm_name(struct nvdimm *nvdimm);
126void *nvdimm_provider_data(struct nvdimm *nvdimm);
127struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data,
128 const struct attribute_group **groups, unsigned long flags,
129 unsigned long *dsm_mask);
130const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd);
131const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd);
132u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
133 const struct nd_cmd_desc *desc, int idx, void *buf);
134u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
135 const struct nd_cmd_desc *desc, int idx, const u32 *in_field,
136 const u32 *out_field);
137int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count);
138struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus,
139 struct nd_region_desc *ndr_desc);
140struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus,
141 struct nd_region_desc *ndr_desc);
142struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus,
143 struct nd_region_desc *ndr_desc);
144void *nd_region_provider_data(struct nd_region *nd_region);
145void *nd_blk_region_provider_data(struct nd_blk_region *ndbr);
146void nd_blk_region_set_provider_data(struct nd_blk_region *ndbr, void *data);
147struct nvdimm *nd_blk_region_to_dimm(struct nd_blk_region *ndbr);
148unsigned int nd_region_acquire_lane(struct nd_region *nd_region);
149void nd_region_release_lane(struct nd_region *nd_region, unsigned int lane);
150u64 nd_fletcher64(void *addr, size_t len, bool le);
151#endif /* __LIBNVDIMM_H__ */