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