[mirror_ubuntu-bionic-kernel.git] / drivers / acpi / nfit / 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/workqueue.h>
#include <linux/libnvdimm.h>
#include <linux/ndctl.h>
#include <linux/types.h>
#include <linux/uuid.h>
#include <linux/acpi.h>
#include <acpi/acuuid.h>

/* ACPI 6.1 */
#define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"

/* http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf */
#define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"

/* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */
#define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6"
#define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e"

/* https://msdn.microsoft.com/library/windows/hardware/mt604741 */
#define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05"

#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 {
	/* for simplicity alias the uuid index with the family id */
	NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
	NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
	NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
	NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT,
	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_UUID_MAX,
};

/*
 * Region format interface codes are stored with the interface as the
 * LSB and the function as the MSB.
 */
#define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
#define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
#define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */

enum {
	NFIT_BLK_READ_FLUSH = 1,
	NFIT_BLK_DCR_LATCH = 2,
	NFIT_ARS_STATUS_DONE = 0,
	NFIT_ARS_STATUS_BUSY = 1 << 16,
	NFIT_ARS_STATUS_NONE = 2 << 16,
	NFIT_ARS_STATUS_INTR = 3 << 16,
	NFIT_ARS_START_BUSY = 6,
	NFIT_ARS_CAP_NONE = 1,
	NFIT_ARS_F_OVERFLOW = 1,
	NFIT_ARS_TIMEOUT = 90,
};

enum nfit_root_notifiers {
	NFIT_NOTIFY_UPDATE = 0x80,
};

struct nfit_spa {
	struct list_head list;
	struct nd_region *nd_region;
	unsigned int ars_required:1;
	u32 clear_err_unit;
	u32 max_ars;
	struct acpi_nfit_system_address spa[0];
};

struct nfit_dcr {
	struct list_head list;
	struct acpi_nfit_control_region dcr[0];
};

struct nfit_bdw {
	struct list_head list;
	struct acpi_nfit_data_region bdw[0];
};

struct nfit_idt {
	struct list_head list;
	struct acpi_nfit_interleave idt[0];
};

struct nfit_flush {
	struct list_head list;
	struct acpi_nfit_flush_address flush[0];
};

struct nfit_memdev {
	struct list_head list;
	struct acpi_nfit_memory_map memdev[0];
};

/* 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;
	struct acpi_nfit_desc *acpi_desc;
	struct resource *flush_wpq;
	unsigned long dsm_mask;
	int family;
};

struct acpi_nfit_desc {
	struct nvdimm_bus_descriptor nd_desc;
	struct acpi_table_header acpi_header;
	struct mutex init_mutex;
	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;
	struct nd_cmd_ars_status *ars_status;
	size_t ars_status_size;
	struct work_struct work;
	struct list_head list;
	struct kernfs_node *scrub_count_state;
	unsigned int scrub_count;
	unsigned int cancel:1;
	unsigned long dimm_cmd_force_en;
	unsigned long bus_cmd_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 *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;
	u32 dimm_flags;
};

extern struct list_head acpi_descs;
extern struct mutex acpi_desc_lock;
int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc);

#ifdef CONFIG_X86_MCE
void nfit_mce_register(void);
void nfit_mce_unregister(void);
#else
static inline void nfit_mce_register(void)
{
}
static inline void nfit_mce_unregister(void)
{
}
#endif

int nfit_spa_type(struct acpi_nfit_system_address *spa);

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 *acpi_desc, void *nfit, acpi_size sz);
void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event);
void acpi_nfit_desc_init(struct acpi_nfit_desc *acpi_desc, struct device *dev);
#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__
7ae0fa43	17	#include <linux/workqueue.h>
b94d5230	18	#include <linux/libnvdimm.h>
6839a6d9	19	#include <linux/ndctl.h>
b94d5230 DW	20	#include <linux/types.h>
	21	#include <linux/uuid.h>
	22	#include <linux/acpi.h>
	23	#include <acpi/acuuid.h>
	24
31eca76b	25	/* ACPI 6.1 */
b94d5230	26	#define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
31eca76b DW	27
31eca76b DW	28	/* http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf */
b94d5230	29	#define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
31eca76b DW	30
	31	/* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */
	32	#define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6"
	33	#define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e"
	34
e02fb726	35	/* https://msdn.microsoft.com/library/windows/hardware/mt604741 */
	36	#define UUID_NFIT_DIMM_N_MSFT "1ee68b36-d4bd-4a1a-9a16-4f8e53d46e05"
	37
