1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (C) 2010 Freescale Semiconductor, Inc.
4  * Terry Lv <r65388@freescale.com>
5  */
6 
7 #ifndef __DWC_AHSATA_PRIV_H__
8 #define __DWC_AHSATA_PRIV_H__
9 
10 #define DWC_AHSATA_MAX_CMD_SLOTS	32
11 
12 /* Max host controller numbers */
13 #define SATA_HC_MAX_NUM		4
14 /* Max command queue depth per host controller */
15 #define DWC_AHSATA_HC_MAX_CMD	32
16 /* Max port number per host controller */
17 #define SATA_HC_MAX_PORT	16
18 
19 /* Generic Host Register */
20 
21 /* HBA Capabilities Register */
22 #define SATA_HOST_CAP_S64A		0x80000000
23 #define SATA_HOST_CAP_SNCQ		0x40000000
24 #define SATA_HOST_CAP_SSNTF		0x20000000
25 #define SATA_HOST_CAP_SMPS		0x10000000
26 #define SATA_HOST_CAP_SSS		0x08000000
27 #define SATA_HOST_CAP_SALP		0x04000000
28 #define SATA_HOST_CAP_SAL		0x02000000
29 #define SATA_HOST_CAP_SCLO		0x01000000
30 #define SATA_HOST_CAP_ISS_MASK		0x00f00000
31 #define SATA_HOST_CAP_ISS_OFFSET	20
32 #define SATA_HOST_CAP_SNZO		0x00080000
33 #define SATA_HOST_CAP_SAM		0x00040000
34 #define SATA_HOST_CAP_SPM		0x00020000
35 #define SATA_HOST_CAP_PMD		0x00008000
36 #define SATA_HOST_CAP_SSC		0x00004000
37 #define SATA_HOST_CAP_PSC		0x00002000
38 #define SATA_HOST_CAP_NCS		0x00001f00
39 #define SATA_HOST_CAP_CCCS		0x00000080
40 #define SATA_HOST_CAP_EMS		0x00000040
41 #define SATA_HOST_CAP_SXS		0x00000020
42 #define SATA_HOST_CAP_NP_MASK		0x0000001f
43 
44 /* Global HBA Control Register */
45 #define SATA_HOST_GHC_AE	0x80000000
46 #define SATA_HOST_GHC_IE	0x00000002
47 #define SATA_HOST_GHC_HR	0x00000001
48 
49 /* Interrupt Status Register */
50 
51 /* Ports Implemented Register */
52 
53 /* AHCI Version Register */
54 #define SATA_HOST_VS_MJR_MASK	0xffff0000
55 #define SATA_HOST_VS_MJR_OFFSET	16
56 #define SATA_HOST_VS_MJR_MNR	0x0000ffff
57 
58 /* Command Completion Coalescing Control */
59 #define SATA_HOST_CCC_CTL_TV_MASK	0xffff0000
60 #define SATA_HOST_CCC_CTL_TV_OFFSET		16
61 #define SATA_HOST_CCC_CTL_CC_MASK	0x0000ff00
62 #define SATA_HOST_CCC_CTL_CC_OFFSET		8
63 #define SATA_HOST_CCC_CTL_INT_MASK	0x000000f8
64 #define SATA_HOST_CCC_CTL_INT_OFFSET	3
65 #define SATA_HOST_CCC_CTL_EN	0x00000001
66 
67 /* Command Completion Coalescing Ports */
68 
69 /* HBA Capabilities Extended Register */
70 #define SATA_HOST_CAP2_APST		0x00000004
71 
72 /* BIST Activate FIS Register */
73 #define SATA_HOST_BISTAFR_NCP_MASK	0x0000ff00
74 #define SATA_HOST_BISTAFR_NCP_OFFSET	8
75 #define SATA_HOST_BISTAFR_PD_MASK	0x000000ff
76 #define SATA_HOST_BISTAFR_PD_OFFSET		0
77 
78 /* BIST Control Register */
79 #define SATA_HOST_BISTCR_FERLB	0x00100000
80 #define SATA_HOST_BISTCR_TXO	0x00040000
81 #define SATA_HOST_BISTCR_CNTCLR	0x00020000
82 #define SATA_HOST_BISTCR_NEALB	0x00010000
83 #define SATA_HOST_BISTCR_LLC_MASK	0x00000700
84 #define SATA_HOST_BISTCR_LLC_OFFSET	8
85 #define SATA_HOST_BISTCR_ERREN	0x00000040
86 #define SATA_HOST_BISTCR_FLIP	0x00000020
87 #define SATA_HOST_BISTCR_PV		0x00000010
88 #define SATA_HOST_BISTCR_PATTERN_MASK	0x0000000f
89 #define SATA_HOST_BISTCR_PATTERN_OFFSET	0
90 
91 /* BIST FIS Count Register */
92 
93 /* BIST Status Register */
94 #define SATA_HOST_BISTSR_FRAMERR_MASK	0x0000ffff
95 #define SATA_HOST_BISTSR_FRAMERR_OFFSET	0
96 #define SATA_HOST_BISTSR_BRSTERR_MASK	0x00ff0000
97 #define SATA_HOST_BISTSR_BRSTERR_OFFSET	16
98 
99 /* BIST DWORD Error Count Register */
100 
101 /* OOB Register*/
102 #define SATA_HOST_OOBR_WE		0x80000000
103 #define SATA_HOST_OOBR_cwMin_MASK	0x7f000000
104 #define SATA_HOST_OOBR_cwMAX_MASK	0x00ff0000
105 #define SATA_HOST_OOBR_ciMin_MASK	0x0000ff00
106 #define SATA_HOST_OOBR_ciMax_MASK	0x000000ff
107 
108 /* Timer 1-ms Register */
109 
110 /* Global Parameter 1 Register */
111 #define SATA_HOST_GPARAM1R_ALIGN_M	0x80000000
112 #define SATA_HOST_GPARAM1R_RX_BUFFER	0x40000000
113 #define SATA_HOST_GPARAM1R_PHY_DATA_MASK	0x30000000
114 #define SATA_HOST_GPARAM1R_PHY_RST	0x08000000
115 #define SATA_HOST_GPARAM1R_PHY_CTRL_MASK	0x07e00000
116 #define SATA_HOST_GPARAM1R_PHY_STAT_MASK	0x001f8000
117 #define SATA_HOST_GPARAM1R_LATCH_M	0x00004000
118 #define SATA_HOST_GPARAM1R_BIST_M	0x00002000
119 #define SATA_HOST_GPARAM1R_PHY_TYPE	0x00001000
120 #define SATA_HOST_GPARAM1R_RETURN_ERR	0x00000400
121 #define SATA_HOST_GPARAM1R_AHB_ENDIAN_MASK	0x00000300
122 #define SATA_HOST_GPARAM1R_S_HADDR	0X00000080
123 #define SATA_HOST_GPARAM1R_M_HADDR	0X00000040
124 
125 /* Global Parameter 2 Register */
126 #define SATA_HOST_GPARAM2R_DEV_CP	0x00004000
127 #define SATA_HOST_GPARAM2R_DEV_MP	0x00002000
128 #define SATA_HOST_GPARAM2R_DEV_ENCODE_M	0x00001000
129 #define SATA_HOST_GPARAM2R_RXOOB_CLK_M	0x00000800
130 #define SATA_HOST_GPARAM2R_RXOOB_M	0x00000400
131 #define SATA_HOST_GPARAM2R_TX_OOB_M	0x00000200
132 #define SATA_HOST_GPARAM2R_RXOOB_CLK_MASK	0x000001ff
133 
134 /* Port Parameter Register */
135 #define SATA_HOST_PPARAMR_TX_MEM_M	0x00000200
136 #define SATA_HOST_PPARAMR_TX_MEM_S	0x00000100
137 #define SATA_HOST_PPARAMR_RX_MEM_M	0x00000080
138 #define SATA_HOST_PPARAMR_RX_MEM_S	0x00000040
139 #define SATA_HOST_PPARAMR_TXFIFO_DEPTH_MASK	0x00000038
140 #define SATA_HOST_PPARAMR_RXFIFO_DEPTH_MASK	0x00000007
141 
142 /* Test Register */
143 #define SATA_HOST_TESTR_PSEL_MASK	0x00070000
144 #define SATA_HOST_TESTR_TEST_IF		0x00000001
145 
146 /* Port Register Descriptions */
147 /* Port# Command List Base Address Register */
148 #define SATA_PORT_CLB_CLB_MASK		0xfffffc00
149 
150 /* Port# Command List Base Address Upper 32-Bits Register */
151 
152 /* Port# FIS Base Address Register */
153 #define SATA_PORT_FB_FB_MASK		0xfffffff0
154 
155 /* Port# FIS Base Address Upper 32-Bits Register */
156 
157 /* Port# Interrupt Status Register */
158 #define SATA_PORT_IS_CPDS		0x80000000
159 #define SATA_PORT_IS_TFES		0x40000000
160 #define SATA_PORT_IS_HBFS		0x20000000
161 #define SATA_PORT_IS_HBDS		0x10000000
162 #define SATA_PORT_IS_IFS		0x08000000
163 #define SATA_PORT_IS_INFS		0x04000000
164 #define SATA_PORT_IS_OFS		0x01000000
165 #define SATA_PORT_IS_IPMS		0x00800000
166 #define SATA_PORT_IS_PRCS		0x00400000
167 #define SATA_PORT_IS_DMPS		0x00000080
168 #define SATA_PORT_IS_PCS		0x00000040
169 #define SATA_PORT_IS_DPS		0x00000020
170 #define SATA_PORT_IS_UFS		0x00000010
171 #define SATA_PORT_IS_SDBS		0x00000008
172 #define SATA_PORT_IS_DSS		0x00000004
173 #define SATA_PORT_IS_PSS		0x00000002
174 #define SATA_PORT_IS_DHRS		0x00000001
175 
176 /* Port# Interrupt Enable Register */
177 #define SATA_PORT_IE_CPDE		0x80000000
178 #define SATA_PORT_IE_TFEE		0x40000000
179 #define SATA_PORT_IE_HBFE		0x20000000
180 #define SATA_PORT_IE_HBDE		0x10000000
181 #define SATA_PORT_IE_IFE		0x08000000
182 #define SATA_PORT_IE_INFE		0x04000000
183 #define SATA_PORT_IE_OFE		0x01000000
184 #define SATA_PORT_IE_IPME		0x00800000
185 #define SATA_PORT_IE_PRCE		0x00400000
186 #define SATA_PORT_IE_DMPE		0x00000080
187 #define SATA_PORT_IE_PCE		0x00000040
188 #define SATA_PORT_IE_DPE		0x00000020
189 #define SATA_PORT_IE_UFE		0x00000010
190 #define SATA_PORT_IE_SDBE		0x00000008
191 #define SATA_PORT_IE_DSE		0x00000004
192 #define SATA_PORT_IE_PSE		0x00000002
193 #define SATA_PORT_IE_DHRE		0x00000001
194 
195 /* Port# Command Register */
196 #define SATA_PORT_CMD_ICC_MASK		0xf0000000
197 #define SATA_PORT_CMD_ASP		0x08000000
198 #define SATA_PORT_CMD_ALPE		0x04000000
199 #define SATA_PORT_CMD_DLAE		0x02000000
200 #define SATA_PORT_CMD_ATAPI		0x01000000
201 #define SATA_PORT_CMD_APSTE		0x00800000
202 #define SATA_PORT_CMD_ESP		0x00200000
203 #define SATA_PORT_CMD_CPD		0x00100000
204 #define SATA_PORT_CMD_MPSP		0x00080000
205 #define SATA_PORT_CMD_HPCP		0x00040000
206 #define SATA_PORT_CMD_PMA		0x00020000
207 #define SATA_PORT_CMD_CPS		0x00010000
208 #define SATA_PORT_CMD_CR		0x00008000
209 #define SATA_PORT_CMD_FR		0x00004000
210 #define SATA_PORT_CMD_MPSS		0x00002000
211 #define SATA_PORT_CMD_CCS_MASK		0x00001f00
212 #define SATA_PORT_CMD_FRE		0x00000010
213 #define SATA_PORT_CMD_CLO		0x00000008
214 #define SATA_PORT_CMD_POD		0x00000004
215 #define SATA_PORT_CMD_SUD		0x00000002
216 #define SATA_PORT_CMD_ST		0x00000001
217 
218 /* Port# Task File Data Register */
219 #define SATA_PORT_TFD_ERR_MASK		0x0000ff00
220 #define SATA_PORT_TFD_STS_MASK		0x000000ff
221 #define SATA_PORT_TFD_STS_ERR		0x00000001
222 #define SATA_PORT_TFD_STS_DRQ		0x00000008
223 #define SATA_PORT_TFD_STS_BSY		0x00000080
224 
225 /* Port# Signature Register */
226 
227 /* Port# Serial ATA Status {SStatus} Register */
228 #define SATA_PORT_SSTS_IPM_MASK		0x00000f00
229 #define SATA_PORT_SSTS_SPD_MASK		0x000000f0
230 #define SATA_PORT_SSTS_DET_MASK		0x0000000f
231 
232 /* Port# Serial ATA Control {SControl} Register */
233 #define SATA_PORT_SCTL_IPM_MASK		0x00000f00
234 #define SATA_PORT_SCTL_SPD_MASK		0x000000f0
235 #define SATA_PORT_SCTL_DET_MASK		0x0000000f
236 
237 /* Port# Serial ATA Error {SError} Register */
238 #define SATA_PORT_SERR_DIAG_X		0x04000000
239 #define SATA_PORT_SERR_DIAG_F		0x02000000
240 #define SATA_PORT_SERR_DIAG_T		0x01000000
241 #define SATA_PORT_SERR_DIAG_S		0x00800000
242 #define SATA_PORT_SERR_DIAG_H		0x00400000
243 #define SATA_PORT_SERR_DIAG_C		0x00200000
244 #define SATA_PORT_SERR_DIAG_D		0x00100000
245 #define SATA_PORT_SERR_DIAG_B		0x00080000
246 #define SATA_PORT_SERR_DIAG_W		0x00040000
247 #define SATA_PORT_SERR_DIAG_I		0x00020000
248 #define SATA_PORT_SERR_DIAG_N		0x00010000
249 #define SATA_PORT_SERR_ERR_E		0x00000800
250 #define SATA_PORT_SERR_ERR_P		0x00000400
251 #define SATA_PORT_SERR_ERR_C		0x00000200
252 #define SATA_PORT_SERR_ERR_T		0x00000100
253 #define SATA_PORT_SERR_ERR_M		0x00000002
254 #define SATA_PORT_SERR_ERR_I		0x00000001
255 
256 /* Port# Serial ATA Active {SActive} Register */
257 
258 /* Port# Command Issue Register */
259 
260 /* Port# Serial ATA Notification Register */
261 
262 /* Port# DMA Control Register */
263 #define SATA_PORT_DMACR_RXABL_MASK	0x0000f000
264 #define SATA_PORT_DMACR_TXABL_MASK	0x00000f00
265 #define SATA_PORT_DMACR_RXTS_MASK	0x000000f0
266 #define SATA_PORT_DMACR_TXTS_MASK	0x0000000f
267 
268 /* Port# PHY Control Register */
269 
270 /* Port# PHY Status Register */
271 
272 #define SATA_HC_CMD_HDR_ENTRY_SIZE	sizeof(struct cmd_hdr_entry)
273 
274 /* DW0
275 */
276 #define CMD_HDR_DI_CFL_MASK	0x0000001f
277 #define CMD_HDR_DI_CFL_OFFSET	0
278 #define CMD_HDR_DI_A			0x00000020
279 #define CMD_HDR_DI_W			0x00000040
280 #define CMD_HDR_DI_P			0x00000080
281 #define CMD_HDR_DI_R			0x00000100
282 #define CMD_HDR_DI_B			0x00000200
283 #define CMD_HDR_DI_C			0x00000400
284 #define CMD_HDR_DI_PMP_MASK	0x0000f000
285 #define CMD_HDR_DI_PMP_OFFSET	12
286 #define CMD_HDR_DI_PRDTL		0xffff0000
287 #define CMD_HDR_DI_PRDTL_OFFSET	16
288 
289 /* prde_fis_len
290 */
291 #define CMD_HDR_PRD_ENTRY_SHIFT	16
292 #define CMD_HDR_PRD_ENTRY_MASK	0x003f0000
293 #define CMD_HDR_FIS_LEN_SHIFT	2
294 
295 /* attribute
296 */
297 #define CMD_HDR_ATTR_RES	0x00000800 /* Reserved bit, should be 1 */
298 #define CMD_HDR_ATTR_VBIST	0x00000400 /* Vendor BIST */
299 /* Snoop enable for all descriptor */
300 #define CMD_HDR_ATTR_SNOOP	0x00000200
301 #define CMD_HDR_ATTR_FPDMA	0x00000100 /* FPDMA queued command */
302 #define CMD_HDR_ATTR_RESET	0x00000080 /* Reset - a SRST or device reset */
303 /* BIST - require the host to enter BIST mode */
304 #define CMD_HDR_ATTR_BIST	0x00000040
305 #define CMD_HDR_ATTR_ATAPI	0x00000020 /* ATAPI command */
306 #define CMD_HDR_ATTR_TAG	0x0000001f /* TAG mask */
307 
308 #define FLAGS_DMA	0x00000000
309 #define FLAGS_FPDMA	0x00000001
310 
311 #define SATA_FLAG_Q_DEP_MASK	0x0000000f
312 #define SATA_FLAG_WCACHE	0x00000100
313 #define SATA_FLAG_FLUSH		0x00000200
314 #define SATA_FLAG_FLUSH_EXT	0x00000400
315 
316 #define READ_CMD	0
317 #define WRITE_CMD	1
318 
319 #endif /* __DWC_AHSATA_H__ */
320