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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2006, Intel Corporation.
 *
 * 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,		\
				dmar_rcu_check())

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

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

#define for_each_iommu(i, drhd)						\
	list_for_each_entry_rcu(drhd, &dmar_drhd_units, list,		\
				dmar_rcu_check())			\
		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(devs, cnt, i, tmp)				\
	for ((i) = 0; ((tmp) = (i) < (cnt) ?				\
	    dmar_rcu_dereference((devs)[(i)].dev) : NULL, (i) < (cnt)); \
	    (i)++)

#define for_each_active_dev_scope(devs, cnt, i, tmp)			\
	for_each_dev_scope((devs), (cnt), (i), (tmp))			\
		if (!(tmp)) { 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 void intel_iommu_shutdown(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; }
static inline void intel_iommu_shutdown(void) { }

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