[mirror_ubuntu-bionic-kernel.git] / include / linux / dmar.h

/*
 * Copyright (c) 2006, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307 USA.
 *
 * Copyright (C) Ashok Raj <ashok.raj@intel.com>
 * Copyright (C) Shaohua Li <shaohua.li@intel.com>
 */

#ifndef __DMAR_H__
#define __DMAR_H__

#include <linux/acpi.h>
#include <linux/types.h>
#include <linux/msi.h>
#include <linux/irqreturn.h>
#include <linux/rwsem.h>
#include <linux/rculist.h>

struct acpi_dmar_header;

#ifdef	CONFIG_X86
# define	DMAR_UNITS_SUPPORTED	MAX_IO_APICS
#else
# define	DMAR_UNITS_SUPPORTED	64
#endif

/* DMAR Flags */
#define DMAR_INTR_REMAP		0x1
#define DMAR_X2APIC_OPT_OUT	0x2
#define DMAR_PLATFORM_OPT_IN	0x4

struct intel_iommu;

struct dmar_dev_scope {
	struct device __rcu *dev;
	u8 bus;
	u8 devfn;
};

#ifdef CONFIG_DMAR_TABLE
extern struct acpi_table_header *dmar_tbl;
struct dmar_drhd_unit {
	struct list_head list;		/* list of drhd units	*/
	struct  acpi_dmar_header *hdr;	/* ACPI header		*/
	u64	reg_base_addr;		/* register base address*/
	struct	dmar_dev_scope *devices;/* target device array	*/
	int	devices_cnt;		/* target device count	*/
	u16	segment;		/* PCI domain		*/
	u8	ignored:1; 		/* ignore drhd		*/
	u8	include_all:1;
	struct intel_iommu *iommu;
};

struct dmar_pci_path {
	u8 bus;
	u8 device;
	u8 function;
};

struct dmar_pci_notify_info {
	struct pci_dev			*dev;
	unsigned long			event;
	int				bus;
	u16				seg;
	u16				level;
	struct dmar_pci_path		path[];
}  __attribute__((packed));

extern struct rw_semaphore dmar_global_lock;
extern struct list_head dmar_drhd_units;

#define for_each_drhd_unit(drhd) \
	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list)

#define for_each_active_drhd_unit(drhd)					\
	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list)		\
		if (drhd->ignored) {} else

#define for_each_active_iommu(i, drhd)					\
	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list)		\
		if (i=drhd->iommu, drhd->ignored) {} else

#define for_each_iommu(i, drhd)						\
	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list)		\
		if (i=drhd->iommu, 0) {} else 

static inline bool dmar_rcu_check(void)
{
	return rwsem_is_locked(&dmar_global_lock) ||
	       system_state == SYSTEM_BOOTING;
}

#define	dmar_rcu_dereference(p)	rcu_dereference_check((p), dmar_rcu_check())

#define	for_each_dev_scope(a, c, p, d)	\
	for ((p) = 0; ((d) = (p) < (c) ? dmar_rcu_dereference((a)[(p)].dev) : \
			NULL, (p) < (c)); (p)++)

#define	for_each_active_dev_scope(a, c, p, d)	\
	for_each_dev_scope((a), (c), (p), (d))	if (!(d)) { continue; } else

extern int dmar_table_init(void);
extern int dmar_dev_scope_init(void);
extern void dmar_register_bus_notifier(void);
extern int dmar_parse_dev_scope(void *start, void *end, int *cnt,
				struct dmar_dev_scope **devices, u16 segment);
extern void *dmar_alloc_dev_scope(void *start, void *end, int *cnt);
extern void dmar_free_dev_scope(struct dmar_dev_scope **devices, int *cnt);
extern int dmar_insert_dev_scope(struct dmar_pci_notify_info *info,
				 void *start, void*end, u16 segment,
				 struct dmar_dev_scope *devices,
				 int devices_cnt);
extern int dmar_remove_dev_scope(struct dmar_pci_notify_info *info,
				 u16 segment, struct dmar_dev_scope *devices,
				 int count);
/* Intel IOMMU detection */
extern int detect_intel_iommu(void);
extern int enable_drhd_fault_handling(void);
extern int dmar_device_add(acpi_handle handle);
extern int dmar_device_remove(acpi_handle handle);

static inline int dmar_res_noop(struct acpi_dmar_header *hdr, void *arg)
{
	return 0;
}

