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