1
2
3
4
5
6
7
8
9
10
11
12
13
14
15#ifndef __NFIT_H__
16#define __NFIT_H__
17#include <linux/workqueue.h>
18#include <linux/libnvdimm.h>
19#include <linux/ndctl.h>
20#include <linux/types.h>
21#include <linux/uuid.h>
22#include <linux/acpi.h>
23#include <acpi/acuuid.h>
24
25
26#define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
27
28
29#define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
30
31
32#define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6"
33#define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e"
34
35
36#define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05"
37
38#define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
39 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
40 | ACPI_NFIT_MEM_NOT_ARMED)
41
42enum nfit_uuids {
43
44 NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
45 NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
46 NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
47 NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT,
48 NFIT_SPA_VOLATILE,
49 NFIT_SPA_PM,
50 NFIT_SPA_DCR,
51 NFIT_SPA_BDW,
52 NFIT_SPA_VDISK,
53 NFIT_SPA_VCD,
54 NFIT_SPA_PDISK,
55 NFIT_SPA_PCD,
56 NFIT_DEV_BUS,
57 NFIT_UUID_MAX,
58};
59
60
61
62
63
64#define NFIT_FIC_BYTE cpu_to_le16(0x101)
65#define NFIT_FIC_BLK cpu_to_le16(0x201)
66#define NFIT_FIC_BYTEN cpu_to_le16(0x301)
67
68enum {
69 NFIT_BLK_READ_FLUSH = 1,
70 NFIT_BLK_DCR_LATCH = 2,
71 NFIT_ARS_STATUS_DONE = 0,
72 NFIT_ARS_STATUS_BUSY = 1 << 16,
73 NFIT_ARS_STATUS_NONE = 2 << 16,
74 NFIT_ARS_STATUS_INTR = 3 << 16,
75 NFIT_ARS_START_BUSY = 6,
76 NFIT_ARS_CAP_NONE = 1,
77 NFIT_ARS_F_OVERFLOW = 1,
78 NFIT_ARS_TIMEOUT = 90,
79};
80
81enum nfit_root_notifiers {
82 NFIT_NOTIFY_UPDATE = 0x80,
83};
84
85enum nfit_dimm_notifiers {
86 NFIT_NOTIFY_DIMM_HEALTH = 0x81,
87};
88
89struct nfit_spa {
90 struct list_head list;
91 struct nd_region *nd_region;
92 unsigned int ars_required:1;
93 u32 clear_err_unit;
94 u32 max_ars;
95 struct acpi_nfit_system_address spa[0];
96};
97
98struct nfit_dcr {
99 struct list_head list;
100 struct acpi_nfit_control_region dcr[0];
101};
102
103struct nfit_bdw {
104 struct list_head list;
105 struct acpi_nfit_data_region bdw[0];
106};
107
108struct nfit_idt {
109 struct list_head list;
110 struct acpi_nfit_interleave idt[0];
111};
112
113struct nfit_flush {
114 struct list_head list;
115 struct acpi_nfit_flush_address flush[0];
116};
117
118struct nfit_memdev {
119 struct list_head list;
120 struct acpi_nfit_memory_map memdev[0];
121};
122
123
124struct nfit_mem {
125 struct nvdimm *nvdimm;
126 struct acpi_nfit_memory_map *memdev_dcr;
127 struct acpi_nfit_memory_map *memdev_pmem;
128 struct acpi_nfit_memory_map *memdev_bdw;
129 struct acpi_nfit_control_region *dcr;
130 struct acpi_nfit_data_region *bdw;
131 struct acpi_nfit_system_address *spa_dcr;
132 struct acpi_nfit_system_address *spa_bdw;
133 struct acpi_nfit_interleave *idt_dcr;
134 struct acpi_nfit_interleave *idt_bdw;
135 struct kernfs_node *flags_attr;
136 struct nfit_flush *nfit_flush;
137 struct list_head list;
138 struct acpi_device *adev;
139 struct acpi_nfit_desc *acpi_desc;
140 struct resource *flush_wpq;
141 unsigned long dsm_mask;
142 int family;
143};
144
145struct acpi_nfit_desc {
146 struct nvdimm_bus_descriptor nd_desc;
147 struct acpi_table_header acpi_header;
148 struct mutex init_mutex;
149 struct list_head memdevs;
150 struct list_head flushes;
151 struct list_head dimms;
152 struct list_head spas;
153 struct list_head dcrs;
154 struct list_head bdws;
155 struct list_head idts;
156 struct nvdimm_bus *nvdimm_bus;
157 struct device *dev;
158 struct nd_cmd_ars_status *ars_status;
159 size_t ars_status_size;
160 struct work_struct work;
161 struct list_head list;
162 struct kernfs_node *scrub_count_state;
163 unsigned int scrub_count;
164 unsigned int scrub_mode;
165 unsigned int cancel:1;
166 unsigned long dimm_cmd_force_en;
167 unsigned long bus_cmd_force_en;
168 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
169 void *iobuf, u64 len, int rw);
170};
171
172enum scrub_mode {
173 HW_ERROR_SCRUB_OFF,
174 HW_ERROR_SCRUB_ON,
175};
176
177enum nd_blk_mmio_selector {
178 BDW,
179 DCR,
180};
181
182struct nd_blk_addr {
183 union {
184 void __iomem *base;
185 void *aperture;
186 };
187};
188
189struct nfit_blk {
190 struct nfit_blk_mmio {
191 struct nd_blk_addr addr;
192 u64 size;
193 u64 base_offset;
194 u32 line_size;
195 u32 num_lines;
196 u32 table_size;
197 struct acpi_nfit_interleave *idt;
198 struct acpi_nfit_system_address *spa;
199 } mmio[2];
200 struct nd_region *nd_region;
201 u64 bdw_offset;
202 u64 stat_offset;
203 u64 cmd_offset;
204 u32 dimm_flags;
205};
206
207extern struct list_head acpi_descs;
208extern struct mutex acpi_desc_lock;
209int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc);
210
211#ifdef CONFIG_X86_MCE
212void nfit_mce_register(void);
213void nfit_mce_unregister(void);
214#else
215static inline void nfit_mce_register(void)
216{
217}
218static inline void nfit_mce_unregister(void)
219{
220}
221#endif
222
223int nfit_spa_type(struct acpi_nfit_system_address *spa);
224
225static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
226 struct nfit_mem *nfit_mem)
227{
228 if (nfit_mem->memdev_dcr)
229 return nfit_mem->memdev_dcr;
230 return nfit_mem->memdev_pmem;
231}
232
233static inline struct acpi_nfit_desc *to_acpi_desc(
234 struct nvdimm_bus_descriptor *nd_desc)
235{
236 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
237}
238
239const u8 *to_nfit_uuid(enum nfit_uuids id);
240int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz);
241void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event);
242void __acpi_nvdimm_notify(struct device *dev, u32 event);
243int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm,
244 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc);
245void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
246#endif
247
