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