drivers/acpi/nfit/nfit.h

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