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/libnvdimm.h>
18 #include <linux/types.h>
19 #include <linux/uuid.h>
20 #include <linux/acpi.h>
21 #include <acpi/acuuid.h>
22
23 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
24 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
25 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
26 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
27 | ACPI_NFIT_MEM_NOT_ARMED)
28
29 enum nfit_uuids {
30 NFIT_SPA_VOLATILE,
31 NFIT_SPA_PM,
32 NFIT_SPA_DCR,
33 NFIT_SPA_BDW,
34 NFIT_SPA_VDISK,
35 NFIT_SPA_VCD,
36 NFIT_SPA_PDISK,
37 NFIT_SPA_PCD,
38 NFIT_DEV_BUS,
39 NFIT_DEV_DIMM,
40 NFIT_UUID_MAX,
41 };
42
43 enum {
44 ND_BLK_READ_FLUSH = 1,
45 ND_BLK_DCR_LATCH = 2,
46 };
47
48 enum nfit_root_notifiers {
49 NFIT_NOTIFY_UPDATE = 0x80,
50 };
51
52 struct nfit_spa {
53 struct acpi_nfit_system_address *spa;
54 struct list_head list;
55 int is_registered;
56 };
57
58 struct nfit_dcr {
59 struct acpi_nfit_control_region *dcr;
60 struct list_head list;
61 };
62
63 struct nfit_bdw {
64 struct acpi_nfit_data_region *bdw;
65 struct list_head list;
66 };
67
68 struct nfit_idt {
69 struct acpi_nfit_interleave *idt;
70 struct list_head list;
71 };
72
73 struct nfit_flush {
74 struct acpi_nfit_flush_address *flush;
75 struct list_head list;
76 };
77
78 struct nfit_memdev {
79 struct acpi_nfit_memory_map *memdev;
80 struct list_head list;
81 };
82
83 /* assembled tables for a given dimm/memory-device */
84 struct nfit_mem {
85 struct nvdimm *nvdimm;
86 struct acpi_nfit_memory_map *memdev_dcr;
87 struct acpi_nfit_memory_map *memdev_pmem;
88 struct acpi_nfit_memory_map *memdev_bdw;
89 struct acpi_nfit_control_region *dcr;
90 struct acpi_nfit_data_region *bdw;
91 struct acpi_nfit_system_address *spa_dcr;
92 struct acpi_nfit_system_address *spa_bdw;
93 struct acpi_nfit_interleave *idt_dcr;
94 struct acpi_nfit_interleave *idt_bdw;
95 struct nfit_flush *nfit_flush;
96 struct list_head list;
97 struct acpi_device *adev;
98 unsigned long dsm_mask;
99 };
100
101 struct acpi_nfit_desc {
102 struct nvdimm_bus_descriptor nd_desc;
103 struct acpi_table_header acpi_header;
104 struct acpi_nfit_header *nfit;
105 struct mutex spa_map_mutex;
106 struct mutex init_mutex;
107 struct list_head spa_maps;
108 struct list_head memdevs;
109 struct list_head flushes;
110 struct list_head dimms;
111 struct list_head spas;
112 struct list_head dcrs;
113 struct list_head bdws;
114 struct list_head idts;
115 struct nvdimm_bus *nvdimm_bus;
116 struct device *dev;
117 unsigned long dimm_dsm_force_en;
118 unsigned long bus_dsm_force_en;
119 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
120 void *iobuf, u64 len, int rw);
121 };
122
123 enum nd_blk_mmio_selector {
124 BDW,
125 DCR,
126 };
127
128 struct nd_blk_addr {
129 union {
130 void __iomem *base;
131 void __pmem *aperture;
132 };
133 };
134
135 struct nfit_blk {
136 struct nfit_blk_mmio {
137 struct nd_blk_addr addr;
138 u64 size;
139 u64 base_offset;
140 u32 line_size;
141 u32 num_lines;
142 u32 table_size;
143 struct acpi_nfit_interleave *idt;
144 struct acpi_nfit_system_address *spa;
145 } mmio[2];
146 struct nd_region *nd_region;
147 u64 bdw_offset; /* post interleave offset */
148 u64 stat_offset;
149 u64 cmd_offset;
150 void __iomem *nvdimm_flush;
151 u32 dimm_flags;
152 };
153
154 enum spa_map_type {
155 SPA_MAP_CONTROL,
156 SPA_MAP_APERTURE,
157 };
158
159 struct nfit_spa_mapping {
160 struct acpi_nfit_desc *acpi_desc;
161 struct acpi_nfit_system_address *spa;
162 struct list_head list;
163 struct kref kref;
164 enum spa_map_type type;
165 struct nd_blk_addr addr;
166 };
167
to_spa_map(struct kref * kref)168 static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
169 {
170 return container_of(kref, struct nfit_spa_mapping, kref);
171 }
172
__to_nfit_memdev(struct nfit_mem * nfit_mem)173 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
174 struct nfit_mem *nfit_mem)
175 {
176 if (nfit_mem->memdev_dcr)
177 return nfit_mem->memdev_dcr;
178 return nfit_mem->memdev_pmem;
179 }
180
to_acpi_desc(struct nvdimm_bus_descriptor * nd_desc)181 static inline struct acpi_nfit_desc *to_acpi_desc(
182 struct nvdimm_bus_descriptor *nd_desc)
183 {
184 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
185 }
186
187 const u8 *to_nfit_uuid(enum nfit_uuids id);
188 int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
189 extern const struct attribute_group *acpi_nfit_attribute_groups[];
190 #endif /* __NFIT_H__ */
191