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