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