lunaix-os/hal/ahci/ahci.c

   1 /**
   2  * @file ahci.c
   3  * @author Lunaixsky (zelong56@gmail.com)
   4  * @brief A software implementation of Serial ATA AHCI 1.3.1 Specification
   5  * @version 0.1
   6  * @date 2022-06-28
   7  *
   8  * @copyright Copyright (c) 2022
   9  *
  10  */
  11 #include <hal/ahci/ahci.h>
  12 #include <hal/ahci/hba.h>
  13 #include <hal/ahci/sata.h>
  14 #include <hal/ahci/scsi.h>
  15 #include <hal/ahci/utils.h>
  16
  17 #include <hal/pci.h>
  18 #include <klibc/string.h>
  19 #include <lunaix/mm/mmio.h>
  20 #include <lunaix/mm/pmm.h>
  21 #include <lunaix/mm/valloc.h>
  22 #include <lunaix/mm/vmm.h>
  23 #include <lunaix/spike.h>
  24 #include <lunaix/syslog.h>
  25
  26 #define HBA_FIS_SIZE 256
  27 #define HBA_CLB_SIZE 1024
  28
  29 LOG_MODULE("AHCI")
  30
  31 static struct ahci_hba hba;
  32
  33 void
  34 __ahci_hba_isr(isr_param param);
  35
  36 int
  37 ahci_init_device(struct hba_port* port);
  38
  39 void
  40 ahci_init()
  41 {
  42     struct pci_device* ahci_dev = pci_get_device_by_class(AHCI_HBA_CLASS);
  43     assert_msg(ahci_dev, "AHCI: Not found.");
  44
  45     uintptr_t bar6, size;
  46     size = pci_bar_sizing(ahci_dev, &bar6, 6);
  47     assert_msg(bar6 && PCI_BAR_MMIO(bar6), "AHCI: BAR#6 is not MMIO.");
  48
  49     pci_reg_t cmd = pci_read_cspace(ahci_dev->cspace_base, PCI_REG_STATUS_CMD);
  50
  51     // 禁用传统中断（因为我们使用MSI），启用MMIO访问，允许PCI设备间访问
  52     cmd |= (PCI_RCMD_MM_ACCESS | PCI_RCMD_DISABLE_INTR | PCI_RCMD_BUS_MASTER);
  53
  54     pci_write_cspace(ahci_dev->cspace_base, PCI_REG_STATUS_CMD, cmd);
  55
  56     pci_setup_msi(ahci_dev, AHCI_HBA_IV);
  57     intr_subscribe(AHCI_HBA_IV, __ahci_hba_isr);
  58
  59     memset(&hba, 0, sizeof(hba));
  60
  61     hba.base = (hba_reg_t*)ioremap(PCI_BAR_ADDR_MM(bar6), size);
  62
  63     // 重置HBA
  64     hba.base[HBA_RGHC] |= HBA_RGHC_RESET;
  65     wait_until(!(hba.base[HBA_RGHC] & HBA_RGHC_RESET));
  66
  67     // 启用AHCI工作模式，启用中断
  68     hba.base[HBA_RGHC] |= HBA_RGHC_ACHI_ENABLE;
  69     hba.base[HBA_RGHC] |= HBA_RGHC_INTR_ENABLE;
  70
  71     // As per section 3.1.1, this is 0 based value.
  72     hba_reg_t cap = hba.base[HBA_RCAP];
  73     hba.ports_num = (cap & 0x1f) + 1;  // CAP.PI
  74     hba.cmd_slots = (cap >> 8) & 0x1f; // CAP.NCS
  75     hba.version = hba.base[HBA_RVER];
  76
  77     /* ------ HBA端口配置 ------ */
  78     hba_reg_t pmap = hba.base[HBA_RPI];
  79     uintptr_t clb_pg_addr, fis_pg_addr, clb_pa, fis_pa;
  80     for (size_t i = 0, fisp = 0, clbp = 0; i < 32;
  81          i++, pmap >>= 1, fisp = (fisp + 1) % 16, clbp = (clbp + 1) % 4) {
  82         if (!(pmap & 0x1)) {
  83             continue;
  84         }
  85
  86         struct hba_port* port =
  87           (struct hba_port*)valloc(sizeof(struct hba_port));
  88         hba_reg_t* port_regs =
  89           (hba_reg_t*)(&hba.base[HBA_RPBASE + i * HBA_RPSIZE]);
  90
  91         if (!clbp) {
  92             // 每页最多4个命令队列
  93             clb_pa = pmm_alloc_page(KERNEL_PID, PP_FGLOCKED);
  94             clb_pg_addr = ioremap(clb_pa, 0x1000);
  95             memset(clb_pg_addr, 0, 0x1000);
  96         }
  97         if (!fisp) {
  98             // 每页最多16个FIS
  99             fis_pa = pmm_alloc_page(KERNEL_PID, PP_FGLOCKED);
 100             fis_pg_addr = ioremap(fis_pa, 0x1000);
 101             memset(fis_pg_addr, 0, 0x1000);
 102         }
 103
 104         /* 重定向CLB与FIS */
 105         port_regs[HBA_RPxCLB] = clb_pa + clbp * HBA_CLB_SIZE;
 106         port_regs[HBA_RPxFB] = fis_pa + fisp * HBA_FIS_SIZE;
 107
 108         *port = (struct hba_port){ .regs = port_regs,
 109                                    .ssts = port_regs[HBA_RPxSSTS],
 110                                    .cmdlst = clb_pg_addr + clbp * HBA_CLB_SIZE,
 111                                    .fis = fis_pg_addr + fisp * HBA_FIS_SIZE };
 112
 113         /* 初始化端口，并置于就绪状态 */
 114         port_regs[HBA_RPxCI] = 0;
 115
 116         // 需要通过全部置位去清空这些寄存器（相当的奇怪……）
 117         port_regs[HBA_RPxSERR] = -1;
 118
 119         port_regs[HBA_RPxIE] |= (HBA_PxINTR_DMA);
 120         port_regs[HBA_RPxIE] |= (HBA_PxINTR_D2HR);
 121
 122         hba.ports[i] = port;
 123
 124         if (HBA_RPxSSTS_IF(port->ssts)) {
 125             wait_until(!(port_regs[HBA_RPxCMD] & HBA_PxCMD_CR));
 126             port_regs[HBA_RPxCMD] |= HBA_PxCMD_FRE;
 127             port_regs[HBA_RPxCMD] |= HBA_PxCMD_ST;
 128
 129             if (!ahci_init_device(port)) {
 130                 kprintf(KERROR "fail to init device");
 131             }
 132         }
 133     }
 134 }
 135
 136 char sata_ifs[][20] = { "Not detected",
 137                         "SATA I (1.5Gbps)",
 138                         "SATA II (3.0Gbps)",
 139                         "SATA III (6.0Gbps)" };
 140
 141 void
 142 __ahci_hba_isr(isr_param param)
 143 {
 144     // TODO: hba interrupt
 145     kprintf(KDEBUG "HBA INTR\n");
 146 }
 147
 148 void
 149 ahci_list_device()
 150 {
 151     kprintf(KINFO "Version: %x; Ports: %d; Slot: %d\n",
 152             hba.version,
 153             hba.ports_num,
 154             hba.cmd_slots);
 155     struct hba_port* port;
 156     for (size_t i = 0; i < 32; i++) {
 157         port = hba.ports[i];
 158
 159         // 愚蠢的gcc似乎认为 struct hba_port* 不可能为空
 160         //  所以将这个非常关键的if给优化掉了。
 161         //  这里将指针强制转换为整数，欺骗gcc :)
 162         if ((uintptr_t)port == 0) {
 163             continue;
 164         }
 165
 166         int device_state = HBA_RPxSSTS_IF(port->ssts);
 167
 168         kprintf("\t Port %d: %s (%x)\n",
 169                 i,
 170                 &sata_ifs[device_state],
 171                 port->regs[HBA_RPxSIG]);
 172
 173         struct hba_device* dev_info = port->device;
 174         if (!device_state || !dev_info) {
 175             continue;
 176         }
 177         kprintf("\t\t capacity: %d KiB\n",
 178                 (dev_info->max_lba * dev_info->block_size) >> 10);
 179         kprintf("\t\t sector size: %dB\n", dev_info->block_size);
 180         kprintf("\t\t model: %s\n", &dev_info->model);
 181         kprintf("\t\t serial: %s\n", &dev_info->serial_num);
 182     }
 183 }
 184
 185 int
 186 __get_free_slot(struct hba_port* port)
 187 {
 188     hba_reg_t pxsact = port->regs[HBA_RPxSACT];
 189     hba_reg_t pxci = port->regs[HBA_RPxCI];
 190     hba_reg_t free_bmp = pxsact | pxci;
 191     uint32_t i = 0;
 192     for (; i <= hba.cmd_slots && (free_bmp & 0x1); i++, free_bmp >>= 1)
 193         ;
 194     return i | -(i > hba.cmd_slots);
 195 }
 196
 197 void
 198 sata_create_fis(struct sata_reg_fis* cmd_fis,
 199                 uint8_t command,
 200                 uint32_t lba_lo,
 201                 uint32_t lba_hi,
 202                 uint16_t sector_count)
 203 {
 204     cmd_fis->head.type = SATA_REG_FIS_H2D;
 205     cmd_fis->head.options = SATA_REG_FIS_COMMAND;
 206     cmd_fis->head.status_cmd = command;
 207     cmd_fis->dev = 0;
 208
 209     cmd_fis->lba0 = SATA_LBA_COMPONENT(lba_lo, 0);
 210     cmd_fis->lba8 = SATA_LBA_COMPONENT(lba_lo, 8);
 211     cmd_fis->lba16 = SATA_LBA_COMPONENT(lba_lo, 16);
 212     cmd_fis->lba24 = SATA_LBA_COMPONENT(lba_lo, 24);
 213
 214     cmd_fis->lba32 = SATA_LBA_COMPONENT(lba_hi, 0);
 215     cmd_fis->lba40 = SATA_LBA_COMPONENT(lba_hi, 8);
 216
 217     cmd_fis->count = sector_count;
 218 }
 219
 220 int
 221 hba_alloc_slot(struct hba_port* port,
 222                struct hba_cmdt** cmdt,
 223                struct hba_cmdh** cmdh,
 224                uint16_t header_options)
 225 {
 226     int slot = __get_free_slot(port);
 227     assert_msg(slot >= 0, "HBA: No free slot");
 228
 229     // 构建命令头（Command Header）和命令表（Command Table）
 230     struct hba_cmdh* cmd_header = &port->cmdlst[slot];
 231     struct hba_cmdt* cmd_table = valloc_dma(sizeof(struct hba_cmdt));
 232
 233     memset(cmd_header, 0, sizeof(*cmd_header));
 234     memset(cmd_table, 0, sizeof(*cmd_table));
 235
 236     // 将命令表挂到命令头上
 237     cmd_header->prdt_len = 1;
 238     cmd_header->cmd_table_base = vmm_v2p(cmd_table);
 239     cmd_header->options = HBA_CMDH_FIS_LEN(sizeof(struct sata_reg_fis)) |
 240                           HBA_CMDH_CLR_BUSY | (header_options & ~0x1f);
 241
 242     *cmdh = cmd_header;
 243     *cmdt = cmd_table;
 244
 245     return slot;
 246 }
 247
 248 int
 249 ahci_init_device(struct hba_port* port)
 250 {
 251     /* 发送ATA命令，参考：SATA AHCI Spec Rev.1.3.1, section 5.5 */
 252     struct hba_cmdt* cmd_table;
 253     struct hba_cmdh* cmd_header;
 254
 255     int slot = hba_alloc_slot(port, &cmd_table, &cmd_header, 0);
 256
 257     // 清空任何待响应的中断
 258     port->regs[HBA_RPxIS] = 0;
 259     port->device = valloc(sizeof(struct hba_device));
 260     port->device->signature = port->regs[HBA_RPxSIG];
 261
 262     // 预备DMA接收缓存，用于存放HBA传回的数据
 263     uint16_t* data_in = (uint16_t*)valloc_dma(512);
 264
 265     cmd_table->entries[0] =
 266       (struct hba_prdte){ .data_base = vmm_v2p(data_in),
 267                           .byte_count = 511 }; // byte_count是从0开始算的
 268     cmd_header->prdt_len = 1;
 269
 270     // 在命令表中构建命令FIS
 271     struct sata_reg_fis* cmd_fis = (struct sata_reg_fis*)cmd_table->command_fis;
 272
 273     // 根据设备类型使用合适的命令
 274     if (port->device->signature == HBA_DEV_SIG_ATA) {
 275         // ATA 一般为硬盘
 276         sata_create_fis(cmd_fis, ATA_IDENTIFY_DEVICE, 0, 0, 0);
 277     } else {
 278         // ATAPI 一般为光驱，软驱，或者磁带机
 279         sata_create_fis(cmd_fis, ATA_IDENTIFY_PAKCET_DEVICE, 0, 0, 0);
 280     }
 281
 282     // PxCI寄存器置位，告诉HBA这儿有个数据需要发送到SATA端口
 283     port->regs[HBA_RPxCI] = (1 << slot);
 284
 285     wait_until(!(port->regs[HBA_RPxCI] & (1 << slot)));
 286
 287     /*
 288         等待数据到达内存
 289         解析IDENTIFY DEVICE传回来的数据。
 290           参考：
 291             * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.12.7
 292     */
 293     ahci_parse_dev_info(port->device, data_in);
 294
 295     if (port->device->signature == HBA_DEV_SIG_ATA) {
 296         goto done;
 297     }
 298
 299     /*
 300         注意：ATAPI设备是无法通过IDENTIFY PACKET DEVICE 获取容量信息的。
 301         我们需要使用SCSI命令的READ_CAPACITY(16)进行获取。
 302         步骤如下：
 303             1. 因为ATAPI走的是SCSI，而AHCI对此专门进行了SATA的封装，
 304                也就是通过SATA的PACKET命令对SCSI命令进行封装。所以我们
 305                首先需要构建一个PACKET命令的FIS
 306             2. 接着，在ACMD中构建命令READ_CAPACITY的CDB - 一种SCSI命令的封装
 307             3. 然后把cmd_header->options的A位置位，表示这是一个送往ATAPI的命令。
 308                 一点细节：
 309                     1. HBA往底层SATA控制器发送PACKET FIS
 310                     2. SATA控制器回复PIO Setup FIS
 311                     3. HBA读入ACMD中的CDB，打包成Data FIS进行答复
 312                     4. SATA控制器解包，拿到CDB，通过SCSI协议转发往ATAPI设备。
 313                     5. ATAPI设备回复Return Parameter，SATA通过DMA Setup FIS
 314                        发起DMA请求，HBA介入，将Return Parameter写入我们在PRDT
 315                        里设置的data_in位置。
 316             4. 最后照常等待HBA把结果写入data_in，然后直接解析就好了。
 317           参考：
 318             * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.18
 319             * SATA AHCI HBA Spec, Section 5.3.7
 320             * SCSI Command Reference Manual, Section 3.26
 321     */
 322     sata_create_fis(cmd_fis, ATA_PACKET, 512 << 8, 0, 0);
 323     struct scsi_cdb16* cdb16 = (struct scsi_cdb16*)cmd_table->atapi_cmd;
 324     scsi_create_packet16(cdb16, SCSI_READ_CAPACITY_16, 0, 0, 512);
 325     cdb16->misc1 = 0x10; // service action
 326     cmd_header->transferred_size = 0;
 327     cmd_header->options |= HBA_CMDH_ATAPI;
 328
 329     port->regs[HBA_RPxCI] = (1 << slot);
 330     wait_until(!(port->regs[HBA_RPxCI] & (1 << slot)));
 331
 332     scsi_parse_capacity(port->device, (uint32_t*)data_in);
 333
 334 done:
 335     vfree_dma(data_in);
 336     vfree_dma(cmd_table);
 337
 338     return 1;
 339 }
 340
 341 // TODO: Support ATAPI Device.