Deleted Added
full compact
ahci.h (199322) ahci.h (199747)
1/*-
2 * Copyright (c) 1998 - 2008 S�ren Schmidt <sos@FreeBSD.org>
3 * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer,
11 * without modification, immediately at the beginning of the file.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
1/*-
2 * Copyright (c) 1998 - 2008 S�ren Schmidt <sos@FreeBSD.org>
3 * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer,
11 * without modification, immediately at the beginning of the file.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD: head/sys/dev/ahci/ahci.h 199322 2009-11-16 15:38:27Z mav $
27 * $FreeBSD: head/sys/dev/ahci/ahci.h 199747 2009-11-24 12:47:58Z mav $
28 */
29
30/* ATA register defines */
31#define ATA_DATA 0 /* (RW) data */
32
33#define ATA_FEATURE 1 /* (W) feature */
34#define ATA_F_DMA 0x01 /* enable DMA */
35#define ATA_F_OVL 0x02 /* enable overlap */
36
37#define ATA_COUNT 2 /* (W) sector count */
38
39#define ATA_SECTOR 3 /* (RW) sector # */
40#define ATA_CYL_LSB 4 /* (RW) cylinder# LSB */
41#define ATA_CYL_MSB 5 /* (RW) cylinder# MSB */
42#define ATA_DRIVE 6 /* (W) Sector/Drive/Head */
43#define ATA_D_LBA 0x40 /* use LBA addressing */
44#define ATA_D_IBM 0xa0 /* 512 byte sectors, ECC */
45
46#define ATA_COMMAND 7 /* (W) command */
47
48#define ATA_ERROR 8 /* (R) error */
49#define ATA_E_ILI 0x01 /* illegal length */
50#define ATA_E_NM 0x02 /* no media */
51#define ATA_E_ABORT 0x04 /* command aborted */
52#define ATA_E_MCR 0x08 /* media change request */
53#define ATA_E_IDNF 0x10 /* ID not found */
54#define ATA_E_MC 0x20 /* media changed */
55#define ATA_E_UNC 0x40 /* uncorrectable data */
56#define ATA_E_ICRC 0x80 /* UDMA crc error */
57#define ATA_E_ATAPI_SENSE_MASK 0xf0 /* ATAPI sense key mask */
58
59#define ATA_IREASON 9 /* (R) interrupt reason */
60#define ATA_I_CMD 0x01 /* cmd (1) | data (0) */
61#define ATA_I_IN 0x02 /* read (1) | write (0) */
62#define ATA_I_RELEASE 0x04 /* released bus (1) */
63#define ATA_I_TAGMASK 0xf8 /* tag mask */
64
65#define ATA_STATUS 10 /* (R) status */
66#define ATA_ALTSTAT 11 /* (R) alternate status */
67#define ATA_S_ERROR 0x01 /* error */
68#define ATA_S_INDEX 0x02 /* index */
69#define ATA_S_CORR 0x04 /* data corrected */
70#define ATA_S_DRQ 0x08 /* data request */
71#define ATA_S_DSC 0x10 /* drive seek completed */
72#define ATA_S_SERVICE 0x10 /* drive needs service */
73#define ATA_S_DWF 0x20 /* drive write fault */
74#define ATA_S_DMA 0x20 /* DMA ready */
75#define ATA_S_READY 0x40 /* drive ready */
76#define ATA_S_BUSY 0x80 /* busy */
77
78#define ATA_CONTROL 12 /* (W) control */
79#define ATA_A_IDS 0x02 /* disable interrupts */
80#define ATA_A_RESET 0x04 /* RESET controller */
81#define ATA_A_4BIT 0x08 /* 4 head bits */
82#define ATA_A_HOB 0x80 /* High Order Byte enable */
83
84/* SATA register defines */
85#define ATA_SSTATUS 13
86#define ATA_SS_DET_MASK 0x0000000f
87#define ATA_SS_DET_NO_DEVICE 0x00000000
88#define ATA_SS_DET_DEV_PRESENT 0x00000001
89#define ATA_SS_DET_PHY_ONLINE 0x00000003
90#define ATA_SS_DET_PHY_OFFLINE 0x00000004
91
92#define ATA_SS_SPD_MASK 0x000000f0
93#define ATA_SS_SPD_NO_SPEED 0x00000000
94#define ATA_SS_SPD_GEN1 0x00000010
95#define ATA_SS_SPD_GEN2 0x00000020
96#define ATA_SS_SPD_GEN3 0x00000040
97
98#define ATA_SS_IPM_MASK 0x00000f00
99#define ATA_SS_IPM_NO_DEVICE 0x00000000
100#define ATA_SS_IPM_ACTIVE 0x00000100
101#define ATA_SS_IPM_PARTIAL 0x00000200
102#define ATA_SS_IPM_SLUMBER 0x00000600
103
104#define ATA_SERROR 14
105#define ATA_SE_DATA_CORRECTED 0x00000001
106#define ATA_SE_COMM_CORRECTED 0x00000002
107#define ATA_SE_DATA_ERR 0x00000100
108#define ATA_SE_COMM_ERR 0x00000200
109#define ATA_SE_PROT_ERR 0x00000400
110#define ATA_SE_HOST_ERR 0x00000800
111#define ATA_SE_PHY_CHANGED 0x00010000
112#define ATA_SE_PHY_IERROR 0x00020000
113#define ATA_SE_COMM_WAKE 0x00040000
114#define ATA_SE_DECODE_ERR 0x00080000
115#define ATA_SE_PARITY_ERR 0x00100000
116#define ATA_SE_CRC_ERR 0x00200000
117#define ATA_SE_HANDSHAKE_ERR 0x00400000
118#define ATA_SE_LINKSEQ_ERR 0x00800000
119#define ATA_SE_TRANSPORT_ERR 0x01000000
120#define ATA_SE_UNKNOWN_FIS 0x02000000
121
122#define ATA_SCONTROL 15
123#define ATA_SC_DET_MASK 0x0000000f
124#define ATA_SC_DET_IDLE 0x00000000
125#define ATA_SC_DET_RESET 0x00000001
126#define ATA_SC_DET_DISABLE 0x00000004
127
128#define ATA_SC_SPD_MASK 0x000000f0
129#define ATA_SC_SPD_NO_SPEED 0x00000000
130#define ATA_SC_SPD_SPEED_GEN1 0x00000010
131#define ATA_SC_SPD_SPEED_GEN2 0x00000020
132#define ATA_SC_SPD_SPEED_GEN3 0x00000040
133
134#define ATA_SC_IPM_MASK 0x00000f00
135#define ATA_SC_IPM_NONE 0x00000000
136#define ATA_SC_IPM_DIS_PARTIAL 0x00000100
137#define ATA_SC_IPM_DIS_SLUMBER 0x00000200
138
139#define ATA_SACTIVE 16
140
141#define AHCI_MAX_PORTS 32
142#define AHCI_MAX_SLOTS 32
143
144/* SATA AHCI v1.0 register defines */
145#define AHCI_CAP 0x00
146#define AHCI_CAP_NPMASK 0x0000001f
147#define AHCI_CAP_SXS 0x00000020
148#define AHCI_CAP_EMS 0x00000040
149#define AHCI_CAP_CCCS 0x00000080
150#define AHCI_CAP_NCS 0x00001F00
151#define AHCI_CAP_NCS_SHIFT 8
152#define AHCI_CAP_PSC 0x00002000
153#define AHCI_CAP_SSC 0x00004000
154#define AHCI_CAP_PMD 0x00008000
155#define AHCI_CAP_FBSS 0x00010000
156#define AHCI_CAP_SPM 0x00020000
157#define AHCI_CAP_SAM 0x00080000
158#define AHCI_CAP_ISS 0x00F00000
159#define AHCI_CAP_ISS_SHIFT 20
160#define AHCI_CAP_SCLO 0x01000000
161#define AHCI_CAP_SAL 0x02000000
162#define AHCI_CAP_SALP 0x04000000
163#define AHCI_CAP_SSS 0x08000000
164#define AHCI_CAP_SMPS 0x10000000
165#define AHCI_CAP_SSNTF 0x20000000
166#define AHCI_CAP_SNCQ 0x40000000
167#define AHCI_CAP_64BIT 0x80000000
168
169#define AHCI_GHC 0x04
170#define AHCI_GHC_AE 0x80000000
171#define AHCI_GHC_MRSM 0x00000004
172#define AHCI_GHC_IE 0x00000002
173#define AHCI_GHC_HR 0x00000001
174
175#define AHCI_IS 0x08
176#define AHCI_PI 0x0c
177#define AHCI_VS 0x10
178
179#define AHCI_CCCC 0x14
180#define AHCI_CCCC_TV_MASK 0xffff0000
181#define AHCI_CCCC_TV_SHIFT 16
182#define AHCI_CCCC_CC_MASK 0x0000ff00
183#define AHCI_CCCC_CC_SHIFT 8
184#define AHCI_CCCC_INT_MASK 0x000000f8
185#define AHCI_CCCC_INT_SHIFT 3
186#define AHCI_CCCC_EN 0x00000001
187#define AHCI_CCCP 0x18
188
189#define AHCI_CAP2 0x24
190#define AHCI_CAP2_BOH 0x00000001
191#define AHCI_CAP2_NVMP 0x00000002
192#define AHCI_CAP2_APST 0x00000004
193
194#define AHCI_OFFSET 0x100
195#define AHCI_STEP 0x80
196
197#define AHCI_P_CLB 0x00
198#define AHCI_P_CLBU 0x04
199#define AHCI_P_FB 0x08
200#define AHCI_P_FBU 0x0c
201#define AHCI_P_IS 0x10
202#define AHCI_P_IE 0x14
203#define AHCI_P_IX_DHR 0x00000001
204#define AHCI_P_IX_PS 0x00000002
205#define AHCI_P_IX_DS 0x00000004
206#define AHCI_P_IX_SDB 0x00000008
207#define AHCI_P_IX_UF 0x00000010
208#define AHCI_P_IX_DP 0x00000020
209#define AHCI_P_IX_PC 0x00000040
210#define AHCI_P_IX_DI 0x00000080
211
212#define AHCI_P_IX_PRC 0x00400000
213#define AHCI_P_IX_IPM 0x00800000
214#define AHCI_P_IX_OF 0x01000000
215#define AHCI_P_IX_INF 0x04000000
216#define AHCI_P_IX_IF 0x08000000
217#define AHCI_P_IX_HBD 0x10000000
218#define AHCI_P_IX_HBF 0x20000000
219#define AHCI_P_IX_TFE 0x40000000
220#define AHCI_P_IX_CPD 0x80000000
221
222#define AHCI_P_CMD 0x18
223#define AHCI_P_CMD_ST 0x00000001
224#define AHCI_P_CMD_SUD 0x00000002
225#define AHCI_P_CMD_POD 0x00000004
226#define AHCI_P_CMD_CLO 0x00000008
227#define AHCI_P_CMD_FRE 0x00000010
228#define AHCI_P_CMD_CCS_MASK 0x00001f00
229#define AHCI_P_CMD_CCS_SHIFT 8
230#define AHCI_P_CMD_ISS 0x00002000
231#define AHCI_P_CMD_FR 0x00004000
232#define AHCI_P_CMD_CR 0x00008000
233#define AHCI_P_CMD_CPS 0x00010000
234#define AHCI_P_CMD_PMA 0x00020000
235#define AHCI_P_CMD_HPCP 0x00040000
236#define AHCI_P_CMD_ISP 0x00080000
237#define AHCI_P_CMD_CPD 0x00100000
238#define AHCI_P_CMD_ATAPI 0x01000000
239#define AHCI_P_CMD_DLAE 0x02000000
240#define AHCI_P_CMD_ALPE 0x04000000
241#define AHCI_P_CMD_ASP 0x08000000
242#define AHCI_P_CMD_ICC_MASK 0xf0000000
243#define AHCI_P_CMD_NOOP 0x00000000
244#define AHCI_P_CMD_ACTIVE 0x10000000
245#define AHCI_P_CMD_PARTIAL 0x20000000
246#define AHCI_P_CMD_SLUMBER 0x60000000
247
248#define AHCI_P_TFD 0x20
249#define AHCI_P_SIG 0x24
250#define AHCI_P_SSTS 0x28
251#define AHCI_P_SCTL 0x2c
252#define AHCI_P_SERR 0x30
253#define AHCI_P_SACT 0x34
254#define AHCI_P_CI 0x38
255#define AHCI_P_SNTF 0x3C
256#define AHCI_P_FBS 0x40
257
258/* Just to be sure, if building as module. */
259#if MAXPHYS < 512 * 1024
260#undef MAXPHYS
261#define MAXPHYS 512 * 1024
262#endif
263/* Pessimistic prognosis on number of required S/G entries */
264#define AHCI_SG_ENTRIES (roundup(btoc(MAXPHYS) + 1, 8))
265/* Command list. 32 commands. First, 1Kbyte aligned. */
266#define AHCI_CL_OFFSET 0
267#define AHCI_CL_SIZE 32
268/* Command tables. Up to 32 commands, Each, 128byte aligned. */
269#define AHCI_CT_OFFSET (AHCI_CL_OFFSET + AHCI_CL_SIZE * AHCI_MAX_SLOTS)
270#define AHCI_CT_SIZE (128 + AHCI_SG_ENTRIES * 16)
271/* Total main work area. */
272#define AHCI_WORK_SIZE (AHCI_CT_OFFSET + AHCI_CT_SIZE * ch->numslots)
273
274struct ahci_dma_prd {
275 u_int64_t dba;
276 u_int32_t reserved;
277 u_int32_t dbc; /* 0 based */
278#define AHCI_PRD_MASK 0x003fffff /* max 4MB */
279#define AHCI_PRD_MAX (AHCI_PRD_MASK + 1)
280#define AHCI_PRD_IPC (1 << 31)
281} __packed;
282
283struct ahci_cmd_tab {
284 u_int8_t cfis[64];
285 u_int8_t acmd[32];
286 u_int8_t reserved[32];
287 struct ahci_dma_prd prd_tab[AHCI_SG_ENTRIES];
288} __packed;
289
290struct ahci_cmd_list {
291 u_int16_t cmd_flags;
292#define AHCI_CMD_ATAPI 0x0020
293#define AHCI_CMD_WRITE 0x0040
294#define AHCI_CMD_PREFETCH 0x0080
295#define AHCI_CMD_RESET 0x0100
296#define AHCI_CMD_BIST 0x0200
297#define AHCI_CMD_CLR_BUSY 0x0400
298
299 u_int16_t prd_length; /* PRD entries */
300 u_int32_t bytecount;
301 u_int64_t cmd_table_phys; /* 128byte aligned */
302} __packed;
303
304/* misc defines */
305#define ATA_IRQ_RID 0
306#define ATA_INTR_FLAGS (INTR_MPSAFE|INTR_TYPE_BIO|INTR_ENTROPY)
307
308struct ata_dmaslot {
309 bus_dmamap_t data_map; /* data DMA map */
310 int nsegs; /* Number of segs loaded */
311};
312
313/* structure holding DMA related information */
314struct ata_dma {
315 bus_dma_tag_t work_tag; /* workspace DMA tag */
316 bus_dmamap_t work_map; /* workspace DMA map */
317 uint8_t *work; /* workspace */
318 bus_addr_t work_bus; /* bus address of work */
319 bus_dma_tag_t rfis_tag; /* RFIS list DMA tag */
320 bus_dmamap_t rfis_map; /* RFIS list DMA map */
321 uint8_t *rfis; /* FIS receive area */
322 bus_addr_t rfis_bus; /* bus address of rfis */
323 bus_dma_tag_t data_tag; /* data DMA tag */
324 u_int64_t max_address; /* highest DMA'able address */
325};
326
327enum ahci_slot_states {
328 AHCI_SLOT_EMPTY,
329 AHCI_SLOT_LOADING,
330 AHCI_SLOT_RUNNING,
331 AHCI_SLOT_EXECUTING
332};
333
334struct ahci_slot {
335 device_t dev; /* Device handle */
336 u_int8_t slot; /* Number of this slot */
337 enum ahci_slot_states state; /* Slot state */
338 union ccb *ccb; /* CCB occupying slot */
339 struct ata_dmaslot dma; /* DMA data of this slot */
340 struct callout timeout; /* Execution timeout */
341};
342
28 */
29
30/* ATA register defines */
31#define ATA_DATA 0 /* (RW) data */
32
33#define ATA_FEATURE 1 /* (W) feature */
34#define ATA_F_DMA 0x01 /* enable DMA */
35#define ATA_F_OVL 0x02 /* enable overlap */
36
37#define ATA_COUNT 2 /* (W) sector count */
38
39#define ATA_SECTOR 3 /* (RW) sector # */
40#define ATA_CYL_LSB 4 /* (RW) cylinder# LSB */
41#define ATA_CYL_MSB 5 /* (RW) cylinder# MSB */
42#define ATA_DRIVE 6 /* (W) Sector/Drive/Head */
43#define ATA_D_LBA 0x40 /* use LBA addressing */
44#define ATA_D_IBM 0xa0 /* 512 byte sectors, ECC */
45
46#define ATA_COMMAND 7 /* (W) command */
47
48#define ATA_ERROR 8 /* (R) error */
49#define ATA_E_ILI 0x01 /* illegal length */
50#define ATA_E_NM 0x02 /* no media */
51#define ATA_E_ABORT 0x04 /* command aborted */
52#define ATA_E_MCR 0x08 /* media change request */
53#define ATA_E_IDNF 0x10 /* ID not found */
54#define ATA_E_MC 0x20 /* media changed */
55#define ATA_E_UNC 0x40 /* uncorrectable data */
56#define ATA_E_ICRC 0x80 /* UDMA crc error */
57#define ATA_E_ATAPI_SENSE_MASK 0xf0 /* ATAPI sense key mask */
58
59#define ATA_IREASON 9 /* (R) interrupt reason */
60#define ATA_I_CMD 0x01 /* cmd (1) | data (0) */
61#define ATA_I_IN 0x02 /* read (1) | write (0) */
62#define ATA_I_RELEASE 0x04 /* released bus (1) */
63#define ATA_I_TAGMASK 0xf8 /* tag mask */
64
65#define ATA_STATUS 10 /* (R) status */
66#define ATA_ALTSTAT 11 /* (R) alternate status */
67#define ATA_S_ERROR 0x01 /* error */
68#define ATA_S_INDEX 0x02 /* index */
69#define ATA_S_CORR 0x04 /* data corrected */
70#define ATA_S_DRQ 0x08 /* data request */
71#define ATA_S_DSC 0x10 /* drive seek completed */
72#define ATA_S_SERVICE 0x10 /* drive needs service */
73#define ATA_S_DWF 0x20 /* drive write fault */
74#define ATA_S_DMA 0x20 /* DMA ready */
75#define ATA_S_READY 0x40 /* drive ready */
76#define ATA_S_BUSY 0x80 /* busy */
77
78#define ATA_CONTROL 12 /* (W) control */
79#define ATA_A_IDS 0x02 /* disable interrupts */
80#define ATA_A_RESET 0x04 /* RESET controller */
81#define ATA_A_4BIT 0x08 /* 4 head bits */
82#define ATA_A_HOB 0x80 /* High Order Byte enable */
83
84/* SATA register defines */
85#define ATA_SSTATUS 13
86#define ATA_SS_DET_MASK 0x0000000f
87#define ATA_SS_DET_NO_DEVICE 0x00000000
88#define ATA_SS_DET_DEV_PRESENT 0x00000001
89#define ATA_SS_DET_PHY_ONLINE 0x00000003
90#define ATA_SS_DET_PHY_OFFLINE 0x00000004
91
92#define ATA_SS_SPD_MASK 0x000000f0
93#define ATA_SS_SPD_NO_SPEED 0x00000000
94#define ATA_SS_SPD_GEN1 0x00000010
95#define ATA_SS_SPD_GEN2 0x00000020
96#define ATA_SS_SPD_GEN3 0x00000040
97
98#define ATA_SS_IPM_MASK 0x00000f00
99#define ATA_SS_IPM_NO_DEVICE 0x00000000
100#define ATA_SS_IPM_ACTIVE 0x00000100
101#define ATA_SS_IPM_PARTIAL 0x00000200
102#define ATA_SS_IPM_SLUMBER 0x00000600
103
104#define ATA_SERROR 14
105#define ATA_SE_DATA_CORRECTED 0x00000001
106#define ATA_SE_COMM_CORRECTED 0x00000002
107#define ATA_SE_DATA_ERR 0x00000100
108#define ATA_SE_COMM_ERR 0x00000200
109#define ATA_SE_PROT_ERR 0x00000400
110#define ATA_SE_HOST_ERR 0x00000800
111#define ATA_SE_PHY_CHANGED 0x00010000
112#define ATA_SE_PHY_IERROR 0x00020000
113#define ATA_SE_COMM_WAKE 0x00040000
114#define ATA_SE_DECODE_ERR 0x00080000
115#define ATA_SE_PARITY_ERR 0x00100000
116#define ATA_SE_CRC_ERR 0x00200000
117#define ATA_SE_HANDSHAKE_ERR 0x00400000
118#define ATA_SE_LINKSEQ_ERR 0x00800000
119#define ATA_SE_TRANSPORT_ERR 0x01000000
120#define ATA_SE_UNKNOWN_FIS 0x02000000
121
122#define ATA_SCONTROL 15
123#define ATA_SC_DET_MASK 0x0000000f
124#define ATA_SC_DET_IDLE 0x00000000
125#define ATA_SC_DET_RESET 0x00000001
126#define ATA_SC_DET_DISABLE 0x00000004
127
128#define ATA_SC_SPD_MASK 0x000000f0
129#define ATA_SC_SPD_NO_SPEED 0x00000000
130#define ATA_SC_SPD_SPEED_GEN1 0x00000010
131#define ATA_SC_SPD_SPEED_GEN2 0x00000020
132#define ATA_SC_SPD_SPEED_GEN3 0x00000040
133
134#define ATA_SC_IPM_MASK 0x00000f00
135#define ATA_SC_IPM_NONE 0x00000000
136#define ATA_SC_IPM_DIS_PARTIAL 0x00000100
137#define ATA_SC_IPM_DIS_SLUMBER 0x00000200
138
139#define ATA_SACTIVE 16
140
141#define AHCI_MAX_PORTS 32
142#define AHCI_MAX_SLOTS 32
143
144/* SATA AHCI v1.0 register defines */
145#define AHCI_CAP 0x00
146#define AHCI_CAP_NPMASK 0x0000001f
147#define AHCI_CAP_SXS 0x00000020
148#define AHCI_CAP_EMS 0x00000040
149#define AHCI_CAP_CCCS 0x00000080
150#define AHCI_CAP_NCS 0x00001F00
151#define AHCI_CAP_NCS_SHIFT 8
152#define AHCI_CAP_PSC 0x00002000
153#define AHCI_CAP_SSC 0x00004000
154#define AHCI_CAP_PMD 0x00008000
155#define AHCI_CAP_FBSS 0x00010000
156#define AHCI_CAP_SPM 0x00020000
157#define AHCI_CAP_SAM 0x00080000
158#define AHCI_CAP_ISS 0x00F00000
159#define AHCI_CAP_ISS_SHIFT 20
160#define AHCI_CAP_SCLO 0x01000000
161#define AHCI_CAP_SAL 0x02000000
162#define AHCI_CAP_SALP 0x04000000
163#define AHCI_CAP_SSS 0x08000000
164#define AHCI_CAP_SMPS 0x10000000
165#define AHCI_CAP_SSNTF 0x20000000
166#define AHCI_CAP_SNCQ 0x40000000
167#define AHCI_CAP_64BIT 0x80000000
168
169#define AHCI_GHC 0x04
170#define AHCI_GHC_AE 0x80000000
171#define AHCI_GHC_MRSM 0x00000004
172#define AHCI_GHC_IE 0x00000002
173#define AHCI_GHC_HR 0x00000001
174
175#define AHCI_IS 0x08
176#define AHCI_PI 0x0c
177#define AHCI_VS 0x10
178
179#define AHCI_CCCC 0x14
180#define AHCI_CCCC_TV_MASK 0xffff0000
181#define AHCI_CCCC_TV_SHIFT 16
182#define AHCI_CCCC_CC_MASK 0x0000ff00
183#define AHCI_CCCC_CC_SHIFT 8
184#define AHCI_CCCC_INT_MASK 0x000000f8
185#define AHCI_CCCC_INT_SHIFT 3
186#define AHCI_CCCC_EN 0x00000001
187#define AHCI_CCCP 0x18
188
189#define AHCI_CAP2 0x24
190#define AHCI_CAP2_BOH 0x00000001
191#define AHCI_CAP2_NVMP 0x00000002
192#define AHCI_CAP2_APST 0x00000004
193
194#define AHCI_OFFSET 0x100
195#define AHCI_STEP 0x80
196
197#define AHCI_P_CLB 0x00
198#define AHCI_P_CLBU 0x04
199#define AHCI_P_FB 0x08
200#define AHCI_P_FBU 0x0c
201#define AHCI_P_IS 0x10
202#define AHCI_P_IE 0x14
203#define AHCI_P_IX_DHR 0x00000001
204#define AHCI_P_IX_PS 0x00000002
205#define AHCI_P_IX_DS 0x00000004
206#define AHCI_P_IX_SDB 0x00000008
207#define AHCI_P_IX_UF 0x00000010
208#define AHCI_P_IX_DP 0x00000020
209#define AHCI_P_IX_PC 0x00000040
210#define AHCI_P_IX_DI 0x00000080
211
212#define AHCI_P_IX_PRC 0x00400000
213#define AHCI_P_IX_IPM 0x00800000
214#define AHCI_P_IX_OF 0x01000000
215#define AHCI_P_IX_INF 0x04000000
216#define AHCI_P_IX_IF 0x08000000
217#define AHCI_P_IX_HBD 0x10000000
218#define AHCI_P_IX_HBF 0x20000000
219#define AHCI_P_IX_TFE 0x40000000
220#define AHCI_P_IX_CPD 0x80000000
221
222#define AHCI_P_CMD 0x18
223#define AHCI_P_CMD_ST 0x00000001
224#define AHCI_P_CMD_SUD 0x00000002
225#define AHCI_P_CMD_POD 0x00000004
226#define AHCI_P_CMD_CLO 0x00000008
227#define AHCI_P_CMD_FRE 0x00000010
228#define AHCI_P_CMD_CCS_MASK 0x00001f00
229#define AHCI_P_CMD_CCS_SHIFT 8
230#define AHCI_P_CMD_ISS 0x00002000
231#define AHCI_P_CMD_FR 0x00004000
232#define AHCI_P_CMD_CR 0x00008000
233#define AHCI_P_CMD_CPS 0x00010000
234#define AHCI_P_CMD_PMA 0x00020000
235#define AHCI_P_CMD_HPCP 0x00040000
236#define AHCI_P_CMD_ISP 0x00080000
237#define AHCI_P_CMD_CPD 0x00100000
238#define AHCI_P_CMD_ATAPI 0x01000000
239#define AHCI_P_CMD_DLAE 0x02000000
240#define AHCI_P_CMD_ALPE 0x04000000
241#define AHCI_P_CMD_ASP 0x08000000
242#define AHCI_P_CMD_ICC_MASK 0xf0000000
243#define AHCI_P_CMD_NOOP 0x00000000
244#define AHCI_P_CMD_ACTIVE 0x10000000
245#define AHCI_P_CMD_PARTIAL 0x20000000
246#define AHCI_P_CMD_SLUMBER 0x60000000
247
248#define AHCI_P_TFD 0x20
249#define AHCI_P_SIG 0x24
250#define AHCI_P_SSTS 0x28
251#define AHCI_P_SCTL 0x2c
252#define AHCI_P_SERR 0x30
253#define AHCI_P_SACT 0x34
254#define AHCI_P_CI 0x38
255#define AHCI_P_SNTF 0x3C
256#define AHCI_P_FBS 0x40
257
258/* Just to be sure, if building as module. */
259#if MAXPHYS < 512 * 1024
260#undef MAXPHYS
261#define MAXPHYS 512 * 1024
262#endif
263/* Pessimistic prognosis on number of required S/G entries */
264#define AHCI_SG_ENTRIES (roundup(btoc(MAXPHYS) + 1, 8))
265/* Command list. 32 commands. First, 1Kbyte aligned. */
266#define AHCI_CL_OFFSET 0
267#define AHCI_CL_SIZE 32
268/* Command tables. Up to 32 commands, Each, 128byte aligned. */
269#define AHCI_CT_OFFSET (AHCI_CL_OFFSET + AHCI_CL_SIZE * AHCI_MAX_SLOTS)
270#define AHCI_CT_SIZE (128 + AHCI_SG_ENTRIES * 16)
271/* Total main work area. */
272#define AHCI_WORK_SIZE (AHCI_CT_OFFSET + AHCI_CT_SIZE * ch->numslots)
273
274struct ahci_dma_prd {
275 u_int64_t dba;
276 u_int32_t reserved;
277 u_int32_t dbc; /* 0 based */
278#define AHCI_PRD_MASK 0x003fffff /* max 4MB */
279#define AHCI_PRD_MAX (AHCI_PRD_MASK + 1)
280#define AHCI_PRD_IPC (1 << 31)
281} __packed;
282
283struct ahci_cmd_tab {
284 u_int8_t cfis[64];
285 u_int8_t acmd[32];
286 u_int8_t reserved[32];
287 struct ahci_dma_prd prd_tab[AHCI_SG_ENTRIES];
288} __packed;
289
290struct ahci_cmd_list {
291 u_int16_t cmd_flags;
292#define AHCI_CMD_ATAPI 0x0020
293#define AHCI_CMD_WRITE 0x0040
294#define AHCI_CMD_PREFETCH 0x0080
295#define AHCI_CMD_RESET 0x0100
296#define AHCI_CMD_BIST 0x0200
297#define AHCI_CMD_CLR_BUSY 0x0400
298
299 u_int16_t prd_length; /* PRD entries */
300 u_int32_t bytecount;
301 u_int64_t cmd_table_phys; /* 128byte aligned */
302} __packed;
303
304/* misc defines */
305#define ATA_IRQ_RID 0
306#define ATA_INTR_FLAGS (INTR_MPSAFE|INTR_TYPE_BIO|INTR_ENTROPY)
307
308struct ata_dmaslot {
309 bus_dmamap_t data_map; /* data DMA map */
310 int nsegs; /* Number of segs loaded */
311};
312
313/* structure holding DMA related information */
314struct ata_dma {
315 bus_dma_tag_t work_tag; /* workspace DMA tag */
316 bus_dmamap_t work_map; /* workspace DMA map */
317 uint8_t *work; /* workspace */
318 bus_addr_t work_bus; /* bus address of work */
319 bus_dma_tag_t rfis_tag; /* RFIS list DMA tag */
320 bus_dmamap_t rfis_map; /* RFIS list DMA map */
321 uint8_t *rfis; /* FIS receive area */
322 bus_addr_t rfis_bus; /* bus address of rfis */
323 bus_dma_tag_t data_tag; /* data DMA tag */
324 u_int64_t max_address; /* highest DMA'able address */
325};
326
327enum ahci_slot_states {
328 AHCI_SLOT_EMPTY,
329 AHCI_SLOT_LOADING,
330 AHCI_SLOT_RUNNING,
331 AHCI_SLOT_EXECUTING
332};
333
334struct ahci_slot {
335 device_t dev; /* Device handle */
336 u_int8_t slot; /* Number of this slot */
337 enum ahci_slot_states state; /* Slot state */
338 union ccb *ccb; /* CCB occupying slot */
339 struct ata_dmaslot dma; /* DMA data of this slot */
340 struct callout timeout; /* Execution timeout */
341};
342
343struct ahci_device {
344 u_int revision;
345 int mode;
346 u_int bytecount;
347 u_int tags;
348};
349
343/* structure describing an ATA channel */
344struct ahci_channel {
345 device_t dev; /* Device handle */
346 int unit; /* Physical channel */
347 struct resource *r_mem; /* Memory of this channel */
348 struct resource *r_irq; /* Interrupt of this channel */
349 void *ih; /* Interrupt handle */
350 struct ata_dma dma; /* DMA data */
351 struct cam_sim *sim;
352 struct cam_path *path;
353 uint32_t caps; /* Controller capabilities */
354 uint32_t caps2; /* Controller capabilities */
355 int quirks;
356 int numslots; /* Number of present slots */
357 int pm_level; /* power management level */
358 int sata_rev; /* Maximum allowed SATA generation */
359
360 struct ahci_slot slot[AHCI_MAX_SLOTS];
361 union ccb *hold[AHCI_MAX_SLOTS];
362 struct mtx mtx; /* state lock */
363 int devices; /* What is present */
364 int pm_present; /* PM presence reported */
350/* structure describing an ATA channel */
351struct ahci_channel {
352 device_t dev; /* Device handle */
353 int unit; /* Physical channel */
354 struct resource *r_mem; /* Memory of this channel */
355 struct resource *r_irq; /* Interrupt of this channel */
356 void *ih; /* Interrupt handle */
357 struct ata_dma dma; /* DMA data */
358 struct cam_sim *sim;
359 struct cam_path *path;
360 uint32_t caps; /* Controller capabilities */
361 uint32_t caps2; /* Controller capabilities */
362 int quirks;
363 int numslots; /* Number of present slots */
364 int pm_level; /* power management level */
365 int sata_rev; /* Maximum allowed SATA generation */
366
367 struct ahci_slot slot[AHCI_MAX_SLOTS];
368 union ccb *hold[AHCI_MAX_SLOTS];
369 struct mtx mtx; /* state lock */
370 int devices; /* What is present */
371 int pm_present; /* PM presence reported */
372 uint32_t oslots; /* Occupied slots */
365 uint32_t rslots; /* Running slots */
366 uint32_t aslots; /* Slots with atomic commands */
367 int numrslots; /* Number of running slots */
368 int numtslots; /* Number of tagged slots */
369 int readlog; /* Our READ LOG active */
370 int fatalerr; /* Fatal error happend */
371 int lastslot; /* Last used slot */
372 int taggedtarget; /* Last tagged target */
373 union ccb *frozen; /* Frozen command */
374 struct callout pm_timer; /* Power management events */
373 uint32_t rslots; /* Running slots */
374 uint32_t aslots; /* Slots with atomic commands */
375 int numrslots; /* Number of running slots */
376 int numtslots; /* Number of tagged slots */
377 int readlog; /* Our READ LOG active */
378 int fatalerr; /* Fatal error happend */
379 int lastslot; /* Last used slot */
380 int taggedtarget; /* Last tagged target */
381 union ccb *frozen; /* Frozen command */
382 struct callout pm_timer; /* Power management events */
383
384 struct ahci_device user[16]; /* User-specified settings */
385 struct ahci_device curr[16]; /* Current settings */
375};
376
377/* structure describing a AHCI controller */
378struct ahci_controller {
379 device_t dev;
380 int r_rid;
381 struct resource *r_mem;
382 struct rman sc_iomem;
383 struct ahci_controller_irq {
384 struct ahci_controller *ctlr;
385 struct resource *r_irq;
386 void *handle;
387 int r_irq_rid;
388 int mode;
389#define AHCI_IRQ_MODE_ALL 0
390#define AHCI_IRQ_MODE_AFTER 1
391#define AHCI_IRQ_MODE_ONE 2
392 } irqs[16];
393 uint32_t caps; /* Controller capabilities */
394 uint32_t caps2; /* Controller capabilities */
395 int quirks;
396 int numirqs;
397 int channels;
398 int ichannels;
399 int ccc; /* CCC timeout */
400 int cccv; /* CCC vector */
401 struct {
402 void (*function)(void *);
403 void *argument;
404 } interrupt[AHCI_MAX_PORTS];
405};
406
407enum ahci_err_type {
408 AHCI_ERR_NONE, /* No error */
409 AHCI_ERR_INVALID, /* Error detected by us before submitting. */
410 AHCI_ERR_INNOCENT, /* Innocent victim. */
411 AHCI_ERR_TFE, /* Task File Error. */
412 AHCI_ERR_SATA, /* SATA error. */
413 AHCI_ERR_TIMEOUT, /* Command execution timeout. */
414 AHCI_ERR_NCQ, /* NCQ command error. CCB should be put on hold
415 * until READ LOG executed to reveal error. */
416};
417
418/* macros to hide busspace uglyness */
419#define ATA_INB(res, offset) \
420 bus_read_1((res), (offset))
421#define ATA_INW(res, offset) \
422 bus_read_2((res), (offset))
423#define ATA_INL(res, offset) \
424 bus_read_4((res), (offset))
425#define ATA_INSW(res, offset, addr, count) \
426 bus_read_multi_2((res), (offset), (addr), (count))
427#define ATA_INSW_STRM(res, offset, addr, count) \
428 bus_read_multi_stream_2((res), (offset), (addr), (count))
429#define ATA_INSL(res, offset, addr, count) \
430 bus_read_multi_4((res), (offset), (addr), (count))
431#define ATA_INSL_STRM(res, offset, addr, count) \
432 bus_read_multi_stream_4((res), (offset), (addr), (count))
433#define ATA_OUTB(res, offset, value) \
434 bus_write_1((res), (offset), (value))
435#define ATA_OUTW(res, offset, value) \
436 bus_write_2((res), (offset), (value))
437#define ATA_OUTL(res, offset, value) \
438 bus_write_4((res), (offset), (value))
439#define ATA_OUTSW(res, offset, addr, count) \
440 bus_write_multi_2((res), (offset), (addr), (count))
441#define ATA_OUTSW_STRM(res, offset, addr, count) \
442 bus_write_multi_stream_2((res), (offset), (addr), (count))
443#define ATA_OUTSL(res, offset, addr, count) \
444 bus_write_multi_4((res), (offset), (addr), (count))
445#define ATA_OUTSL_STRM(res, offset, addr, count) \
446 bus_write_multi_stream_4((res), (offset), (addr), (count))
386};
387
388/* structure describing a AHCI controller */
389struct ahci_controller {
390 device_t dev;
391 int r_rid;
392 struct resource *r_mem;
393 struct rman sc_iomem;
394 struct ahci_controller_irq {
395 struct ahci_controller *ctlr;
396 struct resource *r_irq;
397 void *handle;
398 int r_irq_rid;
399 int mode;
400#define AHCI_IRQ_MODE_ALL 0
401#define AHCI_IRQ_MODE_AFTER 1
402#define AHCI_IRQ_MODE_ONE 2
403 } irqs[16];
404 uint32_t caps; /* Controller capabilities */
405 uint32_t caps2; /* Controller capabilities */
406 int quirks;
407 int numirqs;
408 int channels;
409 int ichannels;
410 int ccc; /* CCC timeout */
411 int cccv; /* CCC vector */
412 struct {
413 void (*function)(void *);
414 void *argument;
415 } interrupt[AHCI_MAX_PORTS];
416};
417
418enum ahci_err_type {
419 AHCI_ERR_NONE, /* No error */
420 AHCI_ERR_INVALID, /* Error detected by us before submitting. */
421 AHCI_ERR_INNOCENT, /* Innocent victim. */
422 AHCI_ERR_TFE, /* Task File Error. */
423 AHCI_ERR_SATA, /* SATA error. */
424 AHCI_ERR_TIMEOUT, /* Command execution timeout. */
425 AHCI_ERR_NCQ, /* NCQ command error. CCB should be put on hold
426 * until READ LOG executed to reveal error. */
427};
428
429/* macros to hide busspace uglyness */
430#define ATA_INB(res, offset) \
431 bus_read_1((res), (offset))
432#define ATA_INW(res, offset) \
433 bus_read_2((res), (offset))
434#define ATA_INL(res, offset) \
435 bus_read_4((res), (offset))
436#define ATA_INSW(res, offset, addr, count) \
437 bus_read_multi_2((res), (offset), (addr), (count))
438#define ATA_INSW_STRM(res, offset, addr, count) \
439 bus_read_multi_stream_2((res), (offset), (addr), (count))
440#define ATA_INSL(res, offset, addr, count) \
441 bus_read_multi_4((res), (offset), (addr), (count))
442#define ATA_INSL_STRM(res, offset, addr, count) \
443 bus_read_multi_stream_4((res), (offset), (addr), (count))
444#define ATA_OUTB(res, offset, value) \
445 bus_write_1((res), (offset), (value))
446#define ATA_OUTW(res, offset, value) \
447 bus_write_2((res), (offset), (value))
448#define ATA_OUTL(res, offset, value) \
449 bus_write_4((res), (offset), (value))
450#define ATA_OUTSW(res, offset, addr, count) \
451 bus_write_multi_2((res), (offset), (addr), (count))
452#define ATA_OUTSW_STRM(res, offset, addr, count) \
453 bus_write_multi_stream_2((res), (offset), (addr), (count))
454#define ATA_OUTSL(res, offset, addr, count) \
455 bus_write_multi_4((res), (offset), (addr), (count))
456#define ATA_OUTSL_STRM(res, offset, addr, count) \
457 bus_write_multi_stream_4((res), (offset), (addr), (count))