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_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 {
  44         ND_BLK_DCR_LATCH = 2,
  45 };
  46
  47 struct nfit_spa {
  48         struct acpi_nfit_system_address *spa;
  49         struct list_head list;
  50 };
  51
  52 struct nfit_dcr {
  53         struct acpi_nfit_control_region *dcr;
  54         struct list_head list;
  55 };
  56
  57 struct nfit_bdw {
  58         struct acpi_nfit_data_region *bdw;
  59         struct list_head list;
  60 };
  61
  62 struct nfit_idt {
  63         struct acpi_nfit_interleave *idt;
  64         struct list_head list;
  65 };
  66
  67 struct nfit_flush {
  68         struct acpi_nfit_flush_address *flush;
  69         struct list_head list;
  70 };
  71
  72 struct nfit_memdev {
  73         struct acpi_nfit_memory_map *memdev;
  74         struct list_head list;
  75 };
  76
  77 /* assembled tables for a given dimm/memory-device */
  78 struct nfit_mem {
  79         struct nvdimm *nvdimm;
  80         struct acpi_nfit_memory_map *memdev_dcr;
  81         struct acpi_nfit_memory_map *memdev_pmem;
  82         struct acpi_nfit_memory_map *memdev_bdw;
  83         struct acpi_nfit_control_region *dcr;
  84         struct acpi_nfit_data_region *bdw;
  85         struct acpi_nfit_system_address *spa_dcr;
  86         struct acpi_nfit_system_address *spa_bdw;
  87         struct acpi_nfit_interleave *idt_dcr;
  88         struct acpi_nfit_interleave *idt_bdw;
  89         struct nfit_flush *nfit_flush;
  90         struct list_head list;
  91         struct acpi_device *adev;
  92         unsigned long dsm_mask;
  93 };
  94
  95 struct acpi_nfit_desc {
  96         struct nvdimm_bus_descriptor nd_desc;
  97         struct acpi_table_nfit *nfit;
  98         struct mutex spa_map_mutex;
  99         struct list_head spa_maps;
 100         struct list_head memdevs;
 101         struct list_head flushes;
 102         struct list_head dimms;
 103         struct list_head spas;
 104         struct list_head dcrs;
 105         struct list_head bdws;
 106         struct list_head idts;
 107         struct nvdimm_bus *nvdimm_bus;
 108         struct device *dev;
 109         unsigned long dimm_dsm_force_en;
 110         int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
 111                         void *iobuf, u64 len, int rw);
 112 };
 113
 114 enum nd_blk_mmio_selector {
 115         BDW,
 116         DCR,
 117 };
 118
 119 struct nfit_blk {
 120         struct nfit_blk_mmio {
 121                 union {
 122                         void __iomem *base;
 123                         void __pmem  *aperture;
 124                 };
 125                 u64 size;
 126                 u64 base_offset;
 127                 u32 line_size;
 128                 u32 num_lines;
 129                 u32 table_size;
 130                 struct acpi_nfit_interleave *idt;
 131                 struct acpi_nfit_system_address *spa;
 132         } mmio[2];
 133         struct nd_region *nd_region;
 134         u64 bdw_offset; /* post interleave offset */
 135         u64 stat_offset;
 136         u64 cmd_offset;
 137         void __iomem *nvdimm_flush;
 138         u32 dimm_flags;
 139 };
 140
 141 enum spa_map_type {
 142         SPA_MAP_CONTROL,
 143         SPA_MAP_APERTURE,
 144 };
 145
 146 struct nfit_spa_mapping {
 147         struct acpi_nfit_desc *acpi_desc;
 148         struct acpi_nfit_system_address *spa;
 149         struct list_head list;
 150         struct kref kref;
 151         void __iomem *iomem;
 152 };
 153
 154 static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
 155 {
 156         return container_of(kref, struct nfit_spa_mapping, kref);
 157 }
 158
 159 static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
 160                 struct nfit_mem *nfit_mem)
 161 {
 162         if (nfit_mem->memdev_dcr)
 163                 return nfit_mem->memdev_dcr;
 164         return nfit_mem->memdev_pmem;
 165 }
 166
 167 static inline struct acpi_nfit_desc *to_acpi_desc(
 168                 struct nvdimm_bus_descriptor *nd_desc)
 169 {
 170         return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
 171 }
 172
 173 const u8 *to_nfit_uuid(enum nfit_uuids id);
 174 int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
 175 extern const struct attribute_group *acpi_nfit_attribute_groups[];
 176 #endif /* __NFIT_H__ */