]>
Commit | Line | Data |
---|---|---|
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__ | |
62232e45 DW |
17 | #include <linux/sizes.h> |
18 | #include <linux/types.h> | |
e6dfb2de DW |
19 | |
20 | enum { | |
21 | /* when a dimm supports both PMEM and BLK access a label is required */ | |
22 | NDD_ALIASING = 1 << 0, | |
62232e45 DW |
23 | |
24 | /* need to set a limit somewhere, but yes, this is likely overkill */ | |
25 | ND_IOCTL_MAX_BUFLEN = SZ_4M, | |
26 | ND_CMD_MAX_ELEM = 4, | |
27 | ND_CMD_MAX_ENVELOPE = 16, | |
28 | ND_CMD_ARS_STATUS_MAX = SZ_4K, | |
1f7df6f8 | 29 | ND_MAX_MAPPINGS = 32, |
e6dfb2de DW |
30 | }; |
31 | ||
45def22c | 32 | extern struct attribute_group nvdimm_bus_attribute_group; |
62232e45 | 33 | extern struct attribute_group nvdimm_attribute_group; |
4d88a97a | 34 | extern struct attribute_group nd_device_attribute_group; |
1f7df6f8 DW |
35 | extern struct attribute_group nd_region_attribute_group; |
36 | extern struct attribute_group nd_mapping_attribute_group; | |
45def22c | 37 | |
b94d5230 DW |
38 | struct nvdimm; |
39 | struct nvdimm_bus_descriptor; | |
40 | typedef int (*ndctl_fn)(struct nvdimm_bus_descriptor *nd_desc, | |
41 | struct nvdimm *nvdimm, unsigned int cmd, void *buf, | |
42 | unsigned int buf_len); | |
43 | ||
1f7df6f8 DW |
44 | struct nd_mapping { |
45 | struct nvdimm *nvdimm; | |
46 | u64 start; | |
47 | u64 size; | |
48 | }; | |
49 | ||
b94d5230 | 50 | struct nvdimm_bus_descriptor { |
45def22c | 51 | const struct attribute_group **attr_groups; |
b94d5230 DW |
52 | unsigned long dsm_mask; |
53 | char *provider_name; | |
54 | ndctl_fn ndctl; | |
55 | }; | |
56 | ||
62232e45 DW |
57 | struct nd_cmd_desc { |
58 | int in_num; | |
59 | int out_num; | |
60 | u32 in_sizes[ND_CMD_MAX_ELEM]; | |
61 | int out_sizes[ND_CMD_MAX_ELEM]; | |
62 | }; | |
63 | ||
1f7df6f8 DW |
64 | struct nd_region_desc { |
65 | struct resource *res; | |
66 | struct nd_mapping *nd_mapping; | |
67 | u16 num_mappings; | |
68 | const struct attribute_group **attr_groups; | |
69 | void *provider_data; | |
70 | }; | |
71 | ||
62232e45 | 72 | struct nvdimm_bus; |
b94d5230 | 73 | struct device; |
b94d5230 DW |
74 | struct nvdimm_bus *nvdimm_bus_register(struct device *parent, |
75 | struct nvdimm_bus_descriptor *nfit_desc); | |
76 | void nvdimm_bus_unregister(struct nvdimm_bus *nvdimm_bus); | |
45def22c | 77 | struct nvdimm_bus *to_nvdimm_bus(struct device *dev); |
e6dfb2de | 78 | struct nvdimm *to_nvdimm(struct device *dev); |
1f7df6f8 | 79 | struct nd_region *to_nd_region(struct device *dev); |
45def22c | 80 | struct nvdimm_bus_descriptor *to_nd_desc(struct nvdimm_bus *nvdimm_bus); |
e6dfb2de DW |
81 | const char *nvdimm_name(struct nvdimm *nvdimm); |
82 | void *nvdimm_provider_data(struct nvdimm *nvdimm); | |
1f7df6f8 | 83 | void *nd_region_provider_data(struct nd_region *nd_region); |
e6dfb2de | 84 | struct nvdimm *nvdimm_create(struct nvdimm_bus *nvdimm_bus, void *provider_data, |
62232e45 DW |
85 | const struct attribute_group **groups, unsigned long flags, |
86 | unsigned long *dsm_mask); | |
87 | const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd); | |
88 | const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd); | |
89 | u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd, | |
90 | const struct nd_cmd_desc *desc, int idx, void *buf); | |
91 | u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd, | |
92 | const struct nd_cmd_desc *desc, int idx, const u32 *in_field, | |
93 | const u32 *out_field); | |
4d88a97a | 94 | int nvdimm_bus_check_dimm_count(struct nvdimm_bus *nvdimm_bus, int dimm_count); |
1f7df6f8 DW |
95 | struct nd_region *nvdimm_pmem_region_create(struct nvdimm_bus *nvdimm_bus, |
96 | struct nd_region_desc *ndr_desc); | |
97 | struct nd_region *nvdimm_blk_region_create(struct nvdimm_bus *nvdimm_bus, | |
98 | struct nd_region_desc *ndr_desc); | |
99 | struct nd_region *nvdimm_volatile_region_create(struct nvdimm_bus *nvdimm_bus, | |
100 | struct nd_region_desc *ndr_desc); | |
b94d5230 | 101 | #endif /* __LIBNVDIMM_H__ */ |