[deliverable/linux.git] / include / linux / intel-iommu.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) 2006-2008 Intel Corporation
 * Author: Ashok Raj <ashok.raj@intel.com>
 * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
 */

#ifndef _INTEL_IOMMU_H_
#define _INTEL_IOMMU_H_

#include <linux/types.h>
#include <linux/iova.h>
#include <linux/io.h>
#include <linux/dma_remapping.h>
#include <asm/cacheflush.h>
#include <asm/iommu.h>

/*
 * Intel IOMMU register specification per version 1.0 public spec.
 */

#define	DMAR_VER_REG	0x0	/* Arch version supported by this IOMMU */
#define	DMAR_CAP_REG	0x8	/* Hardware supported capabilities */
#define	DMAR_ECAP_REG	0x10	/* Extended capabilities supported */
#define	DMAR_GCMD_REG	0x18	/* Global command register */
#define	DMAR_GSTS_REG	0x1c	/* Global status register */
#define	DMAR_RTADDR_REG	0x20	/* Root entry table */
#define	DMAR_CCMD_REG	0x28	/* Context command reg */
#define	DMAR_FSTS_REG	0x34	/* Fault Status register */
#define	DMAR_FECTL_REG	0x38	/* Fault control register */
#define	DMAR_FEDATA_REG	0x3c	/* Fault event interrupt data register */
#define	DMAR_FEADDR_REG	0x40	/* Fault event interrupt addr register */
#define	DMAR_FEUADDR_REG 0x44	/* Upper address register */
#define	DMAR_AFLOG_REG	0x58	/* Advanced Fault control */
#define	DMAR_PMEN_REG	0x64	/* Enable Protected Memory Region */
#define	DMAR_PLMBASE_REG 0x68	/* PMRR Low addr */
#define	DMAR_PLMLIMIT_REG 0x6c	/* PMRR low limit */
#define	DMAR_PHMBASE_REG 0x70	/* pmrr high base addr */
#define	DMAR_PHMLIMIT_REG 0x78	/* pmrr high limit */
#define DMAR_IQH_REG	0x80	/* Invalidation queue head register */
#define DMAR_IQT_REG	0x88	/* Invalidation queue tail register */
#define DMAR_IQ_SHIFT	4	/* Invalidation queue head/tail shift */
#define DMAR_IQA_REG	0x90	/* Invalidation queue addr register */
#define DMAR_ICS_REG	0x9c	/* Invalidation complete status register */
#define DMAR_IRTA_REG	0xb8    /* Interrupt remapping table addr register */

#define OFFSET_STRIDE		(9)
/*
#define dmar_readl(dmar, reg) readl(dmar + reg)
#define dmar_readq(dmar, reg) ({ \
		u32 lo, hi; \
		lo = readl(dmar + reg); \
		hi = readl(dmar + reg + 4); \
		(((u64) hi) << 32) + lo; })
*/
static inline u64 dmar_readq(void __iomem *addr)
{
	u32 lo, hi;
	lo = readl(addr);
	hi = readl(addr + 4);
	return (((u64) hi) << 32) + lo;
}

static inline void dmar_writeq(void __iomem *addr, u64 val)
{
	writel((u32)val, addr);
	writel((u32)(val >> 32), addr + 4);
}

#define DMAR_VER_MAJOR(v)		(((v) & 0xf0) >> 4)
#define DMAR_VER_MINOR(v)		((v) & 0x0f)

/*
 * Decoding Capability Register
 */
#define cap_pi_support(c)	(((c) >> 59) & 1)
#define cap_read_drain(c)	(((c) >> 55) & 1)
#define cap_write_drain(c)	(((c) >> 54) & 1)
#define cap_max_amask_val(c)	(((c) >> 48) & 0x3f)
#define cap_num_fault_regs(c)	((((c) >> 40) & 0xff) + 1)
#define cap_pgsel_inv(c)	(((c) >> 39) & 1)

#define cap_super_page_val(c)	(((c) >> 34) & 0xf)
#define cap_super_offset(c)	(((find_first_bit(&cap_super_page_val(c), 4)) \
					* OFFSET_STRIDE) + 21)

#define cap_fault_reg_offset(c)	((((c) >> 24) & 0x3ff) * 16)
#define cap_max_fault_reg_offset(c) \
	(cap_fault_reg_offset(c) + cap_num_fault_regs(c) * 16)

#define cap_zlr(c)		(((c) >> 22) & 1)
#define cap_isoch(c)		(((c) >> 23) & 1)
#define cap_mgaw(c)		((((c) >> 16) & 0x3f) + 1)
#define cap_sagaw(c)		(((c) >> 8) & 0x1f)
#define cap_caching_mode(c)	(((c) >> 7) & 1)
#define cap_phmr(c)		(((c) >> 6) & 1)
#define cap_plmr(c)		(((c) >> 5) & 1)
#define cap_rwbf(c)		(((c) >> 4) & 1)
#define cap_afl(c)		(((c) >> 3) & 1)
#define cap_ndoms(c)		(((unsigned long)1) << (4 + 2 * ((c) & 0x7)))
/*
 * Extended Capability Register
 */

