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