src/ahci.h

   1 #ifndef __AHCI_H
   2 #define __AHCI_H
   3
   4 struct sata_cmd_fis {
   5     u8 reg;
   6     u8 pmp_type;
   7     u8 command;
   8     u8 feature;
   9
  10     u8 lba_low;
  11     u8 lba_mid;
  12     u8 lba_high;
  13     u8 device;
  14
  15     u8 lba_low2;
  16     u8 lba_mid2;
  17     u8 lba_high2;
  18     u8 feature2;
  19
  20     u8 sector_count;
  21     u8 sector_count2;
  22     u8 res_1;
  23     u8 control;
  24
  25     u8 res_2[64 - 16];
  26 };
  27
  28 struct ahci_ctrl_s {
  29     int pci_bdf;
  30     u8  irq;
  31     u32 iobase;
  32     u32 caps;
  33     u32 ports;
  34 };
  35
  36 struct ahci_cmd_s {
  37     struct sata_cmd_fis fis;
  38     u8 atapi[0x20];
  39     u8 res[0x20];
  40     struct {
  41         u32 base;
  42         u32 baseu;
  43         u32 res;
  44         u32 flags;
  45     } prdt[];
  46 };
  47
  48 /* command list */
  49 struct ahci_list_s {
  50     u32 flags;
  51     u32 bytes;
  52     u32 base;
  53     u32 baseu;
  54     u32 res[4];
  55 };
  56
  57 struct ahci_fis_s {
  58     u8 dsfis[0x1c];  /* dma setup */
  59     u8 res_1[0x04];
  60     u8 psfis[0x14];  /* pio setup */
  61     u8 res_2[0x0c];
  62     u8 rfis[0x14];   /* d2h register */
  63     u8 res_3[0x04];
  64     u8 sdbfis[0x08]; /* set device bits */
  65     u8 ufis[0x40];   /* unknown */
  66     u8 res_4[0x60];
  67 };
  68
  69 struct ahci_port_s {
  70     struct drive_s     drive;
  71     struct ahci_ctrl_s *ctrl;
  72     struct ahci_list_s *list;
  73     struct ahci_fis_s  *fis;
  74     struct ahci_cmd_s  *cmd;
  75     u32                pnr;
  76     u32                atapi;
  77 };
  78
  79 void ahci_setup(void);
  80 int process_ahci_op(struct disk_op_s *op);
  81 int ahci_cmd_data(struct disk_op_s *op, void *cdbcmd, u16 blocksize);
  82
  83 #define AHCI_IRQ_ON_SG            (1 << 31)
  84 #define AHCI_CMD_ATAPI            (1 << 5)
  85 #define AHCI_CMD_WRITE            (1 << 6)
  86 #define AHCI_CMD_PREFETCH         (1 << 7)
  87 #define AHCI_CMD_RESET            (1 << 8)
  88 #define AHCI_CMD_CLR_BUSY         (1 << 10)
  89
  90 #define RX_FIS_D2H_REG            0x40 /* offset of D2H Register FIS data */
  91 #define RX_FIS_SDB                0x58 /* offset of SDB FIS data */
  92 #define RX_FIS_UNK                0x60 /* offset of Unknown FIS data */
  93
  94 /* global controller registers */
  95 #define HOST_CAP                  0x00 /* host capabilities */
  96 #define HOST_CTL                  0x04 /* global host control */
  97 #define HOST_IRQ_STAT             0x08 /* interrupt status */
  98 #define HOST_PORTS_IMPL           0x0c /* bitmap of implemented ports */
  99 #define HOST_VERSION              0x10 /* AHCI spec. version compliancy */
 100
 101 /* HOST_CTL bits */
 102 #define HOST_CTL_RESET            (1 << 0)  /* reset controller; self-clear */
 103 #define HOST_CTL_IRQ_EN           (1 << 1)  /* global IRQ enable */
 104 #define HOST_CTL_AHCI_EN          (1 << 31) /* AHCI enabled */
 105
 106 /* HOST_CAP bits */
 107 #define HOST_CAP_SSC              (1 << 14) /* Slumber capable */
 108 #define HOST_CAP_AHCI             (1 << 18) /* AHCI only */
 109 #define HOST_CAP_CLO              (1 << 24) /* Command List Override support */
 110 #define HOST_CAP_SSS              (1 << 27) /* Staggered Spin-up */
 111 #define HOST_CAP_NCQ              (1 << 30) /* Native Command Queueing */
 112 #define HOST_CAP_64               (1 << 31) /* PCI DAC (64-bit DMA) support */
 113
 114 /* registers for each SATA port */
 115 #define PORT_LST_ADDR             0x00 /* command list DMA addr */
 116 #define PORT_LST_ADDR_HI          0x04 /* command list DMA addr hi */
 117 #define PORT_FIS_ADDR             0x08 /* FIS rx buf addr */
 118 #define PORT_FIS_ADDR_HI          0x0c /* FIS rx buf addr hi */
 119 #define PORT_IRQ_STAT             0x10 /* interrupt status */
 120 #define PORT_IRQ_MASK             0x14 /* interrupt enable/disable mask */
 121 #define PORT_CMD                  0x18 /* port command */
 122 #define PORT_TFDATA               0x20 /* taskfile data */
 123 #define PORT_SIG                  0x24 /* device TF signature */
 124 #define PORT_SCR_STAT             0x28 /* SATA phy register: SStatus */
 125 #define PORT_SCR_CTL              0x2c /* SATA phy register: SControl */
 126 #define PORT_SCR_ERR              0x30 /* SATA phy register: SError */
 127 #define PORT_SCR_ACT              0x34 /* SATA phy register: SActive */
 128 #define PORT_CMD_ISSUE            0x38 /* command issue */
 129 #define PORT_RESERVED             0x3c /* reserved */
 130
 131 /* PORT_IRQ_{STAT,MASK} bits */
 132 #define PORT_IRQ_COLD_PRES        (1 << 31) /* cold presence detect */
 133 #define PORT_IRQ_TF_ERR           (1 << 30) /* task file error */
 134 #define PORT_IRQ_HBUS_ERR         (1 << 29) /* host bus fatal error */
 135 #define PORT_IRQ_HBUS_DATA_ERR    (1 << 28) /* host bus data error */
 136 #define PORT_IRQ_IF_ERR           (1 << 27) /* interface fatal error */
 137 #define PORT_IRQ_IF_NONFATAL      (1 << 26) /* interface non-fatal error */
 138 #define PORT_IRQ_OVERFLOW         (1 << 24) /* xfer exhausted available S/G */
 139 #define PORT_IRQ_BAD_PMP          (1 << 23) /* incorrect port multiplier */
 140
 141 #define PORT_IRQ_PHYRDY           (1 << 22) /* PhyRdy changed */
 142 #define PORT_IRQ_DEV_ILCK         (1 << 7) /* device interlock */
 143 #define PORT_IRQ_CONNECT          (1 << 6) /* port connect change status */
 144 #define PORT_IRQ_SG_DONE          (1 << 5) /* descriptor processed */
 145 #define PORT_IRQ_UNK_FIS          (1 << 4) /* unknown FIS rx'd */
 146 #define PORT_IRQ_SDB_FIS          (1 << 3) /* Set Device Bits FIS rx'd */
 147 #define PORT_IRQ_DMAS_FIS         (1 << 2) /* DMA Setup FIS rx'd */
 148 #define PORT_IRQ_PIOS_FIS         (1 << 1) /* PIO Setup FIS rx'd */
 149 #define PORT_IRQ_D2H_REG_FIS      (1 << 0) /* D2H Register FIS rx'd */
 150
 151 #define PORT_IRQ_FREEZE           (PORT_IRQ_HBUS_ERR | PORT_IRQ_IF_ERR |   \
 152                                    PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY |    \
 153                                    PORT_IRQ_UNK_FIS)
 154 #define PORT_IRQ_ERROR            (PORT_IRQ_FREEZE | PORT_IRQ_TF_ERR |     \
 155                                    PORT_IRQ_HBUS_DATA_ERR)
 156 #define DEF_PORT_IRQ              (PORT_IRQ_ERROR | PORT_IRQ_SG_DONE |     \
 157                                    PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS |  \
 158                                    PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS)
 159
 160 /* PORT_CMD bits */
 161 #define PORT_CMD_ATAPI            (1 << 24) /* Device is ATAPI */
 162 #define PORT_CMD_LIST_ON          (1 << 15) /* cmd list DMA engine running */
 163 #define PORT_CMD_FIS_ON           (1 << 14) /* FIS DMA engine running */
 164 #define PORT_CMD_FIS_RX           (1 << 4) /* Enable FIS receive DMA engine */
 165 #define PORT_CMD_CLO              (1 << 3) /* Command list override */
 166 #define PORT_CMD_POWER_ON         (1 << 2) /* Power up device */
 167 #define PORT_CMD_SPIN_UP          (1 << 1) /* Spin up device */
 168 #define PORT_CMD_START            (1 << 0) /* Enable port DMA engine */
 169
 170 #define PORT_CMD_ICC_MASK         (0xf << 28) /* i/f ICC state mask */
 171 #define PORT_CMD_ICC_ACTIVE       (0x1 << 28) /* Put i/f in active state */
 172 #define PORT_CMD_ICC_PARTIAL      (0x2 << 28) /* Put i/f in partial state */
 173 #define PORT_CMD_ICC_SLUMBER      (0x6 << 28) /* Put i/f in slumber state */
 174
 175 #define PORT_IRQ_STAT_DHRS        (1 << 0) /* Device to Host Register FIS */
 176 #define PORT_IRQ_STAT_PSS         (1 << 1) /* PIO Setup FIS */
 177 #define PORT_IRQ_STAT_DSS         (1 << 2) /* DMA Setup FIS */
 178 #define PORT_IRQ_STAT_SDBS        (1 << 3) /* Set Device Bits */
 179 #define PORT_IRQ_STAT_UFS         (1 << 4) /* Unknown FIS */
 180 #define PORT_IRQ_STAT_DPS         (1 << 5) /* Descriptor Processed */
 181 #define PORT_IRQ_STAT_PCS         (1 << 6) /* Port Connect Change Status */
 182 #define PORT_IRQ_STAT_DMPS        (1 << 7) /* Device Mechanical Presence
 183                                               Status */
 184 #define PORT_IRQ_STAT_PRCS        (1 << 22) /* File Ready Status */
 185 #define PORT_IRQ_STAT_IPMS        (1 << 23) /* Incorrect Port Multiplier
 186                                                Status */
 187 #define PORT_IRQ_STAT_OFS         (1 << 24) /* Overflow Status */
 188 #define PORT_IRQ_STAT_INFS        (1 << 26) /* Interface Non-Fatal Error
 189                                                Status */
 190 #define PORT_IRQ_STAT_IFS         (1 << 27) /* Interface Fatal Error */
 191 #define PORT_IRQ_STAT_HBDS        (1 << 28) /* Host Bus Data Error Status */
 192 #define PORT_IRQ_STAT_HBFS        (1 << 29) /* Host Bus Fatal Error Status */
 193 #define PORT_IRQ_STAT_TFES        (1 << 30) /* Task File Error Status */
 194 #define PORT_IRQ_STAT_CPDS        (1 << 31) /* Code Port Detect Status */
 195
 196 #endif // ahci.h