xref: /openbmc/linux/drivers/acpi/nfit/nfit.h (revision 5d0e4d78)
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_Example.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 enum nfit_uuids {
42 	/* for simplicity alias the uuid index with the family id */
43 	NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
44 	NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
45 	NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
46 	NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT,
47 	NFIT_SPA_VOLATILE,
48 	NFIT_SPA_PM,
49 	NFIT_SPA_DCR,
50 	NFIT_SPA_BDW,
51 	NFIT_SPA_VDISK,
52 	NFIT_SPA_VCD,
53 	NFIT_SPA_PDISK,
54 	NFIT_SPA_PCD,
55 	NFIT_DEV_BUS,
56 	NFIT_UUID_MAX,
57 };
58 
59 /*
60  * Region format interface codes are stored with the interface as the
61  * LSB and the function as the MSB.
62  */
63 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
64 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
65 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */
66 
67 enum {
68 	NFIT_BLK_READ_FLUSH = 1,
69 	NFIT_BLK_DCR_LATCH = 2,
70 	NFIT_ARS_STATUS_DONE = 0,
71 	NFIT_ARS_STATUS_BUSY = 1 << 16,
72 	NFIT_ARS_STATUS_NONE = 2 << 16,
73 	NFIT_ARS_STATUS_INTR = 3 << 16,
74 	NFIT_ARS_START_BUSY = 6,
75 	NFIT_ARS_CAP_NONE = 1,
76 	NFIT_ARS_F_OVERFLOW = 1,
77 	NFIT_ARS_TIMEOUT = 90,
78 };
79 
80 enum nfit_root_notifiers {
81 	NFIT_NOTIFY_UPDATE = 0x80,
82 	NFIT_NOTIFY_UC_MEMORY_ERROR = 0x81,
83 };
84 
85 enum nfit_dimm_notifiers {
86 	NFIT_NOTIFY_DIMM_HEALTH = 0x81,
87 };
88 
89 struct 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 
98 struct nfit_dcr {
99 	struct list_head list;
100 	struct acpi_nfit_control_region dcr[0];
101 };
102 
103 struct nfit_bdw {
104 	struct list_head list;
105 	struct acpi_nfit_data_region bdw[0];
106 };
107 
108 struct nfit_idt {
109 	struct list_head list;
110 	struct acpi_nfit_interleave idt[0];
111 };
112 
113 struct nfit_flush {
114 	struct list_head list;
115 	struct acpi_nfit_flush_address flush[0];
116 };
117 
118 struct nfit_memdev {
119 	struct list_head list;
120 	struct acpi_nfit_memory_map memdev[0];
121 };
122 
123 /* assembled tables for a given dimm/memory-device */
124 struct 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 
145 struct 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 	u8 ars_start_flags;
159 	struct nd_cmd_ars_status *ars_status;
160 	size_t ars_status_size;
161 	struct work_struct work;
162 	struct list_head list;
163 	struct kernfs_node *scrub_count_state;
164 	unsigned int scrub_count;
165 	unsigned int scrub_mode;
166 	unsigned int cancel:1;
167 	unsigned int init_complete:1;
168 	unsigned long dimm_cmd_force_en;
169 	unsigned long bus_cmd_force_en;
170 	int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
171 			void *iobuf, u64 len, int rw);
172 };
173 
174 enum scrub_mode {
175 	HW_ERROR_SCRUB_OFF,
176 	HW_ERROR_SCRUB_ON,
177 };
178 
179 enum nd_blk_mmio_selector {
180 	BDW,
181 	DCR,
182 };
183 
184 struct nd_blk_addr {
185 	union {
186 		void __iomem *base;
187 		void *aperture;
188 	};
189 };
190 
191 struct nfit_blk {
192 	struct nfit_blk_mmio {
193 		struct nd_blk_addr addr;
194 		u64 size;
195 		u64 base_offset;
196 		u32 line_size;
197 		u32 num_lines;
198 		u32 table_size;
199 		struct acpi_nfit_interleave *idt;
200 		struct acpi_nfit_system_address *spa;
201 	} mmio[2];
202 	struct nd_region *nd_region;
203 	u64 bdw_offset; /* post interleave offset */
204 	u64 stat_offset;
205 	u64 cmd_offset;
206 	u32 dimm_flags;
207 };
208 
209 extern struct list_head acpi_descs;
210 extern struct mutex acpi_desc_lock;
211 int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc, u8 flags);
212 
213 #ifdef CONFIG_X86_MCE
214 void nfit_mce_register(void);
215 void nfit_mce_unregister(void);
216 #else
217 static inline void nfit_mce_register(void)
218 {
219 }
220 static inline void nfit_mce_unregister(void)
221 {
222 }
223 #endif
224 
225 int nfit_spa_type(struct acpi_nfit_system_address *spa);
226 
227 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
228 		struct nfit_mem *nfit_mem)
229 {
230 	if (nfit_mem->memdev_dcr)
231 		return nfit_mem->memdev_dcr;
232 	return nfit_mem->memdev_pmem;
233 }
234 
235 static inline struct acpi_nfit_desc *to_acpi_desc(
236 		struct nvdimm_bus_descriptor *nd_desc)
237 {
238 	return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
239 }
240 
241 const guid_t *to_nfit_uuid(enum nfit_uuids id);
242 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz);
243 void acpi_nfit_shutdown(void *data);
244 void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event);
245 void __acpi_nvdimm_notify(struct device *dev, u32 event);
246 int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm,
247 		unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc);
248 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
249 #endif /* __NFIT_H__ */
250