#define ecap_pasid(e)		((e >> 40) & 0x1)
#define ecap_pss(e)		((e >> 35) & 0x1f)
#define ecap_eafs(e)		((e >> 34) & 0x1)
#define ecap_nwfs(e)		((e >> 33) & 0x1)
#define ecap_srs(e)		((e >> 31) & 0x1)
#define ecap_ers(e)		((e >> 30) & 0x1)
#define ecap_prs(e)		((e >> 29) & 0x1)
/* PASID support used to be on bit 28 */
#define ecap_dis(e)		((e >> 27) & 0x1)
#define ecap_nest(e)		((e >> 26) & 0x1)
#define ecap_mts(e)		((e >> 25) & 0x1)
#define ecap_ecs(e)		((e >> 24) & 0x1)
#define ecap_iotlb_offset(e) 	((((e) >> 8) & 0x3ff) * 16)
#define ecap_max_iotlb_offset(e) (ecap_iotlb_offset(e) + 16)
#define ecap_coherent(e)	((e) & 0x1)
#define ecap_qis(e)		((e) & 0x2)
#define ecap_pass_through(e)	((e >> 6) & 0x1)
#define ecap_eim_support(e)	((e >> 4) & 0x1)
#define ecap_ir_support(e)	((e >> 3) & 0x1)
#define ecap_dev_iotlb_support(e)	(((e) >> 2) & 0x1)
#define ecap_max_handle_mask(e) ((e >> 20) & 0xf)
#define ecap_sc_support(e)	((e >> 7) & 0x1) /* Snooping Control */

/* IOTLB_REG */
#define DMA_TLB_FLUSH_GRANU_OFFSET  60
#define DMA_TLB_GLOBAL_FLUSH (((u64)1) << 60)
#define DMA_TLB_DSI_FLUSH (((u64)2) << 60)
#define DMA_TLB_PSI_FLUSH (((u64)3) << 60)
#define DMA_TLB_IIRG(type) ((type >> 60) & 7)
#define DMA_TLB_IAIG(val) (((val) >> 57) & 7)
#define DMA_TLB_READ_DRAIN (((u64)1) << 49)
#define DMA_TLB_WRITE_DRAIN (((u64)1) << 48)
#define DMA_TLB_DID(id)	(((u64)((id) & 0xffff)) << 32)
#define DMA_TLB_IVT (((u64)1) << 63)
#define DMA_TLB_IH_NONLEAF (((u64)1) << 6)
#define DMA_TLB_MAX_SIZE (0x3f)

/* INVALID_DESC */
#define DMA_CCMD_INVL_GRANU_OFFSET  61
#define DMA_ID_TLB_GLOBAL_FLUSH	(((u64)1) << 3)
#define DMA_ID_TLB_DSI_FLUSH	(((u64)2) << 3)
#define DMA_ID_TLB_PSI_FLUSH	(((u64)3) << 3)
#define DMA_ID_TLB_READ_DRAIN	(((u64)1) << 7)
#define DMA_ID_TLB_WRITE_DRAIN	(((u64)1) << 6)
#define DMA_ID_TLB_DID(id)	(((u64)((id & 0xffff) << 16)))
#define DMA_ID_TLB_IH_NONLEAF	(((u64)1) << 6)
#define DMA_ID_TLB_ADDR(addr)	(addr)
#define DMA_ID_TLB_ADDR_MASK(mask)	(mask)

/* PMEN_REG */
#define DMA_PMEN_EPM (((u32)1)<<31)
#define DMA_PMEN_PRS (((u32)1)<<0)

/* GCMD_REG */
#define DMA_GCMD_TE (((u32)1) << 31)
#define DMA_GCMD_SRTP (((u32)1) << 30)
#define DMA_GCMD_SFL (((u32)1) << 29)
#define DMA_GCMD_EAFL (((u32)1) << 28)
#define DMA_GCMD_WBF (((u32)1) << 27)
#define DMA_GCMD_QIE (((u32)1) << 26)
#define DMA_GCMD_SIRTP (((u32)1) << 24)
#define DMA_GCMD_IRE (((u32) 1) << 25)
#define DMA_GCMD_CFI (((u32) 1) << 23)

/* GSTS_REG */
#define DMA_GSTS_TES (((u32)1) << 31)
#define DMA_GSTS_RTPS (((u32)1) << 30)
#define DMA_GSTS_FLS (((u32)1) << 29)
#define DMA_GSTS_AFLS (((u32)1) << 28)
#define DMA_GSTS_WBFS (((u32)1) << 27)
#define DMA_GSTS_QIES (((u32)1) << 26)
#define DMA_GSTS_IRTPS (((u32)1) << 24)
#define DMA_GSTS_IRES (((u32)1) << 25)
#define DMA_GSTS_CFIS (((u32)1) << 23)

/* DMA_RTADDR_REG */
#define DMA_RTADDR_RTT (((u64)1) << 11)

/* CCMD_REG */
#define DMA_CCMD_ICC (((u64)1) << 63)
#define DMA_CCMD_GLOBAL_INVL (((u64)1) << 61)
#define DMA_CCMD_DOMAIN_INVL (((u64)2) << 61)
#define DMA_CCMD_DEVICE_INVL (((u64)3) << 61)
#define DMA_CCMD_FM(m) (((u64)((m) & 0x3)) << 32)
#define DMA_CCMD_MASK_NOBIT 0
#define DMA_CCMD_MASK_1BIT 1
#define DMA_CCMD_MASK_2BIT 2
#define DMA_CCMD_MASK_3BIT 3
#define DMA_CCMD_SID(s) (((u64)((s) & 0xffff)) << 16)
#define DMA_CCMD_DID(d) ((u64)((d) & 0xffff))