58138820 DW	38	#define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
58138820 DW	39	\| ACPI_NFIT_MEM_RESTORE_FAILED \| ACPI_NFIT_MEM_FLUSH_FAILED \
ca321d1c	40	\| ACPI_NFIT_MEM_NOT_ARMED)
b94d5230 DW	41
b94d5230 DW	42	enum nfit_uuids {
31eca76b DW	43	/* for simplicity alias the uuid index with the family id */
	44	NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
	45	NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
	46	NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
e02fb726	47	NFIT_DEV_DIMM_N_MSFT = NVDIMM_FAMILY_MSFT,
b94d5230 DW	48	NFIT_SPA_VOLATILE,
	49	NFIT_SPA_PM,
	50	NFIT_SPA_DCR,
	51	NFIT_SPA_BDW,
	52	NFIT_SPA_VDISK,
	53	NFIT_SPA_VCD,
	54	NFIT_SPA_PDISK,
	55	NFIT_SPA_PCD,
	56	NFIT_DEV_BUS,
b94d5230 DW	57	NFIT_UUID_MAX,
	58	};
	59
30ec5fd4	60	/*
1bcbf42d DW	61	* Region format interface codes are stored with the interface as the
1bcbf42d DW	62	* LSB and the function as the MSB.
30ec5fd4	63	*/
1bcbf42d DW	64	#define NFIT_FIC_BYTE cpu_to_le16(0x101) /* byte-addressable energy backed */
	65	#define NFIT_FIC_BLK cpu_to_le16(0x201) /* block-addressable non-energy backed */
	66	#define NFIT_FIC_BYTEN cpu_to_le16(0x301) /* byte-addressable non-energy backed */
be26f9ae	67
f0f2c072	68	enum {
aef25338 DW	69	NFIT_BLK_READ_FLUSH = 1,
	70	NFIT_BLK_DCR_LATCH = 2,
	71	NFIT_ARS_STATUS_DONE = 0,
	72	NFIT_ARS_STATUS_BUSY = 1 << 16,
	73	NFIT_ARS_STATUS_NONE = 2 << 16,
	74	NFIT_ARS_STATUS_INTR = 3 << 16,
	75	NFIT_ARS_START_BUSY = 6,
	76	NFIT_ARS_CAP_NONE = 1,
	77	NFIT_ARS_F_OVERFLOW = 1,
1cf03c00	78	NFIT_ARS_TIMEOUT = 90,
f0f2c072 RZ	79	};
f0f2c072 RZ	80
c09f1218 VV	81	enum nfit_root_notifiers {
	82	NFIT_NOTIFY_UPDATE = 0x80,
	83	};
	84
b94d5230	85	struct nfit_spa {
b94d5230	86	struct list_head list;
1cf03c00	87	struct nd_region *nd_region;
37b137ff	88	unsigned int ars_required:1;
1cf03c00 DW	89	u32 clear_err_unit;
1cf03c00 DW	90	u32 max_ars;
31932041	91	struct acpi_nfit_system_address spa[0];
b94d5230 DW	92	};
	93
	94	struct nfit_dcr {
b94d5230	95	struct list_head list;
31932041	96	struct acpi_nfit_control_region dcr[0];
b94d5230 DW	97	};
	98
	99	struct nfit_bdw {
b94d5230	100	struct list_head list;
31932041	101	struct acpi_nfit_data_region bdw[0];
b94d5230 DW	102	};
b94d5230 DW	103
047fc8a1	104	struct nfit_idt {
047fc8a1	105	struct list_head list;
31932041	106	struct acpi_nfit_interleave idt[0];
047fc8a1 RZ	107	};
047fc8a1 RZ	108
c2ad2954	109	struct nfit_flush {
c2ad2954	110	struct list_head list;
31932041	111	struct acpi_nfit_flush_address flush[0];
c2ad2954 RZ	112	};
c2ad2954 RZ	113
b94d5230	114	struct nfit_memdev {
b94d5230	115	struct list_head list;
31932041	116	struct acpi_nfit_memory_map memdev[0];
b94d5230 DW	117	};
	118
	119	/* assembled tables for a given dimm/memory-device */
	120	struct nfit_mem {
e6dfb2de	121	struct nvdimm *nvdimm;
b94d5230 DW	122	struct acpi_nfit_memory_map *memdev_dcr;
b94d5230 DW	123	struct acpi_nfit_memory_map *memdev_pmem;
047fc8a1	124	struct acpi_nfit_memory_map *memdev_bdw;
b94d5230 DW	125	struct acpi_nfit_control_region *dcr;
	126	struct acpi_nfit_data_region *bdw;
	127	struct acpi_nfit_system_address *spa_dcr;
	128	struct acpi_nfit_system_address *spa_bdw;
047fc8a1 RZ	129	struct acpi_nfit_interleave *idt_dcr;
047fc8a1 RZ	130	struct acpi_nfit_interleave *idt_bdw;
c2ad2954	131	struct nfit_flush *nfit_flush;
b94d5230	132	struct list_head list;
62232e45	133	struct acpi_device *adev;
8cc6ddfc	134	struct acpi_nfit_desc *acpi_desc;
e5ae3b25	135	struct resource *flush_wpq;
62232e45	136	unsigned long dsm_mask;
31eca76b	137	int family;
b94d5230 DW	138	};
	139
	140	struct acpi_nfit_desc {
	141	struct nvdimm_bus_descriptor nd_desc;
6b577c9d	142	struct acpi_table_header acpi_header;
20985164	143	struct mutex init_mutex;
b94d5230	144	struct list_head memdevs;
c2ad2954	145	struct list_head flushes;
b94d5230 DW	146	struct list_head dimms;
	147	struct list_head spas;
	148	struct list_head dcrs;
	149	struct list_head bdws;
047fc8a1	150	struct list_head idts;
b94d5230 DW	151	struct nvdimm_bus *nvdimm_bus;
b94d5230 DW	152	struct device *dev;
1cf03c00 DW	153	struct nd_cmd_ars_status *ars_status;
1cf03c00 DW	154	size_t ars_status_size;
7ae0fa43	155	struct work_struct work;
6839a6d9	156	struct list_head list;
37b137ff VV	157	struct kernfs_node *scrub_count_state;
37b137ff VV	158	unsigned int scrub_count;
7ae0fa43	159	unsigned int cancel:1;
e3654eca DW	160	unsigned long dimm_cmd_force_en;
e3654eca DW	161	unsigned long bus_cmd_force_en;
6bc75619 DW	162	int (blk_do_io)(struct nd_blk_region ndbr, resource_size_t dpa,
6bc75619 DW	163	void *iobuf, u64 len, int rw);
b94d5230 DW	164	};
b94d5230 DW	165
047fc8a1 RZ	166	enum nd_blk_mmio_selector {
	167	BDW,
	168	DCR,
	169	};
	170
