]>
Commit | Line | Data |
---|---|---|
b94d5230 DW |
1 | /* |
2 | * NVDIMM Firmware Interface Table - NFIT | |
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 __NFIT_H__ | |
16 | #define __NFIT_H__ | |
17 | #include <linux/libnvdimm.h> | |
18 | #include <linux/types.h> | |
19 | #include <linux/uuid.h> | |
20 | #include <linux/acpi.h> | |
21 | #include <acpi/acuuid.h> | |
22 | ||
23 | #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba" | |
24 | #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66" | |
58138820 DW |
25 | #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \ |
26 | | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \ | |
ca321d1c | 27 | | ACPI_NFIT_MEM_NOT_ARMED) |
b94d5230 DW |
28 | |
29 | enum nfit_uuids { | |
30 | NFIT_SPA_VOLATILE, | |
31 | NFIT_SPA_PM, | |
32 | NFIT_SPA_DCR, | |
33 | NFIT_SPA_BDW, | |
34 | NFIT_SPA_VDISK, | |
35 | NFIT_SPA_VCD, | |
36 | NFIT_SPA_PDISK, | |
37 | NFIT_SPA_PCD, | |
38 | NFIT_DEV_BUS, | |
39 | NFIT_DEV_DIMM, | |
40 | NFIT_UUID_MAX, | |
41 | }; | |
42 | ||
be26f9ae DW |
43 | enum nfit_fic { |
44 | NFIT_FIC_BYTE = 0x101, /* byte-addressable energy backed */ | |
45 | NFIT_FIC_BLK = 0x201, /* block-addressable non-energy backed */ | |
46 | NFIT_FIC_BYTEN = 0x301, /* byte-addressable non-energy backed */ | |
47 | }; | |
48 | ||
f0f2c072 | 49 | enum { |
aef25338 DW |
50 | NFIT_BLK_READ_FLUSH = 1, |
51 | NFIT_BLK_DCR_LATCH = 2, | |
52 | NFIT_ARS_STATUS_DONE = 0, | |
53 | NFIT_ARS_STATUS_BUSY = 1 << 16, | |
54 | NFIT_ARS_STATUS_NONE = 2 << 16, | |
55 | NFIT_ARS_STATUS_INTR = 3 << 16, | |
56 | NFIT_ARS_START_BUSY = 6, | |
57 | NFIT_ARS_CAP_NONE = 1, | |
58 | NFIT_ARS_F_OVERFLOW = 1, | |
f0f2c072 RZ |
59 | }; |
60 | ||
b94d5230 DW |
61 | struct nfit_spa { |
62 | struct acpi_nfit_system_address *spa; | |
63 | struct list_head list; | |
20985164 | 64 | int is_registered; |
b94d5230 DW |
65 | }; |
66 | ||
67 | struct nfit_dcr { | |
68 | struct acpi_nfit_control_region *dcr; | |
69 | struct list_head list; | |
70 | }; | |
71 | ||
72 | struct nfit_bdw { | |
73 | struct acpi_nfit_data_region *bdw; | |
74 | struct list_head list; | |
75 | }; | |
76 | ||
047fc8a1 RZ |
77 | struct nfit_idt { |
78 | struct acpi_nfit_interleave *idt; | |
79 | struct list_head list; | |
80 | }; | |
81 | ||
c2ad2954 RZ |
82 | struct nfit_flush { |
83 | struct acpi_nfit_flush_address *flush; | |
84 | struct list_head list; | |
85 | }; | |
86 | ||
b94d5230 DW |
87 | struct nfit_memdev { |
88 | struct acpi_nfit_memory_map *memdev; | |
89 | struct list_head list; | |
90 | }; | |
91 | ||
92 | /* assembled tables for a given dimm/memory-device */ | |
93 | struct nfit_mem { | |
e6dfb2de | 94 | struct nvdimm *nvdimm; |
b94d5230 DW |
95 | struct acpi_nfit_memory_map *memdev_dcr; |
96 | struct acpi_nfit_memory_map *memdev_pmem; | |
047fc8a1 | 97 | struct acpi_nfit_memory_map *memdev_bdw; |
b94d5230 DW |
98 | struct acpi_nfit_control_region *dcr; |
99 | struct acpi_nfit_data_region *bdw; | |
100 | struct acpi_nfit_system_address *spa_dcr; | |
101 | struct acpi_nfit_system_address *spa_bdw; | |
047fc8a1 RZ |
102 | struct acpi_nfit_interleave *idt_dcr; |
103 | struct acpi_nfit_interleave *idt_bdw; | |
c2ad2954 | 104 | struct nfit_flush *nfit_flush; |
b94d5230 | 105 | struct list_head list; |
62232e45 DW |
106 | struct acpi_device *adev; |
107 | unsigned long dsm_mask; | |
b94d5230 DW |
108 | }; |
109 | ||
110 | struct acpi_nfit_desc { | |
111 | struct nvdimm_bus_descriptor nd_desc; | |
6b577c9d LK |
112 | struct acpi_table_header acpi_header; |
113 | struct acpi_nfit_header *nfit; | |
047fc8a1 | 114 | struct mutex spa_map_mutex; |
20985164 | 115 | struct mutex init_mutex; |
047fc8a1 | 116 | struct list_head spa_maps; |
b94d5230 | 117 | struct list_head memdevs; |
c2ad2954 | 118 | struct list_head flushes; |
b94d5230 DW |
119 | struct list_head dimms; |
120 | struct list_head spas; | |
121 | struct list_head dcrs; | |
122 | struct list_head bdws; | |
047fc8a1 | 123 | struct list_head idts; |
b94d5230 DW |
124 | struct nvdimm_bus *nvdimm_bus; |
125 | struct device *dev; | |
62232e45 | 126 | unsigned long dimm_dsm_force_en; |
39c686b8 | 127 | unsigned long bus_dsm_force_en; |
6bc75619 DW |
128 | int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, |
129 | void *iobuf, u64 len, int rw); | |
b94d5230 DW |
130 | }; |
131 | ||
047fc8a1 RZ |
132 | enum nd_blk_mmio_selector { |
133 | BDW, | |
134 | DCR, | |
135 | }; | |
136 | ||
67a3e8fe RZ |
137 | struct nd_blk_addr { |
138 | union { | |
139 | void __iomem *base; | |
140 | void __pmem *aperture; | |
141 | }; | |
142 | }; | |
143 | ||
047fc8a1 RZ |
144 | struct nfit_blk { |
145 | struct nfit_blk_mmio { | |
67a3e8fe | 146 | struct nd_blk_addr addr; |
047fc8a1 RZ |
147 | u64 size; |
148 | u64 base_offset; | |
149 | u32 line_size; | |
150 | u32 num_lines; | |
151 | u32 table_size; | |
152 | struct acpi_nfit_interleave *idt; | |
153 | struct acpi_nfit_system_address *spa; | |
154 | } mmio[2]; | |
155 | struct nd_region *nd_region; | |
156 | u64 bdw_offset; /* post interleave offset */ | |
157 | u64 stat_offset; | |
158 | u64 cmd_offset; | |
c2ad2954 | 159 | void __iomem *nvdimm_flush; |
f0f2c072 | 160 | u32 dimm_flags; |
c2ad2954 RZ |
161 | }; |
162 | ||
163 | enum spa_map_type { | |
164 | SPA_MAP_CONTROL, | |
165 | SPA_MAP_APERTURE, | |
047fc8a1 RZ |
166 | }; |
167 | ||
168 | struct nfit_spa_mapping { | |
169 | struct acpi_nfit_desc *acpi_desc; | |
170 | struct acpi_nfit_system_address *spa; | |
171 | struct list_head list; | |
172 | struct kref kref; | |
67a3e8fe RZ |
173 | enum spa_map_type type; |
174 | struct nd_blk_addr addr; | |
047fc8a1 RZ |
175 | }; |
176 | ||
177 | static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref) | |
178 | { | |
179 | return container_of(kref, struct nfit_spa_mapping, kref); | |
180 | } | |
181 | ||
b94d5230 DW |
182 | static inline struct acpi_nfit_memory_map *__to_nfit_memdev( |
183 | struct nfit_mem *nfit_mem) | |
184 | { | |
185 | if (nfit_mem->memdev_dcr) | |
186 | return nfit_mem->memdev_dcr; | |
187 | return nfit_mem->memdev_pmem; | |
188 | } | |
45def22c DW |
189 | |
190 | static inline struct acpi_nfit_desc *to_acpi_desc( | |
191 | struct nvdimm_bus_descriptor *nd_desc) | |
192 | { | |
193 | return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); | |
194 | } | |
6bc75619 DW |
195 | |
196 | const u8 *to_nfit_uuid(enum nfit_uuids id); | |
197 | int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz); | |
198 | extern const struct attribute_group *acpi_nfit_attribute_groups[]; | |
b94d5230 | 199 | #endif /* __NFIT_H__ */ |