2 * NVDIMM Firmware Interface Table - NFIT
4 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
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.
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.
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>
25 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
27 /* http://pmem.io/documents/NVDIMM_DSM_Interface-V1.6.pdf */
28 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
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"
34 /* https://msdn.microsoft.com/library/windows/hardware/mt604741 */
35 #define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05"
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)
41 #define NVDIMM_FAMILY_MAX NVDIMM_FAMILY_MSFT
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)
50 * Command numbers that the kernel needs to know about to handle
51 * non-default DSM revision ids
53 enum nvdimm_family_cmds
{
54 NVDIMM_INTEL_GET_MODES
= 11,
55 NVDIMM_INTEL_GET_FWINFO
= 12,
56 NVDIMM_INTEL_START_FWUPDATE
= 13,
57 NVDIMM_INTEL_SEND_FWUPDATE
= 14,
58 NVDIMM_INTEL_FINISH_FWUPDATE
= 15,
59 NVDIMM_INTEL_QUERY_FWUPDATE
= 16,
60 NVDIMM_INTEL_SET_THRESHOLD
= 17,
61 NVDIMM_INTEL_INJECT_ERROR
= 18,
64 #define NVDIMM_INTEL_CMDMASK \
65 (NVDIMM_STANDARD_CMDMASK | 1 << NVDIMM_INTEL_GET_MODES \
66 | 1 << NVDIMM_INTEL_GET_FWINFO | 1 << NVDIMM_INTEL_START_FWUPDATE \
67 | 1 << NVDIMM_INTEL_SEND_FWUPDATE | 1 << NVDIMM_INTEL_FINISH_FWUPDATE \
68 | 1 << NVDIMM_INTEL_QUERY_FWUPDATE | 1 << NVDIMM_INTEL_SET_THRESHOLD \
69 | 1 << NVDIMM_INTEL_INJECT_ERROR)
72 /* for simplicity alias the uuid index with the family id */
73 NFIT_DEV_DIMM
= NVDIMM_FAMILY_INTEL
,
74 NFIT_DEV_DIMM_N_HPE1
= NVDIMM_FAMILY_HPE1
,
75 NFIT_DEV_DIMM_N_HPE2
= NVDIMM_FAMILY_HPE2
,
76 NFIT_DEV_DIMM_N_MSFT
= NVDIMM_FAMILY_MSFT
,
90 * Region format interface codes are stored with the interface as the
91 * LSB and the function as the MSB.
93 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
94 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
95 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */
98 NFIT_BLK_READ_FLUSH
= 1,
99 NFIT_BLK_DCR_LATCH
= 2,
100 NFIT_ARS_STATUS_DONE
= 0,
101 NFIT_ARS_STATUS_BUSY
= 1 << 16,
102 NFIT_ARS_STATUS_NONE
= 2 << 16,
103 NFIT_ARS_STATUS_INTR
= 3 << 16,
104 NFIT_ARS_START_BUSY
= 6,
105 NFIT_ARS_CAP_NONE
= 1,
106 NFIT_ARS_F_OVERFLOW
= 1,
107 NFIT_ARS_TIMEOUT
= 90,
110 enum nfit_root_notifiers
{
111 NFIT_NOTIFY_UPDATE
= 0x80,
112 NFIT_NOTIFY_UC_MEMORY_ERROR
= 0x81,
115 enum nfit_dimm_notifiers
{
116 NFIT_NOTIFY_DIMM_HEALTH
= 0x81,
120 struct list_head list
;
121 struct nd_region
*nd_region
;
122 unsigned int ars_required
:1;
125 struct acpi_nfit_system_address spa
[0];
129 struct list_head list
;
130 struct acpi_nfit_control_region dcr
[0];
134 struct list_head list
;
135 struct acpi_nfit_data_region bdw
[0];
139 struct list_head list
;
140 struct acpi_nfit_interleave idt
[0];
144 struct list_head list
;
145 struct acpi_nfit_flush_address flush
[0];
149 struct list_head list
;
150 struct acpi_nfit_memory_map memdev
[0];
153 /* assembled tables for a given dimm/memory-device */
155 struct nvdimm
*nvdimm
;
156 struct acpi_nfit_memory_map
*memdev_dcr
;
157 struct acpi_nfit_memory_map
*memdev_pmem
;
158 struct acpi_nfit_memory_map
*memdev_bdw
;
159 struct acpi_nfit_control_region
*dcr
;
160 struct acpi_nfit_data_region
*bdw
;
161 struct acpi_nfit_system_address
*spa_dcr
;
162 struct acpi_nfit_system_address
*spa_bdw
;
163 struct acpi_nfit_interleave
*idt_dcr
;
164 struct acpi_nfit_interleave
*idt_bdw
;
165 struct kernfs_node
*flags_attr
;
166 struct nfit_flush
*nfit_flush
;
167 struct list_head list
;
168 struct acpi_device
*adev
;
169 struct acpi_nfit_desc
*acpi_desc
;
170 struct resource
*flush_wpq
;
171 unsigned long dsm_mask
;
178 struct acpi_nfit_desc
{
179 struct nvdimm_bus_descriptor nd_desc
;
180 struct acpi_table_header acpi_header
;
181 struct mutex init_mutex
;
182 struct list_head memdevs
;
183 struct list_head flushes
;
184 struct list_head dimms
;
185 struct list_head spas
;
186 struct list_head dcrs
;
187 struct list_head bdws
;
188 struct list_head idts
;
189 struct nvdimm_bus
*nvdimm_bus
;
192 struct nd_cmd_ars_status
*ars_status
;
193 size_t ars_status_size
;
194 struct work_struct work
;
195 struct list_head list
;
196 struct kernfs_node
*scrub_count_state
;
197 unsigned int scrub_count
;
198 unsigned int scrub_mode
;
199 unsigned int cancel
:1;
200 unsigned int init_complete
:1;
201 unsigned long dimm_cmd_force_en
;
202 unsigned long bus_cmd_force_en
;
203 unsigned long bus_nfit_cmd_force_en
;
204 int (*blk_do_io
)(struct nd_blk_region
*ndbr
, resource_size_t dpa
,
205 void *iobuf
, u64 len
, int rw
);
213 enum nd_blk_mmio_selector
{
226 struct nfit_blk_mmio
{
227 struct nd_blk_addr addr
;
233 struct acpi_nfit_interleave
*idt
;
234 struct acpi_nfit_system_address
*spa
;
236 struct nd_region
*nd_region
;
237 u64 bdw_offset
; /* post interleave offset */
243 extern struct list_head acpi_descs
;
244 extern struct mutex acpi_desc_lock
;
245 int acpi_nfit_ars_rescan(struct acpi_nfit_desc
*acpi_desc
, u8 flags
);
247 #ifdef CONFIG_X86_MCE
248 void nfit_mce_register(void);
249 void nfit_mce_unregister(void);
251 static inline void nfit_mce_register(void)
254 static inline void nfit_mce_unregister(void)
259 int nfit_spa_type(struct acpi_nfit_system_address
*spa
);
261 static inline struct acpi_nfit_memory_map
*__to_nfit_memdev(
262 struct nfit_mem
*nfit_mem
)
264 if (nfit_mem
->memdev_dcr
)
265 return nfit_mem
->memdev_dcr
;
266 return nfit_mem
->memdev_pmem
;
269 static inline struct acpi_nfit_desc
*to_acpi_desc(
270 struct nvdimm_bus_descriptor
*nd_desc
)
272 return container_of(nd_desc
, struct acpi_nfit_desc
, nd_desc
);
275 const guid_t
*to_nfit_uuid(enum nfit_uuids id
);
276 int acpi_nfit_init(struct acpi_nfit_desc
*acpi_desc
, void *nfit
, acpi_size sz
);
277 void acpi_nfit_shutdown(void *data
);
278 void __acpi_nfit_notify(struct device
*dev
, acpi_handle handle
, u32 event
);
279 void __acpi_nvdimm_notify(struct device
*dev
, u32 event
);
280 int acpi_nfit_ctl(struct nvdimm_bus_descriptor
*nd_desc
, struct nvdimm
*nvdimm
,
281 unsigned int cmd
, void *buf
, unsigned int buf_len
, int *cmd_rc
);
282 void acpi_nfit_desc_init(struct acpi_nfit_desc
*acpi_desc
, struct device
*dev
);
283 #endif /* __NFIT_H__ */