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/libnvdimm.h>
  18 #include <linux/types.h>
  19 #include <linux/uuid.h>
  20 #include <linux/acpi.h>
  21 #include <acpi/acuuid.h>
  22
  23 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
  24 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
  25 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
  26                 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
  27                 | ACPI_NFIT_MEM_NOT_ARMED)
  28
  29 enum nfit_uuids {
  30         NFIT_SPA_VOLATILE,
  31         NFIT_SPA_PM,
  32         NFIT_SPA_DCR,
  33         NFIT_SPA_BDW,
  34         NFIT_SPA_VDISK,
  35         NFIT_SPA_VCD,
  36         NFIT_SPA_PDISK,
  37         NFIT_SPA_PCD,
  38         NFIT_DEV_BUS,
  39         NFIT_DEV_DIMM,
  40         NFIT_UUID_MAX,
  41 };
  42
  43 enum nfit_fic {
  44         NFIT_FIC_BYTE = 0x101, /* byte-addressable energy backed */
  45         NFIT_FIC_BLK = 0x201, /* block-addressable non-energy backed */
  46         NFIT_FIC_BYTEN = 0x301, /* byte-addressable non-energy backed */
  47 };
  48
  49 enum {
  50         ND_BLK_READ_FLUSH = 1,
  51         ND_BLK_DCR_LATCH = 2,
  52 };
  53
  54 struct nfit_spa {
  55         struct acpi_nfit_system_address *spa;
  56         struct list_head list;
  57         int is_registered;
  58 };
  59
  60 struct nfit_dcr {
  61         struct acpi_nfit_control_region *dcr;
  62         struct list_head list;
  63 };
  64
  65 struct nfit_bdw {
  66         struct acpi_nfit_data_region *bdw;
  67         struct list_head list;
  68 };
  69
  70 struct nfit_idt {
  71         struct acpi_nfit_interleave *idt;
  72         struct list_head list;
  73 };
  74
  75 struct nfit_flush {
  76         struct acpi_nfit_flush_address *flush;
  77         struct list_head list;
  78 };
  79
  80 struct nfit_memdev {
  81         struct acpi_nfit_memory_map *memdev;
  82         struct list_head list;
  83 };
  84
  85 /* assembled tables for a given dimm/memory-device */
  86 struct nfit_mem {
  87         struct nvdimm *nvdimm;
  88         struct acpi_nfit_memory_map *memdev_dcr;
  89         struct acpi_nfit_memory_map *memdev_pmem;
  90         struct acpi_nfit_memory_map *memdev_bdw;
  91         struct acpi_nfit_control_region *dcr;
  92         struct acpi_nfit_data_region *bdw;
  93         struct acpi_nfit_system_address *spa_dcr;
  94         struct acpi_nfit_system_address *spa_bdw;
  95         struct acpi_nfit_interleave *idt_dcr;
  96         struct acpi_nfit_interleave *idt_bdw;
  97         struct nfit_flush *nfit_flush;
  98         struct list_head list;
  99         struct acpi_device *adev;
 100         unsigned long dsm_mask;
 101 };
 102
 103 struct acpi_nfit_desc {
 104         struct nvdimm_bus_descriptor nd_desc;
 105         struct acpi_table_header acpi_header;
 106         struct acpi_nfit_header *nfit;
 107         struct mutex spa_map_mutex;
 108         struct mutex init_mutex;
 109         struct list_head spa_maps;
 110         struct list_head memdevs;
 111         struct list_head flushes;
 112         struct list_head dimms;
 113         struct list_head spas;
 114         struct list_head dcrs;
 115         struct list_head bdws;
 116         struct list_head idts;
 117         struct nvdimm_bus *nvdimm_bus;
 118         struct device *dev;
 119         unsigned long dimm_dsm_force_en;
 120         unsigned long bus_dsm_force_en;
 121         int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 122                         void *iobuf, u64 len, int rw);
 123 };
 124
 125 enum nd_blk_mmio_selector {
 126         BDW,
 127         DCR,
 128 };
 129
 130 struct nd_blk_addr {
 131         union {
 132                 void __iomem *base;
 133                 void __pmem  *aperture;
 134         };
 135 };
 136
 137 struct nfit_blk {
 138         struct nfit_blk_mmio {
 139                 struct nd_blk_addr addr;
 140                 u64 size;
 141                 u64 base_offset;
 142                 u32 line_size;
 143                 u32 num_lines;
 144                 u32 table_size;
 145                 struct acpi_nfit_interleave *idt;
 146                 struct acpi_nfit_system_address *spa;
 147         } mmio[2];
 148         struct nd_region *nd_region;
 149         u64 bdw_offset; /* post interleave offset */
 150         u64 stat_offset;
 151         u64 cmd_offset;
 152         void __iomem *nvdimm_flush;
 153         u32 dimm_flags;
 154 };
 155
 156 enum spa_map_type {
 157         SPA_MAP_CONTROL,
 158         SPA_MAP_APERTURE,
 159 };
 160
 161 struct nfit_spa_mapping {
 162         struct acpi_nfit_desc *acpi_desc;
 163         struct acpi_nfit_system_address *spa;
 164         struct list_head list;
 165         struct kref kref;
 166         enum spa_map_type type;
 167         struct nd_blk_addr addr;
 168 };
 169
 170 static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
 171 {
 172         return container_of(kref, struct nfit_spa_mapping, kref);
 173 }
 174
 175 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
 176                 struct nfit_mem *nfit_mem)
 177 {
 178         if (nfit_mem->memdev_dcr)
 179                 return nfit_mem->memdev_dcr;
 180         return nfit_mem->memdev_pmem;
 181 }
 182
 183 static inline struct acpi_nfit_desc *to_acpi_desc(
 184                 struct nvdimm_bus_descriptor *nd_desc)
 185 {
 186         return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
 187 }
 188
 189 const u8 *to_nfit_uuid(enum nfit_uuids id);
 190 int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
 191 extern const struct attribute_group *acpi_nfit_attribute_groups[];
 192 #endif /* __NFIT_H__ */