/* FECTL_REG */
#define DMA_FECTL_IM (((u32)1) << 31)

/* FSTS_REG */
#define DMA_FSTS_PPF ((u32)2)
#define DMA_FSTS_PFO ((u32)1)
#define DMA_FSTS_IQE (1 << 4)
#define DMA_FSTS_ICE (1 << 5)
#define DMA_FSTS_ITE (1 << 6)
#define dma_fsts_fault_record_index(s) (((s) >> 8) & 0xff)

/* FRCD_REG, 32 bits access */
#define DMA_FRCD_F (((u32)1) << 31)
#define dma_frcd_type(d) ((d >> 30) & 1)
#define dma_frcd_fault_reason(c) (c & 0xff)
#define dma_frcd_source_id(c) (c & 0xffff)
/* low 64 bit */
#define dma_frcd_page_addr(d) (d & (((u64)-1) << PAGE_SHIFT))

#define IOMMU_WAIT_OP(iommu, offset, op, cond, sts)			\
do {									\
	cycles_t start_time = get_cycles();				\
	while (1) {							\
		sts = op(iommu->reg + offset);				\
		if (cond)						\
			break;						\
		if (DMAR_OPERATION_TIMEOUT < (get_cycles() - start_time))\
			panic("DMAR hardware is malfunctioning\n");	\
		cpu_relax();						\
	}								\
} while (0)

#define QI_LENGTH	256	/* queue length */

enum {
	QI_FREE,
	QI_IN_USE,
	QI_DONE,
	QI_ABORT
};

#define QI_CC_TYPE		0x1
#define QI_IOTLB_TYPE		0x2
#define QI_DIOTLB_TYPE		0x3
#define QI_IEC_TYPE		0x4
#define QI_IWD_TYPE		0x5

#define QI_IEC_SELECTIVE	(((u64)1) << 4)
#define QI_IEC_IIDEX(idx)	(((u64)(idx & 0xffff) << 32))
#define QI_IEC_IM(m)		(((u64)(m & 0x1f) << 27))

#define QI_IWD_STATUS_DATA(d)	(((u64)d) << 32)
#define QI_IWD_STATUS_WRITE	(((u64)1) << 5)

#define QI_IOTLB_DID(did) 	(((u64)did) << 16)
#define QI_IOTLB_DR(dr) 	(((u64)dr) << 7)
#define QI_IOTLB_DW(dw) 	(((u64)dw) << 6)
#define QI_IOTLB_GRAN(gran) 	(((u64)gran) >> (DMA_TLB_FLUSH_GRANU_OFFSET-4))
#define QI_IOTLB_ADDR(addr)	(((u64)addr) & VTD_PAGE_MASK)
#define QI_IOTLB_IH(ih)		(((u64)ih) << 6)
#define QI_IOTLB_AM(am)		(((u8)am))

#define QI_CC_FM(fm)		(((u64)fm) << 48)
#define QI_CC_SID(sid)		(((u64)sid) << 32)
#define QI_CC_DID(did)		(((u64)did) << 16)
#define QI_CC_GRAN(gran)	(((u64)gran) >> (DMA_CCMD_INVL_GRANU_OFFSET-4))

#define QI_DEV_IOTLB_SID(sid)	((u64)((sid) & 0xffff) << 32)
#define QI_DEV_IOTLB_QDEP(qdep)	(((qdep) & 0x1f) << 16)
#define QI_DEV_IOTLB_ADDR(addr)	((u64)(addr) & VTD_PAGE_MASK)
#define QI_DEV_IOTLB_SIZE	1
#define QI_DEV_IOTLB_MAX_INVS	32

struct qi_desc {
	u64 low, high;
};

struct q_inval {
	raw_spinlock_t  q_lock;
	struct qi_desc  *desc;          /* invalidation queue */
	int             *desc_status;   /* desc status */
	int             free_head;      /* first free entry */
	int             free_tail;      /* last free entry */
	int             free_cnt;
};

#ifdef CONFIG_IRQ_REMAP
/* 1MB - maximum possible interrupt remapping table size */
#define INTR_REMAP_PAGE_ORDER	8
#define INTR_REMAP_TABLE_REG_SIZE	0xf
#define INTR_REMAP_TABLE_REG_SIZE_MASK  0xf

#define INTR_REMAP_TABLE_ENTRIES	65536

struct irq_domain;

struct ir_table {
	struct irte *base;
	unsigned long *bitmap;
};
#endif

struct iommu_flush {
	void (*flush_context)(struct intel_iommu *iommu, u16 did, u16 sid,
			      u8 fm, u64 type);
	void (*flush_iotlb)(struct intel_iommu *iommu, u16 did, u64 addr,
			    unsigned int size_order, u64 type);
};

enum {
	SR_DMAR_FECTL_REG,
	SR_DMAR_FEDATA_REG,
	SR_DMAR_FEADDR_REG,
	SR_DMAR_FEUADDR_REG,
	MAX_SR_DMAR_REGS
};

#define VTD_FLAG_TRANS_PRE_ENABLED	(1 << 0)
#define VTD_FLAG_IRQ_REMAP_PRE_ENABLED	(1 << 1)