#ifdef CONFIG_INTEL_IOMMU
extern int iommu_detected, no_iommu;
extern int intel_iommu_init(void);
extern int dmar_parse_one_rmrr(struct acpi_dmar_header *header, void *arg);
extern int dmar_parse_one_atsr(struct acpi_dmar_header *header, void *arg);
extern int dmar_check_one_atsr(struct acpi_dmar_header *hdr, void *arg);
extern int dmar_release_one_atsr(struct acpi_dmar_header *hdr, void *arg);
extern int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
extern int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info);
#else /* !CONFIG_INTEL_IOMMU: */
static inline int intel_iommu_init(void) { return -ENODEV; }

#define	dmar_parse_one_rmrr		dmar_res_noop
#define	dmar_parse_one_atsr		dmar_res_noop
#define	dmar_check_one_atsr		dmar_res_noop
#define	dmar_release_one_atsr		dmar_res_noop

static inline int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info)
{
	return 0;
}

static inline int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
{
	return 0;
}
#endif /* CONFIG_INTEL_IOMMU */

#ifdef CONFIG_IRQ_REMAP
extern int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
#else  /* CONFIG_IRQ_REMAP */
static inline int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
{ return 0; }
#endif /* CONFIG_IRQ_REMAP */

extern bool dmar_platform_optin(void);

#else /* CONFIG_DMAR_TABLE */

static inline int dmar_device_add(void *handle)
{
	return 0;
}

static inline int dmar_device_remove(void *handle)
{
	return 0;
}

static inline bool dmar_platform_optin(void)
{
	return false;
}

#endif /* CONFIG_DMAR_TABLE */

struct irte {
	union {
		/* Shared between remapped and posted mode*/
		struct {
			__u64	present		: 1,  /*  0      */
				fpd		: 1,  /*  1      */
				__res0		: 6,  /*  2 -  6 */
				avail		: 4,  /*  8 - 11 */
				__res1		: 3,  /* 12 - 14 */
				pst		: 1,  /* 15      */
				vector		: 8,  /* 16 - 23 */
				__res2		: 40; /* 24 - 63 */
		};

		/* Remapped mode */
		struct {
			__u64	r_present	: 1,  /*  0      */
				r_fpd		: 1,  /*  1      */
				dst_mode	: 1,  /*  2      */
				redir_hint	: 1,  /*  3      */
				trigger_mode	: 1,  /*  4      */
				dlvry_mode	: 3,  /*  5 -  7 */
				r_avail		: 4,  /*  8 - 11 */
				r_res0		: 4,  /* 12 - 15 */
				r_vector	: 8,  /* 16 - 23 */
				r_res1		: 8,  /* 24 - 31 */
				dest_id		: 32; /* 32 - 63 */
		};

		/* Posted mode */
		struct {
			__u64	p_present	: 1,  /*  0      */
				p_fpd		: 1,  /*  1      */
				p_res0		: 6,  /*  2 -  7 */
				p_avail		: 4,  /*  8 - 11 */
				p_res1		: 2,  /* 12 - 13 */
				p_urgent	: 1,  /* 14      */
				p_pst		: 1,  /* 15      */
				p_vector	: 8,  /* 16 - 23 */
				p_res2		: 14, /* 24 - 37 */
				pda_l		: 26; /* 38 - 63 */
		};
		__u64 low;
	};

	union {
		/* Shared between remapped and posted mode*/
		struct {
			__u64	sid		: 16,  /* 64 - 79  */
				sq		: 2,   /* 80 - 81  */
				svt		: 2,   /* 82 - 83  */
				__res3		: 44;  /* 84 - 127 */
		};

		/* Posted mode*/
		struct {
			__u64	p_sid		: 16,  /* 64 - 79  */
				p_sq		: 2,   /* 80 - 81  */
				p_svt		: 2,   /* 82 - 83  */
				p_res3		: 12,  /* 84 - 95  */
				pda_h		: 32;  /* 96 - 127 */
		};
		__u64 high;
	};
};

static inline void dmar_copy_shared_irte(struct irte *dst, struct irte *src)
{
	dst->present	= src->present;
	dst->fpd	= src->fpd;
	dst->avail	= src->avail;
	dst->pst	= src->pst;
	dst->vector	= src->vector;
	dst->sid	= src->sid;
	dst->sq		= src->sq;
	dst->svt	= src->svt;
}

#define PDA_LOW_BIT    26
#define PDA_HIGH_BIT   32

/* Can't use the common MSI interrupt functions
 * since DMAR is not a pci device
 */
