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