struct intel_iommu {
	void __iomem	*reg; /* Pointer to hardware regs, virtual addr */
	u64 		reg_phys; /* physical address of hw register set */
	u64		reg_size; /* size of hw register set */
	u64		cap;
	u64		ecap;
	u32		gcmd; /* Holds TE, EAFL. Don't need SRTP, SFL, WBF */
	raw_spinlock_t	register_lock; /* protect register handling */
	int		seq_id;	/* sequence id of the iommu */
	int		agaw; /* agaw of this iommu */
	int		msagaw; /* max sagaw of this iommu */
	unsigned int 	irq;
	u16		segment;     /* PCI segment# */
	unsigned char 	name[13];    /* Device Name */

#ifdef CONFIG_INTEL_IOMMU
	unsigned long 	*domain_ids; /* bitmap of domains */
	struct dmar_domain ***domains; /* ptr to domains */
	spinlock_t	lock; /* protect context, domain ids */
	struct root_entry *root_entry; /* virtual address */

	struct iommu_flush flush;
#endif
	struct q_inval  *qi;            /* Queued invalidation info */
	u32 *iommu_state; /* Store iommu states between suspend and resume.*/

#ifdef CONFIG_IRQ_REMAP
	struct ir_table *ir_table;	/* Interrupt remapping info */
	struct irq_domain *ir_domain;
	struct irq_domain *ir_msi_domain;
#endif
	struct device	*iommu_dev; /* IOMMU-sysfs device */
	int		node;
	u32		flags;      /* Software defined flags */
};

static inline void __iommu_flush_cache(
	struct intel_iommu *iommu, void *addr, int size)
{
	if (!ecap_coherent(iommu->ecap))
		clflush_cache_range(addr, size);
}

extern struct dmar_drhd_unit * dmar_find_matched_drhd_unit(struct pci_dev *dev);
extern int dmar_find_matched_atsr_unit(struct pci_dev *dev);

extern int dmar_enable_qi(struct intel_iommu *iommu);
extern void dmar_disable_qi(struct intel_iommu *iommu);
extern int dmar_reenable_qi(struct intel_iommu *iommu);
extern void qi_global_iec(struct intel_iommu *iommu);

extern void qi_flush_context(struct intel_iommu *iommu, u16 did, u16 sid,
			     u8 fm, u64 type);
extern void qi_flush_iotlb(struct intel_iommu *iommu, u16 did, u64 addr,
			  unsigned int size_order, u64 type);
extern void qi_flush_dev_iotlb(struct intel_iommu *iommu, u16 sid, u16 qdep,
			       u64 addr, unsigned mask);

extern int qi_submit_sync(struct qi_desc *desc, struct intel_iommu *iommu);

extern int dmar_ir_support(void);

extern const struct attribute_group *intel_iommu_groups[];

#endif
Commit	Line	Data
ba395927 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	*
98bcef56	17	* Copyright (C) 2006-2008 Intel Corporation
	18	* Author: Ashok Raj <ashok.raj@intel.com>
	19	* Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
ba395927 KA	20	*/
	21
	22	#ifndef _INTEL_IOMMU_H_
	23	#define _INTEL_IOMMU_H_
	24
	25	#include <linux/types.h>
38717946	26	#include <linux/iova.h>
ba395927	27	#include <linux/io.h>
38717946	28	#include <linux/dma_remapping.h>
fe962e90	29	#include <asm/cacheflush.h>
5b6985ce	30	#include <asm/iommu.h>
f661197e	31
ba395927 KA	32	/*
	33	* Intel IOMMU register specification per version 1.0 public spec.
	34	*/
	35
	36	#define DMAR_VER_REG 0x0 /* Arch version supported by this IOMMU */
	37	#define DMAR_CAP_REG 0x8 /* Hardware supported capabilities */
	38	#define DMAR_ECAP_REG 0x10 /* Extended capabilities supported */
	39	#define DMAR_GCMD_REG 0x18 /* Global command register */
	40	#define DMAR_GSTS_REG 0x1c /* Global status register */
	41	#define DMAR_RTADDR_REG 0x20 /* Root entry table */
	42	#define DMAR_CCMD_REG 0x28 /* Context command reg */
	43	#define DMAR_FSTS_REG 0x34 /* Fault Status register */
	44	#define DMAR_FECTL_REG 0x38 /* Fault control register */
	45	#define DMAR_FEDATA_REG 0x3c /* Fault event interrupt data register */
	46	#define DMAR_FEADDR_REG 0x40 /* Fault event interrupt addr register */
	47	#define DMAR_FEUADDR_REG 0x44 /* Upper address register */
	48	#define DMAR_AFLOG_REG 0x58 /* Advanced Fault control */
	49	#define DMAR_PMEN_REG 0x64 /* Enable Protected Memory Region */
	50	#define DMAR_PLMBASE_REG 0x68 /* PMRR Low addr */
	51	#define DMAR_PLMLIMIT_REG 0x6c /* PMRR low limit */
	52	#define DMAR_PHMBASE_REG 0x70 /* pmrr high base addr */
	53	#define DMAR_PHMLIMIT_REG 0x78 /* pmrr high limit */
