* @copyright Copyright (c) 2022
*
*/
-#include <hal/ahci.h>
+#include <hal/ahci/ahci.h>
+#include <hal/ahci/hba.h>
+#include <hal/ahci/sata.h>
+#include <hal/ahci/scsi.h>
#include <hal/pci.h>
+
+#include <sys/pci_hba.h>
+#include <sys/port_io.h>
+
#include <klibc/string.h>
-#include <lunaix/mm/kalloc.h>
+#include <lunaix/block.h>
+#include <lunaix/isrm.h>
#include <lunaix/mm/mmio.h>
#include <lunaix/mm/pmm.h>
+#include <lunaix/mm/valloc.h>
+#include <lunaix/mm/vmm.h>
#include <lunaix/spike.h>
#include <lunaix/syslog.h>
#define HBA_FIS_SIZE 256
#define HBA_CLB_SIZE 1024
+#define HBA_MY_IE (HBA_PxINTR_DHR | HBA_PxINTR_TFE | HBA_PxINTR_OF)
+#define AHCI_DEVCLASS DEVCLASS(DEVIF_PCI, DEVFN_STORAGE, DEV_SATA)
+
+// #define DO_HBA_FULL_RESET
+
LOG_MODULE("AHCI")
-static struct ahci_hba hba;
+DEFINE_LLIST(ahcis);
+
+static char sata_ifs[][20] = { "Not detected",
+ "SATA I (1.5Gbps)",
+ "SATA II (3.0Gbps)",
+ "SATA III (6.0Gbps)" };
+
+static struct devclass ahci_class = AHCI_DEVCLASS;
+
+extern void
+ahci_fsexport(struct block_dev* bdev, void* fs_node);
+
+extern void
+__ahci_blkio_handler(struct blkio_req* req);
+
+int
+ahci_init_device(struct hba_port* port);
void
-ahci_init()
-{
- struct pci_device* ahci_dev = pci_get_device_by_class(AHCI_HBA_CLASS);
- assert_msg(ahci_dev, "AHCI: Not found.");
+achi_register_ops(struct hba_port* port);
- uintptr_t bar6, size;
- size = pci_bar_sizing(ahci_dev, &bar6, 6);
- assert_msg(bar6 && PCI_BAR_MMIO(bar6), "AHCI: BAR#6 is not MMIO.");
+void
+ahci_register_device(struct hba_device* hbadev);
- pci_reg_t cmd = pci_read_cspace(ahci_dev->cspace_base, PCI_REG_STATUS_CMD);
+void
+__hba_reset_port(hba_reg_t* port_reg)
+{
+ // 根据:SATA-AHCI spec section 10.4.2 描述的端口重置流程
+ port_reg[HBA_RPxCMD] &= ~HBA_PxCMD_ST;
+ port_reg[HBA_RPxCMD] &= ~HBA_PxCMD_FRE;
+ int cnt = wait_until_expire(!(port_reg[HBA_RPxCMD] & HBA_PxCMD_CR), 500000);
+ if (cnt) {
+ return;
+ }
+ // 如果port未响应,则继续执行重置
+ port_reg[HBA_RPxSCTL] = (port_reg[HBA_RPxSCTL] & ~0xf) | 1;
+ port_delay(100000); // 等待至少一毫秒,差不多就行了
+ port_reg[HBA_RPxSCTL] &= ~0xf;
+}
+
+struct ahci_driver*
+ahci_driver_init(struct ahci_driver_param* param)
+{
+ struct ahci_driver* ahci_drv = vzalloc(sizeof(*ahci_drv));
+ struct ahci_hba* hba = &ahci_drv->hba;
+ ahci_drv->id = param->ahci_iv;
- // 禁用传统中断(因为我们使用MSI),启用MMIO访问,允许PCI设备间访问
- cmd |= (PCI_RCMD_MM_ACCESS | PCI_RCMD_DISABLE_INTR | PCI_RCMD_BUS_MASTER);
+ isrm_set_payload(param->ahci_iv, (ptr_t)&ahcis);
- pci_write_cspace(ahci_dev->cspace_base, PCI_REG_STATUS_CMD, cmd);
+ llist_append(&ahcis, &ahci_drv->ahci_drvs);
- hba.base = (hba_reg_t*)ioremap(PCI_BAR_ADDR_MM(bar6), size);
+ hba->base = (hba_reg_t*)ioremap(param->mmio_base, param->mmio_size);
+#ifdef DO_HBA_FULL_RESET
// 重置HBA
- hba.base[HBA_RGHC] |= HBA_RGHC_RESET;
- wait_until(!(hba.base[HBA_RGHC] & HBA_RGHC_RESET));
+ hba->base[HBA_RGHC] |= HBA_RGHC_RESET;
+ wait_until(!(hba->base[HBA_RGHC] & HBA_RGHC_RESET));
+#endif
// 启用AHCI工作模式,启用中断
- hba.base[HBA_RGHC] |= (HBA_RGHC_ACHI_ENABLE | HBA_RGHC_INTR_ENABLE);
+ hba->base[HBA_RGHC] |= HBA_RGHC_ACHI_ENABLE;
+ hba->base[HBA_RGHC] |= HBA_RGHC_INTR_ENABLE;
// As per section 3.1.1, this is 0 based value.
- hba_reg_t cap = hba.base[HBA_RCAP];
- hba.ports_num = (cap & 0x1f) + 1; // CAP.PI
- hba.cmd_slots = (cap >> 8) & 0x1f; // CAP.NCS
- hba.version = hba.base[HBA_RVER];
+ hba_reg_t cap = hba->base[HBA_RCAP];
+ hba_reg_t pmap = hba->base[HBA_RPI];
+
+ hba->ports_num = (cap & 0x1f) + 1; // CAP.PI
+ hba->cmd_slots = (cap >> 8) & 0x1f; // CAP.NCS
+ hba->version = hba->base[HBA_RVER];
+ hba->ports_bmp = pmap;
/* ------ HBA端口配置 ------ */
- hba_reg_t pmap = hba.base[HBA_RPI];
- uintptr_t clb_pg_addr, fis_pg_addr, clb_pa, fis_pa;
+ ptr_t clb_pg_addr = 0, fis_pg_addr = 0;
+ ptr_t clb_pa = 0, fis_pa = 0;
+
for (size_t i = 0, fisp = 0, clbp = 0; i < 32;
i++, pmap >>= 1, fisp = (fisp + 1) % 16, clbp = (clbp + 1) % 4) {
if (!(pmap & 0x1)) {
continue;
}
- struct ahci_port* port =
- (struct ahci_port*)lxmalloc(sizeof(struct ahci_port));
+ struct hba_port* port =
+ (struct hba_port*)valloc(sizeof(struct hba_port));
hba_reg_t* port_regs =
- (hba_reg_t*)(&hba.base[HBA_RPBASE + i * HBA_RPSIZE]);
+ (hba_reg_t*)(&hba->base[HBA_RPBASE + i * HBA_RPSIZE]);
+
+#ifndef DO_HBA_FULL_RESET
+ __hba_reset_port(port_regs);
+#endif
if (!clbp) {
// 每页最多4个命令队列
- clb_pa = pmm_alloc_page(KERNEL_PID, PP_FGLOCKED);
- clb_pg_addr = ioremap(clb_pa, 0x1000);
- memset(clb_pg_addr, 0, 0x1000);
+ clb_pa = pmm_alloc_page(PP_FGLOCKED);
+ clb_pg_addr = (ptr_t)ioremap(clb_pa, 0x1000);
+ memset((void*)clb_pg_addr, 0, 0x1000);
}
if (!fisp) {
// 每页最多16个FIS
- fis_pa = pmm_alloc_page(KERNEL_PID, PP_FGLOCKED);
- fis_pg_addr = ioremap(fis_pa, 0x1000);
- memset(fis_pg_addr, 0, 0x1000);
+ fis_pa = pmm_alloc_page(PP_FGLOCKED);
+ fis_pg_addr = (ptr_t)ioremap(fis_pa, 0x1000);
+ memset((void*)fis_pg_addr, 0, 0x1000);
}
/* 重定向CLB与FIS */
port_regs[HBA_RPxCLB] = clb_pa + clbp * HBA_CLB_SIZE;
port_regs[HBA_RPxFB] = fis_pa + fisp * HBA_FIS_SIZE;
- *port =
- (struct ahci_port){ .regs = port_regs,
- .ssts = port_regs[HBA_RPxSSTS],
- .cmdlstv = clb_pg_addr + clbp * HBA_CLB_SIZE,
- .fisv = fis_pg_addr + fisp * HBA_FIS_SIZE };
+ *port = (struct hba_port){
+ .regs = port_regs,
+ .ssts = port_regs[HBA_RPxSSTS],
+ .cmdlst = (struct hba_cmdh*)(clb_pg_addr + clbp * HBA_CLB_SIZE),
+ .fis = (void*)(fis_pg_addr + fisp * HBA_FIS_SIZE),
+ .hba = hba
+ };
/* 初始化端口,并置于就绪状态 */
port_regs[HBA_RPxCI] = 0;
- port_regs[HBA_RPxIE] |= (HBA_PxINTR_DMA | HBA_PxINTR_D2HR);
- port_regs[HBA_RPxCMD] |= (HBA_PxCMD_FRE | HBA_PxCMD_ST);
- hba.ports[i] = port;
+ hba_clear_reg(port_regs[HBA_RPxSERR]);
+
+ hba->ports[i] = port;
+
+ if (!HBA_RPxSSTS_IF(port->ssts)) {
+ continue;
+ }
+
+ wait_until(!(port_regs[HBA_RPxCMD] & HBA_PxCMD_CR));
+ port_regs[HBA_RPxCMD] |= HBA_PxCMD_FRE;
+ port_regs[HBA_RPxCMD] |= HBA_PxCMD_ST;
+
+ if (!ahci_init_device(port)) {
+ ERROR("init fail: 0x%x@p%d", port->regs[HBA_RPxSIG], i);
+ continue;
+ }
+
+ struct hba_device* hbadev = port->device;
+ kprintf(KINFO "sata%d: %s, blk_size=%d, blk=0..%d",
+ i,
+ hbadev->model,
+ hbadev->block_size,
+ (u32_t)hbadev->max_lba);
+
+ ahci_register_device(hbadev);
}
+
+ return ahci_drv;
+}
+
+void
+ahci_register_device(struct hba_device* hbadev)
+{
+ struct block_dev* bdev =
+ block_alloc_dev(hbadev->model, hbadev, __ahci_blkio_handler);
+
+ bdev->end_lba = hbadev->max_lba;
+ bdev->blk_size = hbadev->block_size;
+ bdev->class = &ahci_class;
+
+ block_mount(bdev, ahci_fsexport);
}
-char sata_ifs[][20] = { "Not detected",
- "SATA I (1.5Gbps)",
- "SATA II (3.0Gbps)",
- "SATA III (6.0Gbps)" };
+int
+__get_free_slot(struct hba_port* port)
+{
+ hba_reg_t pxsact = port->regs[HBA_RPxSACT];
+ hba_reg_t pxci = port->regs[HBA_RPxCI];
+ hba_reg_t free_bmp = pxsact | pxci;
+ u32_t i = 0;
+ for (; i <= port->hba->cmd_slots && (free_bmp & 0x1); i++, free_bmp >>= 1)
+ ;
+ return i | -(i > port->hba->cmd_slots);
+}
void
-ahci_list_device()
+sata_create_fis(struct sata_reg_fis* cmd_fis,
+ u8_t command,
+ lba_t lba,
+ u16_t sector_count)
{
- kprintf(KINFO "Version: %x; Ports: %d\n", hba.version, hba.ports_num);
- for (size_t i = 0; i < 32; i++) {
- struct ahci_port* port = hba.ports[i];
- if (!port)
- continue;
- kprintf("\t Port %d: %s\n", i, &sata_ifs[HBA_RPxSSTS_IF(port->ssts)]);
+ cmd_fis->head.type = SATA_REG_FIS_H2D;
+ cmd_fis->head.options = SATA_REG_FIS_COMMAND;
+ cmd_fis->head.status_cmd = command;
+ cmd_fis->dev = 0;
+
+ cmd_fis->lba0 = SATA_LBA_COMPONENT(lba, 0);
+ cmd_fis->lba8 = SATA_LBA_COMPONENT(lba, 8);
+ cmd_fis->lba16 = SATA_LBA_COMPONENT(lba, 16);
+ cmd_fis->lba24 = SATA_LBA_COMPONENT(lba, 24);
+
+ cmd_fis->lba32 = SATA_LBA_COMPONENT(lba, 32);
+ cmd_fis->lba40 = SATA_LBA_COMPONENT(lba, 40);
+
+ cmd_fis->count = sector_count;
+}
+
+int
+hba_bind_sbuf(struct hba_cmdh* cmdh, struct hba_cmdt* cmdt, struct membuf mbuf)
+{
+ assert_msg(mbuf.size <= 0x400000U, "HBA: Buffer too big");
+ cmdh->prdt_len = 1;
+ cmdt->entries[0] =
+ (struct hba_prdte){ .data_base = vmm_v2p((ptr_t)mbuf.buffer),
+ .byte_count = mbuf.size - 1 };
+
+ return 0;
+}
+
+int
+hba_bind_vbuf(struct hba_cmdh* cmdh, struct hba_cmdt* cmdt, struct vecbuf* vbuf)
+{
+ size_t i = 0;
+ struct vecbuf* pos = vbuf;
+
+ do {
+ assert_msg(i < HBA_MAX_PRDTE, "HBA: Too many PRDTEs");
+ assert_msg(pos->buf.size <= 0x400000U, "HBA: Buffer too big");
+
+ cmdt->entries[i++] =
+ (struct hba_prdte){ .data_base = vmm_v2p((ptr_t)pos->buf.buffer),
+ .byte_count = pos->buf.size - 1 };
+ pos = list_entry(pos->components.next, struct vecbuf, components);
+ } while (pos != vbuf);
+
+ cmdh->prdt_len = i + 1;
+
+ return 0;
+}
+
+int
+hba_prepare_cmd(struct hba_port* port,
+ struct hba_cmdt** cmdt,
+ struct hba_cmdh** cmdh)
+{
+ int slot = __get_free_slot(port);
+ assert_msg(slot >= 0, "HBA: No free slot");
+
+ // 构建命令头(Command Header)和命令表(Command Table)
+ struct hba_cmdh* cmd_header = &port->cmdlst[slot];
+ struct hba_cmdt* cmd_table = vzalloc_dma(sizeof(struct hba_cmdt));
+
+ memset(cmd_header, 0, sizeof(*cmd_header));
+
+ // 将命令表挂到命令头上
+ cmd_header->cmd_table_base = vmm_v2p((ptr_t)cmd_table);
+ cmd_header->options =
+ HBA_CMDH_FIS_LEN(sizeof(struct sata_reg_fis)) | HBA_CMDH_CLR_BUSY;
+
+ *cmdh = cmd_header;
+ *cmdt = cmd_table;
+
+ return slot;
+}
+
+int
+ahci_init_device(struct hba_port* port)
+{
+ /* 发送ATA命令,参考:SATA AHCI Spec Rev.1.3.1, section 5.5 */
+ struct hba_cmdt* cmd_table;
+ struct hba_cmdh* cmd_header;
+
+ // mask DHR interrupt
+ port->regs[HBA_RPxIE] &= ~HBA_MY_IE;
+
+ // 预备DMA接收缓存,用于存放HBA传回的数据
+ u16_t* data_in = (u16_t*)valloc_dma(512);
+
+ int slot = hba_prepare_cmd(port, &cmd_table, &cmd_header);
+ hba_bind_sbuf(
+ cmd_header, cmd_table, (struct membuf){ .buffer = data_in, .size = 512 });
+
+ port->device = vzalloc(sizeof(struct hba_device));
+ port->device->port = port;
+ port->device->hba = port->hba;
+
+ // 在命令表中构建命令FIS
+ struct sata_reg_fis* cmd_fis = (struct sata_reg_fis*)cmd_table->command_fis;
+
+ // 根据设备类型使用合适的命令
+ if (port->regs[HBA_RPxSIG] == HBA_DEV_SIG_ATA) {
+ // ATA 一般为硬盘
+ sata_create_fis(cmd_fis, ATA_IDENTIFY_DEVICE, 0, 0);
+ } else {
+ // ATAPI 一般为光驱,软驱,或者磁带机
+ port->device->flags |= HBA_DEV_FATAPI;
+ sata_create_fis(cmd_fis, ATA_IDENTIFY_PAKCET_DEVICE, 0, 0);
}
-}
\ No newline at end of file
+
+ if (!ahci_try_send(port, slot)) {
+ goto fail;
+ }
+
+ /*
+ 等待数据到达内存
+ 解析IDENTIFY DEVICE传回来的数据。
+ 参考:
+ * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.12.7
+ */
+ ahci_parse_dev_info(port->device, data_in);
+
+ if (!(port->device->flags & HBA_DEV_FATAPI)) {
+ goto done;
+ }
+
+ /*
+ 注意:ATAPI设备是无法通过IDENTIFY PACKET DEVICE 获取容量信息的。
+ 我们需要使用SCSI命令的READ_CAPACITY(16)进行获取。
+ 步骤如下:
+ 1. 因为ATAPI走的是SCSI,而AHCI对此专门进行了SATA的封装,
+ 也就是通过SATA的PACKET命令对SCSI命令进行封装。所以我们
+ 首先需要构建一个PACKET命令的FIS
+ 2. 接着,在ACMD中构建命令READ_CAPACITY的CDB - 一种SCSI命令的封装
+ 3. 然后把cmd_header->options的A位置位,表示这是一个送往ATAPI的命令。
+ 一点细节:
+ 1. HBA往底层SATA控制器发送PACKET FIS
+ 2. SATA控制器回复PIO Setup FIS
+ 3. HBA读入ACMD中的CDB,打包成Data FIS进行答复
+ 4. SATA控制器解包,拿到CDB,通过SCSI协议转发往ATAPI设备。
+ 5. ATAPI设备回复Return Parameter,SATA通过DMA Setup FIS
+ 发起DMA请求,HBA介入,将Return Parameter写入我们在PRDT
+ 里设置的data_in位置。
+ 4. 最后照常等待HBA把结果写入data_in,然后直接解析就好了。
+ 参考:
+ * ATA/ATAPI Command Set - 3 (ACS-3), Section 7.18
+ * SATA AHCI HBA Spec, Section 5.3.7
+ * SCSI Command Reference Manual, Section 3.26
+ */
+
+ sata_create_fis(cmd_fis, ATA_PACKET, 512 << 8, 0);
+
+ // for dev use 12 bytes cdb, READ_CAPACITY must use the 10 bytes variation.
+ if (port->device->cbd_size == SCSI_CDB12) {
+ struct scsi_cdb12* cdb12 = (struct scsi_cdb12*)cmd_table->atapi_cmd;
+ // ugly tricks to construct 10 byte cdb from 12 byte cdb
+ scsi_create_packet12(cdb12, SCSI_READ_CAPACITY_10, 0, 512 << 8);
+ } else {
+ struct scsi_cdb16* cdb16 = (struct scsi_cdb16*)cmd_table->atapi_cmd;
+ scsi_create_packet16(cdb16, SCSI_READ_CAPACITY_16, 0, 512);
+ cdb16->misc1 = 0x10; // service action
+ }
+
+ cmd_header->transferred_size = 0;
+ cmd_header->options |= HBA_CMDH_ATAPI;
+
+ if (!ahci_try_send(port, slot)) {
+ goto fail;
+ }
+
+ scsi_parse_capacity(port->device, (u32_t*)data_in);
+
+done:
+ // reset interrupt status and unmask D2HR interrupt
+ port->regs[HBA_RPxIE] |= HBA_MY_IE;
+ achi_register_ops(port);
+
+ vfree_dma(data_in);
+ vfree_dma(cmd_table);
+
+ return 1;
+
+fail:
+ port->regs[HBA_RPxIE] |= HBA_MY_IE;
+ vfree_dma(data_in);
+ vfree_dma(cmd_table);
+
+ return 0;
+}
+
+int
+ahci_identify_device(struct hba_device* device)
+{
+ // 用于重新识别设备(比如在热插拔的情况下)
+ vfree(device);
+ return ahci_init_device(device->port);
+}
+
+void
+achi_register_ops(struct hba_port* port)
+{
+ port->device->ops.identify = ahci_identify_device;
+ if (!(port->device->flags & HBA_DEV_FATAPI)) {
+ port->device->ops.submit = sata_submit;
+ } else {
+ port->device->ops.submit = scsi_submit;
+ }
+}