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