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