struct irq_data;
extern void dmar_msi_unmask(struct irq_data *data);
extern void dmar_msi_mask(struct irq_data *data);
extern void dmar_msi_read(int irq, struct msi_msg *msg);
extern void dmar_msi_write(int irq, struct msi_msg *msg);
extern int dmar_set_interrupt(struct intel_iommu *iommu);
extern irqreturn_t dmar_fault(int irq, void *dev_id);
extern int dmar_alloc_hwirq(int id, int node, void *arg);
extern void dmar_free_hwirq(int irq);

#endif /* __DMAR_H__ */
Commit	Line	Data
10e5247f KA	1	/*
	2	* Copyright (c) 2006, Intel Corporation.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
	15	* Place - Suite 330, Boston, MA 02111-1307 USA.
	16	*
	17	* Copyright (C) Ashok Raj <ashok.raj@intel.com>
	18	* Copyright (C) Shaohua Li <shaohua.li@intel.com>
	19	*/
	20
	21	#ifndef __DMAR_H__
	22	#define __DMAR_H__
	23
	24	#include <linux/acpi.h>
	25	#include <linux/types.h>
ba395927	26	#include <linux/msi.h>
1531a6a6	27	#include <linux/irqreturn.h>
3a5670e8	28	#include <linux/rwsem.h>
b2d09103	29	#include <linux/rculist.h>
10e5247f	30
6eea69dd AM	31	struct acpi_dmar_header;
6eea69dd AM	32
78d8e704 JL	33	#ifdef CONFIG_X86
	34	# define DMAR_UNITS_SUPPORTED MAX_IO_APICS
	35	#else
	36	# define DMAR_UNITS_SUPPORTED 64
	37	#endif
	38
41750d31 SS	39	/* DMAR Flags */
	40	#define DMAR_INTR_REMAP 0x1
	41	#define DMAR_X2APIC_OPT_OUT 0x2
3ccaabd3	42	#define DMAR_PLATFORM_OPT_IN 0x4
41750d31	43
ba395927	44	struct intel_iommu;
694835dc	45
832bd858 DW	46	struct dmar_dev_scope {
	47	struct device __rcu *dev;
	48	u8 bus;
	49	u8 devfn;
	50	};
	51
d3f13810	52	#ifdef CONFIG_DMAR_TABLE
41750d31	53	extern struct acpi_table_header *dmar_tbl;
2ae21010 SS	54	struct dmar_drhd_unit {
	55	struct list_head list; /* list of drhd units */
	56	struct acpi_dmar_header hdr; / ACPI header */
	57	u64 reg_base_addr; /* register base address*/
832bd858	58	struct dmar_dev_scope devices;/ target device array */
2ae21010	59	int devices_cnt; /* target device count */
276dbf99	60	u16 segment; /* PCI domain */
2ae21010 SS	61	u8 ignored:1; /* ignore drhd */
	62	u8 include_all:1;
	63	struct intel_iommu *iommu;
	64	};
	65
57384592 JR	66	struct dmar_pci_path {
	67	u8 bus;
	68	u8 device;
	69	u8 function;
	70	};
	71
59ce0515 JL	72	struct dmar_pci_notify_info {
	73	struct pci_dev *dev;
	74	unsigned long event;
	75	int bus;
	76	u16 seg;
	77	u16 level;
57384592	78	struct dmar_pci_path path[];
59ce0515 JL	79	} __attribute__((packed));
59ce0515 JL	80
3a5670e8	81	extern struct rw_semaphore dmar_global_lock;
2ae21010 SS	82	extern struct list_head dmar_drhd_units;
	83
	84	#define for_each_drhd_unit(drhd) \
0e242612	85	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list)
2ae21010	86
7c919779	87	#define for_each_active_drhd_unit(drhd) \
0e242612	88	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list) \
7c919779 JL	89	if (drhd->ignored) {} else
7c919779 JL	90
8f912ba4	91	#define for_each_active_iommu(i, drhd) \
0e242612	92	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list) \
8f912ba4 DW	93	if (i=drhd->iommu, drhd->ignored) {} else
	94
	95	#define for_each_iommu(i, drhd) \
0e242612	96	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list) \
8f912ba4 DW	97	if (i=drhd->iommu, 0) {} else
8f912ba4 DW	98
0e242612 JL	99	static inline bool dmar_rcu_check(void)
	100	{
	101	return rwsem_is_locked(&dmar_global_lock) \|\|
	102	system_state == SYSTEM_BOOTING;
	103	}
	104
	105	#define dmar_rcu_dereference(p) rcu_dereference_check((p), dmar_rcu_check())
	106
