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/uuid.h> 22 #include <linux/acpi.h> 23 #include <acpi/acuuid.h> 24 25 /* ACPI 6.1 */ 26 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba" 27 28 /* http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf */ 29 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66" 30 31 /* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */ 32 #define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6" 33 #define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e" 34 35 /* https://msdn.microsoft.com/library/windows/hardware/mt604741 */ 36 #define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05" 37 38 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \ 39 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \ 40 | ACPI_NFIT_MEM_NOT_ARMED) 41 42 enum nfit_uuids { 43 /* for simplicity alias the uuid index with the family id */ 44 NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL, 45 NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1, 46 NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2, 47 NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT, 48 NFIT_SPA_VOLATILE, 49 NFIT_SPA_PM, 50 NFIT_SPA_DCR, 51 NFIT_SPA_BDW, 52 NFIT_SPA_VDISK, 53 NFIT_SPA_VCD, 54 NFIT_SPA_PDISK, 55 NFIT_SPA_PCD, 56 NFIT_DEV_BUS, 57 NFIT_UUID_MAX, 58 }; 59 60 /* 61 * Region format interface codes are stored with the interface as the 62 * LSB and the function as the MSB. 63 */ 64 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */ 65 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */ 66 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */ 67 68 enum { 69 NFIT_BLK_READ_FLUSH = 1, 70 NFIT_BLK_DCR_LATCH = 2, 71 NFIT_ARS_STATUS_DONE = 0, 72 NFIT_ARS_STATUS_BUSY = 1 << 16, 73 NFIT_ARS_STATUS_NONE = 2 << 16, 74 NFIT_ARS_STATUS_INTR = 3 << 16, 75 NFIT_ARS_START_BUSY = 6, 76 NFIT_ARS_CAP_NONE = 1, 77 NFIT_ARS_F_OVERFLOW = 1, 78 NFIT_ARS_TIMEOUT = 90, 79 }; 80 81 struct nfit_spa { 82 struct list_head list; 83 struct nd_region *nd_region; 84 unsigned int ars_required:1; 85 u32 clear_err_unit; 86 u32 max_ars; 87 struct acpi_nfit_system_address spa[0]; 88 }; 89 90 struct nfit_dcr { 91 struct list_head list; 92 struct acpi_nfit_control_region dcr[0]; 93 }; 94 95 struct nfit_bdw { 96 struct list_head list; 97 struct acpi_nfit_data_region bdw[0]; 98 }; 99 100 struct nfit_idt { 101 struct list_head list; 102 struct acpi_nfit_interleave idt[0]; 103 }; 104 105 struct nfit_flush { 106 struct list_head list; 107 struct acpi_nfit_flush_address flush[0]; 108 }; 109 110 struct nfit_memdev { 111 struct list_head list; 112 struct acpi_nfit_memory_map memdev[0]; 113 }; 114 115 /* assembled tables for a given dimm/memory-device */ 116 struct nfit_mem { 117 struct nvdimm *nvdimm; 118 struct acpi_nfit_memory_map *memdev_dcr; 119 struct acpi_nfit_memory_map *memdev_pmem; 120 struct acpi_nfit_memory_map *memdev_bdw; 121 struct acpi_nfit_control_region *dcr; 122 struct acpi_nfit_data_region *bdw; 123 struct acpi_nfit_system_address *spa_dcr; 124 struct acpi_nfit_system_address *spa_bdw; 125 struct acpi_nfit_interleave *idt_dcr; 126 struct acpi_nfit_interleave *idt_bdw; 127 struct nfit_flush *nfit_flush; 128 struct list_head list; 129 struct acpi_device *adev; 130 struct acpi_nfit_desc *acpi_desc; 131 struct resource *flush_wpq; 132 unsigned long dsm_mask; 133 int family; 134 }; 135 136 struct acpi_nfit_desc { 137 struct nvdimm_bus_descriptor nd_desc; 138 struct acpi_table_header acpi_header; 139 struct mutex init_mutex; 140 struct list_head memdevs; 141 struct list_head flushes; 142 struct list_head dimms; 143 struct list_head spas; 144 struct list_head dcrs; 145 struct list_head bdws; 146 struct list_head idts; 147 struct nvdimm_bus *nvdimm_bus; 148 struct device *dev; 149 struct nd_cmd_ars_status *ars_status; 150 size_t ars_status_size; 151 struct work_struct work; 152 struct list_head list; 153 struct kernfs_node *scrub_count_state; 154 unsigned int scrub_count; 155 unsigned int cancel:1; 156 unsigned long dimm_cmd_force_en; 157 unsigned long bus_cmd_force_en; 158 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 159 void *iobuf, u64 len, int rw); 160 }; 161 162 enum nd_blk_mmio_selector { 163 BDW, 164 DCR, 165 }; 166 167 struct nd_blk_addr { 168 union { 169 void __iomem *base; 170 void *aperture; 171 }; 172 }; 173 174 struct nfit_blk { 175 struct nfit_blk_mmio { 176 struct nd_blk_addr addr; 177 u64 size; 178 u64 base_offset; 179 u32 line_size; 180 u32 num_lines; 181 u32 table_size; 182 struct acpi_nfit_interleave *idt; 183 struct acpi_nfit_system_address *spa; 184 } mmio[2]; 185 struct nd_region *nd_region; 186 u64 bdw_offset; /* post interleave offset */ 187 u64 stat_offset; 188 u64 cmd_offset; 189 u32 dimm_flags; 190 }; 191 192 extern struct list_head acpi_descs; 193 extern struct mutex acpi_desc_lock; 194 int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc); 195 196 #ifdef CONFIG_X86_MCE 197 void nfit_mce_register(void); 198 void nfit_mce_unregister(void); 199 #else 200 static inline void nfit_mce_register(void) 201 { 202 } 203 static inline void nfit_mce_unregister(void) 204 { 205 } 206 #endif 207 208 int nfit_spa_type(struct acpi_nfit_system_address *spa); 209 210 static inline struct acpi_nfit_memory_map *__to_nfit_memdev( 211 struct nfit_mem *nfit_mem) 212 { 213 if (nfit_mem->memdev_dcr) 214 return nfit_mem->memdev_dcr; 215 return nfit_mem->memdev_pmem; 216 } 217 218 static inline struct acpi_nfit_desc *to_acpi_desc( 219 struct nvdimm_bus_descriptor *nd_desc) 220 { 221 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); 222 } 223 224 const u8 *to_nfit_uuid(enum nfit_uuids id); 225 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz); 226 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev); 227 #endif /* __NFIT_H__ */ 228