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/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-V1.6.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 | ACPI_NFIT_MEM_MAP_FAILED) 40 41 #define NVDIMM_FAMILY_MAX NVDIMM_FAMILY_MSFT 42 43 #define NVDIMM_STANDARD_CMDMASK \ 44 (1 << ND_CMD_SMART | 1 << ND_CMD_SMART_THRESHOLD | 1 << ND_CMD_DIMM_FLAGS \ 45 | 1 << ND_CMD_GET_CONFIG_SIZE | 1 << ND_CMD_GET_CONFIG_DATA \ 46 | 1 << ND_CMD_SET_CONFIG_DATA | 1 << ND_CMD_VENDOR_EFFECT_LOG_SIZE \ 47 | 1 << ND_CMD_VENDOR_EFFECT_LOG | 1 << ND_CMD_VENDOR) 48 49 /* 50 * Command numbers that the kernel needs to know about to handle 51 * non-default DSM revision ids 52 */ 53 enum nvdimm_family_cmds { 54 NVDIMM_INTEL_LATCH_SHUTDOWN = 10, 55 NVDIMM_INTEL_GET_MODES = 11, 56 NVDIMM_INTEL_GET_FWINFO = 12, 57 NVDIMM_INTEL_START_FWUPDATE = 13, 58 NVDIMM_INTEL_SEND_FWUPDATE = 14, 59 NVDIMM_INTEL_FINISH_FWUPDATE = 15, 60 NVDIMM_INTEL_QUERY_FWUPDATE = 16, 61 NVDIMM_INTEL_SET_THRESHOLD = 17, 62 NVDIMM_INTEL_INJECT_ERROR = 18, 63 }; 64 65 #define NVDIMM_INTEL_CMDMASK \ 66 (NVDIMM_STANDARD_CMDMASK | 1 << NVDIMM_INTEL_GET_MODES \ 67 | 1 << NVDIMM_INTEL_GET_FWINFO | 1 << NVDIMM_INTEL_START_FWUPDATE \ 68 | 1 << NVDIMM_INTEL_SEND_FWUPDATE | 1 << NVDIMM_INTEL_FINISH_FWUPDATE \ 69 | 1 << NVDIMM_INTEL_QUERY_FWUPDATE | 1 << NVDIMM_INTEL_SET_THRESHOLD \ 70 | 1 << NVDIMM_INTEL_INJECT_ERROR | 1 << NVDIMM_INTEL_LATCH_SHUTDOWN) 71 72 enum nfit_uuids { 73 /* for simplicity alias the uuid index with the family id */ 74 NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL, 75 NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1, 76 NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2, 77 NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT, 78 NFIT_SPA_VOLATILE, 79 NFIT_SPA_PM, 80 NFIT_SPA_DCR, 81 NFIT_SPA_BDW, 82 NFIT_SPA_VDISK, 83 NFIT_SPA_VCD, 84 NFIT_SPA_PDISK, 85 NFIT_SPA_PCD, 86 NFIT_DEV_BUS, 87 NFIT_UUID_MAX, 88 }; 89 90 /* 91 * Region format interface codes are stored with the interface as the 92 * LSB and the function as the MSB. 93 */ 94 #define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */ 95 #define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */ 96 #define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */ 97 98 enum { 99 NFIT_BLK_READ_FLUSH = 1, 100 NFIT_BLK_DCR_LATCH = 2, 101 NFIT_ARS_STATUS_DONE = 0, 102 NFIT_ARS_STATUS_BUSY = 1 << 16, 103 NFIT_ARS_STATUS_NONE = 2 << 16, 104 NFIT_ARS_STATUS_INTR = 3 << 16, 105 NFIT_ARS_START_BUSY = 6, 106 NFIT_ARS_CAP_NONE = 1, 107 NFIT_ARS_F_OVERFLOW = 1, 108 NFIT_ARS_TIMEOUT = 90, 109 }; 110 111 enum nfit_root_notifiers { 112 NFIT_NOTIFY_UPDATE = 0x80, 113 NFIT_NOTIFY_UC_MEMORY_ERROR = 0x81, 114 }; 115 116 enum nfit_dimm_notifiers { 117 NFIT_NOTIFY_DIMM_HEALTH = 0x81, 118 }; 119 120 enum nfit_ars_state { 121 ARS_REQ, 122 ARS_REQ_REDO, 123 ARS_DONE, 124 ARS_SHORT, 125 ARS_FAILED, 126 }; 127 128 struct nfit_spa { 129 struct list_head list; 130 struct nd_region *nd_region; 131 unsigned long ars_state; 132 u32 clear_err_unit; 133 u32 max_ars; 134 struct acpi_nfit_system_address spa[0]; 135 }; 136 137 struct nfit_dcr { 138 struct list_head list; 139 struct acpi_nfit_control_region dcr[0]; 140 }; 141 142 struct nfit_bdw { 143 struct list_head list; 144 struct acpi_nfit_data_region bdw[0]; 145 }; 146 147 struct nfit_idt { 148 struct list_head list; 149 struct acpi_nfit_interleave idt[0]; 150 }; 151 152 struct nfit_flush { 153 struct list_head list; 154 struct acpi_nfit_flush_address flush[0]; 155 }; 156 157 struct nfit_memdev { 158 struct list_head list; 159 struct acpi_nfit_memory_map memdev[0]; 160 }; 161 162 /* assembled tables for a given dimm/memory-device */ 163 struct nfit_mem { 164 struct nvdimm *nvdimm; 165 struct acpi_nfit_memory_map *memdev_dcr; 166 struct acpi_nfit_memory_map *memdev_pmem; 167 struct acpi_nfit_memory_map *memdev_bdw; 168 struct acpi_nfit_control_region *dcr; 169 struct acpi_nfit_data_region *bdw; 170 struct acpi_nfit_system_address *spa_dcr; 171 struct acpi_nfit_system_address *spa_bdw; 172 struct acpi_nfit_interleave *idt_dcr; 173 struct acpi_nfit_interleave *idt_bdw; 174 struct kernfs_node *flags_attr; 175 struct nfit_flush *nfit_flush; 176 struct list_head list; 177 struct acpi_device *adev; 178 struct acpi_nfit_desc *acpi_desc; 179 struct resource *flush_wpq; 180 unsigned long dsm_mask; 181 int family; 182 bool has_lsr; 183 bool has_lsw; 184 }; 185 186 struct acpi_nfit_desc { 187 struct nvdimm_bus_descriptor nd_desc; 188 struct acpi_table_header acpi_header; 189 struct mutex init_mutex; 190 struct list_head memdevs; 191 struct list_head flushes; 192 struct list_head dimms; 193 struct list_head spas; 194 struct list_head dcrs; 195 struct list_head bdws; 196 struct list_head idts; 197 struct nvdimm_bus *nvdimm_bus; 198 struct device *dev; 199 u8 ars_start_flags; 200 struct nd_cmd_ars_status *ars_status; 201 struct delayed_work dwork; 202 struct list_head list; 203 struct kernfs_node *scrub_count_state; 204 unsigned int max_ars; 205 unsigned int scrub_count; 206 unsigned int scrub_mode; 207 unsigned int scrub_busy:1; 208 unsigned int cancel:1; 209 unsigned long dimm_cmd_force_en; 210 unsigned long bus_cmd_force_en; 211 unsigned long bus_nfit_cmd_force_en; 212 unsigned int platform_cap; 213 unsigned int scrub_tmo; 214 int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa, 215 void *iobuf, u64 len, int rw); 216 }; 217 218 enum scrub_mode { 219 HW_ERROR_SCRUB_OFF, 220 HW_ERROR_SCRUB_ON, 221 }; 222 223 enum nd_blk_mmio_selector { 224 BDW, 225 DCR, 226 }; 227 228 struct nd_blk_addr { 229 union { 230 void __iomem *base; 231 void *aperture; 232 }; 233 }; 234 235 struct nfit_blk { 236 struct nfit_blk_mmio { 237 struct nd_blk_addr addr; 238 u64 size; 239 u64 base_offset; 240 u32 line_size; 241 u32 num_lines; 242 u32 table_size; 243 struct acpi_nfit_interleave *idt; 244 struct acpi_nfit_system_address *spa; 245 } mmio[2]; 246 struct nd_region *nd_region; 247 u64 bdw_offset; /* post interleave offset */ 248 u64 stat_offset; 249 u64 cmd_offset; 250 u32 dimm_flags; 251 }; 252 253 extern struct list_head acpi_descs; 254 extern struct mutex acpi_desc_lock; 255 int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc, unsigned long flags); 256 257 #ifdef CONFIG_X86_MCE 258 void nfit_mce_register(void); 259 void nfit_mce_unregister(void); 260 #else 261 static inline void nfit_mce_register(void) 262 { 263 } 264 static inline void nfit_mce_unregister(void) 265 { 266 } 267 #endif 268 269 int nfit_spa_type(struct acpi_nfit_system_address *spa); 270 271 static inline struct acpi_nfit_memory_map *__to_nfit_memdev( 272 struct nfit_mem *nfit_mem) 273 { 274 if (nfit_mem->memdev_dcr) 275 return nfit_mem->memdev_dcr; 276 return nfit_mem->memdev_pmem; 277 } 278 279 static inline struct acpi_nfit_desc *to_acpi_desc( 280 struct nvdimm_bus_descriptor *nd_desc) 281 { 282 return container_of(nd_desc, struct acpi_nfit_desc, nd_desc); 283 } 284 285 const guid_t *to_nfit_uuid(enum nfit_uuids id); 286 int acpi_nfit_init(struct acpi_nfit_desc *acpi_desc, void *nfit, acpi_size sz); 287 void acpi_nfit_shutdown(void *data); 288 void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event); 289 void __acpi_nvdimm_notify(struct device *dev, u32 event); 290 int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc, struct nvdimm *nvdimm, 291 unsigned int cmd, void *buf, unsigned int buf_len, int *cmd_rc); 292 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev); 293 #endif /* __NFIT_H__ */ 294