include/ahci.h

   1 /*
   2  * (C) Copyright 2008-2010 Freescale Semiconductor, Inc.
   3  * Terry Lv <r65388@freescale.com>
   4  *
   5  * Copyright (C) Freescale Semiconductor, Inc. 2006.
   6  * Author: Jason Jin<Jason.jin@freescale.com>
   7  *         Zhang Wei<wei.zhang@freescale.com>
   8  *
   9  * See file CREDITS for list of people who contributed to this
  10  * project.
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License as
  14  * published by the Free Software Foundation; either version 2 of
  15  * the License, or (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,
  25  * MA 02111-1307 USA
  26  *
  27  */
  28 #ifndef _AHCI_H_
  29 #define _AHCI_H_
  30
  31 #include <pci.h>
  32
  33 #define AHCI_PCI_BAR            0x24
  34 #define AHCI_MAX_SG             56 /* hardware max is 64K */
  35 #define AHCI_MAX_CMD_SLOT       32
  36 #define AHCI_CMD_SLOT_SZ        32
  37 #define AHCI_MAX_CMD_SLOT       32
  38 #define AHCI_RX_FIS_SZ          256
  39 #define AHCI_CMD_TBL_HDR        0x80
  40 #define AHCI_CMD_TBL_CDB        0x40
  41 #define AHCI_CMD_TBL_SZ         (AHCI_CMD_TBL_HDR + (AHCI_MAX_SG * 16))
  42 #define AHCI_PORT_PRIV_DMA_SZ   (AHCI_CMD_SLOT_SZ * AHCI_MAX_CMD_SLOT + \
  43                                 AHCI_CMD_TBL_SZ + AHCI_RX_FIS_SZ)
  44 #define AHCI_CMD_ATAPI          (1 << 5)
  45 #define AHCI_CMD_WRITE          (1 << 6)
  46 #define AHCI_CMD_PREFETCH       (1 << 7)
  47 #define AHCI_CMD_RESET          (1 << 8)
  48 #define AHCI_CMD_CLR_BUSY       (1 << 10)
  49
  50 #define RX_FIS_D2H_REG          0x40    /* offset of D2H Register FIS data */
  51
  52 /* Global controller registers */
  53 #define HOST_CAP                0x00 /* host capabilities */
  54 #define HOST_CTL                0x04 /* global host control */
  55 #define HOST_IRQ_STAT           0x08 /* interrupt status */
  56 #define HOST_PORTS_IMPL         0x0c /* bitmap of implemented ports */
  57 #define HOST_VERSION            0x10 /* AHCI spec. version compliancy */
  58 #define HOST_CAP2               0x24 /* host capabilities, extended */
  59
  60 /* HOST_CTL bits */
  61 #define HOST_RESET              (1 << 0)  /* reset controller; self-clear */
  62 #define HOST_IRQ_EN             (1 << 1)  /* global IRQ enable */
  63 #define HOST_AHCI_EN            (1 << 31) /* AHCI enabled */
  64
  65 /* Registers for each SATA port */
  66 #define PORT_LST_ADDR           0x00 /* command list DMA addr */
  67 #define PORT_LST_ADDR_HI        0x04 /* command list DMA addr hi */
  68 #define PORT_FIS_ADDR           0x08 /* FIS rx buf addr */
  69 #define PORT_FIS_ADDR_HI        0x0c /* FIS rx buf addr hi */
  70 #define PORT_IRQ_STAT           0x10 /* interrupt status */
  71 #define PORT_IRQ_MASK           0x14 /* interrupt enable/disable mask */
  72 #define PORT_CMD                0x18 /* port command */
  73 #define PORT_TFDATA             0x20 /* taskfile data */
  74 #define PORT_SIG                0x24 /* device TF signature */
  75 #define PORT_CMD_ISSUE          0x38 /* command issue */
  76 #define PORT_SCR                0x28 /* SATA phy register block */
  77 #define PORT_SCR_STAT           0x28 /* SATA phy register: SStatus */
  78 #define PORT_SCR_CTL            0x2c /* SATA phy register: SControl */
  79 #define PORT_SCR_ERR            0x30 /* SATA phy register: SError */
  80 #define PORT_SCR_ACT            0x34 /* SATA phy register: SActive */
  81
  82 /* PORT_IRQ_{STAT,MASK} bits */
  83 #define PORT_IRQ_COLD_PRES      (1 << 31) /* cold presence detect */
  84 #define PORT_IRQ_TF_ERR         (1 << 30) /* task file error */
  85 #define PORT_IRQ_HBUS_ERR       (1 << 29) /* host bus fatal error */
  86 #define PORT_IRQ_HBUS_DATA_ERR  (1 << 28) /* host bus data error */
  87 #define PORT_IRQ_IF_ERR         (1 << 27) /* interface fatal error */
  88 #define PORT_IRQ_IF_NONFATAL    (1 << 26) /* interface non-fatal error */
  89 #define PORT_IRQ_OVERFLOW       (1 << 24) /* xfer exhausted available S/G */
  90 #define PORT_IRQ_BAD_PMP        (1 << 23) /* incorrect port multiplier */
  91
  92 #define PORT_IRQ_PHYRDY         (1 << 22) /* PhyRdy changed */
  93 #define PORT_IRQ_DEV_ILCK       (1 << 7) /* device interlock */
  94 #define PORT_IRQ_CONNECT        (1 << 6) /* port connect change status */
  95 #define PORT_IRQ_SG_DONE        (1 << 5) /* descriptor processed */
  96 #define PORT_IRQ_UNK_FIS        (1 << 4) /* unknown FIS rx'd */
  97 #define PORT_IRQ_SDB_FIS        (1 << 3) /* Set Device Bits FIS rx'd */
  98 #define PORT_IRQ_DMAS_FIS       (1 << 2) /* DMA Setup FIS rx'd */
  99 #define PORT_IRQ_PIOS_FIS       (1 << 1) /* PIO Setup FIS rx'd */
 100 #define PORT_IRQ_D2H_REG_FIS    (1 << 0) /* D2H Register FIS rx'd */
 101
 102 #define PORT_IRQ_FATAL          PORT_IRQ_TF_ERR | PORT_IRQ_HBUS_ERR     \
 103                                 | PORT_IRQ_HBUS_DATA_ERR | PORT_IRQ_IF_ERR
 104
 105 #define DEF_PORT_IRQ            PORT_IRQ_FATAL | PORT_IRQ_PHYRDY        \
 106                                 | PORT_IRQ_CONNECT | PORT_IRQ_SG_DONE   \
 107                                 | PORT_IRQ_UNK_FIS | PORT_IRQ_SDB_FIS   \
 108                                 | PORT_IRQ_DMAS_FIS | PORT_IRQ_PIOS_FIS \
 109                                 | PORT_IRQ_D2H_REG_FIS
 110
 111 /* PORT_CMD bits */
 112 #define PORT_CMD_ATAPI          (1 << 24) /* Device is ATAPI */
 113 #define PORT_CMD_LIST_ON        (1 << 15) /* cmd list DMA engine running */
 114 #define PORT_CMD_FIS_ON         (1 << 14) /* FIS DMA engine running */
 115 #define PORT_CMD_FIS_RX         (1 << 4) /* Enable FIS receive DMA engine */
 116 #define PORT_CMD_CLO            (1 << 3) /* Command list override */
 117 #define PORT_CMD_POWER_ON       (1 << 2) /* Power up device */
 118 #define PORT_CMD_SPIN_UP        (1 << 1) /* Spin up device */
 119 #define PORT_CMD_START          (1 << 0) /* Enable port DMA engine */
 120
 121 #define PORT_CMD_ICC_ACTIVE     (0x1 << 28) /* Put i/f in active state */
 122 #define PORT_CMD_ICC_PARTIAL    (0x2 << 28) /* Put i/f in partial state */
 123 #define PORT_CMD_ICC_SLUMBER    (0x6 << 28) /* Put i/f in slumber state */
 124
 125 #define AHCI_MAX_PORTS          32
 126
 127 /* SETFEATURES stuff */
 128 #define SETFEATURES_XFER        0x03
 129 #define XFER_UDMA_7             0x47
 130 #define XFER_UDMA_6             0x46
 131 #define XFER_UDMA_5             0x45
 132 #define XFER_UDMA_4             0x44
 133 #define XFER_UDMA_3             0x43
 134 #define XFER_UDMA_2             0x42
 135 #define XFER_UDMA_1             0x41
 136 #define XFER_UDMA_0             0x40
 137 #define XFER_MW_DMA_2           0x22
 138 #define XFER_MW_DMA_1           0x21
 139 #define XFER_MW_DMA_0           0x20
 140 #define XFER_SW_DMA_2           0x12
 141 #define XFER_SW_DMA_1           0x11
 142 #define XFER_SW_DMA_0           0x10
 143 #define XFER_PIO_4              0x0C
 144 #define XFER_PIO_3              0x0B
 145 #define XFER_PIO_2              0x0A
 146 #define XFER_PIO_1              0x09
 147 #define XFER_PIO_0              0x08
 148 #define XFER_PIO_SLOW           0x00
 149
 150 #define ATA_FLAG_SATA           (1 << 3)
 151 #define ATA_FLAG_NO_LEGACY      (1 << 4) /* no legacy mode check */
 152 #define ATA_FLAG_MMIO           (1 << 6) /* use MMIO, not PIO */
 153 #define ATA_FLAG_SATA_RESET     (1 << 7) /* (obsolete) use COMRESET */
 154 #define ATA_FLAG_PIO_DMA        (1 << 8) /* PIO cmds via DMA */
 155 #define ATA_FLAG_NO_ATAPI       (1 << 11) /* No ATAPI support */
 156
 157 struct ahci_cmd_hdr {
 158         u32     opts;
 159         u32     status;
 160         u32     tbl_addr;
 161         u32     tbl_addr_hi;
 162         u32     reserved[4];
 163 };
 164
 165 struct ahci_sg {
 166         u32     addr;
 167         u32     addr_hi;
 168         u32     reserved;
 169         u32     flags_size;
 170 };
 171
 172 struct ahci_ioports {
 173         u32     cmd_addr;
 174         u32     scr_addr;
 175         u32     port_mmio;
 176         struct ahci_cmd_hdr     *cmd_slot;
 177         struct ahci_sg          *cmd_tbl_sg;
 178         u32     cmd_tbl;
 179         u32     rx_fis;
 180 };
 181
 182 struct ahci_probe_ent {
 183         pci_dev_t       dev;
 184         struct ahci_ioports     port[AHCI_MAX_PORTS];
 185         u32     n_ports;
 186         u32     hard_port_no;
 187         u32     host_flags;
 188         u32     host_set_flags;
 189         u32     mmio_base;
 190         u32     pio_mask;
 191         u32     udma_mask;
 192         u32     flags;
 193         u32     cap;    /* cache of HOST_CAP register */
 194         u32     port_map; /* cache of HOST_PORTS_IMPL reg */
 195         u32     link_port_map; /*linkup port map*/
 196 };
 197
 198 int ahci_init(u32 base);
 199
 200 #endif