[deliverable/linux.git] / drivers / acpi / nfit.h

/*
 * NVDIMM Firmware Interface Table - NFIT
 *
 * Copyright(c) 2013-2015 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
#ifndef __NFIT_H__
#define __NFIT_H__
#include <linux/libnvdimm.h>
#include <linux/types.h>
#include <linux/uuid.h>
#include <linux/acpi.h>
#include <acpi/acuuid.h>

#define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
#define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
#define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
		| ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
		| ACPI_NFIT_MEM_NOT_ARMED)

enum nfit_uuids {
	NFIT_SPA_VOLATILE,
	NFIT_SPA_PM,
	NFIT_SPA_DCR,
	NFIT_SPA_BDW,
	NFIT_SPA_VDISK,
	NFIT_SPA_VCD,
	NFIT_SPA_PDISK,
	NFIT_SPA_PCD,
	NFIT_DEV_BUS,
	NFIT_DEV_DIMM,
	NFIT_UUID_MAX,
};

enum {
	ND_BLK_READ_FLUSH = 1,
	ND_BLK_DCR_LATCH = 2,
};

struct nfit_spa {
	struct acpi_nfit_system_address *spa;
	struct list_head list;
	int is_registered;
};

struct nfit_dcr {
	struct acpi_nfit_control_region *dcr;
	struct list_head list;
};

struct nfit_bdw {
	struct acpi_nfit_data_region *bdw;
	struct list_head list;
};

struct nfit_idt {
	struct acpi_nfit_interleave *idt;
	struct list_head list;
};

struct nfit_flush {
	struct acpi_nfit_flush_address *flush;
	struct list_head list;
};

struct nfit_memdev {
	struct acpi_nfit_memory_map *memdev;
	struct list_head list;
};

/* assembled tables for a given dimm/memory-device */
struct nfit_mem {
	struct nvdimm *nvdimm;
	struct acpi_nfit_memory_map *memdev_dcr;
	struct acpi_nfit_memory_map *memdev_pmem;
	struct acpi_nfit_memory_map *memdev_bdw;
	struct acpi_nfit_control_region *dcr;
	struct acpi_nfit_data_region *bdw;
	struct acpi_nfit_system_address *spa_dcr;
	struct acpi_nfit_system_address *spa_bdw;
	struct acpi_nfit_interleave *idt_dcr;
	struct acpi_nfit_interleave *idt_bdw;
	struct nfit_flush *nfit_flush;
	struct list_head list;
	struct acpi_device *adev;
	unsigned long dsm_mask;
};

struct acpi_nfit_desc {
	struct nvdimm_bus_descriptor nd_desc;
	struct acpi_table_header acpi_header;
	struct acpi_nfit_header *nfit;
	struct mutex spa_map_mutex;
	struct mutex init_mutex;
	struct list_head spa_maps;
	struct list_head memdevs;
	struct list_head flushes;
	struct list_head dimms;
	struct list_head spas;
	struct list_head dcrs;
	struct list_head bdws;
	struct list_head idts;
	struct nvdimm_bus *nvdimm_bus;
	struct device *dev;
	unsigned long dimm_dsm_force_en;
	unsigned long bus_dsm_force_en;
	int (*blk_do_io)(struct nd_blk_region *ndbr, resource_size_t dpa,
			void *iobuf, u64 len, int rw);
};

enum nd_blk_mmio_selector {
	BDW,
	DCR,
};

struct nd_blk_addr {
	union {
		void __iomem *base;
		void __pmem  *aperture;
	};
};

struct nfit_blk {
	struct nfit_blk_mmio {
		struct nd_blk_addr addr;
		u64 size;
		u64 base_offset;
		u32 line_size;
		u32 num_lines;
		u32 table_size;
		struct acpi_nfit_interleave *idt;
		struct acpi_nfit_system_address *spa;
	} mmio[2];
	struct nd_region *nd_region;
	u64 bdw_offset; /* post interleave offset */
	u64 stat_offset;
	u64 cmd_offset;
	void __iomem *nvdimm_flush;
	u32 dimm_flags;
};

enum spa_map_type {
	SPA_MAP_CONTROL,
	SPA_MAP_APERTURE,
};

struct nfit_spa_mapping {
	struct acpi_nfit_desc *acpi_desc;
	struct acpi_nfit_system_address *spa;
	struct list_head list;
	struct kref kref;
	enum spa_map_type type;
	struct nd_blk_addr addr;
};

static inline struct nfit_spa_mapping *to_spa_map(struct kref *kref)
{
	return container_of(kref, struct nfit_spa_mapping, kref);
}

static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
		struct nfit_mem *nfit_mem)
{
	if (nfit_mem->memdev_dcr)
		return nfit_mem->memdev_dcr;
	return nfit_mem->memdev_pmem;
}

