| 1 | /******************************************************************************
|
|---|
| 2 | * ahci.h - AHCI-specific constants for os2ahci.h
|
|---|
| 3 | *
|
|---|
| 4 | * Copyright (c) 2011 thi.guten Software Development
|
|---|
| 5 | * Copyright (c) 2011 Mensys B.V.
|
|---|
| 6 | *
|
|---|
| 7 | * Authors: Christian Mueller, Markus Thielen
|
|---|
| 8 | *
|
|---|
| 9 | * Parts copied from/inspired by the Linux AHCI driver;
|
|---|
| 10 | * those parts are (c) Linux AHCI/ATA maintainers
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or modify
|
|---|
| 13 | * it under the terms of the GNU General Public License as published by
|
|---|
| 14 | * the Free Software Foundation; either version 2 of the License, or
|
|---|
| 15 | * (at your option) any later version.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful,
|
|---|
| 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 20 | * GNU General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, write to the Free Software
|
|---|
| 24 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | /* ----------------------------- include files ----------------------------- */
|
|---|
| 28 |
|
|---|
| 29 | /* -------------------------- macros and constants ------------------------- */
|
|---|
| 30 |
|
|---|
| 31 | /******************************************************************************
|
|---|
| 32 | * device prefix strings for Resource Manager
|
|---|
| 33 | */
|
|---|
| 34 | #define RM_HD_PREFIX "HD_(%d,%d) "
|
|---|
| 35 | #define RM_HD_PREFIX_LEN (sizeof(RM_HD_PREFIX) - 1)
|
|---|
| 36 | #define RM_CD_PREFIX "CD_(%d,%d) "
|
|---|
| 37 | #define RM_CD_PREFIX_LEN (sizeof(RM_CD_PREFIX) - 1)
|
|---|
| 38 | #define RM_TAPE_PREFIX "TAPE_(%d,%d) "
|
|---|
| 39 | #define RM_TAPE_PREFIX_LEN (sizeof(RM_TAPE_PREFIX) - 1)
|
|---|
| 40 | #define RM_MAX_PREFIX_LEN RM_TAPE_PREFIX_LEN
|
|---|
| 41 |
|
|---|
| 42 | /******************************************************************************
|
|---|
| 43 | * AHCI flags and constants; those were initially copied from the Linux AHCI
|
|---|
| 44 | * driver but converted to macros because enums are 16 bits for OS/2 drivers
|
|---|
| 45 | * (unless we use KEE and a 32-bit compiler, which we don't)
|
|---|
| 46 | *
|
|---|
| 47 | * Changes from the Linux source:
|
|---|
| 48 | *
|
|---|
| 49 | * - reduced AHCI_MAX_SG from 168 to 48 because the port-specific DMA scratch
|
|---|
| 50 | * buffer needs to be less than 64K to allow mapping the whole DMA area to a
|
|---|
| 51 | * 16-bit memory segment
|
|---|
| 52 | *
|
|---|
| 53 | * - added AHCI_MAX_SG_ELEMENT_LEN constant
|
|---|
| 54 | *
|
|---|
| 55 | * - replaced much of the top-level size/offset math with real structs and
|
|---|
| 56 | * corresponding sizeof() directives.
|
|---|
| 57 | */
|
|---|
| 58 | #define AHCI_PCI_BAR 5
|
|---|
| 59 | #define AHCI_MAX_PORTS 32
|
|---|
| 60 | #define AHCI_MAX_SG 48 /* hardware max is 64K */
|
|---|
| 61 | #define AHCI_MAX_SG_ELEMENT_LEN (1UL << 22)
|
|---|
| 62 | #define AHCI_MAX_CMDS 32
|
|---|
| 63 | #define AHCI_RX_FIS_SZ 256
|
|---|
| 64 |
|
|---|
| 65 | /* port-specific DMA scratch buffer aligned to 1024 bytes */
|
|---|
| 66 | #define AHCI_PORT_PRIV_DMA_SZ (((sizeof(AHCI_PORT_DMA) + 1023U) / 1024U) * 1024U)
|
|---|
| 67 |
|
|---|
| 68 | #define AHCI_IRQ_ON_SG (1UL << 31)
|
|---|
| 69 | #define AHCI_CMD_ATAPI (1UL << 5)
|
|---|
| 70 | #define AHCI_CMD_WRITE (1UL << 6)
|
|---|
| 71 | #define AHCI_CMD_PREFETCH (1UL << 7)
|
|---|
| 72 | #define AHCI_CMD_RESET (1UL << 8)
|
|---|
| 73 | #define AHCI_CMD_CLR_BUSY (1UL << 10)
|
|---|
| 74 |
|
|---|
| 75 | #define RX_FIS_D2H_REG 0x40 /* offset of D2H Register FIS data */
|
|---|
| 76 | #define RX_FIS_SDB 0x58 /* offset of SDB FIS data */
|
|---|
| 77 | #define RX_FIS_UNK 0x60 /* offset of Unknown FIS data */
|
|---|
| 78 |
|
|---|
| 79 | #define board_ahci 0
|
|---|
| 80 | #define board_ahci_vt8251 1
|
|---|
| 81 | #define board_ahci_ign_iferr 2
|
|---|
| 82 | #define board_ahci_sb600 3
|
|---|
| 83 | #define board_ahci_mv 4
|
|---|
| 84 | #define board_ahci_sb700 5 /* for SB700 and SB800 */
|
|---|
| 85 | #define board_ahci_mcp65 6
|
|---|
| 86 | #define board_ahci_nopmp 7
|
|---|
| 87 | #define board_ahci_yesncq 8
|
|---|
| 88 | #define board_ahci_nosntf 9
|
|---|
| 89 |
|
|---|
| 90 | /* global controller registers */
|
|---|
| 91 | #define HOST_CAP 0x00 /* host capabilities */
|
|---|
| 92 | #define HOST_CTL 0x04 /* global host control */
|
|---|
| 93 | #define HOST_IRQ_STAT 0x08 /* interrupt status */
|
|---|
| 94 | #define HOST_PORTS_IMPL 0x0c /* bitmap of implemented ports */
|
|---|
| 95 | #define HOST_VERSION 0x10 /* AHCI spec. version compliancy */
|
|---|
| 96 | #define HOST_CCC 0x14 /* Command Completion Coalescing Control */
|
|---|
| 97 | #define HOST_CCC_PORTS 0x18 /* CCC ports */
|
|---|
| 98 | #define HOST_EM_LOC 0x1c /* Enclosure Management location */
|
|---|
| 99 | #define HOST_EM_CTL 0x20 /* Enclosure Management Control */
|
|---|
| 100 | #define HOST_CAP2 0x24 /* host capabilities, extended */
|
|---|
| 101 | #define HOST_BOHC 0x28 /* BIOS hand off control and status */
|
|---|
| 102 |
|
|---|
| 103 | /* HOST_CTL bits */
|
|---|
| 104 | #define HOST_RESET (1UL << 0) /* reset controller; self-clear */
|
|---|
| 105 | #define HOST_IRQ_EN (1UL << 1) /* global IRQ enable */
|
|---|
| 106 | #define HOST_AHCI_EN (1UL << 31) /* AHCI enabled */
|
|---|
| 107 |
|
|---|
| 108 | /* HOST_CAP bits */
|
|---|
| 109 | #define HOST_CAP_SXS (1UL << 5) /* Supports External SATA */
|
|---|
| 110 | #define HOST_CAP_EMS (1UL << 6) /* Enclosure Management support */
|
|---|
| 111 | #define HOST_CAP_CCC (1UL << 7) /* Command Completion Coalescing */
|
|---|
| 112 | #define HOST_CAP_PART (1UL << 13) /* Partial state capable */
|
|---|
| 113 | #define HOST_CAP_SSC (1UL << 14) /* Slumber state capable */
|
|---|
| 114 | #define HOST_CAP_PIO_MULTI (1UL << 15) /* PIO multiple DRQ support */
|
|---|
| 115 | #define HOST_CAP_FBS (1UL << 16) /* FIS-based switching support */
|
|---|
| 116 | #define HOST_CAP_PMP (1UL << 17) /* Port Multiplier support */
|
|---|
| 117 | #define HOST_CAP_ONLY (1UL << 18) /* Supports AHCI mode only */
|
|---|
| 118 | #define HOST_CAP_CLO (1UL << 24) /* Command List Override support */
|
|---|
| 119 | #define HOST_CAP_LED (1UL << 25) /* Supports activity LED */
|
|---|
| 120 | #define HOST_CAP_ALPM (1UL << 26) /* Aggressive Link PM support */
|
|---|
| 121 | #define HOST_CAP_SSS (1UL << 27) /* Staggered Spin-up */
|
|---|
| 122 | #define HOST_CAP_MPS (1UL << 28) /* Mechanical presence switch */
|
|---|
| 123 | #define HOST_CAP_SNTF (1UL << 29) /* SNotification register */
|
|---|
| 124 | #define HOST_CAP_NCQ (1UL << 30) /* Native Command Queueing */
|
|---|
| 125 | #define HOST_CAP_64 (1UL << 31) /* PCI DAC (64-bit DMA) support */
|
|---|
| 126 |
|
|---|
| 127 | /* HOST_CAP2 bits */
|
|---|
| 128 | #define HOST_CAP2_BOH (1UL << 0) /* BIOS/OS handoff supported */
|
|---|
| 129 | #define HOST_CAP2_NVMHCI (1UL << 1) /* NVMHCI supported */
|
|---|
| 130 | #define HOST_CAP2_APST (1UL << 2) /* Automatic partial to slumber */
|
|---|
| 131 |
|
|---|
| 132 | /* HOST_BOHC bits */
|
|---|
| 133 | #define HOST_BOHC_BOS (1UL << 0) /* BIOS owned (semaphore bit) */
|
|---|
| 134 | #define HOST_BOHC_OOS (1UL << 1) /* OS owned (semaphore bit) */
|
|---|
| 135 | #define HOST_BOHC_SOOE (1UL << 2) /* SMI on ownership change enable */
|
|---|
| 136 | #define HOST_BOHC_OOC (1UL << 3) /* OS ownership change */
|
|---|
| 137 | #define HOST_BOHC_BB (1UL << 4) /* BIOS is busy changing ownership */
|
|---|
| 138 |
|
|---|
| 139 | /* registers for each SATA port */
|
|---|
| 140 | #define PORT_LST_ADDR 0x00 /* command list DMA addr */
|
|---|
| 141 | #define PORT_LST_ADDR_HI 0x04 /* command list DMA addr hi */
|
|---|
| 142 | #define PORT_FIS_ADDR 0x08 /* FIS rx buf addr */
|
|---|
| 143 | #define PORT_FIS_ADDR_HI 0x0c /* FIS rx buf addr hi */
|
|---|
| 144 | #define PORT_IRQ_STAT 0x10 /* interrupt status */
|
|---|
| 145 | #define PORT_IRQ_MASK 0x14 /* interrupt enable/disable mask */
|
|---|
| 146 | #define PORT_CMD 0x18 /* port command */
|
|---|
| 147 | #define PORT_TFDATA 0x20 /* taskfile data */
|
|---|
| 148 | #define PORT_SIG 0x24 /* device TF signature */
|
|---|
| 149 | #define PORT_CMD_ISSUE 0x38 /* command issue */
|
|---|
| 150 | #define PORT_SCR_STAT 0x28 /* SATA phy register: SStatus */
|
|---|
| 151 | #define PORT_SCR_CTL 0x2c /* SATA phy register: SControl */
|
|---|
| 152 | #define PORT_SCR_ERR 0x30 /* SATA phy register: SError */
|
|---|
| 153 | #define PORT_SCR_ACT 0x34 /* SATA phy register: SActive */
|
|---|
| 154 | #define PORT_SCR_NTF 0x3c /* SATA phy register: SNotification */
|
|---|
| 155 |
|
|---|
| 156 | /* PORT_IRQ_{STAT,MASK} bits */
|
|---|
| 157 | #define PORT_IRQ_COLD_PRES (1UL << 31) /* cold presence detect */
|
|---|
| 158 | #define PORT_IRQ_TF_ERR (1UL << 30) /* task file error */
|
|---|
| 159 | #define PORT_IRQ_HBUS_ERR (1UL << 29) /* host bus fatal error */
|
|---|
| 160 | #define PORT_IRQ_HBUS_DATA_ERR (1UL << 28) /* host bus data error */
|
|---|
| 161 | #define PORT_IRQ_IF_ERR (1UL << 27) /* interface fatal error */
|
|---|
| 162 | #define PORT_IRQ_IF_NONFATAL (1UL << 26) /* interface non-fatal error */
|
|---|
| 163 | #define PORT_IRQ_OVERFLOW (1UL << 24) /* xfer exhausted available S/G */
|
|---|
| 164 | #define PORT_IRQ_BAD_PMP (1UL << 23) /* incorrect port multiplier */
|
|---|
| 165 | #define PORT_IRQ_PHYRDY (1UL << 22) /* PhyRdy changed */
|
|---|
| 166 | #define PORT_IRQ_DEV_ILCK (1UL << 7) /* device interlock */
|
|---|
| 167 | #define PORT_IRQ_CONNECT (1UL << 6) /* port connect change status */
|
|---|
| 168 | #define PORT_IRQ_SG_DONE (1UL << 5) /* descriptor processed */
|
|---|
| 169 | #define PORT_IRQ_UNK_FIS (1UL << 4) /* unknown FIS rx'd */
|
|---|
| 170 | #define PORT_IRQ_SDB_FIS (1UL << 3) /* Set Device Bits FIS rx'd */
|
|---|
| 171 | #define PORT_IRQ_DMAS_FIS (1UL << 2) /* DMA Setup FIS rx'd */
|
|---|
| 172 | #define PORT_IRQ_PIOS_FIS (1UL << 1) /* PIO Setup FIS rx'd */
|
|---|
| 173 | #define PORT_IRQ_D2H_REG_FIS (1UL << 0) /* D2H Register FIS rx'd */
|
|---|
| 174 | #define PORT_IRQ_FREEZE (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR | \
|
|---|
| 175 | PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY | \
|
|---|
| 176 | PORT_IRQ_UNK_FIS | PORT_IRQ_BAD_PMP)
|
|---|
| 177 | #define PORT_IRQ_ERROR (PORT_IRQ_FREEZE | PORT_IRQ_TF_ERR | \
|
|---|
| 178 | PORT_IRQ_HBUS_DATA_ERR)
|
|---|
| 179 | #define DEF_PORT_IRQ (PORT_IRQ_ERROR | PORT_IRQ_SG_DONE | \
|
|---|
| 180 | PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS | \
|
|---|
| 181 | PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
|
|---|
| 182 |
|
|---|
| 183 | /* PORT_CMD bits */
|
|---|
| 184 | #define PORT_CMD_ASP (1UL << 27) /* Aggressive Slumber/Partial */
|
|---|
| 185 | #define PORT_CMD_ALPE (1UL << 26) /* Aggressive Link PM enable */
|
|---|
| 186 | #define PORT_CMD_ATAPI (1UL << 24) /* Device is ATAPI */
|
|---|
| 187 | #define PORT_CMD_PMP (1UL << 17) /* PMP attached */
|
|---|
| 188 | #define PORT_CMD_LIST_ON (1UL << 15) /* cmd list DMA engine running */
|
|---|
| 189 | #define PORT_CMD_FIS_ON (1UL << 14) /* FIS DMA engine running */
|
|---|
| 190 | #define PORT_CMD_FIS_RX (1UL << 4) /* Enable FIS receive DMA engine */
|
|---|
| 191 | #define PORT_CMD_CLO (1UL << 3) /* Command list override */
|
|---|
| 192 | #define PORT_CMD_POWER_ON (1UL << 2) /* Power up device */
|
|---|
| 193 | #define PORT_CMD_SPIN_UP (1UL << 1) /* Spin up device */
|
|---|
| 194 | #define PORT_CMD_START (1UL << 0) /* Enable port DMA engine */
|
|---|
| 195 |
|
|---|
| 196 | #define PORT_CMD_ICC_MASK (0xfUL << 28) /* i/f ICC state mask */
|
|---|
| 197 | #define PORT_CMD_ICC_ACTIVE (0x1UL << 28) /* Put i/f in active state */
|
|---|
| 198 | #define PORT_CMD_ICC_PARTIAL (0x2UL << 28) /* Put i/f in partial state */
|
|---|
| 199 | #define PORT_CMD_ICC_SLUMBER (0x6UL << 28) /* Put i/f in slumber state */
|
|---|
| 200 |
|
|---|
| 201 | /* driver status bits */
|
|---|
| 202 | #define AHCI_HFLAG_NO_NCQ (1UL << 0) /* no native cmd queuing */
|
|---|
| 203 | #define AHCI_HFLAG_IGN_IRQ_IF_ERR (1UL << 1) /* ignore IRQ_IF_ERR */
|
|---|
| 204 | #define AHCI_HFLAG_IGN_SERR_INTERNAL (1UL << 2) /* ignore SERR_INTERNAL */
|
|---|
| 205 | #define AHCI_HFLAG_32BIT_ONLY (1UL << 3) /* force 32bit */
|
|---|
| 206 | #define AHCI_HFLAG_MV_PATA (1UL << 4) /* PATA port */
|
|---|
| 207 | #define AHCI_HFLAG_NO_MSI (1UL << 5) /* no PCI MSI */
|
|---|
| 208 | #define AHCI_HFLAG_NO_PMP (1UL << 6) /* no PMP */
|
|---|
| 209 | #define AHCI_HFLAG_NO_HOTPLUG (1UL << 7) /* ignore PxSERR.DIAG.N */
|
|---|
| 210 | #define AHCI_HFLAG_SECT255 (1UL << 8) /* max 255 sectors */
|
|---|
| 211 | #define AHCI_HFLAG_YES_NCQ (1UL << 9) /* force NCQ cap on */
|
|---|
| 212 | #define AHCI_HFLAG_NO_SUSPEND (1UL << 10) /* don't suspend */
|
|---|
| 213 | #define AHCI_HFLAG_SRST_TOUT_IS_OFFLINE (1UL << 11) /* treat SRST timeout as
|
|---|
| 214 | link offline */
|
|---|
| 215 | #define AHCI_HFLAG_NO_SNTF (1UL << 12) /* no sntf */
|
|---|
| 216 |
|
|---|
| 217 | #define ICH_MAP 0x90 /* ICH MAP register */
|
|---|
| 218 |
|
|---|
| 219 | /* em constants */
|
|---|
| 220 | #define EM_MAX_SLOTS 8
|
|---|
| 221 | #define EM_MAX_RETRY 5
|
|---|
| 222 |
|
|---|
| 223 | /* em_ctl bits */
|
|---|
| 224 | #define EM_CTL_RST (1UL << 9) /* Reset */
|
|---|
| 225 | #define EM_CTL_TM (1UL << 8) /* Transmit Message */
|
|---|
| 226 | #define EM_CTL_ALHD (1UL << 26) /* Activity LED */
|
|---|
| 227 |
|
|---|
| 228 | /* ------------------------ typedefs and structures ------------------------ */
|
|---|
| 229 |
|
|---|
| 230 | /* Primitive types
|
|---|
| 231 | *
|
|---|
| 232 | * Note: Since OS/2 is essentially an x86 OS and this driver, as well as the
|
|---|
| 233 | * interface it's developed for, is based on x86 design patterns, we're
|
|---|
| 234 | * not even going to start making a difference between little and big
|
|---|
| 235 | * endian architectures. PCI is little endian, AHCI is little endian,
|
|---|
| 236 | * x86 is little endian, and that's it.
|
|---|
| 237 | */
|
|---|
| 238 | typedef unsigned char u8;
|
|---|
| 239 | typedef unsigned short u16;
|
|---|
| 240 | typedef unsigned long u32;
|
|---|
| 241 |
|
|---|
| 242 | /* AHCI S/G structure */
|
|---|
| 243 | typedef struct {
|
|---|
| 244 | u32 addr; /* address of S/G element */
|
|---|
| 245 | u32 addr_hi; /* address of S/G element (upper 32 bits) */
|
|---|
| 246 | u32 reserved;
|
|---|
| 247 | u32 size; /* size of S/G element - 1; the high 10 bits are flags:
|
|---|
| 248 | * 31 : interrupt on completion of this S/G
|
|---|
| 249 | * 30-22 : reserved */
|
|---|
| 250 | } AHCI_SG;
|
|---|
| 251 |
|
|---|
| 252 | /* AHCI command header */
|
|---|
| 253 | typedef struct {
|
|---|
| 254 | u32 options; /* command options */
|
|---|
| 255 | u32 status; /* command status */
|
|---|
| 256 | u32 tbl_addr; /* command table address */
|
|---|
| 257 | u32 tbl_addr_high; /* command table address (upper 32 bits) */
|
|---|
| 258 | u32 reserved[4];
|
|---|
| 259 | } AHCI_CMD_HDR;
|
|---|
| 260 |
|
|---|
| 261 | /* AHCI command table */
|
|---|
| 262 | typedef struct {
|
|---|
| 263 | u8 cmd_fis[64]; /* ATA command FIS */
|
|---|
| 264 | u8 atapi_cmd[16]; /* ATAPI command */
|
|---|
| 265 | u8 reserved[48];
|
|---|
| 266 | AHCI_SG sg_list[AHCI_MAX_SG]; /* AHCI S/G list */
|
|---|
| 267 | } AHCI_CMD_TBL;
|
|---|
| 268 |
|
|---|
| 269 | /* AHCI port DMA scratch area */
|
|---|
| 270 | typedef struct {
|
|---|
| 271 | AHCI_CMD_HDR cmd_hdr[AHCI_MAX_CMDS]; /* command headers */
|
|---|
| 272 | u8 rx_fis[AHCI_RX_FIS_SZ]; /* FIS RX area */
|
|---|
| 273 | AHCI_CMD_TBL cmd_tbl[AHCI_MAX_CMDS]; /* command table */
|
|---|
| 274 | } AHCI_PORT_DMA;
|
|---|
| 275 |
|
|---|
| 276 | /* AHCI port BIOS configuration save area */
|
|---|
| 277 | typedef struct {
|
|---|
| 278 | u32 cmd_list; /* cmd list base address */
|
|---|
| 279 | u32 cmd_list_h; /* cmd list base address high */
|
|---|
| 280 | u32 fis_rx; /* FIS receive buffer */
|
|---|
| 281 | u32 fis_rx_h; /* FIS receive bufffer high */
|
|---|
| 282 | u32 irq_mask; /* IRQ mask */
|
|---|
| 283 | u32 port_cmd; /* port engine status */
|
|---|
| 284 | } AHCI_PORT_CFG;
|
|---|
| 285 |
|
|---|
