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