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/pci.h>
  16
  17 #include <asm/x86_pmio.h>
  18
  19 #include <klibc/string.h>
  20 #include <lunaix/block.h>
  21 #include <asm-generic/isrm.h>
  22 #include <lunaix/mm/mmio.h>
  23 #include <lunaix/mm/valloc.h>
  24 #include <lunaix/mm/page.h>
  25 #include <lunaix/spike.h>
  26 #include <lunaix/syslog.h>
  27
  28 #define HBA_FIS_SIZE 256
  29 #define HBA_CLB_SIZE 1024
  30
  31 #define HBA_MY_IE (HBA_PxINTR_DHR | HBA_PxINTR_TFE | HBA_PxINTR_OF)
  32 #define AHCI_DEVCLASS DEVCLASS(LUNAIX, STORAGE, SATA)
  33
  34 // #define DO_HBA_FULL_RESET
  35
  36 LOG_MODULE("AHCI")
  37
  38 DEFINE_LLIST(ahcis);
  39
  40 static char sata_ifs[][20] = { "Not detected",
  41                                "SATA I (1.5Gbps)",
  42                                "SATA II (3.0Gbps)",
  43                                "SATA III (6.0Gbps)" };
  44
  45 static struct devclass ahci_class = AHCI_DEVCLASS;
  46
  47 extern void
  48 ahci_fsexport(struct block_dev* bdev, void* fs_node);
  49
  50 extern void
  51 __ahci_blkio_handler(struct blkio_req* req);
  52
  53 int
  54 ahci_init_device(struct hba_port* port);
  55
  56 void
  57 achi_register_ops(struct hba_port* port);
  58
  59 void
  60 ahci_register_device(struct hba_device* hbadev);
  61
  62 void
  63 __hba_reset_port(hba_reg_t* port_reg)
  64 {
  65     // 根据：SATA-AHCI spec section 10.4.2 描述的端口重置流程
  66     port_reg[HBA_RPxCMD] &= ~HBA_PxCMD_ST;
  67     port_reg[HBA_RPxCMD] &= ~HBA_PxCMD_FRE;
  68     int cnt = wait_until_expire(!(port_reg[HBA_RPxCMD] & HBA_PxCMD_CR), 500000);
  69     if (cnt) {
  70         return;
  71     }
  72     // 如果port未响应，则继续执行重置
  73     port_reg[HBA_RPxSCTL] = (port_reg[HBA_RPxSCTL] & ~0xf) | 1;
  74     port_delay(100000); // 等待至少一毫秒，差不多就行了
  75     port_reg[HBA_RPxSCTL] &= ~0xf;
  76 }
  77
  78 struct ahci_driver*
  79 ahci_driver_init(struct ahci_driver_param* param)
  80 {
  81     struct ahci_driver* ahci_drv = vzalloc(sizeof(*ahci_drv));
  82     struct ahci_hba* hba = &ahci_drv->hba;
  83     ahci_drv->id = param->ahci_iv;
  84
  85     isrm_set_payload(param->ahci_iv, (ptr_t)&ahcis);
  86
  87     llist_append(&ahcis, &ahci_drv->ahci_drvs);
  88
  89     hba->base = (hba_reg_t*)ioremap(param->mmio_base, param->mmio_size);
  90
  91 #ifdef DO_HBA_FULL_RESET
  92     // 重置HBA
  93     hba->base[HBA_RGHC] |= HBA_RGHC_RESET;
  94     wait_until(!(hba->base[HBA_RGHC] & HBA_RGHC_RESET));
  95 #endif
  96
  97     // 启用AHCI工作模式，启用中断
  98     hba->base[HBA_RGHC] |= HBA_RGHC_ACHI_ENABLE;
  99     hba->base[HBA_RGHC] |= HBA_RGHC_INTR_ENABLE;
 100
 101     // As per section 3.1.1, this is 0 based value.
 102     hba_reg_t cap = hba->base[HBA_RCAP];
 103     hba_reg_t pmap = hba->base[HBA_RPI];
 104
 105     hba->ports_num = (cap & 0x1f) + 1;  // CAP.PI
 106     hba->cmd_slots = (cap >> 8) & 0x1f; // CAP.NCS
 107     hba->version = hba->base[HBA_RVER];
 108     hba->ports_bmp = pmap;
 109
 110     /* ------ HBA端口配置 ------ */
 111     ptr_t clb_pg_addr = 0, fis_pg_addr = 0;
 112     ptr_t clb_pa = 0, fis_pa = 0;
 113
 114     for (size_t i = 0, fisp = 0, clbp = 0; i < 32;
 115          i++, pmap >>= 1, fisp = (fisp + 1) % 16, clbp = (clbp + 1) % 4) {
 116         if (!(pmap & 0x1)) {
 117             continue;
 118         }
 119
 120         struct hba_port* port =
 121           (struct hba_port*)valloc(sizeof(struct hba_port));
 122         hba_reg_t* port_regs =
 123           (hba_reg_t*)(&hba->base[HBA_RPBASE + i * HBA_RPSIZE]);
 124
 125 #ifndef DO_HBA_FULL_RESET
 126         __hba_reset_port(port_regs);
 127 #endif
 128
 129         struct leaflet* leaflet;
 130         if (!clbp) {
 131             // 每页最多4个命令队列
 132             leaflet = alloc_leaflet(0);
 133             clb_pa = leaflet_addr(leaflet);
 134             clb_pg_addr = vmap(leaflet, KERNEL_DATA);
 135             memset((void*)clb_pg_addr, 0, 0x1000);
 136         }
 137         if (!fisp) {
 138             // 每页最多16个FIS
 139             leaflet = alloc_leaflet(0);
 140             fis_pa = leaflet_addr(leaflet);
 141             fis_pg_addr = vmap(leaflet, KERNEL_DATA);
 142             memset((void*)fis_pg_addr, 0, 0x1000);
 143         }
 144
 145         /* 重定向CLB与FIS */
 146         port_regs[HBA_RPxCLB] = clb_pa + clbp * HBA_CLB_SIZE;
 147         port_regs[HBA_RPxFB] = fis_pa + fisp * HBA_FIS_SIZE;
 148
 149         *port = (struct hba_port){
 150             .regs = port_regs,
 151             .ssts = port_regs[HBA_RPxSSTS],
 152             .cmdlst = (struct hba_cmdh*)(clb_pg_addr + clbp * HBA_CLB_SIZE),
 153             .fis = (void*)(fis_pg_addr + fisp * HBA_FIS_SIZE),
 154             .hba = hba
 155         };
 156
 157         /* 初始化端口，并置于就绪状态 */
 158         port_regs[HBA_RPxCI] = 0;
 159
 160         hba_clear_reg(port_regs[HBA_RPxSERR]);
 161
 162         hba->ports[i] = port;
 163
 164         if (!HBA_RPxSSTS_IF(port->ssts)) {
 165             continue;
 166         }
 167
 168         wait_until(!(port_regs[HBA_RPxCMD] & HBA_PxCMD_CR));
 169         port_regs[HBA_RPxCMD] |= HBA_PxCMD_FRE;
 170         port_regs[HBA_RPxCMD] |= HBA_PxCMD_ST;
 171
 172         if (!ahci_init_device(port)) {
 173             ERROR("init fail: 0x%x@p%d", port->regs[HBA_RPxSIG], i);
 174             continue;
 175         }
 176
 177         struct hba_device* hbadev = port->device;
 178         kprintf(KINFO "sata%d: %s, blk_size=%d, blk=0..%d",
 179                 i,
 180                 hbadev->model,
 181                 hbadev->block_size,
 182                 (u32_t)hbadev->max_lba);
 183
 184         ahci_register_device(hbadev);
 185     }
 186
 187     return ahci_drv;
 188 }
 189
 190 void
 191 ahci_register_device(struct hba_device* hbadev)
 192 {
 193     struct block_dev* bdev =
 194       block_alloc_dev(hbadev->model, hbadev, __ahci_blkio_handler);
 195
 196     bdev->end_lba = hbadev->max_lba;
 197     bdev->blk_size = hbadev->block_size;
 198     bdev->class = &ahci_class;
 199
 200     block_mount(bdev, ahci_fsexport);
 201 }
 202
 203 int
 204 __get_free_slot(struct hba_port* port)
 205 {
 206     hba_reg_t pxsact = port->regs[HBA_RPxSACT];
 207     hba_reg_t pxci = port->regs[HBA_RPxCI];
 208     hba_reg_t free_bmp = pxsact | pxci;
 209     u32_t i = 0;
 210     for (; i <= port->hba->cmd_slots && (free_bmp & 0x1); i++, free_bmp >>= 1)
 211         ;
 212     return i | -(i > port->hba->cmd_slots);
 213 }
 214
 215 void
 216 sata_create_fis(struct sata_reg_fis* cmd_fis,
 217                 u8_t command,
 218                 lba_t lba,
 219                 u16_t sector_count)
 220 {
 221     cmd_fis->head.type = SATA_REG_FIS_H2D;
 222     cmd_fis->head.options = SATA_REG_FIS_COMMAND;
 223     cmd_fis->head.status_cmd = command;
 224     cmd_fis->dev = 0;
 225
 226     cmd_fis->lba0 = SATA_LBA_COMPONENT(lba, 0);
 227     cmd_fis->lba8 = SATA_LBA_COMPONENT(lba, 8);
 228     cmd_fis->lba16 = SATA_LBA_COMPONENT(lba, 16);
 229     cmd_fis->lba24 = SATA_LBA_COMPONENT(lba, 24);
 230
 231     cmd_fis->lba32 = SATA_LBA_COMPONENT(lba, 32);
 232     cmd_fis->lba40 = SATA_LBA_COMPONENT(lba, 40);
 233
 234     cmd_fis->count = sector_count;
 235 }
 236
 237 int
 238 hba_bind_sbuf(struct hba_cmdh* cmdh, struct hba_cmdt* cmdt, struct membuf mbuf)
 239 {
 240     assert_msg(mbuf.size <= 0x400000U, "HBA: Buffer too big");
 241     cmdh->prdt_len = 1;
 242     cmdt->entries[0] =
 243       (struct hba_prdte){ .data_base = vmm_v2p((ptr_t)mbuf.buffer),
 244                           .byte_count = mbuf.size - 1 };
 245
 246     return 0;
 247 }
 248
 249 int
 250 hba_bind_vbuf(struct hba_cmdh* cmdh, struct hba_cmdt* cmdt, struct vecbuf* vbuf)
 251 {
 252     size_t i = 0;
 253     struct vecbuf* pos = vbuf;
 254
 255     do {
 256         assert_msg(i < HBA_MAX_PRDTE, "HBA: Too many PRDTEs");
 257         assert_msg(pos->buf.size <= 0x400000U, "HBA: Buffer too big");
 258         assert_msg(pos->buf.size, "HBA: expect a non-zero buffer size");
 259
 260         cmdt->entries[i++] =
 261           (struct hba_prdte){ .data_base = vmm_v2p((ptr_t)pos->buf.buffer),
 262                               .byte_count = pos->buf.size - 1 };
 263         pos = list_entry(pos->components.next, struct vecbuf, components);
 264     } while (pos != vbuf);
 265
 266     cmdh->prdt_len = i + 1;
 267
 268     return 0;
 269 }
 270
 271 int
 272 hba_prepare_cmd(struct hba_port* port,
 273                 struct hba_cmdt** cmdt,
 274                 struct hba_cmdh** cmdh)
 275 {
 276     int slot = __get_free_slot(port);
 277     assert_msg(slot >= 0, "HBA: No free slot");
 278
 279     // 构建命令头（Command Header）和命令表（Command Table）
 280     struct hba_cmdh* cmd_header = &port->cmdlst[slot];
 281     struct hba_cmdt* cmd_table = vzalloc_dma(sizeof(struct hba_cmdt));
 282
 283     memset(cmd_header, 0, sizeof(*cmd_header));
 284
 285     // 将命令表挂到命令头上
 286     cmd_header->cmd_table_base = vmm_v2p((ptr_t)cmd_table);
 287     cmd_header->options =
 288       HBA_CMDH_FIS_LEN(sizeof(struct sata_reg_fis)) | HBA_CMDH_CLR_BUSY;
 289
 290     *cmdh = cmd_header;
 291     *cmdt = cmd_table;
 292
 293     return slot;
 294 }
 295
 296 int
 297 ahci_init_device(struct hba_port* port)
 298 {
 299     /* 发送ATA命令，参考：SATA AHCI Spec Rev.1.3.1, section 5.5 */
 300     struct hba_cmdt* cmd_table;
 301     struct hba_cmdh* cmd_header;
 302
 303     // mask DHR interrupt
 304     port->regs[HBA_RPxIE] &= ~HBA_MY_IE;
 305
 306     // 预备DMA接收缓存，用于存放HBA传回的数据
 307     u16_t* data_in = (u16_t*)valloc_dma(512);
 308
 309     int slot = hba_prepare_cmd(port, &cmd_table, &cmd_header);
 310     hba_bind_sbuf(
 311       cmd_header, cmd_table, (struct membuf){ .buffer = data_in, .size = 512 });
 312
 313     port->device = vzalloc(sizeof(struct hba_device));
 314     port->device->port = port;
 315     port->device->hba = port->hba;
 316
 317     // 在命令表中构建命令FIS
 318     struct sata_reg_fis* cmd_fis = (struct sata_reg_fis*)cmd_table->command_fis;
 319
 320     // 根据设备类型使用合适的命令
 321     if (port->regs[HBA_RPxSIG] == HBA_DEV_SIG_ATA) {
 322         // ATA 一般为硬盘
 323         sata_create_fis(cmd_fis, ATA_IDENTIFY_DEVICE, 0, 0);
 324     } else {
 325         // ATAPI 一般为光驱，软驱，或者磁带机
 326         port->device->flags |= HBA_DEV_FATAPI;
 327         sata_create_fis(cmd_fis, ATA_IDENTIFY_PAKCET_DEVICE, 0, 0);
 328     }
 329
 330     if (!ahci_try_send(port, slot)) {
 331         goto fail;
 332     }
 333
 334     /*
 335         等待数据到达内存
 336         解析IDENTIFY DEVICE传回来的数据。
 337           参考：
 338             * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.12.7
 339     */
 340     ahci_parse_dev_info(port->device, data_in);
 341
 342     if (!(port->device->flags & HBA_DEV_FATAPI)) {
 343         goto done;
 344     }
 345
 346     /*
 347         注意：ATAPI设备是无法通过IDENTIFY PACKET DEVICE 获取容量信息的。
 348         我们需要使用SCSI命令的READ_CAPACITY(16)进行获取。
 349         步骤如下：
 350             1. 因为ATAPI走的是SCSI，而AHCI对此专门进行了SATA的封装，
 351                也就是通过SATA的PACKET命令对SCSI命令进行封装。所以我们
 352                首先需要构建一个PACKET命令的FIS
 353             2. 接着，在ACMD中构建命令READ_CAPACITY的CDB - 一种SCSI命令的封装
 354             3. 然后把cmd_header->options的A位置位，表示这是一个送往ATAPI的命令。
 355                 一点细节：
 356                     1. HBA往底层SATA控制器发送PACKET FIS
 357                     2. SATA控制器回复PIO Setup FIS
 358                     3. HBA读入ACMD中的CDB，打包成Data FIS进行答复
 359                     4. SATA控制器解包，拿到CDB，通过SCSI协议转发往ATAPI设备。
 360                     5. ATAPI设备回复Return Parameter，SATA通过DMA Setup FIS
 361                        发起DMA请求，HBA介入，将Return Parameter写入我们在PRDT
 362                        里设置的data_in位置。
 363             4. 最后照常等待HBA把结果写入data_in，然后直接解析就好了。
 364           参考：
 365             * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.18
 366             * SATA AHCI HBA Spec, Section 5.3.7
 367             * SCSI Command Reference Manual, Section 3.26
 368     */
 369
 370     sata_create_fis(cmd_fis, ATA_PACKET, 512 << 8, 0);
 371
 372     // for dev use 12 bytes cdb, READ_CAPACITY must use the 10 bytes variation.
 373     if (port->device->cbd_size == SCSI_CDB12) {
 374         struct scsi_cdb12* cdb12 = (struct scsi_cdb12*)cmd_table->atapi_cmd;
 375         // ugly tricks to construct 10 byte cdb from 12 byte cdb
 376         scsi_create_packet12(cdb12, SCSI_READ_CAPACITY_10, 0, 512 << 8);
 377     } else {
 378         struct scsi_cdb16* cdb16 = (struct scsi_cdb16*)cmd_table->atapi_cmd;
 379         scsi_create_packet16(cdb16, SCSI_READ_CAPACITY_16, 0, 512);
 380         cdb16->misc1 = 0x10; // service action
 381     }
 382
 383     cmd_header->transferred_size = 0;
 384     cmd_header->options |= HBA_CMDH_ATAPI;
 385
 386     if (!ahci_try_send(port, slot)) {
 387         goto fail;
 388     }
 389
 390     scsi_parse_capacity(port->device, (u32_t*)data_in);
 391
 392 done:
 393     // reset interrupt status and unmask D2HR interrupt
 394     port->regs[HBA_RPxIE] |= HBA_MY_IE;
 395     achi_register_ops(port);
 396
 397     vfree_dma(data_in);
 398     vfree_dma(cmd_table);
 399
 400     return 1;
 401
 402 fail:
 403     port->regs[HBA_RPxIE] |= HBA_MY_IE;
 404     vfree_dma(data_in);
 405     vfree_dma(cmd_table);
 406
 407     return 0;
 408 }
 409
 410 int
 411 ahci_identify_device(struct hba_device* device)
 412 {
 413     // 用于重新识别设备（比如在热插拔的情况下）
 414     // FIXME this is not right...
 415     vfree(device);
 416     return ahci_init_device(device->port);
 417 }
 418
 419 void
 420 achi_register_ops(struct hba_port* port)
 421 {
 422     port->device->ops.identify = ahci_identify_device;
 423     if (!(port->device->flags & HBA_DEV_FATAPI)) {
 424         port->device->ops.submit = sata_submit;
 425     } else {
 426         port->device->ops.submit = scsi_submit;
 427     }
 428 }