b683b230	107	#define for_each_dev_scope(a, c, p, d) \
832bd858	108	for ((p) = 0; ((d) = (p) < (c) ? dmar_rcu_dereference((a)[(p)].dev) : \
0e242612	109	NULL, (p) < (c)); (p)++)
b683b230 JL	110
	111	#define for_each_active_dev_scope(a, c, p, d) \
	112	for_each_dev_scope((a), (c), (p), (d)) if (!(d)) { continue; } else
	113
2ae21010	114	extern int dmar_table_init(void);
2ae21010	115	extern int dmar_dev_scope_init(void);
ec154bf5	116	extern void dmar_register_bus_notifier(void);
ada4d4b2	117	extern int dmar_parse_dev_scope(void start, void end, int *cnt,
832bd858	118	struct dmar_dev_scope **devices, u16 segment);
bb3a6b78	119	extern void dmar_alloc_dev_scope(void start, void end, int cnt);
832bd858	120	extern void dmar_free_dev_scope(struct dmar_dev_scope *devices, int cnt);
59ce0515 JL	121	extern int dmar_insert_dev_scope(struct dmar_pci_notify_info *info,
59ce0515 JL	122	void start, voidend, u16 segment,
832bd858	123	struct dmar_dev_scope *devices,
59ce0515 JL	124	int devices_cnt);
59ce0515 JL	125	extern int dmar_remove_dev_scope(struct dmar_pci_notify_info *info,
832bd858	126	u16 segment, struct dmar_dev_scope *devices,
59ce0515	127	int count);
2ae21010	128	/* Intel IOMMU detection */
480125ba	129	extern int detect_intel_iommu(void);
9d783ba0	130	extern int enable_drhd_fault_handling(void);
6b197249 JL	131	extern int dmar_device_add(acpi_handle handle);
6b197249 JL	132	extern int dmar_device_remove(acpi_handle handle);
8594d832	133
c2a0b538 JL	134	static inline int dmar_res_noop(struct acpi_dmar_header hdr, void arg)
	135	{
	136	return 0;
	137	}
	138
8594d832 JL	139	#ifdef CONFIG_INTEL_IOMMU
	140	extern int iommu_detected, no_iommu;
	141	extern int intel_iommu_init(void);
c2a0b538 JL	142	extern int dmar_parse_one_rmrr(struct acpi_dmar_header header, void arg);
c2a0b538 JL	143	extern int dmar_parse_one_atsr(struct acpi_dmar_header header, void arg);
6b197249 JL	144	extern int dmar_check_one_atsr(struct acpi_dmar_header hdr, void arg);
	145	extern int dmar_release_one_atsr(struct acpi_dmar_header hdr, void arg);
	146	extern int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
8594d832 JL	147	extern int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info);
	148	#else /* !CONFIG_INTEL_IOMMU: */
	149	static inline int intel_iommu_init(void) { return -ENODEV; }
6b197249	150
c2a0b538 JL	151	#define dmar_parse_one_rmrr dmar_res_noop
c2a0b538 JL	152	#define dmar_parse_one_atsr dmar_res_noop
6b197249 JL	153	#define dmar_check_one_atsr dmar_res_noop
	154	#define dmar_release_one_atsr dmar_res_noop
	155
8594d832	156	static inline int dmar_iommu_notify_scope_dev(struct dmar_pci_notify_info *info)
29b61be6	157	{
8594d832	158	return 0;
29b61be6	159	}
6b197249 JL	160
	161	static inline int dmar_iommu_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
	162	{
	163	return 0;
	164	}
8594d832 JL	165	#endif /* CONFIG_INTEL_IOMMU */
8594d832 JL	166
6b197249 JL	167	#ifdef CONFIG_IRQ_REMAP
	168	extern int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert);
	169	#else /* CONFIG_IRQ_REMAP */
	170	static inline int dmar_ir_hotplug(struct dmar_drhd_unit *dmaru, bool insert)
	171	{ return 0; }
	172	#endif /* CONFIG_IRQ_REMAP */
	173
3ccaabd3 LB	174	extern bool dmar_platform_optin(void);
3ccaabd3 LB	175
6b197249 JL	176	#else /* CONFIG_DMAR_TABLE */
	177
	178	static inline int dmar_device_add(void *handle)
	179	{
	180	return 0;
	181	}
	182
	183	static inline int dmar_device_remove(void *handle)
	184	{
	185	return 0;
	186	}
	187
