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__ | |
7ae0fa43 | 17 | #include <linux/workqueue.h> |
b94d5230 DW |
18 | #include <linux/libnvdimm.h> |
19 | #include <linux/types.h> | |
20 | #include <linux/uuid.h> | |
21 | #include <linux/acpi.h> | |
22 | #include <acpi/acuuid.h> | |
23 | ||
31eca76b | 24 | /* ACPI 6.1 */ |
b94d5230 | 25 | #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba" |
31eca76b DW |
26 | |
27 | /* http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf */ | |
b94d5230 | 28 | #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66" |
31eca76b DW |
29 | |
30 | /* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */ | |
31 | #define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6" | |
32 | #define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e" | |
33 | ||
58138820 DW |
34 | #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \ |
35 | | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \ | |
ca321d1c | 36 | | ACPI_NFIT_MEM_NOT_ARMED) |
b94d5230 DW |
37 | |
38 | enum nfit_uuids { | |
31eca76b DW |
39 | /* for simplicity alias the uuid index with the family id */ |
40 | NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL, | |
41 | NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1, | |
42 | NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2, | |
b94d5230 DW |
43 | NFIT_SPA_VOLATILE, |
44 | NFIT_SPA_PM, | |
45 | NFIT_SPA_DCR, | |
46 | NFIT_SPA_BDW, | |
47 | NFIT_SPA_VDISK, | |
48 | NFIT_SPA_VCD, | |
49 | NFIT_SPA_PDISK, | |
50 | NFIT_SPA_PCD, | |
51 | NFIT_DEV_BUS, | |
b94d5230 DW |
52 | NFIT_UUID_MAX, |
53 | }; | |
54 | ||
30ec5fd4 DW |
55 | /* |
56 | * Region format interface codes are stored as an array of bytes in the | |
57 | * NFIT DIMM Control Region structure | |
58 | */ | |
59 | #define NFIT_FIC_BYTE cpu_to_be16(0x101) /* byte-addressable energy backed */ | |
60 | #define NFIT_FIC_BLK cpu_to_be16(0x201) /* block-addressable non-energy backed */ | |
61 | #define NFIT_FIC_BYTEN cpu_to_be16(0x301) /* byte-addressable non-energy backed */ | |
be26f9ae | 62 | |
f0f2c072 | 63 | enum { |
aef25338 DW |
64 | NFIT_BLK_READ_FLUSH = 1, |
65 | NFIT_BLK_DCR_LATCH = 2, | |
66 | NFIT_ARS_STATUS_DONE = 0, | |
67 | NFIT_ARS_STATUS_BUSY = 1 << 16, | |
68 | NFIT_ARS_STATUS_NONE = 2 << 16, | |
69 | NFIT_ARS_STATUS_INTR = 3 << 16, | |
70 | NFIT_ARS_START_BUSY = 6, | |
71 | NFIT_ARS_CAP_NONE = 1, | |
72 | NFIT_ARS_F_OVERFLOW = 1, | |
1cf03c00 | 73 | NFIT_ARS_TIMEOUT = 90, |
f0f2c072 RZ |
74 | }; |
75 | ||
b94d5230 DW |
76 | struct nfit_spa { |
77 | struct acpi_nfit_system_address *spa; | |
78 | struct list_head list; | |
1cf03c00 DW |
79 | struct nd_region *nd_region; |
80 | unsigned int ars_done:1; | |
81 | u32 clear_err_unit; | |
82 | u32 max_ars; | |
b94d5230 DW |
83 | }; |
84 | ||
85 | struct nfit_dcr { | |
86 | struct acpi_nfit_control_region *dcr; | |
87 | struct list_head list; | |
88 | }; | |
89 | ||
90 | struct nfit_bdw { | |
91 | struct acpi_nfit_data_region *bdw; | |
92 | struct list_head list; | |
93 | }; | |
94 | ||
047fc8a1 RZ |
95 | struct nfit_idt { |
96 | struct acpi_nfit_interleave *idt; | |
97 | struct list_head list; | |
98 | }; | |
99 | ||
c2ad2954 RZ |
100 | struct nfit_flush { |
101 | struct acpi_nfit_flush_address *flush; | |
102 | struct list_head list; | |
103 | }; | |
104 | ||
b94d5230 DW |
105 | struct nfit_memdev { |
106 | struct acpi_nfit_memory_map *memdev; | |
107 | struct list_head list; | |
108 | }; | |
109 | ||
110 | /* assembled tables for a given dimm/memory-device */ | |
111 | struct nfit_mem { | |
e6dfb2de | 112 | struct nvdimm *nvdimm; |
b94d5230 DW |
113 | struct acpi_nfit_memory_map *memdev_dcr; |
114 | struct acpi_nfit_memory_map *memdev_pmem; | |
047fc8a1 | 115 | struct acpi_nfit_memory_map *memdev_bdw; |
b94d5230 DW |
116 | struct acpi_nfit_control_region *dcr; |
117 | struct acpi_nfit_data_region *bdw; | |
118 | struct acpi_nfit_system_address *spa_dcr; | |
119 | struct acpi_nfit_system_address *spa_bdw; | |
047fc8a1 RZ |
120 | struct acpi_nfit_interleave *idt_dcr; |
121 | struct acpi_nfit_interleave *idt_bdw; | |
c2ad2954 | 122 | struct nfit_flush *nfit_flush; |
b94d5230 | 123 | struct list_head list; |
62232e45 | 124 | struct acpi_device *adev; |
8cc6ddfc | 125 | struct acpi_nfit_desc *acpi_desc; |
62232e45 | 126 | unsigned long dsm_mask; |
31eca76b | 127 | int family; |
b94d5230 DW |
128 | }; |
129 | ||
130 | struct acpi_nfit_desc { | |
131 | struct nvdimm_bus_descriptor nd_desc; | |
6b577c9d LK |
132 | struct acpi_table_header acpi_header; |
133 | struct acpi_nfit_header *nfit; | |
047fc8a1 | 134 | struct mutex spa_map_mutex; |
20985164 | 135 | struct mutex init_mutex; |
047fc8a1 | 136 | struct list_head spa_maps; |
b94d5230 | 137 | struct list_head memdevs; |
c2ad2954 | 138 | struct list_head flushes; |
b94d5230 DW |
139 | struct list_head dimms; |
140 | struct list_head spas; | |
141 | struct list_head dcrs; | |
142 | struct list_head bdws; | |
047fc8a1 | 143 | struct list_head idts; |
b94d5230 DW |
144 | struct nvdimm_bus *nvdimm_bus; |
145 | struct device *dev; | |
1cf03c00 DW |
146 | struct nd_cmd_ars_status *ars_status; |
147 | size_t ars_status_size; | |
7ae0fa43 DW |
148 | struct work_struct work; |
149 | unsigned int cancel:1; | |
e3654eca DW |
150 | unsigned long dimm_cmd_force_en; |
151 | unsigned long bus_cmd_force_en; | |
6bc75619 DW |
152 | int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, |
153 | void *iobuf, u64 len, int rw); | |
b94d5230 DW |
154 | }; |
155 | ||
047fc8a1 RZ |
156 | enum nd_blk_mmio_selector { |
157 | BDW, | |
158 | DCR, | |
159 | }; | |
160 | ||
67a3e8fe RZ |
161 | struct nd_blk_addr { |
162 | union { | |
163 | void __iomem *base; | |
164 | void __pmem *aperture; | |
165 | }; | |
166 | }; | |
167 | ||
047fc8a1 RZ |
168 | struct nfit_blk { |
169 | struct nfit_blk_mmio { | |
67a3e8fe | 170 | struct nd_blk_addr addr; |
047fc8a1 RZ |
171 | u64 size; |
172 | u64 base_offset; | |
173 | u32 line_size; | |
174 | u32 num_lines; | |
175 | u32 table_size; | |
176 | struct acpi_nfit_interleave *idt; | |
177 | struct acpi_nfit_system_address *spa; | |
178 | } mmio[2]; | |
179 | struct nd_region *nd_region; | |
180 | u64 bdw_offset; /* post interleave offset */ | |
181 | u64 stat_offset; | |
182 | u64 cmd_offset; | |
c2ad2954 | 183 | void __iomem *nvdimm_flush; |
f0f2c072 | 184 | u32 dimm_flags; |
c2ad2954 RZ |
185 | }; |
186 | ||
187 | enum spa_map_type { | |
188 | SPA_MAP_CONTROL, | |
189 | SPA_MAP_APERTURE, | |
047fc8a1 RZ |
190 | }; |
191 | ||
192 | struct nfit_spa_mapping { | |
193 | struct acpi_nfit_desc *acpi_desc; | |
194 | struct acpi_nfit_system_address *spa; | |
195 | struct list_head list; | |
196 | struct kref kref; | |
67a3e8fe RZ |
197 | enum spa_map_type type; |
198 | struct nd_blk_addr addr; | |
047fc8a1 RZ |
199 | }; |
200 | ||
201 | static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref) | |
202 | { | |
203 | return container_of(kref, struct nfit_spa_mapping, kref); | |
204 | } | |
205 | ||
b94d5230 DW |
206 | static inline struct acpi_nfit_memory_map *__to_nfit_memdev( |
207 | struct nfit_mem *nfit_mem) | |
208 | { | |
209 | if (nfit_mem->memdev_dcr) | |
210 | return nfit_mem->memdev_dcr; | |
211 | return nfit_mem->memdev_pmem; | |
212 | } | |
45def22c DW |
213 | |
214 | static inline struct acpi_nfit_desc *to_acpi_desc( | |
215 | struct nvdimm_bus_descriptor *nd_desc) | |
216 | { | |
217 | return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); | |
218 | } | |
6bc75619 DW |
219 | |
220 | const u8 *to_nfit_uuid(enum nfit_uuids id); | |
221 | int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz); | |
a61fe6f7 | 222 | void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev); |
b94d5230 | 223 | #endif /* __NFIT_H__ */ |