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