Merge tag 'edac_for_4.17' of git://git.kernel.org/pub/scm/linux/kernel/git/bp/bp
[muen/linux.git] / drivers / acpi / nfit / nfit.h
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/workqueue.h>
18 #include <linux/libnvdimm.h>
19 #include <linux/ndctl.h>
20 #include <linux/types.h>
21 #include <linux/acpi.h>
22 #include <acpi/acuuid.h>
23
24 /* ACPI 6.1 */
25 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
26
27 /* http://pmem.io/documents/NVDIMM_DSM_Interface-V1.6.pdf */
28 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
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
34 /* https://msdn.microsoft.com/library/windows/hardware/mt604741 */
35 #define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05"
36
37 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
38                 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
39                 | ACPI_NFIT_MEM_NOT_ARMED | ACPI_NFIT_MEM_MAP_FAILED)
40
41 #define NVDIMM_FAMILY_MAX NVDIMM_FAMILY_MSFT
42
43 #define NVDIMM_STANDARD_CMDMASK \
44 (1 << ND_CMD_SMART | 1 << ND_CMD_SMART_THRESHOLD | 1 << ND_CMD_DIMM_FLAGS \
45  | 1 << ND_CMD_GET_CONFIG_SIZE | 1 << ND_CMD_GET_CONFIG_DATA \
46  | 1 << ND_CMD_SET_CONFIG_DATA | 1 << ND_CMD_VENDOR_EFFECT_LOG_SIZE \
47  | 1 << ND_CMD_VENDOR_EFFECT_LOG | 1 << ND_CMD_VENDOR)
48
49 /*
50  * Command numbers that the kernel needs to know about to handle
51  * non-default DSM revision ids
52  */
53 enum nvdimm_family_cmds {
54         NVDIMM_INTEL_LATCH_SHUTDOWN = 10,
55         NVDIMM_INTEL_GET_MODES = 11,
56         NVDIMM_INTEL_GET_FWINFO = 12,
57         NVDIMM_INTEL_START_FWUPDATE = 13,
58         NVDIMM_INTEL_SEND_FWUPDATE = 14,
59         NVDIMM_INTEL_FINISH_FWUPDATE = 15,
60         NVDIMM_INTEL_QUERY_FWUPDATE = 16,
61         NVDIMM_INTEL_SET_THRESHOLD = 17,
62         NVDIMM_INTEL_INJECT_ERROR = 18,
63 };
64
65 #define NVDIMM_INTEL_CMDMASK \
66 (NVDIMM_STANDARD_CMDMASK | 1 << NVDIMM_INTEL_GET_MODES \
67  | 1 << NVDIMM_INTEL_GET_FWINFO | 1 << NVDIMM_INTEL_START_FWUPDATE \
68  | 1 << NVDIMM_INTEL_SEND_FWUPDATE | 1 << NVDIMM_INTEL_FINISH_FWUPDATE \
69  | 1 << NVDIMM_INTEL_QUERY_FWUPDATE | 1 << NVDIMM_INTEL_SET_THRESHOLD \
70  | 1 << NVDIMM_INTEL_INJECT_ERROR | 1 << NVDIMM_INTEL_LATCH_SHUTDOWN)
71
72 enum nfit_uuids {
73         /* for simplicity alias the uuid index with the family id */
74         NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
75         NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
76         NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
77         NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT,
78         NFIT_SPA_VOLATILE,
79         NFIT_SPA_PM,
80         NFIT_SPA_DCR,
81         NFIT_SPA_BDW,
82         NFIT_SPA_VDISK,
83         NFIT_SPA_VCD,
84         NFIT_SPA_PDISK,
85         NFIT_SPA_PCD,
86         NFIT_DEV_BUS,
87         NFIT_UUID_MAX,
88 };
89
90 /*
91  * Region format interface codes are stored with the interface as the
92  * LSB and the function as the MSB.
93  */
94 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
95 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
96 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */
97
98 enum {
99         NFIT_BLK_READ_FLUSH = 1,
100         NFIT_BLK_DCR_LATCH = 2,
101         NFIT_ARS_STATUS_DONE = 0,
102         NFIT_ARS_STATUS_BUSY = 1 << 16,
103         NFIT_ARS_STATUS_NONE = 2 << 16,
104         NFIT_ARS_STATUS_INTR = 3 << 16,
105         NFIT_ARS_START_BUSY = 6,
106         NFIT_ARS_CAP_NONE = 1,
107         NFIT_ARS_F_OVERFLOW = 1,
108         NFIT_ARS_TIMEOUT = 90,
109 };
110
111 enum nfit_root_notifiers {
112         NFIT_NOTIFY_UPDATE = 0x80,
113         NFIT_NOTIFY_UC_MEMORY_ERROR = 0x81,
114 };
115
116 enum nfit_dimm_notifiers {
117         NFIT_NOTIFY_DIMM_HEALTH = 0x81,
118 };
119
120 struct nfit_spa {
121         struct list_head list;
122         struct nd_region *nd_region;
123         unsigned int ars_required:1;
124         u32 clear_err_unit;
125         u32 max_ars;
126         struct acpi_nfit_system_address spa[0];
127 };
128
129 struct nfit_dcr {
130         struct list_head list;
131         struct acpi_nfit_control_region dcr[0];
132 };
133
134 struct nfit_bdw {
135         struct list_head list;
136         struct acpi_nfit_data_region bdw[0];
137 };
138
139 struct nfit_idt {
140         struct list_head list;
141         struct acpi_nfit_interleave idt[0];
142 };
143
144 struct nfit_flush {
145         struct list_head list;
146         struct acpi_nfit_flush_address flush[0];
147 };
148
149 struct nfit_memdev {
150         struct list_head list;
151         struct acpi_nfit_memory_map memdev[0];
152 };
153
154 /* assembled tables for a given dimm/memory-device */
155 struct nfit_mem {
156         struct nvdimm *nvdimm;
157         struct acpi_nfit_memory_map *memdev_dcr;
158         struct acpi_nfit_memory_map *memdev_pmem;
159         struct acpi_nfit_memory_map *memdev_bdw;
160         struct acpi_nfit_control_region *dcr;
161         struct acpi_nfit_data_region *bdw;
162         struct acpi_nfit_system_address *spa_dcr;
163         struct acpi_nfit_system_address *spa_bdw;
164         struct acpi_nfit_interleave *idt_dcr;
165         struct acpi_nfit_interleave *idt_bdw;
166         struct kernfs_node *flags_attr;
167         struct nfit_flush *nfit_flush;
168         struct list_head list;
169         struct acpi_device *adev;
170         struct acpi_nfit_desc *acpi_desc;
171         struct resource *flush_wpq;
172         unsigned long dsm_mask;
173         int family;
174         u32 has_lsi:1;
175         u32 has_lsr:1;
176         u32 has_lsw:1;
177 };
178
179 struct acpi_nfit_desc {
180         struct nvdimm_bus_descriptor nd_desc;
181         struct acpi_table_header acpi_header;
182         struct mutex init_mutex;
183         struct list_head memdevs;
184         struct list_head flushes;
185         struct list_head dimms;
186         struct list_head spas;
187         struct list_head dcrs;
188         struct list_head bdws;
189         struct list_head idts;
190         struct nvdimm_bus *nvdimm_bus;
191         struct device *dev;
192         u8 ars_start_flags;
193         struct nd_cmd_ars_status *ars_status;
194         size_t ars_status_size;
195         struct work_struct work;
196         struct list_head list;
197         struct kernfs_node *scrub_count_state;
198         unsigned int scrub_count;
199         unsigned int scrub_mode;
200         unsigned int cancel:1;
201         unsigned int init_complete:1;
202         unsigned long dimm_cmd_force_en;
203         unsigned long bus_cmd_force_en;
204         unsigned long bus_nfit_cmd_force_en;
205         unsigned int platform_cap;
206         int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
207                         void *iobuf, u64 len, int rw);
208 };
209
210 enum scrub_mode {
211         HW_ERROR_SCRUB_OFF,
212         HW_ERROR_SCRUB_ON,
213 };
214
215 enum nd_blk_mmio_selector {
216         BDW,
217         DCR,
218 };
219
220 struct nd_blk_addr {
221         union {
222                 void __iomem *base;
223                 void *aperture;
224         };
225 };
226
227 struct nfit_blk {
228         struct nfit_blk_mmio {
229                 struct nd_blk_addr addr;
230                 u64 size;
231                 u64 base_offset;
232                 u32 line_size;
233                 u32 num_lines;
234                 u32 table_size;
235                 struct acpi_nfit_interleave *idt;
236                 struct acpi_nfit_system_address *spa;
237         } mmio[2];
238         struct nd_region *nd_region;
239         u64 bdw_offset; /* post interleave offset */
240         u64 stat_offset;
241         u64 cmd_offset;
242         u32 dimm_flags;
243 };
244
245 extern struct list_head acpi_descs;
246 extern struct mutex acpi_desc_lock;
247 int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc, u8 flags);
248
249 #ifdef CONFIG_X86_MCE
250 void nfit_mce_register(void);
251 void nfit_mce_unregister(void);
252 #else
253 static inline void nfit_mce_register(void)
254 {
255 }
256 static inline void nfit_mce_unregister(void)
257 {
258 }
259 #endif
260
261 int nfit_spa_type(struct acpi_nfit_system_address *spa);
262
263 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
264                 struct nfit_mem *nfit_mem)
265 {
266         if (nfit_mem->memdev_dcr)
267                 return nfit_mem->memdev_dcr;
268         return nfit_mem->memdev_pmem;
269 }
270
271 static inline struct acpi_nfit_desc *to_acpi_desc(
272                 struct nvdimm_bus_descriptor *nd_desc)
273 {
274         return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
275 }
276
277 const guid_t *to_nfit_uuid(enum nfit_uuids id);
278 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz);
279 void acpi_nfit_shutdown(void *data);
280 void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event);
281 void __acpi_nvdimm_notify(struct device *dev, u32 event);
282 int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm,
283                 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc);
284 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
285 #endif /* __NFIT_H__ */