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/types.h> 20 #include <linux/uuid.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) 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 as an array of bytes in the 61 * NFIT DIMM Control Region structure 62 */ 63 #define NFIT_FIC_BYTE cpu_to_be16(0x101) /* byte-addressable energy backed */ 64 #define NFIT_FIC_BLK cpu_to_be16(0x201) /* block-addressable non-energy backed */ 65 #define NFIT_FIC_BYTEN cpu_to_be16(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 struct nfit_spa { 81 struct list_head list; 82 struct nd_region *nd_region; 83 unsigned int ars_required:1; 84 u32 clear_err_unit; 85 u32 max_ars; 86 struct acpi_nfit_system_address spa[0]; 87 }; 88 89 struct nfit_dcr { 90 struct list_head list; 91 struct acpi_nfit_control_region dcr[0]; 92 }; 93 94 struct nfit_bdw { 95 struct list_head list; 96 struct acpi_nfit_data_region bdw[0]; 97 }; 98 99 struct nfit_idt { 100 struct list_head list; 101 struct acpi_nfit_interleave idt[0]; 102 }; 103 104 struct nfit_flush { 105 struct list_head list; 106 struct acpi_nfit_flush_address flush[0]; 107 }; 108 109 struct nfit_memdev { 110 struct list_head list; 111 struct acpi_nfit_memory_map memdev[0]; 112 }; 113 114 /* assembled tables for a given dimm/memory-device */ 115 struct nfit_mem { 116 struct nvdimm *nvdimm; 117 struct acpi_nfit_memory_map *memdev_dcr; 118 struct acpi_nfit_memory_map *memdev_pmem; 119 struct acpi_nfit_memory_map *memdev_bdw; 120 struct acpi_nfit_control_region *dcr; 121 struct acpi_nfit_data_region *bdw; 122 struct acpi_nfit_system_address *spa_dcr; 123 struct acpi_nfit_system_address *spa_bdw; 124 struct acpi_nfit_interleave *idt_dcr; 125 struct acpi_nfit_interleave *idt_bdw; 126 struct nfit_flush *nfit_flush; 127 struct list_head list; 128 struct acpi_device *adev; 129 struct acpi_nfit_desc *acpi_desc; 130 struct resource *flush_wpq; 131 unsigned long dsm_mask; 132 int family; 133 }; 134 135 struct acpi_nfit_desc { 136 struct nvdimm_bus_descriptor nd_desc; 137 struct acpi_table_header acpi_header; 138 struct mutex init_mutex; 139 struct list_head memdevs; 140 struct list_head flushes; 141 struct list_head dimms; 142 struct list_head spas; 143 struct list_head dcrs; 144 struct list_head bdws; 145 struct list_head idts; 146 struct nvdimm_bus *nvdimm_bus; 147 struct device *dev; 148 struct nd_cmd_ars_status *ars_status; 149 size_t ars_status_size; 150 struct work_struct work; 151 struct kernfs_node *scrub_count_state; 152 unsigned int scrub_count; 153 unsigned int cancel:1; 154 unsigned long dimm_cmd_force_en; 155 unsigned long bus_cmd_force_en; 156 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 157 void *iobuf, u64 len, int rw); 158 }; 159 160 enum nd_blk_mmio_selector { 161 BDW, 162 DCR, 163 }; 164 165 struct nd_blk_addr { 166 union { 167 void __iomem *base; 168 void *aperture; 169 }; 170 }; 171 172 struct nfit_blk { 173 struct nfit_blk_mmio { 174 struct nd_blk_addr addr; 175 u64 size; 176 u64 base_offset; 177 u32 line_size; 178 u32 num_lines; 179 u32 table_size; 180 struct acpi_nfit_interleave *idt; 181 struct acpi_nfit_system_address *spa; 182 } mmio[2]; 183 struct nd_region *nd_region; 184 u64 bdw_offset; /* post interleave offset */ 185 u64 stat_offset; 186 u64 cmd_offset; 187 u32 dimm_flags; 188 }; 189 190 static inline struct acpi_nfit_memory_map *__to_nfit_memdev( 191 struct nfit_mem *nfit_mem) 192 { 193 if (nfit_mem->memdev_dcr) 194 return nfit_mem->memdev_dcr; 195 return nfit_mem->memdev_pmem; 196 } 197 198 static inline struct acpi_nfit_desc *to_acpi_desc( 199 struct nvdimm_bus_descriptor *nd_desc) 200 { 201 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); 202 } 203 204 const u8 *to_nfit_uuid(enum nfit_uuids id); 205 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz); 206 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev); 207 #endif /* __NFIT_H__ */ 208