3ccaabd3 LB	188	static inline bool dmar_platform_optin(void)
	189	{
	190	return false;
	191	}
	192
8594d832	193	#endif /* CONFIG_DMAR_TABLE */
2ae21010	194
2ae21010 SS	195	struct irte {
2ae21010 SS	196	union {
3bf17472	197	/* Shared between remapped and posted mode*/
2ae21010	198	struct {
3bf17472 TG	199	__u64 present : 1, /* 0 */
	200	fpd : 1, /* 1 */
	201	__res0 : 6, /* 2 - 6 */
	202	avail : 4, /* 8 - 11 */
	203	__res1 : 3, /* 12 - 14 */
	204	pst : 1, /* 15 */
	205	vector : 8, /* 16 - 23 */
	206	__res2 : 40; /* 24 - 63 */
	207	};
	208
	209	/* Remapped mode */
	210	struct {
	211	__u64 r_present : 1, /* 0 */
	212	r_fpd : 1, /* 1 */
	213	dst_mode : 1, /* 2 */
	214	redir_hint : 1, /* 3 */
	215	trigger_mode : 1, /* 4 */
	216	dlvry_mode : 3, /* 5 - 7 */
	217	r_avail : 4, /* 8 - 11 */
	218	r_res0 : 4, /* 12 - 15 */
	219	r_vector : 8, /* 16 - 23 */
	220	r_res1 : 8, /* 24 - 31 */
	221	dest_id : 32; /* 32 - 63 */
	222	};
	223
	224	/* Posted mode */
	225	struct {
	226	__u64 p_present : 1, /* 0 */
	227	p_fpd : 1, /* 1 */
	228	p_res0 : 6, /* 2 - 7 */
	229	p_avail : 4, /* 8 - 11 */
	230	p_res1 : 2, /* 12 - 13 */
	231	p_urgent : 1, /* 14 */
	232	p_pst : 1, /* 15 */
	233	p_vector : 8, /* 16 - 23 */
	234	p_res2 : 14, /* 24 - 37 */
	235	pda_l : 26; /* 38 - 63 */
2ae21010 SS	236	};
	237	__u64 low;
	238	};
	239
	240	union {
3bf17472	241	/* Shared between remapped and posted mode*/
2ae21010	242	struct {
3bf17472 TG	243	__u64 sid : 16, /* 64 - 79 */
	244	sq : 2, /* 80 - 81 */
	245	svt : 2, /* 82 - 83 */
	246	__res3 : 44; /* 84 - 127 */
	247	};
	248
	249	/* Posted mode*/
	250	struct {
	251	__u64 p_sid : 16, /* 64 - 79 */
	252	p_sq : 2, /* 80 - 81 */
	253	p_svt : 2, /* 82 - 83 */
	254	p_res3 : 12, /* 84 - 95 */
	255	pda_h : 32; /* 96 - 127 */
2ae21010 SS	256	};
	257	__u64 high;
	258	};
	259	};
423f0859	260
bf56027f TG	261	static inline void dmar_copy_shared_irte(struct irte dst, struct irte src)
	262	{
	263	dst->present = src->present;
	264	dst->fpd = src->fpd;
	265	dst->avail = src->avail;
	266	dst->pst = src->pst;
	267	dst->vector = src->vector;
	268	dst->sid = src->sid;
	269	dst->sq = src->sq;
	270	dst->svt = src->svt;
	271	}
	272
3bf17472 TG	273	#define PDA_LOW_BIT 26
	274	#define PDA_HIGH_BIT 32
	275
3460a6d9 KA	276	/* Can't use the common MSI interrupt functions
	277	* since DMAR is not a pci device
	278	*/
5c2837fb TG	279	struct irq_data;
	280	extern void dmar_msi_unmask(struct irq_data *data);
	281	extern void dmar_msi_mask(struct irq_data *data);
3460a6d9 KA	282	extern void dmar_msi_read(int irq, struct msi_msg *msg);
	283	extern void dmar_msi_write(int irq, struct msi_msg *msg);
	284	extern int dmar_set_interrupt(struct intel_iommu *iommu);
1531a6a6	285	extern irqreturn_t dmar_fault(int irq, void *dev_id);
34742db8 JL	286	extern int dmar_alloc_hwirq(int id, int node, void *arg);
34742db8 JL	287	extern void dmar_free_hwirq(int irq);
3460a6d9	288
10e5247f	289	#endif /* __DMAR_H__ */