xref: /openbmc/linux/drivers/ata/ahci.h (revision 96d3c5a7d20ec546e44695983fe0508c6f904248)
1c82ee6d3SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
2365cfa1eSAnton Vorontsov /*
3365cfa1eSAnton Vorontsov  *  ahci.h - Common AHCI SATA definitions and declarations
4365cfa1eSAnton Vorontsov  *
58c3d3d4bSTejun Heo  *  Maintained by:  Tejun Heo <tj@kernel.org>
6365cfa1eSAnton Vorontsov  *    		    Please ALWAYS copy linux-ide@vger.kernel.org
7365cfa1eSAnton Vorontsov  *		    on emails.
8365cfa1eSAnton Vorontsov  *
9365cfa1eSAnton Vorontsov  *  Copyright 2004-2005 Red Hat, Inc.
10365cfa1eSAnton Vorontsov  *
11365cfa1eSAnton Vorontsov  * libata documentation is available via 'make {ps|pdf}docs',
129bb9a39cSMauro Carvalho Chehab  * as Documentation/driver-api/libata.rst
13365cfa1eSAnton Vorontsov  *
14365cfa1eSAnton Vorontsov  * AHCI hardware documentation:
15365cfa1eSAnton Vorontsov  * http://www.intel.com/technology/serialata/pdf/rev1_0.pdf
16365cfa1eSAnton Vorontsov  * http://www.intel.com/technology/serialata/pdf/rev1_1.pdf
17365cfa1eSAnton Vorontsov  */
18365cfa1eSAnton Vorontsov 
19365cfa1eSAnton Vorontsov #ifndef _AHCI_H
20365cfa1eSAnton Vorontsov #define _AHCI_H
21365cfa1eSAnton Vorontsov 
22f893180bSDan Williams #include <linux/pci.h>
23f1e70c2cSViresh Kumar #include <linux/clk.h>
24365cfa1eSAnton Vorontsov #include <linux/libata.h>
2521b5faeeSRoger Quadros #include <linux/phy/phy.h>
264b3e603aSHans de Goede #include <linux/regulator/consumer.h>
27f0778807SArnd Bergmann #include <linux/bits.h>
28365cfa1eSAnton Vorontsov 
29365cfa1eSAnton Vorontsov /* Enclosure Management Control */
30365cfa1eSAnton Vorontsov #define EM_CTRL_MSG_TYPE              0x000f0000
31365cfa1eSAnton Vorontsov 
32365cfa1eSAnton Vorontsov /* Enclosure Management LED Message Type */
33365cfa1eSAnton Vorontsov #define EM_MSG_LED_HBA_PORT           0x0000000f
34365cfa1eSAnton Vorontsov #define EM_MSG_LED_PMP_SLOT           0x0000ff00
35365cfa1eSAnton Vorontsov #define EM_MSG_LED_VALUE              0xffff0000
36365cfa1eSAnton Vorontsov #define EM_MSG_LED_VALUE_ACTIVITY     0x00070000
37365cfa1eSAnton Vorontsov #define EM_MSG_LED_VALUE_OFF          0xfff80000
38365cfa1eSAnton Vorontsov #define EM_MSG_LED_VALUE_ON           0x00010000
39365cfa1eSAnton Vorontsov 
40365cfa1eSAnton Vorontsov enum {
41365cfa1eSAnton Vorontsov 	AHCI_MAX_PORTS		= 32,
42365cfa1eSAnton Vorontsov 	AHCI_MAX_SG		= 168, /* hardware max is 64K */
43365cfa1eSAnton Vorontsov 	AHCI_DMA_BOUNDARY	= 0xffffffff,
44365cfa1eSAnton Vorontsov 	AHCI_MAX_CMDS		= 32,
45365cfa1eSAnton Vorontsov 	AHCI_CMD_SZ		= 32,
46365cfa1eSAnton Vorontsov 	AHCI_CMD_SLOT_SZ	= AHCI_MAX_CMDS * AHCI_CMD_SZ,
47365cfa1eSAnton Vorontsov 	AHCI_RX_FIS_SZ		= 256,
48365cfa1eSAnton Vorontsov 	AHCI_CMD_TBL_CDB	= 0x40,
49365cfa1eSAnton Vorontsov 	AHCI_CMD_TBL_HDR_SZ	= 0x80,
50365cfa1eSAnton Vorontsov 	AHCI_CMD_TBL_SZ		= AHCI_CMD_TBL_HDR_SZ + (AHCI_MAX_SG * 16),
51365cfa1eSAnton Vorontsov 	AHCI_CMD_TBL_AR_SZ	= AHCI_CMD_TBL_SZ * AHCI_MAX_CMDS,
52365cfa1eSAnton Vorontsov 	AHCI_PORT_PRIV_DMA_SZ	= AHCI_CMD_SLOT_SZ + AHCI_CMD_TBL_AR_SZ +
53365cfa1eSAnton Vorontsov 				  AHCI_RX_FIS_SZ,
54365cfa1eSAnton Vorontsov 	AHCI_PORT_PRIV_FBS_DMA_SZ	= AHCI_CMD_SLOT_SZ +
55365cfa1eSAnton Vorontsov 					  AHCI_CMD_TBL_AR_SZ +
56365cfa1eSAnton Vorontsov 					  (AHCI_RX_FIS_SZ * 16),
57f0778807SArnd Bergmann 	AHCI_IRQ_ON_SG		= BIT(31),
58f0778807SArnd Bergmann 	AHCI_CMD_ATAPI		= BIT(5),
59f0778807SArnd Bergmann 	AHCI_CMD_WRITE		= BIT(6),
60f0778807SArnd Bergmann 	AHCI_CMD_PREFETCH	= BIT(7),
61f0778807SArnd Bergmann 	AHCI_CMD_RESET		= BIT(8),
62f0778807SArnd Bergmann 	AHCI_CMD_CLR_BUSY	= BIT(10),
63365cfa1eSAnton Vorontsov 
646ad60195STejun Heo 	RX_FIS_PIO_SETUP	= 0x20,	/* offset of PIO Setup FIS data */
65365cfa1eSAnton Vorontsov 	RX_FIS_D2H_REG		= 0x40,	/* offset of D2H Register FIS data */
66365cfa1eSAnton Vorontsov 	RX_FIS_SDB		= 0x58, /* offset of SDB FIS data */
67365cfa1eSAnton Vorontsov 	RX_FIS_UNK		= 0x60, /* offset of Unknown FIS data */
68365cfa1eSAnton Vorontsov 
69365cfa1eSAnton Vorontsov 	/* global controller registers */
70365cfa1eSAnton Vorontsov 	HOST_CAP		= 0x00, /* host capabilities */
71365cfa1eSAnton Vorontsov 	HOST_CTL		= 0x04, /* global host control */
72365cfa1eSAnton Vorontsov 	HOST_IRQ_STAT		= 0x08, /* interrupt status */
73365cfa1eSAnton Vorontsov 	HOST_PORTS_IMPL		= 0x0c, /* bitmap of implemented ports */
74365cfa1eSAnton Vorontsov 	HOST_VERSION		= 0x10, /* AHCI spec. version compliancy */
75365cfa1eSAnton Vorontsov 	HOST_EM_LOC		= 0x1c, /* Enclosure Management location */
76365cfa1eSAnton Vorontsov 	HOST_EM_CTL		= 0x20, /* Enclosure Management Control */
77365cfa1eSAnton Vorontsov 	HOST_CAP2		= 0x24, /* host capabilities, extended */
78365cfa1eSAnton Vorontsov 
79365cfa1eSAnton Vorontsov 	/* HOST_CTL bits */
80f0778807SArnd Bergmann 	HOST_RESET		= BIT(0),  /* reset controller; self-clear */
81f0778807SArnd Bergmann 	HOST_IRQ_EN		= BIT(1),  /* global IRQ enable */
82f0778807SArnd Bergmann 	HOST_MRSM		= BIT(2),  /* MSI Revert to Single Message */
83f0778807SArnd Bergmann 	HOST_AHCI_EN		= BIT(31), /* AHCI enabled */
84365cfa1eSAnton Vorontsov 
85365cfa1eSAnton Vorontsov 	/* HOST_CAP bits */
86f0778807SArnd Bergmann 	HOST_CAP_SXS		= BIT(5),  /* Supports External SATA */
87f0778807SArnd Bergmann 	HOST_CAP_EMS		= BIT(6),  /* Enclosure Management support */
88f0778807SArnd Bergmann 	HOST_CAP_CCC		= BIT(7),  /* Command Completion Coalescing */
89f0778807SArnd Bergmann 	HOST_CAP_PART		= BIT(13), /* Partial state capable */
90f0778807SArnd Bergmann 	HOST_CAP_SSC		= BIT(14), /* Slumber state capable */
91f0778807SArnd Bergmann 	HOST_CAP_PIO_MULTI	= BIT(15), /* PIO multiple DRQ support */
92f0778807SArnd Bergmann 	HOST_CAP_FBS		= BIT(16), /* FIS-based switching support */
93f0778807SArnd Bergmann 	HOST_CAP_PMP		= BIT(17), /* Port Multiplier support */
94f0778807SArnd Bergmann 	HOST_CAP_ONLY		= BIT(18), /* Supports AHCI mode only */
95f0778807SArnd Bergmann 	HOST_CAP_CLO		= BIT(24), /* Command List Override support */
96f0778807SArnd Bergmann 	HOST_CAP_LED		= BIT(25), /* Supports activity LED */
97f0778807SArnd Bergmann 	HOST_CAP_ALPM		= BIT(26), /* Aggressive Link PM support */
98f0778807SArnd Bergmann 	HOST_CAP_SSS		= BIT(27), /* Staggered Spin-up */
99f0778807SArnd Bergmann 	HOST_CAP_MPS		= BIT(28), /* Mechanical presence switch */
100f0778807SArnd Bergmann 	HOST_CAP_SNTF		= BIT(29), /* SNotification register */
101f0778807SArnd Bergmann 	HOST_CAP_NCQ		= BIT(30), /* Native Command Queueing */
102f0778807SArnd Bergmann 	HOST_CAP_64		= BIT(31), /* PCI DAC (64-bit DMA) support */
103365cfa1eSAnton Vorontsov 
104365cfa1eSAnton Vorontsov 	/* HOST_CAP2 bits */
105f0778807SArnd Bergmann 	HOST_CAP2_BOH		= BIT(0),  /* BIOS/OS handoff supported */
106f0778807SArnd Bergmann 	HOST_CAP2_NVMHCI	= BIT(1),  /* NVMHCI supported */
107f0778807SArnd Bergmann 	HOST_CAP2_APST		= BIT(2),  /* Automatic partial to slumber */
108f0778807SArnd Bergmann 	HOST_CAP2_SDS		= BIT(3),  /* Support device sleep */
109f0778807SArnd Bergmann 	HOST_CAP2_SADM		= BIT(4),  /* Support aggressive DevSlp */
110f0778807SArnd Bergmann 	HOST_CAP2_DESO		= BIT(5),  /* DevSlp from slumber only */
111365cfa1eSAnton Vorontsov 
112365cfa1eSAnton Vorontsov 	/* registers for each SATA port */
113365cfa1eSAnton Vorontsov 	PORT_LST_ADDR		= 0x00, /* command list DMA addr */
114365cfa1eSAnton Vorontsov 	PORT_LST_ADDR_HI	= 0x04, /* command list DMA addr hi */
115365cfa1eSAnton Vorontsov 	PORT_FIS_ADDR		= 0x08, /* FIS rx buf addr */
116365cfa1eSAnton Vorontsov 	PORT_FIS_ADDR_HI	= 0x0c, /* FIS rx buf addr hi */
117365cfa1eSAnton Vorontsov 	PORT_IRQ_STAT		= 0x10, /* interrupt status */
118365cfa1eSAnton Vorontsov 	PORT_IRQ_MASK		= 0x14, /* interrupt enable/disable mask */
119365cfa1eSAnton Vorontsov 	PORT_CMD		= 0x18, /* port command */
120365cfa1eSAnton Vorontsov 	PORT_TFDATA		= 0x20,	/* taskfile data */
121365cfa1eSAnton Vorontsov 	PORT_SIG		= 0x24,	/* device TF signature */
122365cfa1eSAnton Vorontsov 	PORT_CMD_ISSUE		= 0x38, /* command issue */
123365cfa1eSAnton Vorontsov 	PORT_SCR_STAT		= 0x28, /* SATA phy register: SStatus */
124365cfa1eSAnton Vorontsov 	PORT_SCR_CTL		= 0x2c, /* SATA phy register: SControl */
125365cfa1eSAnton Vorontsov 	PORT_SCR_ERR		= 0x30, /* SATA phy register: SError */
126365cfa1eSAnton Vorontsov 	PORT_SCR_ACT		= 0x34, /* SATA phy register: SActive */
127365cfa1eSAnton Vorontsov 	PORT_SCR_NTF		= 0x3c, /* SATA phy register: SNotification */
128365cfa1eSAnton Vorontsov 	PORT_FBS		= 0x40, /* FIS-based Switching */
12965fe1f0fSShane Huang 	PORT_DEVSLP		= 0x44, /* device sleep */
130365cfa1eSAnton Vorontsov 
131365cfa1eSAnton Vorontsov 	/* PORT_IRQ_{STAT,MASK} bits */
132f0778807SArnd Bergmann 	PORT_IRQ_COLD_PRES	= BIT(31), /* cold presence detect */
133f0778807SArnd Bergmann 	PORT_IRQ_TF_ERR		= BIT(30), /* task file error */
134f0778807SArnd Bergmann 	PORT_IRQ_HBUS_ERR	= BIT(29), /* host bus fatal error */
135f0778807SArnd Bergmann 	PORT_IRQ_HBUS_DATA_ERR	= BIT(28), /* host bus data error */
136f0778807SArnd Bergmann 	PORT_IRQ_IF_ERR		= BIT(27), /* interface fatal error */
137f0778807SArnd Bergmann 	PORT_IRQ_IF_NONFATAL	= BIT(26), /* interface non-fatal error */
138f0778807SArnd Bergmann 	PORT_IRQ_OVERFLOW	= BIT(24), /* xfer exhausted available S/G */
139f0778807SArnd Bergmann 	PORT_IRQ_BAD_PMP	= BIT(23), /* incorrect port multiplier */
140365cfa1eSAnton Vorontsov 
141f0778807SArnd Bergmann 	PORT_IRQ_PHYRDY		= BIT(22), /* PhyRdy changed */
142f0778807SArnd Bergmann 	PORT_IRQ_DMPS		= BIT(7),  /* mechanical presence status */
143f0778807SArnd Bergmann 	PORT_IRQ_CONNECT	= BIT(6),  /* port connect change status */
144f0778807SArnd Bergmann 	PORT_IRQ_SG_DONE	= BIT(5),  /* descriptor processed */
145f0778807SArnd Bergmann 	PORT_IRQ_UNK_FIS	= BIT(4),  /* unknown FIS rx'd */
146f0778807SArnd Bergmann 	PORT_IRQ_SDB_FIS	= BIT(3),  /* Set Device Bits FIS rx'd */
147f0778807SArnd Bergmann 	PORT_IRQ_DMAS_FIS	= BIT(2),  /* DMA Setup FIS rx'd */
148f0778807SArnd Bergmann 	PORT_IRQ_PIOS_FIS	= BIT(1),  /* PIO Setup FIS rx'd */
149f0778807SArnd Bergmann 	PORT_IRQ_D2H_REG_FIS	= BIT(0),  /* D2H Register FIS rx'd */
150365cfa1eSAnton Vorontsov 
151365cfa1eSAnton Vorontsov 	PORT_IRQ_FREEZE		= PORT_IRQ_HBUS_ERR |
152365cfa1eSAnton Vorontsov 				  PORT_IRQ_IF_ERR |
153365cfa1eSAnton Vorontsov 				  PORT_IRQ_CONNECT |
154365cfa1eSAnton Vorontsov 				  PORT_IRQ_PHYRDY |
155365cfa1eSAnton Vorontsov 				  PORT_IRQ_UNK_FIS |
156365cfa1eSAnton Vorontsov 				  PORT_IRQ_BAD_PMP,
157365cfa1eSAnton Vorontsov 	PORT_IRQ_ERROR		= PORT_IRQ_FREEZE |
158365cfa1eSAnton Vorontsov 				  PORT_IRQ_TF_ERR |
159365cfa1eSAnton Vorontsov 				  PORT_IRQ_HBUS_DATA_ERR,
160365cfa1eSAnton Vorontsov 	DEF_PORT_IRQ		= PORT_IRQ_ERROR | PORT_IRQ_SG_DONE |
161365cfa1eSAnton Vorontsov 				  PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS |
162365cfa1eSAnton Vorontsov 				  PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS,
163365cfa1eSAnton Vorontsov 
164365cfa1eSAnton Vorontsov 	/* PORT_CMD bits */
165f0778807SArnd Bergmann 	PORT_CMD_ASP		= BIT(27), /* Aggressive Slumber/Partial */
166f0778807SArnd Bergmann 	PORT_CMD_ALPE		= BIT(26), /* Aggressive Link PM enable */
167f0778807SArnd Bergmann 	PORT_CMD_ATAPI		= BIT(24), /* Device is ATAPI */
168f0778807SArnd Bergmann 	PORT_CMD_FBSCP		= BIT(22), /* FBS Capable Port */
169f0778807SArnd Bergmann 	PORT_CMD_ESP		= BIT(21), /* External Sata Port */
170f0778807SArnd Bergmann 	PORT_CMD_CPD		= BIT(20), /* Cold Presence Detection */
171f0778807SArnd Bergmann 	PORT_CMD_MPSP		= BIT(19), /* Mechanical Presence Switch */
172f0778807SArnd Bergmann 	PORT_CMD_HPCP		= BIT(18), /* HotPlug Capable Port */
173f0778807SArnd Bergmann 	PORT_CMD_PMP		= BIT(17), /* PMP attached */
174f0778807SArnd Bergmann 	PORT_CMD_LIST_ON	= BIT(15), /* cmd list DMA engine running */
175f0778807SArnd Bergmann 	PORT_CMD_FIS_ON		= BIT(14), /* FIS DMA engine running */
176f0778807SArnd Bergmann 	PORT_CMD_FIS_RX		= BIT(4),  /* Enable FIS receive DMA engine */
177f0778807SArnd Bergmann 	PORT_CMD_CLO		= BIT(3),  /* Command list override */
178f0778807SArnd Bergmann 	PORT_CMD_POWER_ON	= BIT(2),  /* Power up device */
179f0778807SArnd Bergmann 	PORT_CMD_SPIN_UP	= BIT(1),  /* Spin up device */
180f0778807SArnd Bergmann 	PORT_CMD_START		= BIT(0),  /* Enable port DMA engine */
181365cfa1eSAnton Vorontsov 
182f0778807SArnd Bergmann 	PORT_CMD_ICC_MASK	= (0xfu << 28), /* i/f ICC state mask */
183f0778807SArnd Bergmann 	PORT_CMD_ICC_ACTIVE	= (0x1u << 28), /* Put i/f in active state */
184f0778807SArnd Bergmann 	PORT_CMD_ICC_PARTIAL	= (0x2u << 28), /* Put i/f in partial state */
185f0778807SArnd Bergmann 	PORT_CMD_ICC_SLUMBER	= (0x6u << 28), /* Put i/f in slumber state */
186365cfa1eSAnton Vorontsov 
187eb7cae0bSSerge Semin 	/* PORT_CMD capabilities mask */
188eb7cae0bSSerge Semin 	PORT_CMD_CAP		= PORT_CMD_HPCP | PORT_CMD_MPSP |
189eb7cae0bSSerge Semin 				  PORT_CMD_CPD | PORT_CMD_ESP | PORT_CMD_FBSCP,
190eb7cae0bSSerge Semin 
19165fe1f0fSShane Huang 	/* PORT_FBS bits */
192365cfa1eSAnton Vorontsov 	PORT_FBS_DWE_OFFSET	= 16, /* FBS device with error offset */
193365cfa1eSAnton Vorontsov 	PORT_FBS_ADO_OFFSET	= 12, /* FBS active dev optimization offset */
194365cfa1eSAnton Vorontsov 	PORT_FBS_DEV_OFFSET	= 8,  /* FBS device to issue offset */
195365cfa1eSAnton Vorontsov 	PORT_FBS_DEV_MASK	= (0xf << PORT_FBS_DEV_OFFSET),  /* FBS.DEV */
196f0778807SArnd Bergmann 	PORT_FBS_SDE		= BIT(2), /* FBS single device error */
197f0778807SArnd Bergmann 	PORT_FBS_DEC		= BIT(1), /* FBS device error clear */
198f0778807SArnd Bergmann 	PORT_FBS_EN		= BIT(0), /* Enable FBS */
199365cfa1eSAnton Vorontsov 
20065fe1f0fSShane Huang 	/* PORT_DEVSLP bits */
20165fe1f0fSShane Huang 	PORT_DEVSLP_DM_OFFSET	= 25,             /* DITO multiplier offset */
20265fe1f0fSShane Huang 	PORT_DEVSLP_DM_MASK	= (0xf << 25),    /* DITO multiplier mask */
20365fe1f0fSShane Huang 	PORT_DEVSLP_DITO_OFFSET	= 15,             /* DITO offset */
20465fe1f0fSShane Huang 	PORT_DEVSLP_MDAT_OFFSET	= 10,             /* Minimum assertion time */
20565fe1f0fSShane Huang 	PORT_DEVSLP_DETO_OFFSET	= 2,              /* DevSlp exit timeout */
206f0778807SArnd Bergmann 	PORT_DEVSLP_DSP		= BIT(1),         /* DevSlp present */
207f0778807SArnd Bergmann 	PORT_DEVSLP_ADSE	= BIT(0),         /* Aggressive DevSlp enable */
20865fe1f0fSShane Huang 
209365cfa1eSAnton Vorontsov 	/* hpriv->flags bits */
21055d5ec31SBrian Norris 
21155d5ec31SBrian Norris #define AHCI_HFLAGS(flags)		.private_data	= (void *)(flags)
21255d5ec31SBrian Norris 
213f0778807SArnd Bergmann 	AHCI_HFLAG_NO_NCQ		= BIT(0),
214f0778807SArnd Bergmann 	AHCI_HFLAG_IGN_IRQ_IF_ERR	= BIT(1), /* ignore IRQ_IF_ERR */
215f0778807SArnd Bergmann 	AHCI_HFLAG_IGN_SERR_INTERNAL	= BIT(2), /* ignore SERR_INTERNAL */
216f0778807SArnd Bergmann 	AHCI_HFLAG_32BIT_ONLY		= BIT(3), /* force 32bit */
217f0778807SArnd Bergmann 	AHCI_HFLAG_MV_PATA		= BIT(4), /* PATA port */
218f0778807SArnd Bergmann 	AHCI_HFLAG_NO_MSI		= BIT(5), /* no PCI MSI */
219f0778807SArnd Bergmann 	AHCI_HFLAG_NO_PMP		= BIT(6), /* no PMP */
220f0778807SArnd Bergmann 	AHCI_HFLAG_SECT255		= BIT(8), /* max 255 sectors */
221f0778807SArnd Bergmann 	AHCI_HFLAG_YES_NCQ		= BIT(9), /* force NCQ cap on */
222f0778807SArnd Bergmann 	AHCI_HFLAG_NO_SUSPEND		= BIT(10), /* don't suspend */
223f0778807SArnd Bergmann 	AHCI_HFLAG_SRST_TOUT_IS_OFFLINE	= BIT(11), /* treat SRST timeout as
224365cfa1eSAnton Vorontsov 						      link offline */
225f0778807SArnd Bergmann 	AHCI_HFLAG_NO_SNTF		= BIT(12), /* no sntf */
226f0778807SArnd Bergmann 	AHCI_HFLAG_NO_FPDMA_AA		= BIT(13), /* no FPDMA AA */
227f0778807SArnd Bergmann 	AHCI_HFLAG_YES_FBS		= BIT(14), /* force FBS cap on */
228f0778807SArnd Bergmann 	AHCI_HFLAG_DELAY_ENGINE		= BIT(15), /* do not start engine on
22966583c9fSBrian Norris 						      port start (wait until
23066583c9fSBrian Norris 						      error-handling stage) */
231f0778807SArnd Bergmann 	AHCI_HFLAG_NO_DEVSLP		= BIT(17), /* no device sleep */
232f0778807SArnd Bergmann 	AHCI_HFLAG_NO_FBS		= BIT(18), /* no FBS */
233d867b95fSSuman Tripathi 
234f893180bSDan Williams #ifdef CONFIG_PCI_MSI
235f0778807SArnd Bergmann 	AHCI_HFLAG_MULTI_MSI		= BIT(20), /* per-port MSI(-X) */
236f893180bSDan Williams #else
237f893180bSDan Williams 	/* compile out MSI infrastructure */
238f893180bSDan Williams 	AHCI_HFLAG_MULTI_MSI		= 0,
239f893180bSDan Williams #endif
240f0778807SArnd Bergmann 	AHCI_HFLAG_WAKE_BEFORE_STOP	= BIT(22), /* wake before DMA stop */
241f0778807SArnd Bergmann 	AHCI_HFLAG_YES_ALPM		= BIT(23), /* force ALPM cap on */
242f0778807SArnd Bergmann 	AHCI_HFLAG_NO_WRITE_TO_RO	= BIT(24), /* don't write to read
2437fab72f8SDoug Berger 						      only registers */
244f0778807SArnd Bergmann 	AHCI_HFLAG_USE_LPM_POLICY	= BIT(25), /* chipset that should use
24555b01415SMario Limonciello 						      SATA_MOBILE_LPM_POLICY
246ebb82e3cSHans de Goede 						      as default lpm_policy */
247f0778807SArnd Bergmann 	AHCI_HFLAG_SUSPEND_PHYS		= BIT(26), /* handle PHYs during
24849e54187SMiquel Raynal 						      suspend/resume */
249f0778807SArnd Bergmann 	AHCI_HFLAG_NO_SXS		= BIT(28), /* SXS not supported */
250*b0dd4d7aSLennert Buytenhek 	AHCI_HFLAG_43BIT_ONLY		= BIT(29), /* 43bit DMA addr limit */
251365cfa1eSAnton Vorontsov 
252365cfa1eSAnton Vorontsov 	/* ap->flags bits */
253365cfa1eSAnton Vorontsov 
2549cbe056fSSergei Shtylyov 	AHCI_FLAG_COMMON		= ATA_FLAG_SATA | ATA_FLAG_PIO_DMA |
2551a0f6b7eSSergei Shtylyov 					  ATA_FLAG_ACPI_SATA | ATA_FLAG_AN,
256365cfa1eSAnton Vorontsov 
257365cfa1eSAnton Vorontsov 	ICH_MAP				= 0x90, /* ICH MAP register */
258c312ef17SDan Williams 	PCS_6				= 0x92, /* 6 port PCS */
259c312ef17SDan Williams 	PCS_7				= 0x94, /* 7+ port PCS (Denverton) */
260365cfa1eSAnton Vorontsov 
261365cfa1eSAnton Vorontsov 	/* em constants */
2621e41e693SKai-Heng Feng 	EM_MAX_SLOTS			= SATA_PMP_MAX_PORTS,
263365cfa1eSAnton Vorontsov 	EM_MAX_RETRY			= 5,
264365cfa1eSAnton Vorontsov 
265365cfa1eSAnton Vorontsov 	/* em_ctl bits */
266f0778807SArnd Bergmann 	EM_CTL_RST		= BIT(9), /* Reset */
267f0778807SArnd Bergmann 	EM_CTL_TM		= BIT(8), /* Transmit Message */
268f0778807SArnd Bergmann 	EM_CTL_MR		= BIT(0), /* Message Received */
269f0778807SArnd Bergmann 	EM_CTL_ALHD		= BIT(26), /* Activity LED */
270f0778807SArnd Bergmann 	EM_CTL_XMT		= BIT(25), /* Transmit Only */
271f0778807SArnd Bergmann 	EM_CTL_SMB		= BIT(24), /* Single Message Buffer */
272f0778807SArnd Bergmann 	EM_CTL_SGPIO		= BIT(19), /* SGPIO messages supported */
273f0778807SArnd Bergmann 	EM_CTL_SES		= BIT(18), /* SES-2 messages supported */
274f0778807SArnd Bergmann 	EM_CTL_SAFTE		= BIT(17), /* SAF-TE messages supported */
275f0778807SArnd Bergmann 	EM_CTL_LED		= BIT(16), /* LED messages supported */
276008dbd61SHarry Zhang 
277008dbd61SHarry Zhang 	/* em message type */
278f0778807SArnd Bergmann 	EM_MSG_TYPE_LED		= BIT(0), /* LED */
279f0778807SArnd Bergmann 	EM_MSG_TYPE_SAFTE	= BIT(1), /* SAF-TE */
280f0778807SArnd Bergmann 	EM_MSG_TYPE_SES2	= BIT(2), /* SES-2 */
281f0778807SArnd Bergmann 	EM_MSG_TYPE_SGPIO	= BIT(3), /* SGPIO */
282365cfa1eSAnton Vorontsov };
283365cfa1eSAnton Vorontsov 
284365cfa1eSAnton Vorontsov struct ahci_cmd_hdr {
285365cfa1eSAnton Vorontsov 	__le32			opts;
286365cfa1eSAnton Vorontsov 	__le32			status;
287365cfa1eSAnton Vorontsov 	__le32			tbl_addr;
288365cfa1eSAnton Vorontsov 	__le32			tbl_addr_hi;
289365cfa1eSAnton Vorontsov 	__le32			reserved[4];
290365cfa1eSAnton Vorontsov };
291365cfa1eSAnton Vorontsov 
292365cfa1eSAnton Vorontsov struct ahci_sg {
293365cfa1eSAnton Vorontsov 	__le32			addr;
294365cfa1eSAnton Vorontsov 	__le32			addr_hi;
295365cfa1eSAnton Vorontsov 	__le32			reserved;
296365cfa1eSAnton Vorontsov 	__le32			flags_size;
297365cfa1eSAnton Vorontsov };
298365cfa1eSAnton Vorontsov 
299365cfa1eSAnton Vorontsov struct ahci_em_priv {
300365cfa1eSAnton Vorontsov 	enum sw_activity blink_policy;
301365cfa1eSAnton Vorontsov 	struct timer_list timer;
302365cfa1eSAnton Vorontsov 	unsigned long saved_activity;
303365cfa1eSAnton Vorontsov 	unsigned long activity;
304365cfa1eSAnton Vorontsov 	unsigned long led_state;
3051843594cSKees Cook 	struct ata_link *link;
306365cfa1eSAnton Vorontsov };
307365cfa1eSAnton Vorontsov 
308365cfa1eSAnton Vorontsov struct ahci_port_priv {
309365cfa1eSAnton Vorontsov 	struct ata_link		*active_link;
310365cfa1eSAnton Vorontsov 	struct ahci_cmd_hdr	*cmd_slot;
311365cfa1eSAnton Vorontsov 	dma_addr_t		cmd_slot_dma;
312365cfa1eSAnton Vorontsov 	void			*cmd_tbl;
313365cfa1eSAnton Vorontsov 	dma_addr_t		cmd_tbl_dma;
314365cfa1eSAnton Vorontsov 	void			*rx_fis;
315365cfa1eSAnton Vorontsov 	dma_addr_t		rx_fis_dma;
316365cfa1eSAnton Vorontsov 	/* for NCQ spurious interrupt analysis */
317365cfa1eSAnton Vorontsov 	unsigned int		ncq_saw_d2h:1;
318365cfa1eSAnton Vorontsov 	unsigned int		ncq_saw_dmas:1;
319365cfa1eSAnton Vorontsov 	unsigned int		ncq_saw_sdb:1;
3205ca72c4fSAlexander Gordeev 	spinlock_t		lock;		/* protects parent ata_port */
321365cfa1eSAnton Vorontsov 	u32 			intr_mask;	/* interrupts to enable */
322365cfa1eSAnton Vorontsov 	bool			fbs_supported;	/* set iff FBS is supported */
323365cfa1eSAnton Vorontsov 	bool			fbs_enabled;	/* set iff FBS is enabled */
324365cfa1eSAnton Vorontsov 	int			fbs_last_dev;	/* save FBS.DEV of last FIS */
325365cfa1eSAnton Vorontsov 	/* enclosure management info per PM slot */
326365cfa1eSAnton Vorontsov 	struct ahci_em_priv	em_priv[EM_MAX_SLOTS];
327b29900e6SAlexander Gordeev 	char			*irq_desc;	/* desc in /proc/interrupts */
328365cfa1eSAnton Vorontsov };
329365cfa1eSAnton Vorontsov 
330365cfa1eSAnton Vorontsov struct ahci_host_priv {
331725c7b57SAntoine Ténart 	/* Input fields */
332365cfa1eSAnton Vorontsov 	unsigned int		flags;		/* AHCI_HFLAG_* */
333725c7b57SAntoine Ténart 	u32			mask_port_map;	/* mask out particular bits */
334725c7b57SAntoine Ténart 
335725c7b57SAntoine Ténart 	void __iomem *		mmio;		/* bus-independent mem map */
336365cfa1eSAnton Vorontsov 	u32			cap;		/* cap to use */
337365cfa1eSAnton Vorontsov 	u32			cap2;		/* cap2 to use */
3388ea909cbSMika Westerberg 	u32			version;	/* cached version */
339365cfa1eSAnton Vorontsov 	u32			port_map;	/* port map to use */
340365cfa1eSAnton Vorontsov 	u32			saved_cap;	/* saved initial cap */
341365cfa1eSAnton Vorontsov 	u32			saved_cap2;	/* saved initial cap2 */
342365cfa1eSAnton Vorontsov 	u32			saved_port_map;	/* saved initial port_map */
34318ee7c49SSerge Semin 	u32			saved_port_cap[AHCI_MAX_PORTS]; /* saved port_cap */
344365cfa1eSAnton Vorontsov 	u32 			em_loc; /* enclosure management location */
345c0623166SHarry Zhang 	u32			em_buf_sz;	/* EM buffer size in byte */
346008dbd61SHarry Zhang 	u32			em_msg_type;	/* EM message type */
347894fba7fSKai-Heng Feng 	u32			remapped_nvme;	/* NVMe remapped device count */
348e708e46eSRoger Quadros 	bool			got_runtime_pm; /* Did we do pm_runtime_get? */
349e28b3abfSSerge Semin 	unsigned int		n_clks;
350e28b3abfSSerge Semin 	struct clk_bulk_data	*clks;		/* Optional */
351f67f12ffSSerge Semin 	unsigned int		f_rsts;
3529d2ab995SKunihiko Hayashi 	struct reset_control	*rsts;		/* Optional */
353c7d7ddeeSGregory CLEMENT 	struct regulator	**target_pwrs;	/* Optional */
354a37da918SCorentin Labbe 	struct regulator	*ahci_regulator;/* Optional */
355f20fb266SCorentin Labbe 	struct regulator	*phy_regulator;/* Optional */
356b1a9edbdSAntoine Ténart 	/*
357b1a9edbdSAntoine Ténart 	 * If platform uses PHYs. There is a 1:1 relation between the port number and
358b1a9edbdSAntoine Ténart 	 * the PHY position in this array.
359b1a9edbdSAntoine Ténart 	 */
360b1a9edbdSAntoine Ténart 	struct phy		**phys;
361b1a9edbdSAntoine Ténart 	unsigned		nports;		/* Number of ports */
362d50b110fSMark Langsdorf 	void			*plat_data;	/* Other platform data */
36321bfd1aaSRobert Richter 	unsigned int		irq;		/* interrupt line */
364039ece38SHans de Goede 	/*
365039ece38SHans de Goede 	 * Optional ahci_start_engine override, if not set this gets set to the
366039ece38SHans de Goede 	 * default ahci_start_engine during ahci_save_initial_config, this can
367039ece38SHans de Goede 	 * be overridden anytime before the host is activated.
368039ece38SHans de Goede 	 */
369039ece38SHans de Goede 	void			(*start_engine)(struct ata_port *ap);
370fa89f53bSEvan Wang 	/*
371fa89f53bSEvan Wang 	 * Optional ahci_stop_engine override, if not set this gets set to the
372fa89f53bSEvan Wang 	 * default ahci_stop_engine during ahci_save_initial_config, this can
373fa89f53bSEvan Wang 	 * be overridden anytime before the host is activated.
374fa89f53bSEvan Wang 	 */
375fa89f53bSEvan Wang 	int			(*stop_engine)(struct ata_port *ap);
376fa89f53bSEvan Wang 
377f070d671SSuman Tripathi 	irqreturn_t 		(*irq_handler)(int irq, void *dev_instance);
378365cfa1eSAnton Vorontsov 
3790b9e2988SChristoph Hellwig 	/* only required for per-port MSI(-X) support */
3800b9e2988SChristoph Hellwig 	int			(*get_irq_vector)(struct ata_host *host,
3810b9e2988SChristoph Hellwig 						  int port);
3820b9e2988SChristoph Hellwig };
383f893180bSDan Williams 
384365cfa1eSAnton Vorontsov extern int ahci_ignore_sss;
385365cfa1eSAnton Vorontsov 
386c3f69c7fSBart Van Assche extern const struct attribute_group *ahci_shost_groups[];
387c3f69c7fSBart Van Assche extern const struct attribute_group *ahci_sdev_groups[];
388fad16e7aSTejun Heo 
389018d5ef2SAkinobu Mita /*
390018d5ef2SAkinobu Mita  * This must be instantiated by the edge drivers.  Read the comments
391018d5ef2SAkinobu Mita  * for ATA_BASE_SHT
392018d5ef2SAkinobu Mita  */
393fad16e7aSTejun Heo #define AHCI_SHT(drv_name)						\
394071e86feSLee Jones 	__ATA_BASE_SHT(drv_name),					\
395e2d1f8a0SJens Axboe 	.can_queue		= AHCI_MAX_CMDS,			\
396fad16e7aSTejun Heo 	.sg_tablesize		= AHCI_MAX_SG,				\
397fad16e7aSTejun Heo 	.dma_boundary		= AHCI_DMA_BOUNDARY,			\
398c3f69c7fSBart Van Assche 	.shost_groups		= ahci_shost_groups,			\
399c3f69c7fSBart Van Assche 	.sdev_groups		= ahci_sdev_groups,			\
400071e86feSLee Jones 	.change_queue_depth     = ata_scsi_change_queue_depth,		\
401071e86feSLee Jones 	.tag_alloc_policy       = BLK_TAG_ALLOC_RR,             	\
402071e86feSLee Jones 	.slave_configure        = ata_scsi_slave_config
403fad16e7aSTejun Heo 
404365cfa1eSAnton Vorontsov extern struct ata_port_operations ahci_ops;
4058b789d89SRichard Zhu extern struct ata_port_operations ahci_platform_ops;
406345347c5SYuan-Hsin Chen extern struct ata_port_operations ahci_pmp_retry_srst_ops;
407365cfa1eSAnton Vorontsov 
408bbb4ab43SRob Herring unsigned int ahci_dev_classify(struct ata_port *ap);
40902cdfcf0SDavid Milburn void ahci_fill_cmd_slot(struct ahci_port_priv *pp, unsigned int tag,
41002cdfcf0SDavid Milburn 			u32 opts);
411365cfa1eSAnton Vorontsov void ahci_save_initial_config(struct device *dev,
412725c7b57SAntoine Ténart 			      struct ahci_host_priv *hpriv);
413365cfa1eSAnton Vorontsov void ahci_init_controller(struct ata_host *host);
414365cfa1eSAnton Vorontsov int ahci_reset_controller(struct ata_host *host);
415365cfa1eSAnton Vorontsov 
416365cfa1eSAnton Vorontsov int ahci_do_softreset(struct ata_link *link, unsigned int *class,
417365cfa1eSAnton Vorontsov 		      int pmp, unsigned long deadline,
418365cfa1eSAnton Vorontsov 		      int (*check_ready)(struct ata_link *link));
419365cfa1eSAnton Vorontsov 
420d436501eSBartosz Golaszewski int ahci_do_hardreset(struct ata_link *link, unsigned int *class,
421d436501eSBartosz Golaszewski 		      unsigned long deadline, bool *online);
422d436501eSBartosz Golaszewski 
42339e0ee99SSuman Tripathi unsigned int ahci_qc_issue(struct ata_queued_cmd *qc);
424365cfa1eSAnton Vorontsov int ahci_stop_engine(struct ata_port *ap);
42539e0ee99SSuman Tripathi void ahci_start_fis_rx(struct ata_port *ap);
426365cfa1eSAnton Vorontsov void ahci_start_engine(struct ata_port *ap);
427365cfa1eSAnton Vorontsov int ahci_check_ready(struct ata_link *link);
428365cfa1eSAnton Vorontsov int ahci_kick_engine(struct ata_port *ap);
42902cdfcf0SDavid Milburn int ahci_port_resume(struct ata_port *ap);
430365cfa1eSAnton Vorontsov void ahci_set_em_messages(struct ahci_host_priv *hpriv,
431365cfa1eSAnton Vorontsov 			  struct ata_port_info *pi);
432365cfa1eSAnton Vorontsov int ahci_reset_em(struct ata_host *host);
433365cfa1eSAnton Vorontsov void ahci_print_info(struct ata_host *host, const char *scc_s);
43425df73d9SBart Van Assche int ahci_host_activate(struct ata_host *host, const struct scsi_host_template *sht);
4358b789d89SRichard Zhu void ahci_error_handler(struct ata_port *ap);
436f070d671SSuman Tripathi u32 ahci_handle_port_intr(struct ata_host *host, u32 irq_masked);
437365cfa1eSAnton Vorontsov 
__ahci_port_base(struct ahci_host_priv * hpriv,unsigned int port_no)4387cbbfbe0SSerge Semin static inline void __iomem *__ahci_port_base(struct ahci_host_priv *hpriv,
439365cfa1eSAnton Vorontsov 					     unsigned int port_no)
440365cfa1eSAnton Vorontsov {
441365cfa1eSAnton Vorontsov 	void __iomem *mmio = hpriv->mmio;
442365cfa1eSAnton Vorontsov 
443365cfa1eSAnton Vorontsov 	return mmio + 0x100 + (port_no * 0x80);
444365cfa1eSAnton Vorontsov }
445365cfa1eSAnton Vorontsov 
ahci_port_base(struct ata_port * ap)446365cfa1eSAnton Vorontsov static inline void __iomem *ahci_port_base(struct ata_port *ap)
447365cfa1eSAnton Vorontsov {
4487cbbfbe0SSerge Semin 	struct ahci_host_priv *hpriv = ap->host->private_data;
4497cbbfbe0SSerge Semin 
4507cbbfbe0SSerge Semin 	return __ahci_port_base(hpriv, ap->port_no);
451365cfa1eSAnton Vorontsov }
452365cfa1eSAnton Vorontsov 
ahci_nr_ports(u32 cap)453365cfa1eSAnton Vorontsov static inline int ahci_nr_ports(u32 cap)
454365cfa1eSAnton Vorontsov {
455365cfa1eSAnton Vorontsov 	return (cap & 0x1f) + 1;
456365cfa1eSAnton Vorontsov }
457365cfa1eSAnton Vorontsov 
458365cfa1eSAnton Vorontsov #endif /* _AHCI_H */
459