1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * NVDIMM Firmware Interface Table - NFIT 4 * 5 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved. 6 */ 7 #ifndef __NFIT_H__ 8 #define __NFIT_H__ 9 #include <linux/workqueue.h> 10 #include <linux/libnvdimm.h> 11 #include <linux/ndctl.h> 12 #include <linux/types.h> 13 #include <linux/acpi.h> 14 #include <acpi/acuuid.h> 15 16 /* ACPI 6.1 */ 17 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba" 18 19 /* http://pmem.io/documents/NVDIMM_DSM_Interface-V1.6.pdf */ 20 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66" 21 22 /* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */ 23 #define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6" 24 #define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e" 25 26 /* https://msdn.microsoft.com/library/windows/hardware/mt604741 */ 27 #define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05" 28 29 /* http://www.uefi.org/RFIC_LIST (see "Virtual NVDIMM 0x1901") */ 30 #define UUID_NFIT_DIMM_N_HYPERV "5746c5f2-a9a2-4264-ad0e-e4ddc9e09e80" 31 32 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \ 33 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \ 34 | ACPI_NFIT_MEM_NOT_ARMED | ACPI_NFIT_MEM_MAP_FAILED) 35 36 #define NVDIMM_FAMILY_MAX NVDIMM_FAMILY_HYPERV 37 38 #define NVDIMM_STANDARD_CMDMASK \ 39 (1 << ND_CMD_SMART | 1 << ND_CMD_SMART_THRESHOLD | 1 << ND_CMD_DIMM_FLAGS \ 40 | 1 << ND_CMD_GET_CONFIG_SIZE | 1 << ND_CMD_GET_CONFIG_DATA \ 41 | 1 << ND_CMD_SET_CONFIG_DATA | 1 << ND_CMD_VENDOR_EFFECT_LOG_SIZE \ 42 | 1 << ND_CMD_VENDOR_EFFECT_LOG | 1 << ND_CMD_VENDOR) 43 44 /* 45 * Command numbers that the kernel needs to know about to handle 46 * non-default DSM revision ids 47 */ 48 enum nvdimm_family_cmds { 49 NVDIMM_INTEL_LATCH_SHUTDOWN = 10, 50 NVDIMM_INTEL_GET_MODES = 11, 51 NVDIMM_INTEL_GET_FWINFO = 12, 52 NVDIMM_INTEL_START_FWUPDATE = 13, 53 NVDIMM_INTEL_SEND_FWUPDATE = 14, 54 NVDIMM_INTEL_FINISH_FWUPDATE = 15, 55 NVDIMM_INTEL_QUERY_FWUPDATE = 16, 56 NVDIMM_INTEL_SET_THRESHOLD = 17, 57 NVDIMM_INTEL_INJECT_ERROR = 18, 58 NVDIMM_INTEL_GET_SECURITY_STATE = 19, 59 NVDIMM_INTEL_SET_PASSPHRASE = 20, 60 NVDIMM_INTEL_DISABLE_PASSPHRASE = 21, 61 NVDIMM_INTEL_UNLOCK_UNIT = 22, 62 NVDIMM_INTEL_FREEZE_LOCK = 23, 63 NVDIMM_INTEL_SECURE_ERASE = 24, 64 NVDIMM_INTEL_OVERWRITE = 25, 65 NVDIMM_INTEL_QUERY_OVERWRITE = 26, 66 NVDIMM_INTEL_SET_MASTER_PASSPHRASE = 27, 67 NVDIMM_INTEL_MASTER_SECURE_ERASE = 28, 68 }; 69 70 #define NVDIMM_INTEL_SECURITY_CMDMASK \ 71 (1 << NVDIMM_INTEL_GET_SECURITY_STATE | 1 << NVDIMM_INTEL_SET_PASSPHRASE \ 72 | 1 << NVDIMM_INTEL_DISABLE_PASSPHRASE | 1 << NVDIMM_INTEL_UNLOCK_UNIT \ 73 | 1 << NVDIMM_INTEL_FREEZE_LOCK | 1 << NVDIMM_INTEL_SECURE_ERASE \ 74 | 1 << NVDIMM_INTEL_OVERWRITE | 1 << NVDIMM_INTEL_QUERY_OVERWRITE \ 75 | 1 << NVDIMM_INTEL_SET_MASTER_PASSPHRASE \ 76 | 1 << NVDIMM_INTEL_MASTER_SECURE_ERASE) 77 78 #define NVDIMM_INTEL_CMDMASK \ 79 (NVDIMM_STANDARD_CMDMASK | 1 << NVDIMM_INTEL_GET_MODES \ 80 | 1 << NVDIMM_INTEL_GET_FWINFO | 1 << NVDIMM_INTEL_START_FWUPDATE \ 81 | 1 << NVDIMM_INTEL_SEND_FWUPDATE | 1 << NVDIMM_INTEL_FINISH_FWUPDATE \ 82 | 1 << NVDIMM_INTEL_QUERY_FWUPDATE | 1 << NVDIMM_INTEL_SET_THRESHOLD \ 83 | 1 << NVDIMM_INTEL_INJECT_ERROR | 1 << NVDIMM_INTEL_LATCH_SHUTDOWN \ 84 | NVDIMM_INTEL_SECURITY_CMDMASK) 85 86 enum nfit_uuids { 87 /* for simplicity alias the uuid index with the family id */ 88 NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL, 89 NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1, 90 NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2, 91 NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT, 92 NFIT_DEV_DIMM_N_HYPERV = NVDIMM_FAMILY_HYPERV, 93 NFIT_SPA_VOLATILE, 94 NFIT_SPA_PM, 95 NFIT_SPA_DCR, 96 NFIT_SPA_BDW, 97 NFIT_SPA_VDISK, 98 NFIT_SPA_VCD, 99 NFIT_SPA_PDISK, 100 NFIT_SPA_PCD, 101 NFIT_DEV_BUS, 102 NFIT_UUID_MAX, 103 }; 104 105 /* 106 * Region format interface codes are stored with the interface as the 107 * LSB and the function as the MSB. 108 */ 109 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */ 110 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */ 111 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */ 112 113 enum { 114 NFIT_BLK_READ_FLUSH = 1, 115 NFIT_BLK_DCR_LATCH = 2, 116 NFIT_ARS_STATUS_DONE = 0, 117 NFIT_ARS_STATUS_BUSY = 1 << 16, 118 NFIT_ARS_STATUS_NONE = 2 << 16, 119 NFIT_ARS_STATUS_INTR = 3 << 16, 120 NFIT_ARS_START_BUSY = 6, 121 NFIT_ARS_CAP_NONE = 1, 122 NFIT_ARS_F_OVERFLOW = 1, 123 NFIT_ARS_TIMEOUT = 90, 124 }; 125 126 enum nfit_root_notifiers { 127 NFIT_NOTIFY_UPDATE = 0x80, 128 NFIT_NOTIFY_UC_MEMORY_ERROR = 0x81, 129 }; 130 131 enum nfit_dimm_notifiers { 132 NFIT_NOTIFY_DIMM_HEALTH = 0x81, 133 }; 134 135 enum nfit_ars_state { 136 ARS_REQ_SHORT, 137 ARS_REQ_LONG, 138 ARS_FAILED, 139 }; 140 141 struct nfit_spa { 142 struct list_head list; 143 struct nd_region *nd_region; 144 unsigned long ars_state; 145 u32 clear_err_unit; 146 u32 max_ars; 147 struct acpi_nfit_system_address spa[0]; 148 }; 149 150 struct nfit_dcr { 151 struct list_head list; 152 struct acpi_nfit_control_region dcr[0]; 153 }; 154 155 struct nfit_bdw { 156 struct list_head list; 157 struct acpi_nfit_data_region bdw[0]; 158 }; 159 160 struct nfit_idt { 161 struct list_head list; 162 struct acpi_nfit_interleave idt[0]; 163 }; 164 165 struct nfit_flush { 166 struct list_head list; 167 struct acpi_nfit_flush_address flush[0]; 168 }; 169 170 struct nfit_memdev { 171 struct list_head list; 172 struct acpi_nfit_memory_map memdev[0]; 173 }; 174 175 enum nfit_mem_flags { 176 NFIT_MEM_LSR, 177 NFIT_MEM_LSW, 178 NFIT_MEM_DIRTY, 179 NFIT_MEM_DIRTY_COUNT, 180 }; 181 182 #define NFIT_DIMM_ID_LEN 22 183 184 /* assembled tables for a given dimm/memory-device */ 185 struct nfit_mem { 186 struct nvdimm *nvdimm; 187 struct acpi_nfit_memory_map *memdev_dcr; 188 struct acpi_nfit_memory_map *memdev_pmem; 189 struct acpi_nfit_memory_map *memdev_bdw; 190 struct acpi_nfit_control_region *dcr; 191 struct acpi_nfit_data_region *bdw; 192 struct acpi_nfit_system_address *spa_dcr; 193 struct acpi_nfit_system_address *spa_bdw; 194 struct acpi_nfit_interleave *idt_dcr; 195 struct acpi_nfit_interleave *idt_bdw; 196 struct kernfs_node *flags_attr; 197 struct nfit_flush *nfit_flush; 198 struct list_head list; 199 struct acpi_device *adev; 200 struct acpi_nfit_desc *acpi_desc; 201 char id[NFIT_DIMM_ID_LEN+1]; 202 struct resource *flush_wpq; 203 unsigned long dsm_mask; 204 unsigned long flags; 205 u32 dirty_shutdown; 206 int family; 207 }; 208 209 enum scrub_flags { 210 ARS_BUSY, 211 ARS_CANCEL, 212 ARS_VALID, 213 ARS_POLL, 214 }; 215 216 struct acpi_nfit_desc { 217 struct nvdimm_bus_descriptor nd_desc; 218 struct acpi_table_header acpi_header; 219 struct mutex init_mutex; 220 struct list_head memdevs; 221 struct list_head flushes; 222 struct list_head dimms; 223 struct list_head spas; 224 struct list_head dcrs; 225 struct list_head bdws; 226 struct list_head idts; 227 struct nvdimm_bus *nvdimm_bus; 228 struct device *dev; 229 struct nd_cmd_ars_status *ars_status; 230 struct nfit_spa *scrub_spa; 231 struct delayed_work dwork; 232 struct list_head list; 233 struct kernfs_node *scrub_count_state; 234 unsigned int max_ars; 235 unsigned int scrub_count; 236 unsigned int scrub_mode; 237 unsigned long scrub_flags; 238 unsigned long dimm_cmd_force_en; 239 unsigned long bus_cmd_force_en; 240 unsigned long bus_nfit_cmd_force_en; 241 unsigned int platform_cap; 242 unsigned int scrub_tmo; 243 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 244 void *iobuf, u64 len, int rw); 245 }; 246 247 enum scrub_mode { 248 HW_ERROR_SCRUB_OFF, 249 HW_ERROR_SCRUB_ON, 250 }; 251 252 enum nd_blk_mmio_selector { 253 BDW, 254 DCR, 255 }; 256 257 struct nd_blk_addr { 258 union { 259 void __iomem *base; 260 void *aperture; 261 }; 262 }; 263 264 struct nfit_blk { 265 struct nfit_blk_mmio { 266 struct nd_blk_addr addr; 267 u64 size; 268 u64 base_offset; 269 u32 line_size; 270 u32 num_lines; 271 u32 table_size; 272 struct acpi_nfit_interleave *idt; 273 struct acpi_nfit_system_address *spa; 274 } mmio[2]; 275 struct nd_region *nd_region; 276 u64 bdw_offset; /* post interleave offset */ 277 u64 stat_offset; 278 u64 cmd_offset; 279 u32 dimm_flags; 280 }; 281 282 extern struct list_head acpi_descs; 283 extern struct mutex acpi_desc_lock; 284 int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc, 285 enum nfit_ars_state req_type); 286 287 #ifdef CONFIG_X86_MCE 288 void nfit_mce_register(void); 289 void nfit_mce_unregister(void); 290 #else 291 static inline void nfit_mce_register(void) 292 { 293 } 294 static inline void nfit_mce_unregister(void) 295 { 296 } 297 #endif 298 299 int nfit_spa_type(struct acpi_nfit_system_address *spa); 300 301 static inline struct acpi_nfit_memory_map *__to_nfit_memdev( 302 struct nfit_mem *nfit_mem) 303 { 304 if (nfit_mem->memdev_dcr) 305 return nfit_mem->memdev_dcr; 306 return nfit_mem->memdev_pmem; 307 } 308 309 static inline struct acpi_nfit_desc *to_acpi_desc( 310 struct nvdimm_bus_descriptor *nd_desc) 311 { 312 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); 313 } 314 315 #ifdef CONFIG_PROVE_LOCKING 316 static inline void nfit_device_lock(struct device *dev) 317 { 318 device_lock(dev); 319 mutex_lock(&dev->lockdep_mutex); 320 } 321 322 static inline void nfit_device_unlock(struct device *dev) 323 { 324 mutex_unlock(&dev->lockdep_mutex); 325 device_unlock(dev); 326 } 327 #else 328 static inline void nfit_device_lock(struct device *dev) 329 { 330 device_lock(dev); 331 } 332 333 static inline void nfit_device_unlock(struct device *dev) 334 { 335 device_unlock(dev); 336 } 337 #endif 338 339 const guid_t *to_nfit_uuid(enum nfit_uuids id); 340 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz); 341 void acpi_nfit_shutdown(void *data); 342 void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event); 343 void __acpi_nvdimm_notify(struct device *dev, u32 event); 344 int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm, 345 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc); 346 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev); 347 #endif /* __NFIT_H__ */ 348