fe962e90 SS	54	#define DMAR_IQH_REG 0x80 /* Invalidation queue head register */
fe962e90 SS	55	#define DMAR_IQT_REG 0x88 /* Invalidation queue tail register */
6ba6c3a4	56	#define DMAR_IQ_SHIFT 4 /* Invalidation queue head/tail shift */
fe962e90	57	#define DMAR_IQA_REG 0x90 /* Invalidation queue addr register */
82aeef0b	58	#define DMAR_ICS_REG 0x9c /* Invalidation complete status register */
2ae21010	59	#define DMAR_IRTA_REG 0xb8 /* Interrupt remapping table addr register */
ba395927 KA	60
	61	#define OFFSET_STRIDE (9)
	62	/*
	63	#define dmar_readl(dmar, reg) readl(dmar + reg)
	64	#define dmar_readq(dmar, reg) ({ \
	65	u32 lo, hi; \
	66	lo = readl(dmar + reg); \
	67	hi = readl(dmar + reg + 4); \
	68	(((u64) hi) << 32) + lo; })
	69	*/
4fe05bbc	70	static inline u64 dmar_readq(void __iomem *addr)
ba395927 KA	71	{
	72	u32 lo, hi;
	73	lo = readl(addr);
	74	hi = readl(addr + 4);
	75	return (((u64) hi) << 32) + lo;
	76	}
	77
	78	static inline void dmar_writeq(void __iomem *addr, u64 val)
	79	{
	80	writel((u32)val, addr);
	81	writel((u32)(val >> 32), addr + 4);
	82	}
	83
	84	#define DMAR_VER_MAJOR(v) (((v) & 0xf0) >> 4)
	85	#define DMAR_VER_MINOR(v) ((v) & 0x0f)
	86
	87	/*
	88	* Decoding Capability Register
	89	*/
07c09787	90	#define cap_pi_support(c) (((c) >> 59) & 1)
ba395927 KA	91	#define cap_read_drain(c) (((c) >> 55) & 1)
	92	#define cap_write_drain(c) (((c) >> 54) & 1)
	93	#define cap_max_amask_val(c) (((c) >> 48) & 0x3f)
	94	#define cap_num_fault_regs(c) ((((c) >> 40) & 0xff) + 1)
	95	#define cap_pgsel_inv(c) (((c) >> 39) & 1)
	96
	97	#define cap_super_page_val(c) (((c) >> 34) & 0xf)
	98	#define cap_super_offset(c) (((find_first_bit(&cap_super_page_val(c), 4)) \
	99	* OFFSET_STRIDE) + 21)
	100
	101	#define cap_fault_reg_offset(c) ((((c) >> 24) & 0x3ff) * 16)
	102	#define cap_max_fault_reg_offset(c) \
	103	(cap_fault_reg_offset(c) + cap_num_fault_regs(c) * 16)
	104
	105	#define cap_zlr(c) (((c) >> 22) & 1)
	106	#define cap_isoch(c) (((c) >> 23) & 1)
	107	#define cap_mgaw(c) ((((c) >> 16) & 0x3f) + 1)
	108	#define cap_sagaw(c) (((c) >> 8) & 0x1f)
	109	#define cap_caching_mode(c) (((c) >> 7) & 1)
	110	#define cap_phmr(c) (((c) >> 6) & 1)
	111	#define cap_plmr(c) (((c) >> 5) & 1)
	112	#define cap_rwbf(c) (((c) >> 4) & 1)
	113	#define cap_afl(c) (((c) >> 3) & 1)
	114	#define cap_ndoms(c) (((unsigned long)1) << (4 + 2 * ((c) & 0x7)))
	115	/*
	116	* Extended Capability Register
	117	*/
	118
bd00c606	119	#define ecap_pasid(e) ((e >> 40) & 0x1)
4423f5e7 DW	120	#define ecap_pss(e) ((e >> 35) & 0x1f)
	121	#define ecap_eafs(e) ((e >> 34) & 0x1)
	122	#define ecap_nwfs(e) ((e >> 33) & 0x1)
	123	#define ecap_srs(e) ((e >> 31) & 0x1)
	124	#define ecap_ers(e) ((e >> 30) & 0x1)
	125	#define ecap_prs(e) ((e >> 29) & 0x1)
bd00c606	126	/* PASID support used to be on bit 28 */
4423f5e7 DW	127	#define ecap_dis(e) ((e >> 27) & 0x1)
	128	#define ecap_nest(e) ((e >> 26) & 0x1)
	129	#define ecap_mts(e) ((e >> 25) & 0x1)
	130	#define ecap_ecs(e) ((e >> 24) & 0x1)
