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