drivers/acpi/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/types.h>
  20 #include <linux/uuid.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 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
  35                 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
  36                 | ACPI_NFIT_MEM_NOT_ARMED)
  37
  38 enum nfit_uuids {
  39         /* for simplicity alias the uuid index with the family id */
  40         NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
  41         NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
  42         NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
  43         NFIT_SPA_VOLATILE,
  44         NFIT_SPA_PM,
  45         NFIT_SPA_DCR,
  46         NFIT_SPA_BDW,
  47         NFIT_SPA_VDISK,
  48         NFIT_SPA_VCD,
  49         NFIT_SPA_PDISK,
  50         NFIT_SPA_PCD,
  51         NFIT_DEV_BUS,
  52         NFIT_UUID_MAX,
  53 };
  54
  55 enum nfit_fic {
  56         NFIT_FIC_BYTE = 0x101, /* byte-addressable energy backed */
  57         NFIT_FIC_BLK = 0x201, /* block-addressable non-energy backed */
  58         NFIT_FIC_BYTEN = 0x301, /* byte-addressable non-energy backed */
  59 };
  60
  61 enum {
  62         NFIT_BLK_READ_FLUSH = 1,
  63         NFIT_BLK_DCR_LATCH = 2,
  64         NFIT_ARS_STATUS_DONE = 0,
  65         NFIT_ARS_STATUS_BUSY = 1 << 16,
  66         NFIT_ARS_STATUS_NONE = 2 << 16,
  67         NFIT_ARS_STATUS_INTR = 3 << 16,
  68         NFIT_ARS_START_BUSY = 6,
  69         NFIT_ARS_CAP_NONE = 1,
  70         NFIT_ARS_F_OVERFLOW = 1,
  71         NFIT_ARS_TIMEOUT = 90,
  72 };
  73
  74 struct nfit_spa {
  75         struct acpi_nfit_system_address *spa;
  76         struct list_head list;
  77         struct nd_region *nd_region;
  78         unsigned int ars_done:1;
  79         u32 clear_err_unit;
  80         u32 max_ars;
  81 };
  82
  83 struct nfit_dcr {
  84         struct acpi_nfit_control_region *dcr;
  85         struct list_head list;
  86 };
  87
  88 struct nfit_bdw {
  89         struct acpi_nfit_data_region *bdw;
  90         struct list_head list;
  91 };
  92
  93 struct nfit_idt {
  94         struct acpi_nfit_interleave *idt;
  95         struct list_head list;
  96 };
  97
  98 struct nfit_flush {
  99         struct acpi_nfit_flush_address *flush;
 100         struct list_head list;
 101 };
 102
 103 struct nfit_memdev {
 104         struct acpi_nfit_memory_map *memdev;
 105         struct list_head list;
 106 };
 107
 108 /* assembled tables for a given dimm/memory-device */
 109 struct nfit_mem {
 110         struct nvdimm *nvdimm;
 111         struct acpi_nfit_memory_map *memdev_dcr;
 112         struct acpi_nfit_memory_map *memdev_pmem;
 113         struct acpi_nfit_memory_map *memdev_bdw;
 114         struct acpi_nfit_control_region *dcr;
 115         struct acpi_nfit_data_region *bdw;
 116         struct acpi_nfit_system_address *spa_dcr;
 117         struct acpi_nfit_system_address *spa_bdw;
 118         struct acpi_nfit_interleave *idt_dcr;
 119         struct acpi_nfit_interleave *idt_bdw;
 120         struct nfit_flush *nfit_flush;
 121         struct list_head list;
 122         struct acpi_device *adev;
 123         unsigned long dsm_mask;
 124         int family;
 125 };
 126
 127 struct acpi_nfit_desc {
 128         struct nvdimm_bus_descriptor nd_desc;
 129         struct acpi_table_header acpi_header;
 130         struct acpi_nfit_header *nfit;
 131         struct mutex spa_map_mutex;
 132         struct mutex init_mutex;
 133         struct list_head spa_maps;
 134         struct list_head memdevs;
 135         struct list_head flushes;
 136         struct list_head dimms;
 137         struct list_head spas;
 138         struct list_head dcrs;
 139         struct list_head bdws;
 140         struct list_head idts;
 141         struct nvdimm_bus *nvdimm_bus;
 142         struct device *dev;
 143         struct nd_cmd_ars_status *ars_status;
 144         size_t ars_status_size;
 145         struct work_struct work;
 146         unsigned int cancel:1;
 147         unsigned long dimm_cmd_force_en;
 148         unsigned long bus_cmd_force_en;
 149         int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 150                         void *iobuf, u64 len, int rw);
 151 };
 152
 153 enum nd_blk_mmio_selector {
 154         BDW,
 155         DCR,
 156 };
 157
 158 struct nd_blk_addr {
 159         union {
 160                 void __iomem *base;
 161                 void __pmem  *aperture;
 162         };
 163 };
 164
 165 struct nfit_blk {
 166         struct nfit_blk_mmio {
 167                 struct nd_blk_addr addr;
 168                 u64 size;
 169                 u64 base_offset;
 170                 u32 line_size;
 171                 u32 num_lines;
 172                 u32 table_size;
 173                 struct acpi_nfit_interleave *idt;
 174                 struct acpi_nfit_system_address *spa;
 175         } mmio[2];
 176         struct nd_region *nd_region;
 177         u64 bdw_offset; /* post interleave offset */
 178         u64 stat_offset;
 179         u64 cmd_offset;
 180         void __iomem *nvdimm_flush;
 181         u32 dimm_flags;
 182 };
 183
 184 enum spa_map_type {
 185         SPA_MAP_CONTROL,
 186         SPA_MAP_APERTURE,
 187 };
 188
 189 struct nfit_spa_mapping {
 190         struct acpi_nfit_desc *acpi_desc;
 191         struct acpi_nfit_system_address *spa;
 192         struct list_head list;
 193         struct kref kref;
 194         enum spa_map_type type;
 195         struct nd_blk_addr addr;
 196 };
 197
 198 static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
 199 {
 200         return container_of(kref, struct nfit_spa_mapping, kref);
 201 }
 202
 203 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
 204                 struct nfit_mem *nfit_mem)
 205 {
 206         if (nfit_mem->memdev_dcr)
 207                 return nfit_mem->memdev_dcr;
 208         return nfit_mem->memdev_pmem;
 209 }
 210
 211 static inline struct acpi_nfit_desc *to_acpi_desc(
 212                 struct nvdimm_bus_descriptor *nd_desc)
 213 {
 214         return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
 215 }
 216
 217 const u8 *to_nfit_uuid(enum nfit_uuids id);
 218 int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
 219 void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
 220 #endif /* __NFIT_H__ */