67a3e8fe RZ	171	struct nd_blk_addr {
	172	union {
	173	void __iomem *base;
7a9eb206	174	void *aperture;
67a3e8fe RZ	175	};
	176	};
	177
047fc8a1 RZ	178	struct nfit_blk {
047fc8a1 RZ	179	struct nfit_blk_mmio {
67a3e8fe	180	struct nd_blk_addr addr;
047fc8a1 RZ	181	u64 size;
	182	u64 base_offset;
	183	u32 line_size;
	184	u32 num_lines;
	185	u32 table_size;
	186	struct acpi_nfit_interleave *idt;
	187	struct acpi_nfit_system_address *spa;
	188	} mmio[2];
	189	struct nd_region *nd_region;
	190	u64 bdw_offset; /* post interleave offset */
	191	u64 stat_offset;
	192	u64 cmd_offset;
f0f2c072	193	u32 dimm_flags;
c2ad2954 RZ	194	};
c2ad2954 RZ	195
6839a6d9 VV	196	extern struct list_head acpi_descs;
	197	extern struct mutex acpi_desc_lock;
	198	int acpi_nfit_ars_rescan(struct acpi_nfit_desc *acpi_desc);
047fc8a1	199
6839a6d9 VV	200	#ifdef CONFIG_X86_MCE
	201	void nfit_mce_register(void);
	202	void nfit_mce_unregister(void);
	203	#else
	204	static inline void nfit_mce_register(void)
047fc8a1	205	{
047fc8a1	206	}
6839a6d9 VV	207	static inline void nfit_mce_unregister(void)
	208	{
	209	}
	210	#endif
	211
	212	int nfit_spa_type(struct acpi_nfit_system_address *spa);
047fc8a1	213
b94d5230 DW	214	static inline struct acpi_nfit_memory_map *__to_nfit_memdev(
	215	struct nfit_mem *nfit_mem)
	216	{
	217	if (nfit_mem->memdev_dcr)
	218	return nfit_mem->memdev_dcr;
	219	return nfit_mem->memdev_pmem;
	220	}
45def22c DW	221
	222	static inline struct acpi_nfit_desc *to_acpi_desc(
	223	struct nvdimm_bus_descriptor *nd_desc)
	224	{
	225	return container_of(nd_desc, struct acpi_nfit_desc, nd_desc);
	226	}
6bc75619 DW	227
6bc75619 DW	228	const u8 *to_nfit_uuid(enum nfit_uuids id);
e7a11b44	229	int acpi_nfit_init(struct acpi_nfit_desc acpi_desc, void nfit, acpi_size sz);
c14a868a	230	void __acpi_nfit_notify(struct device *dev, acpi_handle handle, u32 event);
a61fe6f7	231	void acpi_nfit_desc_init(struct acpi_nfit_desc acpi_desc, struct device dev);
b94d5230	232	#endif /* __NFIT_H__ */