ba395927	131	#define ecap_iotlb_offset(e) ((((e) >> 8) & 0x3ff) * 16)
44caf2f3	132	#define ecap_max_iotlb_offset(e) (ecap_iotlb_offset(e) + 16)
ba395927	133	#define ecap_coherent(e) ((e) & 0x1)
fe962e90	134	#define ecap_qis(e) ((e) & 0x2)
4ed0d3e6	135	#define ecap_pass_through(e) ((e >> 6) & 0x1)
ad3ad3f6 SS	136	#define ecap_eim_support(e) ((e >> 4) & 0x1)
ad3ad3f6 SS	137	#define ecap_ir_support(e) ((e >> 3) & 0x1)
93a23a72	138	#define ecap_dev_iotlb_support(e) (((e) >> 2) & 0x1)
b6fcb33a	139	#define ecap_max_handle_mask(e) ((e >> 20) & 0xf)
58c610bd	140	#define ecap_sc_support(e) ((e >> 7) & 0x1) /* Snooping Control */
ba395927 KA	141
ba395927 KA	142	/* IOTLB_REG */
3481f210	143	#define DMA_TLB_FLUSH_GRANU_OFFSET 60
ba395927 KA	144	#define DMA_TLB_GLOBAL_FLUSH (((u64)1) << 60)
	145	#define DMA_TLB_DSI_FLUSH (((u64)2) << 60)
	146	#define DMA_TLB_PSI_FLUSH (((u64)3) << 60)
	147	#define DMA_TLB_IIRG(type) ((type >> 60) & 7)
	148	#define DMA_TLB_IAIG(val) (((val) >> 57) & 7)
	149	#define DMA_TLB_READ_DRAIN (((u64)1) << 49)
	150	#define DMA_TLB_WRITE_DRAIN (((u64)1) << 48)
	151	#define DMA_TLB_DID(id) (((u64)((id) & 0xffff)) << 32)
	152	#define DMA_TLB_IVT (((u64)1) << 63)
	153	#define DMA_TLB_IH_NONLEAF (((u64)1) << 6)
	154	#define DMA_TLB_MAX_SIZE (0x3f)
	155
fe962e90	156	/* INVALID_DESC */
3481f210	157	#define DMA_CCMD_INVL_GRANU_OFFSET 61
fe962e90 SS	158	#define DMA_ID_TLB_GLOBAL_FLUSH (((u64)1) << 3)
	159	#define DMA_ID_TLB_DSI_FLUSH (((u64)2) << 3)
	160	#define DMA_ID_TLB_PSI_FLUSH (((u64)3) << 3)
	161	#define DMA_ID_TLB_READ_DRAIN (((u64)1) << 7)
	162	#define DMA_ID_TLB_WRITE_DRAIN (((u64)1) << 6)
	163	#define DMA_ID_TLB_DID(id) (((u64)((id & 0xffff) << 16)))
	164	#define DMA_ID_TLB_IH_NONLEAF (((u64)1) << 6)
	165	#define DMA_ID_TLB_ADDR(addr) (addr)
	166	#define DMA_ID_TLB_ADDR_MASK(mask) (mask)
	167
f8bab735	168	/* PMEN_REG */
	169	#define DMA_PMEN_EPM (((u32)1)<<31)
	170	#define DMA_PMEN_PRS (((u32)1)<<0)
	171
ba395927 KA	172	/* GCMD_REG */
	173	#define DMA_GCMD_TE (((u32)1) << 31)
	174	#define DMA_GCMD_SRTP (((u32)1) << 30)
	175	#define DMA_GCMD_SFL (((u32)1) << 29)
	176	#define DMA_GCMD_EAFL (((u32)1) << 28)
	177	#define DMA_GCMD_WBF (((u32)1) << 27)
2ae21010 SS	178	#define DMA_GCMD_QIE (((u32)1) << 26)
	179	#define DMA_GCMD_SIRTP (((u32)1) << 24)
	180	#define DMA_GCMD_IRE (((u32) 1) << 25)
161fde08	181	#define DMA_GCMD_CFI (((u32) 1) << 23)
ba395927 KA	182
	183	/* GSTS_REG */
	184	#define DMA_GSTS_TES (((u32)1) << 31)
	185	#define DMA_GSTS_RTPS (((u32)1) << 30)
	186	#define DMA_GSTS_FLS (((u32)1) << 29)
	187	#define DMA_GSTS_AFLS (((u32)1) << 28)
	188	#define DMA_GSTS_WBFS (((u32)1) << 27)
2ae21010 SS	189	#define DMA_GSTS_QIES (((u32)1) << 26)
	190	#define DMA_GSTS_IRTPS (((u32)1) << 24)
	191	#define DMA_GSTS_IRES (((u32)1) << 25)
161fde08	192	#define DMA_GSTS_CFIS (((u32)1) << 23)
ba395927	193
4423f5e7 DW	194	/* DMA_RTADDR_REG */
	195	#define DMA_RTADDR_RTT (((u64)1) << 11)
	196
ba395927 KA	197	/* CCMD_REG */
	198	#define DMA_CCMD_ICC (((u64)1) << 63)
	199	#define DMA_CCMD_GLOBAL_INVL (((u64)1) << 61)
	200	#define DMA_CCMD_DOMAIN_INVL (((u64)2) << 61)
	201	#define DMA_CCMD_DEVICE_INVL (((u64)3) << 61)
	202	#define DMA_CCMD_FM(m) (((u64)((m) & 0x3)) << 32)
	203	#define DMA_CCMD_MASK_NOBIT 0
	204	#define DMA_CCMD_MASK_1BIT 1
	205	#define DMA_CCMD_MASK_2BIT 2
	206	#define DMA_CCMD_MASK_3BIT 3
	207	#define DMA_CCMD_SID(s) (((u64)((s) & 0xffff)) << 16)
	208	#define DMA_CCMD_DID(d) ((u64)((d) & 0xffff))
	209
	210	/* FECTL_REG */
	211	#define DMA_FECTL_IM (((u32)1) << 31)
	212
	213	/* FSTS_REG */
	214	#define DMA_FSTS_PPF ((u32)2)
	215	#define DMA_FSTS_PFO ((u32)1)
