xref: /linux/drivers/dma/ioat/registers.h (revision c6d3aaa4e35c71a32a86ececacd4eea7ecfc316c)
1 /*
2  * Copyright(c) 2004 - 2009 Intel Corporation. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License as published by the Free
6  * Software Foundation; either version 2 of the License, or (at your option)
7  * any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc., 59
16  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  *
18  * The full GNU General Public License is included in this distribution in the
19  * file called COPYING.
20  */
21 #ifndef _IOAT_REGISTERS_H_
22 #define _IOAT_REGISTERS_H_
23 
24 #define IOAT_PCI_DMACTRL_OFFSET			0x48
25 #define IOAT_PCI_DMACTRL_DMA_EN			0x00000001
26 #define IOAT_PCI_DMACTRL_MSI_EN			0x00000002
27 
28 #define IOAT_PCI_DEVICE_ID_OFFSET		0x02
29 #define IOAT_PCI_DMAUNCERRSTS_OFFSET		0x148
30 #define IOAT_PCI_CHANERRMASK_INT_OFFSET		0x184
31 
32 /* MMIO Device Registers */
33 #define IOAT_CHANCNT_OFFSET			0x00	/*  8-bit */
34 
35 #define IOAT_XFERCAP_OFFSET			0x01	/*  8-bit */
36 #define IOAT_XFERCAP_4KB			12
37 #define IOAT_XFERCAP_8KB			13
38 #define IOAT_XFERCAP_16KB			14
39 #define IOAT_XFERCAP_32KB			15
40 #define IOAT_XFERCAP_32GB			0
41 
42 #define IOAT_GENCTRL_OFFSET			0x02	/*  8-bit */
43 #define IOAT_GENCTRL_DEBUG_EN			0x01
44 
45 #define IOAT_INTRCTRL_OFFSET			0x03	/*  8-bit */
46 #define IOAT_INTRCTRL_MASTER_INT_EN		0x01	/* Master Interrupt Enable */
47 #define IOAT_INTRCTRL_INT_STATUS		0x02	/* ATTNSTATUS -or- Channel Int */
48 #define IOAT_INTRCTRL_INT			0x04	/* INT_STATUS -and- MASTER_INT_EN */
49 #define IOAT_INTRCTRL_MSIX_VECTOR_CONTROL	0x08	/* Enable all MSI-X vectors */
50 
51 #define IOAT_ATTNSTATUS_OFFSET			0x04	/* Each bit is a channel */
52 
53 #define IOAT_VER_OFFSET				0x08	/*  8-bit */
54 #define IOAT_VER_MAJOR_MASK			0xF0
55 #define IOAT_VER_MINOR_MASK			0x0F
56 #define GET_IOAT_VER_MAJOR(x)			(((x) & IOAT_VER_MAJOR_MASK) >> 4)
57 #define GET_IOAT_VER_MINOR(x)			((x) & IOAT_VER_MINOR_MASK)
58 
59 #define IOAT_PERPORTOFFSET_OFFSET		0x0A	/* 16-bit */
60 
61 #define IOAT_INTRDELAY_OFFSET			0x0C	/* 16-bit */
62 #define IOAT_INTRDELAY_INT_DELAY_MASK		0x3FFF	/* Interrupt Delay Time */
63 #define IOAT_INTRDELAY_COALESE_SUPPORT		0x8000	/* Interrupt Coalescing Supported */
64 
65 #define IOAT_DEVICE_STATUS_OFFSET		0x0E	/* 16-bit */
66 #define IOAT_DEVICE_STATUS_DEGRADED_MODE	0x0001
67 #define IOAT_DEVICE_MMIO_RESTRICTED		0x0002
68 #define IOAT_DEVICE_MEMORY_BYPASS		0x0004
69 #define IOAT_DEVICE_ADDRESS_REMAPPING		0x0008
70 
71 #define IOAT_DMA_CAP_OFFSET			0x10	/* 32-bit */
72 #define IOAT_CAP_PAGE_BREAK			0x00000001
73 #define IOAT_CAP_CRC				0x00000002
74 #define IOAT_CAP_SKIP_MARKER			0x00000004
75 #define IOAT_CAP_DCA				0x00000010
76 #define IOAT_CAP_CRC_MOVE			0x00000020
77 #define IOAT_CAP_FILL_BLOCK			0x00000040
78 #define IOAT_CAP_APIC				0x00000080
79 #define IOAT_CAP_XOR				0x00000100
80 #define IOAT_CAP_PQ				0x00000200
81 
82 #define IOAT_CHANNEL_MMIO_SIZE			0x80	/* Each Channel MMIO space is this size */
83 
84 /* DMA Channel Registers */
85 #define IOAT_CHANCTRL_OFFSET			0x00	/* 16-bit Channel Control Register */
86 #define IOAT_CHANCTRL_CHANNEL_PRIORITY_MASK	0xF000
87 #define IOAT3_CHANCTRL_COMPL_DCA_EN		0x0200
88 #define IOAT_CHANCTRL_CHANNEL_IN_USE		0x0100
89 #define IOAT_CHANCTRL_DESCRIPTOR_ADDR_SNOOP_CONTROL	0x0020
90 #define IOAT_CHANCTRL_ERR_INT_EN		0x0010
91 #define IOAT_CHANCTRL_ANY_ERR_ABORT_EN		0x0008
92 #define IOAT_CHANCTRL_ERR_COMPLETION_EN		0x0004
93 #define IOAT_CHANCTRL_INT_REARM			0x0001
94 #define IOAT_CHANCTRL_RUN			(IOAT_CHANCTRL_INT_REARM |\
95 						 IOAT_CHANCTRL_ERR_COMPLETION_EN |\
96 						 IOAT_CHANCTRL_ANY_ERR_ABORT_EN |\
97 						 IOAT_CHANCTRL_ERR_INT_EN)
98 
99 #define IOAT_DMA_COMP_OFFSET			0x02	/* 16-bit DMA channel compatibility */
100 #define IOAT_DMA_COMP_V1			0x0001	/* Compatibility with DMA version 1 */
101 #define IOAT_DMA_COMP_V2			0x0002	/* Compatibility with DMA version 2 */
102 
103 
104 #define IOAT1_CHANSTS_OFFSET		0x04	/* 64-bit Channel Status Register */
105 #define IOAT2_CHANSTS_OFFSET		0x08	/* 64-bit Channel Status Register */
106 #define IOAT_CHANSTS_OFFSET(ver)		((ver) < IOAT_VER_2_0 \
107 						? IOAT1_CHANSTS_OFFSET : IOAT2_CHANSTS_OFFSET)
108 #define IOAT1_CHANSTS_OFFSET_LOW	0x04
109 #define IOAT2_CHANSTS_OFFSET_LOW	0x08
110 #define IOAT_CHANSTS_OFFSET_LOW(ver)		((ver) < IOAT_VER_2_0 \
111 						? IOAT1_CHANSTS_OFFSET_LOW : IOAT2_CHANSTS_OFFSET_LOW)
112 #define IOAT1_CHANSTS_OFFSET_HIGH	0x08
113 #define IOAT2_CHANSTS_OFFSET_HIGH	0x0C
114 #define IOAT_CHANSTS_OFFSET_HIGH(ver)		((ver) < IOAT_VER_2_0 \
115 						? IOAT1_CHANSTS_OFFSET_HIGH : IOAT2_CHANSTS_OFFSET_HIGH)
116 #define IOAT_CHANSTS_COMPLETED_DESCRIPTOR_ADDR	(~0x3fULL)
117 #define IOAT_CHANSTS_SOFT_ERR			0x10ULL
118 #define IOAT_CHANSTS_UNAFFILIATED_ERR		0x8ULL
119 #define IOAT_CHANSTS_STATUS	0x7ULL
120 #define IOAT_CHANSTS_ACTIVE	0x0
121 #define IOAT_CHANSTS_DONE	0x1
122 #define IOAT_CHANSTS_SUSPENDED	0x2
123 #define IOAT_CHANSTS_HALTED	0x3
124 
125 
126 
127 #define IOAT_CHAN_DMACOUNT_OFFSET	0x06    /* 16-bit DMA Count register */
128 
129 #define IOAT_DCACTRL_OFFSET         0x30   /* 32 bit Direct Cache Access Control Register */
130 #define IOAT_DCACTRL_CMPL_WRITE_ENABLE 0x10000
131 #define IOAT_DCACTRL_TARGET_CPU_MASK   0xFFFF /* APIC ID */
132 
133 /* CB DCA Memory Space Registers */
134 #define IOAT_DCAOFFSET_OFFSET       0x14
135 /* CB_BAR + IOAT_DCAOFFSET value */
136 #define IOAT_DCA_VER_OFFSET         0x00
137 #define IOAT_DCA_VER_MAJOR_MASK     0xF0
138 #define IOAT_DCA_VER_MINOR_MASK     0x0F
139 
140 #define IOAT_DCA_COMP_OFFSET        0x02
141 #define IOAT_DCA_COMP_V1            0x1
142 
143 #define IOAT_FSB_CAPABILITY_OFFSET  0x04
144 #define IOAT_FSB_CAPABILITY_PREFETCH    0x1
145 
146 #define IOAT_PCI_CAPABILITY_OFFSET  0x06
147 #define IOAT_PCI_CAPABILITY_MEMWR   0x1
148 
149 #define IOAT_FSB_CAP_ENABLE_OFFSET  0x08
150 #define IOAT_FSB_CAP_ENABLE_PREFETCH    0x1
151 
152 #define IOAT_PCI_CAP_ENABLE_OFFSET  0x0A
153 #define IOAT_PCI_CAP_ENABLE_MEMWR   0x1
154 
155 #define IOAT_APICID_TAG_MAP_OFFSET  0x0C
156 #define IOAT_APICID_TAG_MAP_TAG0    0x0000000F
157 #define IOAT_APICID_TAG_MAP_TAG0_SHIFT 0
158 #define IOAT_APICID_TAG_MAP_TAG1    0x000000F0
159 #define IOAT_APICID_TAG_MAP_TAG1_SHIFT 4
160 #define IOAT_APICID_TAG_MAP_TAG2    0x00000F00
161 #define IOAT_APICID_TAG_MAP_TAG2_SHIFT 8
162 #define IOAT_APICID_TAG_MAP_TAG3    0x0000F000
163 #define IOAT_APICID_TAG_MAP_TAG3_SHIFT 12
164 #define IOAT_APICID_TAG_MAP_TAG4    0x000F0000
165 #define IOAT_APICID_TAG_MAP_TAG4_SHIFT 16
166 #define IOAT_APICID_TAG_CB2_VALID   0x8080808080
167 
168 #define IOAT_DCA_GREQID_OFFSET      0x10
169 #define IOAT_DCA_GREQID_SIZE        0x04
170 #define IOAT_DCA_GREQID_MASK        0xFFFF
171 #define IOAT_DCA_GREQID_IGNOREFUN   0x10000000
172 #define IOAT_DCA_GREQID_VALID       0x20000000
173 #define IOAT_DCA_GREQID_LASTID      0x80000000
174 
175 #define IOAT3_CSI_CAPABILITY_OFFSET 0x08
176 #define IOAT3_CSI_CAPABILITY_PREFETCH    0x1
177 
178 #define IOAT3_PCI_CAPABILITY_OFFSET 0x0A
179 #define IOAT3_PCI_CAPABILITY_MEMWR  0x1
180 
181 #define IOAT3_CSI_CONTROL_OFFSET    0x0C
182 #define IOAT3_CSI_CONTROL_PREFETCH  0x1
183 
184 #define IOAT3_PCI_CONTROL_OFFSET    0x0E
185 #define IOAT3_PCI_CONTROL_MEMWR     0x1
186 
187 #define IOAT3_APICID_TAG_MAP_OFFSET 0x10
188 #define IOAT3_APICID_TAG_MAP_OFFSET_LOW  0x10
189 #define IOAT3_APICID_TAG_MAP_OFFSET_HIGH 0x14
190 
191 #define IOAT3_DCA_GREQID_OFFSET     0x02
192 
193 #define IOAT1_CHAINADDR_OFFSET		0x0C	/* 64-bit Descriptor Chain Address Register */
194 #define IOAT2_CHAINADDR_OFFSET		0x10	/* 64-bit Descriptor Chain Address Register */
195 #define IOAT_CHAINADDR_OFFSET(ver)		((ver) < IOAT_VER_2_0 \
196 						? IOAT1_CHAINADDR_OFFSET : IOAT2_CHAINADDR_OFFSET)
197 #define IOAT1_CHAINADDR_OFFSET_LOW	0x0C
198 #define IOAT2_CHAINADDR_OFFSET_LOW	0x10
199 #define IOAT_CHAINADDR_OFFSET_LOW(ver)		((ver) < IOAT_VER_2_0 \
200 						? IOAT1_CHAINADDR_OFFSET_LOW : IOAT2_CHAINADDR_OFFSET_LOW)
201 #define IOAT1_CHAINADDR_OFFSET_HIGH	0x10
202 #define IOAT2_CHAINADDR_OFFSET_HIGH	0x14
203 #define IOAT_CHAINADDR_OFFSET_HIGH(ver)		((ver) < IOAT_VER_2_0 \
204 						? IOAT1_CHAINADDR_OFFSET_HIGH : IOAT2_CHAINADDR_OFFSET_HIGH)
205 
206 #define IOAT1_CHANCMD_OFFSET		0x14	/*  8-bit DMA Channel Command Register */
207 #define IOAT2_CHANCMD_OFFSET		0x04	/*  8-bit DMA Channel Command Register */
208 #define IOAT_CHANCMD_OFFSET(ver)		((ver) < IOAT_VER_2_0 \
209 						? IOAT1_CHANCMD_OFFSET : IOAT2_CHANCMD_OFFSET)
210 #define IOAT_CHANCMD_RESET			0x20
211 #define IOAT_CHANCMD_RESUME			0x10
212 #define IOAT_CHANCMD_ABORT			0x08
213 #define IOAT_CHANCMD_SUSPEND			0x04
214 #define IOAT_CHANCMD_APPEND			0x02
215 #define IOAT_CHANCMD_START			0x01
216 
217 #define IOAT_CHANCMP_OFFSET			0x18	/* 64-bit Channel Completion Address Register */
218 #define IOAT_CHANCMP_OFFSET_LOW			0x18
219 #define IOAT_CHANCMP_OFFSET_HIGH		0x1C
220 
221 #define IOAT_CDAR_OFFSET			0x20	/* 64-bit Current Descriptor Address Register */
222 #define IOAT_CDAR_OFFSET_LOW			0x20
223 #define IOAT_CDAR_OFFSET_HIGH			0x24
224 
225 #define IOAT_CHANERR_OFFSET			0x28	/* 32-bit Channel Error Register */
226 #define IOAT_CHANERR_SRC_ADDR_ERR	0x0001
227 #define IOAT_CHANERR_DEST_ADDR_ERR	0x0002
228 #define IOAT_CHANERR_NEXT_ADDR_ERR	0x0004
229 #define IOAT_CHANERR_NEXT_DESC_ALIGN_ERR	0x0008
230 #define IOAT_CHANERR_CHAIN_ADDR_VALUE_ERR	0x0010
231 #define IOAT_CHANERR_CHANCMD_ERR		0x0020
232 #define IOAT_CHANERR_CHIPSET_UNCORRECTABLE_DATA_INTEGRITY_ERR	0x0040
233 #define IOAT_CHANERR_DMA_UNCORRECTABLE_DATA_INTEGRITY_ERR	0x0080
234 #define IOAT_CHANERR_READ_DATA_ERR		0x0100
235 #define IOAT_CHANERR_WRITE_DATA_ERR		0x0200
236 #define IOAT_CHANERR_CONTROL_ERR	0x0400
237 #define IOAT_CHANERR_LENGTH_ERR	0x0800
238 #define IOAT_CHANERR_COMPLETION_ADDR_ERR	0x1000
239 #define IOAT_CHANERR_INT_CONFIGURATION_ERR	0x2000
240 #define IOAT_CHANERR_SOFT_ERR			0x4000
241 #define IOAT_CHANERR_UNAFFILIATED_ERR		0x8000
242 #define IOAT_CHANERR_XOR_P_OR_CRC_ERR		0x10000
243 #define IOAT_CHANERR_XOR_Q_ERR			0x20000
244 #define IOAT_CHANERR_DESCRIPTOR_COUNT_ERR	0x40000
245 
246 #define IOAT_CHANERR_HANDLE_MASK (IOAT_CHANERR_XOR_P_OR_CRC_ERR | IOAT_CHANERR_XOR_Q_ERR)
247 
248 #define IOAT_CHANERR_MASK_OFFSET		0x2C	/* 32-bit Channel Error Register */
249 
250 #endif /* _IOAT_REGISTERS_H_ */
251