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