static inline struct acpi_nfit_desc *to_acpi_desc(
		struct nvdimm_bus_descriptor *nd_desc)
{
	return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
}

const u8 *to_nfit_uuid(enum nfit_uuids id);
int acpi_nfit_init(struct acpi_nfit_desc *nfit, acpi_size sz);
extern const struct attribute_group *acpi_nfit_attribute_groups[];
#endif /* __NFIT_H__ */
Commit	Line	Data
b94d5230 DW	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"
58138820 DW	25	#define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
58138820 DW	26	\| ACPI_NFIT_MEM_RESTORE_FAILED \| ACPI_NFIT_MEM_FLUSH_FAILED \
ca321d1c	27	\| ACPI_NFIT_MEM_NOT_ARMED)
b94d5230 DW	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
f0f2c072	43	enum {
67a3e8fe	44	ND_BLK_READ_FLUSH = 1,
f0f2c072 RZ	45	ND_BLK_DCR_LATCH = 2,
	46	};
	47
b94d5230 DW	48	struct nfit_spa {
	49	struct acpi_nfit_system_address *spa;
	50	struct list_head list;
20985164	51	int is_registered;
b94d5230 DW	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
047fc8a1 RZ	64	struct nfit_idt {
	65	struct acpi_nfit_interleave *idt;
	66	struct list_head list;
	67	};
	68
c2ad2954 RZ	69	struct nfit_flush {
	70	struct acpi_nfit_flush_address *flush;
	71	struct list_head list;
	72	};
	73
b94d5230 DW	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 {
e6dfb2de	81	struct nvdimm *nvdimm;
b94d5230 DW	82	struct acpi_nfit_memory_map *memdev_dcr;
b94d5230 DW	83	struct acpi_nfit_memory_map *memdev_pmem;
047fc8a1	84	struct acpi_nfit_memory_map *memdev_bdw;
b94d5230 DW	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;
047fc8a1 RZ	89	struct acpi_nfit_interleave *idt_dcr;
047fc8a1 RZ	90	struct acpi_nfit_interleave *idt_bdw;
c2ad2954	91	struct nfit_flush *nfit_flush;
b94d5230	92	struct list_head list;
62232e45 DW	93	struct acpi_device *adev;
62232e45 DW	94	unsigned long dsm_mask;
b94d5230 DW	95	};
	96
	97	struct acpi_nfit_desc {
	98	struct nvdimm_bus_descriptor nd_desc;
6b577c9d LK	99	struct acpi_table_header acpi_header;
6b577c9d LK	100	struct acpi_nfit_header *nfit;
047fc8a1	101	struct mutex spa_map_mutex;
20985164	102	struct mutex init_mutex;
047fc8a1	103	struct list_head spa_maps;
b94d5230	104	struct list_head memdevs;
c2ad2954	105	struct list_head flushes;
b94d5230 DW	106	struct list_head dimms;
	107	struct list_head spas;
	108	struct list_head dcrs;
	109	struct list_head bdws;
047fc8a1	110	struct list_head idts;
b94d5230 DW	111	struct nvdimm_bus *nvdimm_bus;
b94d5230 DW	112	struct device *dev;
62232e45	113	unsigned long dimm_dsm_force_en;
39c686b8	114	unsigned long bus_dsm_force_en;
6bc75619 DW	115	int (blk_do_io)(struct nd_blk_region ndbr, resource_size_t dpa,
6bc75619 DW	116	void *iobuf, u64 len, int rw);
b94d5230 DW	117	};
b94d5230 DW	118
047fc8a1 RZ	119	enum nd_blk_mmio_selector {
	120	BDW,
	121	DCR,
	122	};
	123
67a3e8fe RZ	124	struct nd_blk_addr {
	125	union {
	126	void __iomem *base;
	127	void __pmem *aperture;
	128	};
	129	};
	130
047fc8a1 RZ	131	struct nfit_blk {
047fc8a1 RZ	132	struct nfit_blk_mmio {
67a3e8fe	133	struct nd_blk_addr addr;
047fc8a1 RZ	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;
c2ad2954	146	void __iomem *nvdimm_flush;
f0f2c072	147	u32 dimm_flags;
c2ad2954 RZ	148	};
	149
	150	enum spa_map_type {
	151	SPA_MAP_CONTROL,
	152	SPA_MAP_APERTURE,
047fc8a1 RZ	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;
67a3e8fe RZ	160	enum spa_map_type type;
67a3e8fe RZ	161	struct nd_blk_addr addr;
047fc8a1 RZ	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
b94d5230 DW	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	}
45def22c DW	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	}
6bc75619 DW	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[];
b94d5230	186	#endif /* __NFIT_H__ */