704126ad	216	#define DMA_FSTS_IQE (1 << 4)
6ba6c3a4 YZ	217	#define DMA_FSTS_ICE (1 << 5)
6ba6c3a4 YZ	218	#define DMA_FSTS_ITE (1 << 6)
ba395927 KA	219	#define dma_fsts_fault_record_index(s) (((s) >> 8) & 0xff)
	220
	221	/* FRCD_REG, 32 bits access */
	222	#define DMA_FRCD_F (((u32)1) << 31)
	223	#define dma_frcd_type(d) ((d >> 30) & 1)
	224	#define dma_frcd_fault_reason(c) (c & 0xff)
	225	#define dma_frcd_source_id(c) (c & 0xffff)
5b6985ce FY	226	/* low 64 bit */
	227	#define dma_frcd_page_addr(d) (d & (((u64)-1) << PAGE_SHIFT))
	228
	229	#define IOMMU_WAIT_OP(iommu, offset, op, cond, sts) \
	230	do { \
	231	cycles_t start_time = get_cycles(); \
	232	while (1) { \
	233	sts = op(iommu->reg + offset); \
	234	if (cond) \
	235	break; \
cf1337f0	236	if (DMAR_OPERATION_TIMEOUT < (get_cycles() - start_time))\
5b6985ce FY	237	panic("DMAR hardware is malfunctioning\n"); \
	238	cpu_relax(); \
	239	} \
	240	} while (0)
cf1337f0	241
fe962e90 SS	242	#define QI_LENGTH 256 /* queue length */
	243
	244	enum {
	245	QI_FREE,
	246	QI_IN_USE,
6ba6c3a4 YZ	247	QI_DONE,
6ba6c3a4 YZ	248	QI_ABORT
fe962e90 SS	249	};
	250
	251	#define QI_CC_TYPE 0x1
	252	#define QI_IOTLB_TYPE 0x2
	253	#define QI_DIOTLB_TYPE 0x3
	254	#define QI_IEC_TYPE 0x4
	255	#define QI_IWD_TYPE 0x5
	256
	257	#define QI_IEC_SELECTIVE (((u64)1) << 4)
	258	#define QI_IEC_IIDEX(idx) (((u64)(idx & 0xffff) << 32))
	259	#define QI_IEC_IM(m) (((u64)(m & 0x1f) << 27))
	260
	261	#define QI_IWD_STATUS_DATA(d) (((u64)d) << 32)
	262	#define QI_IWD_STATUS_WRITE (((u64)1) << 5)
	263
3481f210 YS	264	#define QI_IOTLB_DID(did) (((u64)did) << 16)
	265	#define QI_IOTLB_DR(dr) (((u64)dr) << 7)
	266	#define QI_IOTLB_DW(dw) (((u64)dw) << 6)
	267	#define QI_IOTLB_GRAN(gran) (((u64)gran) >> (DMA_TLB_FLUSH_GRANU_OFFSET-4))
5b6985ce	268	#define QI_IOTLB_ADDR(addr) (((u64)addr) & VTD_PAGE_MASK)
3481f210 YS	269	#define QI_IOTLB_IH(ih) (((u64)ih) << 6)
	270	#define QI_IOTLB_AM(am) (((u8)am))
	271
	272	#define QI_CC_FM(fm) (((u64)fm) << 48)
	273	#define QI_CC_SID(sid) (((u64)sid) << 32)
	274	#define QI_CC_DID(did) (((u64)did) << 16)
	275	#define QI_CC_GRAN(gran) (((u64)gran) >> (DMA_CCMD_INVL_GRANU_OFFSET-4))
	276
6ba6c3a4 YZ	277	#define QI_DEV_IOTLB_SID(sid) ((u64)((sid) & 0xffff) << 32)
	278	#define QI_DEV_IOTLB_QDEP(qdep) (((qdep) & 0x1f) << 16)
	279	#define QI_DEV_IOTLB_ADDR(addr) ((u64)(addr) & VTD_PAGE_MASK)
	280	#define QI_DEV_IOTLB_SIZE 1
	281	#define QI_DEV_IOTLB_MAX_INVS 32
	282
fe962e90 SS	283	struct qi_desc {
	284	u64 low, high;
	285	};
	286
	287	struct q_inval {
3b8f4048	288	raw_spinlock_t q_lock;
fe962e90 SS	289	struct qi_desc desc; / invalidation queue */
	290	int desc_status; / desc status */
	291	int free_head; /* first free entry */
	292	int free_tail; /* last free entry */
	293	int free_cnt;
	294	};
	295
d3f13810	296	#ifdef CONFIG_IRQ_REMAP
2ae21010 SS	297	/* 1MB - maximum possible interrupt remapping table size */
	298	#define INTR_REMAP_PAGE_ORDER 8
	299	#define INTR_REMAP_TABLE_REG_SIZE 0xf
af3b358e	300	#define INTR_REMAP_TABLE_REG_SIZE_MASK 0xf
2ae21010	301
b6fcb33a SS	302	#define INTR_REMAP_TABLE_ENTRIES 65536
b6fcb33a SS	303
b106ee63 JL	304	struct irq_domain;
b106ee63 JL	305
2ae21010 SS	306	struct ir_table {
2ae21010 SS	307	struct irte *base;
360eb3c5	308	unsigned long *bitmap;
2ae21010 SS	309	};
	310	#endif
	311
