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