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/types.h>
20 #include <linux/uuid.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_Example.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 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
35 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
36 | ACPI_NFIT_MEM_NOT_ARMED)
39 /* for simplicity alias the uuid index with the family id */
40 NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
41 NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
42 NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
56 * Region format interface codes are stored with the interface as the
57 * LSB and the function as the MSB.
59 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
60 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
61 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */
64 NFIT_BLK_READ_FLUSH = 1,
65 NFIT_BLK_DCR_LATCH = 2,
66 NFIT_ARS_STATUS_DONE = 0,
67 NFIT_ARS_STATUS_BUSY = 1 << 16,
68 NFIT_ARS_STATUS_NONE = 2 << 16,
69 NFIT_ARS_STATUS_INTR = 3 << 16,
70 NFIT_ARS_START_BUSY = 6,
71 NFIT_ARS_CAP_NONE = 1,
72 NFIT_ARS_F_OVERFLOW = 1,
73 NFIT_ARS_TIMEOUT = 90,
77 struct acpi_nfit_system_address *spa;
78 struct list_head list;
79 struct nd_region *nd_region;
80 unsigned int ars_done:1;
86 struct acpi_nfit_control_region *dcr;
87 struct list_head list;
91 struct acpi_nfit_data_region *bdw;
92 struct list_head list;
96 struct acpi_nfit_interleave *idt;
97 struct list_head list;
101 struct acpi_nfit_flush_address *flush;
102 struct list_head list;
106 struct acpi_nfit_memory_map *memdev;
107 struct list_head list;
110 /* assembled tables for a given dimm/memory-device */
112 struct nvdimm *nvdimm;
113 struct acpi_nfit_memory_map *memdev_dcr;
114 struct acpi_nfit_memory_map *memdev_pmem;
115 struct acpi_nfit_memory_map *memdev_bdw;
116 struct acpi_nfit_control_region *dcr;
117 struct acpi_nfit_data_region *bdw;
118 struct acpi_nfit_system_address *spa_dcr;
119 struct acpi_nfit_system_address *spa_bdw;
120 struct acpi_nfit_interleave *idt_dcr;
121 struct acpi_nfit_interleave *idt_bdw;
122 struct nfit_flush *nfit_flush;
123 struct list_head list;
124 struct acpi_device *adev;
125 struct acpi_nfit_desc *acpi_desc;
126 unsigned long dsm_mask;
130 struct acpi_nfit_desc {
131 struct nvdimm_bus_descriptor nd_desc;
132 struct acpi_table_header acpi_header;
133 struct acpi_nfit_header *nfit;
134 struct mutex spa_map_mutex;
135 struct mutex init_mutex;
136 struct list_head spa_maps;
137 struct list_head memdevs;
138 struct list_head flushes;
139 struct list_head dimms;
140 struct list_head spas;
141 struct list_head dcrs;
142 struct list_head bdws;
143 struct list_head idts;
144 struct nvdimm_bus *nvdimm_bus;
146 struct nd_cmd_ars_status *ars_status;
147 size_t ars_status_size;
148 struct work_struct work;
149 unsigned int cancel:1;
150 unsigned long dimm_cmd_force_en;
151 unsigned long bus_cmd_force_en;
152 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
153 void *iobuf, u64 len, int rw);
156 enum nd_blk_mmio_selector {
164 void __pmem *aperture;
169 struct nfit_blk_mmio {
170 struct nd_blk_addr addr;
176 struct acpi_nfit_interleave *idt;
177 struct acpi_nfit_system_address *spa;
179 struct nd_region *nd_region;
180 u64 bdw_offset; /* post interleave offset */
183 void __iomem *nvdimm_flush;
192 struct nfit_spa_mapping {
193 struct acpi_nfit_desc *acpi_desc;
194 struct acpi_nfit_system_address *spa;
195 struct list_head list;
197 enum spa_map_type type;
198 struct nd_blk_addr addr;
201 static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
203 return container_of(kref, struct nfit_spa_mapping, kref);
206 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
207 struct nfit_mem *nfit_mem)
209 if (nfit_mem->memdev_dcr)
210 return nfit_mem->memdev_dcr;
211 return nfit_mem->memdev_pmem;
214 static inline struct acpi_nfit_desc *to_acpi_desc(
215 struct nvdimm_bus_descriptor *nd_desc)
217 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
220 const u8 *to_nfit_uuid(enum nfit_uuids id);
221 int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
222 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
223 #endif /* __NFIT_H__ */