a77b67d4	312	struct iommu_flush {
4c25a2c1 DW	313	void (flush_context)(struct intel_iommu iommu, u16 did, u16 sid,
4c25a2c1 DW	314	u8 fm, u64 type);
1f0ef2aa DW	315	void (flush_iotlb)(struct intel_iommu iommu, u16 did, u64 addr,
1f0ef2aa DW	316	unsigned int size_order, u64 type);
a77b67d4 YS	317	};
a77b67d4 YS	318
f59c7b69 FY	319	enum {
	320	SR_DMAR_FECTL_REG,
	321	SR_DMAR_FEDATA_REG,
	322	SR_DMAR_FEADDR_REG,
	323	SR_DMAR_FEUADDR_REG,
	324	MAX_SR_DMAR_REGS
	325	};
	326
4158c2ec JR	327	#define VTD_FLAG_TRANS_PRE_ENABLED (1 << 0)
	328	#define VTD_FLAG_IRQ_REMAP_PRE_ENABLED (1 << 1)
	329
ba395927 KA	330	struct intel_iommu {
ba395927 KA	331	void __iomem reg; / Pointer to hardware regs, virtual addr */
6f5cf521 DD	332	u64 reg_phys; /* physical address of hw register set */
6f5cf521 DD	333	u64 reg_size; /* size of hw register set */
ba395927 KA	334	u64 cap;
ba395927 KA	335	u64 ecap;
ba395927	336	u32 gcmd; /* Holds TE, EAFL. Don't need SRTP, SFL, WBF */
1f5b3c3f	337	raw_spinlock_t register_lock; /* protect register handling */
c42d9f32	338	int seq_id; /* sequence id of the iommu */
1b573683	339	int agaw; /* agaw of this iommu */
4ed0d3e6	340	int msagaw; /* max sagaw of this iommu */
9d783ba0	341	unsigned int irq;
67ccac41	342	u16 segment; /* PCI segment# */
9d783ba0	343	unsigned char name[13]; /* Device Name */
e61d98d8	344
d3f13810	345	#ifdef CONFIG_INTEL_IOMMU
e61d98d8	346	unsigned long domain_ids; / bitmap of domains */
8bf47816	347	struct dmar_domain **domains; / ptr to domains */
e61d98d8	348	spinlock_t lock; /* protect context, domain ids */
ba395927 KA	349	struct root_entry root_entry; / virtual address */
ba395927 KA	350
a77b67d4	351	struct iommu_flush flush;
e61d98d8	352	#endif
fe962e90	353	struct q_inval qi; / Queued invalidation info */
f59c7b69 FY	354	u32 iommu_state; / Store iommu states between suspend and resume.*/
f59c7b69 FY	355
d3f13810	356	#ifdef CONFIG_IRQ_REMAP
2ae21010	357	struct ir_table ir_table; / Interrupt remapping info */
b106ee63 JL	358	struct irq_domain *ir_domain;
b106ee63 JL	359	struct irq_domain *ir_msi_domain;
2ae21010	360	#endif
a5459cfe	361	struct device iommu_dev; / IOMMU-sysfs device */
ee34b32d	362	int node;
4158c2ec	363	u32 flags; /* Software defined flags */
ba395927 KA	364	};
ba395927 KA	365
fe962e90 SS	366	static inline void __iommu_flush_cache(
	367	struct intel_iommu iommu, void addr, int size)
	368	{
	369	if (!ecap_coherent(iommu->ecap))
	370	clflush_cache_range(addr, size);
	371	}
	372
e61d98d8	373	extern struct dmar_drhd_unit * dmar_find_matched_drhd_unit(struct pci_dev *dev);
aa5d2b51	374	extern int dmar_find_matched_atsr_unit(struct pci_dev *dev);
e61d98d8	375
2ae21010	376	extern int dmar_enable_qi(struct intel_iommu *iommu);
eba67e5d	377	extern void dmar_disable_qi(struct intel_iommu *iommu);
f59c7b69	378	extern int dmar_reenable_qi(struct intel_iommu *iommu);
2ae21010	379	extern void qi_global_iec(struct intel_iommu *iommu);
e820482c	380
4c25a2c1 DW	381	extern void qi_flush_context(struct intel_iommu *iommu, u16 did, u16 sid,
4c25a2c1 DW	382	u8 fm, u64 type);
1f0ef2aa DW	383	extern void qi_flush_iotlb(struct intel_iommu *iommu, u16 did, u64 addr,
1f0ef2aa DW	384	unsigned int size_order, u64 type);
6ba6c3a4 YZ	385	extern void qi_flush_dev_iotlb(struct intel_iommu *iommu, u16 sid, u16 qdep,
6ba6c3a4 YZ	386	u64 addr, unsigned mask);
3481f210	387
704126ad	388	extern int qi_submit_sync(struct qi_desc desc, struct intel_iommu iommu);
38717946	389
074835f0 YS	390	extern int dmar_ir_support(void);
074835f0 YS	391
a5459cfe AW	392	extern const struct attribute_group *intel_iommu_groups[];
a5459cfe AW	393
ba395927	394	#endif