[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/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 | ACPI_NFIT_MEM_MAP_FAILED)

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,
	NFIT_NOTIFY_UC_MEMORY_ERROR = 0x81,
};

enum nfit_dimm_notifiers {
	NFIT_NOTIFY_DIMM_HEALTH = 0x81,
};

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 kernfs_node *flags_attr;
	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;
	u8 ars_start_flags;
	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 scrub_mode;
	unsigned int cancel:1;
	unsigned int init_complete: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 scrub_mode {
	HW_ERROR_SCRUB_OFF,
	HW_ERROR_SCRUB_ON,
};

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, u8 flags);

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