drivers/acpi/nfit/nfit.h

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