mirror of
https://github.com/DragonOS-Community/DragonOS.git
synced 2025-06-09 11:16:47 +00:00
402 lines
12 KiB
C
402 lines
12 KiB
C
#pragma once
|
||
|
||
#include "../block_device.h"
|
||
#include "../../pci/pci.h"
|
||
#include "../../../mm/mm.h"
|
||
|
||
/**
|
||
* @todo 加入io调度器(当操作系统实现了多进程之后要加入这个)
|
||
*
|
||
*/
|
||
#define AHCI_MAPPING_BASE SPECIAL_MEMOEY_MAPPING_VIRT_ADDR_BASE + AHCI_MAPPING_OFFSET
|
||
|
||
#define MAX_AHCI_DEVICES 100
|
||
|
||
#define HBA_PxCMD_ST 0x0001
|
||
#define HBA_PxCMD_FRE 0x0010
|
||
#define HBA_PxCMD_FR 0x4000
|
||
#define HBA_PxCMD_CR 0x8000
|
||
|
||
#define ATA_DEV_BUSY 0x80
|
||
#define ATA_DEV_DRQ 0x08
|
||
|
||
#define ATA_CMD_READ_DMA_EXT 0x25
|
||
#define ATA_CMD_WRITE_DMA_EXT 0x30
|
||
|
||
#define HBA_PxIS_TFES (1 << 30) /* TFES - Task File Error Status */
|
||
|
||
#define AHCI_SUCCESS 0 // 请求成功
|
||
#define E_NOEMPTYSLOT 1 // 没有空闲的slot
|
||
#define E_PORT_HUNG 2 // 端口被挂起
|
||
#define E_TASK_FILE_ERROR 3 // 任务文件错误
|
||
#define E_UNSUPPORTED_CMD 4 // 不支持的命令
|
||
|
||
extern struct block_device_operation ahci_operation;
|
||
|
||
/**
|
||
* @brief 在SATA3.0规范中定义的Frame Information Structure类型
|
||
*
|
||
*/
|
||
typedef enum
|
||
{
|
||
FIS_TYPE_REG_H2D = 0x27, // Register FIS - host to device
|
||
FIS_TYPE_REG_D2H = 0x34, // Register FIS - device to host
|
||
FIS_TYPE_DMA_ACT = 0x39, // DMA activate FIS - device to host
|
||
FIS_TYPE_DMA_SETUP = 0x41, // DMA setup FIS - bidirectional
|
||
FIS_TYPE_DATA = 0x46, // Data FIS - bidirectional
|
||
FIS_TYPE_BIST = 0x58, // BIST activate FIS - bidirectional
|
||
FIS_TYPE_PIO_SETUP = 0x5F, // PIO setup FIS - device to host
|
||
FIS_TYPE_DEV_BITS = 0xA1, // Set device bits FIS - device to host
|
||
} FIS_TYPE;
|
||
|
||
/**
|
||
* @brief FIS_REG_H2D 被用于从主机向设备发送控制命令
|
||
* 注意:reserved bit应当被清零
|
||
*/
|
||
typedef struct tagFIS_REG_H2D
|
||
{
|
||
// DWORD 0
|
||
uint8_t fis_type; // FIS_TYPE_REG_H2D
|
||
|
||
uint8_t pmport : 4; // Port multiplier
|
||
uint8_t rsv0 : 3; // Reserved
|
||
uint8_t c : 1; // 1: Command, 0: Control
|
||
|
||
uint8_t command; // Command register
|
||
uint8_t featurel; // Feature register, 7:0
|
||
|
||
// DWORD 1
|
||
uint8_t lba0; // LBA low register, 7:0
|
||
uint8_t lba1; // LBA mid register, 15:8
|
||
uint8_t lba2; // LBA high register, 23:16
|
||
uint8_t device; // Device register
|
||
|
||
// DWORD 2
|
||
uint8_t lba3; // LBA register, 31:24
|
||
uint8_t lba4; // LBA register, 39:32
|
||
uint8_t lba5; // LBA register, 47:40
|
||
uint8_t featureh; // Feature register, 15:8
|
||
|
||
// DWORD 3
|
||
uint8_t countl; // Count register, 7:0
|
||
uint8_t counth; // Count register, 15:8
|
||
uint8_t icc; // Isochronous command completion
|
||
uint8_t control; // Control register
|
||
|
||
// DWORD 4
|
||
uint8_t rsv1[4]; // Reserved
|
||
} FIS_REG_H2D;
|
||
|
||
// A device to host register FIS is used by the device to notify the host that some ATA register has changed.
|
||
// It contains the updated task files such as status, error and other registers.
|
||
typedef struct tagFIS_REG_D2H
|
||
{
|
||
// DWORD 0
|
||
uint8_t fis_type; // FIS_TYPE_REG_D2H
|
||
|
||
uint8_t pmport : 4; // Port multiplier
|
||
uint8_t rsv0 : 2; // Reserved
|
||
uint8_t i : 1; // Interrupt bit
|
||
uint8_t rsv1 : 1; // Reserved
|
||
|
||
uint8_t status; // Status register
|
||
uint8_t error; // Error register
|
||
|
||
// DWORD 1
|
||
uint8_t lba0; // LBA low register, 7:0
|
||
uint8_t lba1; // LBA mid register, 15:8
|
||
uint8_t lba2; // LBA high register, 23:16
|
||
uint8_t device; // Device register
|
||
|
||
// DWORD 2
|
||
uint8_t lba3; // LBA register, 31:24
|
||
uint8_t lba4; // LBA register, 39:32
|
||
uint8_t lba5; // LBA register, 47:40
|
||
uint8_t rsv2; // Reserved
|
||
|
||
// DWORD 3
|
||
uint8_t countl; // Count register, 7:0
|
||
uint8_t counth; // Count register, 15:8
|
||
uint8_t rsv3[2]; // Reserved
|
||
|
||
// DWORD 4
|
||
uint8_t rsv4[4]; // Reserved
|
||
} FIS_REG_D2H;
|
||
|
||
// This FIS is used by the host or device to send data payload. The data size can be varied.
|
||
typedef struct tagFIS_DATA
|
||
{
|
||
// DWORD 0
|
||
uint8_t fis_type; // FIS_TYPE_DATA
|
||
|
||
uint8_t pmport : 4; // Port multiplier
|
||
uint8_t rsv0 : 4; // Reserved
|
||
|
||
uint8_t rsv1[2]; // Reserved
|
||
|
||
// DWORD 1 ~ N
|
||
uint32_t data[1]; // Payload
|
||
} FIS_DATA;
|
||
|
||
// This FIS is used by the device to tell the host that it’s about to send or ready to receive a PIO data payload.
|
||
typedef struct tagFIS_PIO_SETUP
|
||
{
|
||
// DWORD 0
|
||
uint8_t fis_type; // FIS_TYPE_PIO_SETUP
|
||
|
||
uint8_t pmport : 4; // Port multiplier
|
||
uint8_t rsv0 : 1; // Reserved
|
||
uint8_t d : 1; // Data transfer direction, 1 - device to host
|
||
uint8_t i : 1; // Interrupt bit
|
||
uint8_t rsv1 : 1;
|
||
|
||
uint8_t status; // Status register
|
||
uint8_t error; // Error register
|
||
|
||
// DWORD 1
|
||
uint8_t lba0; // LBA low register, 7:0
|
||
uint8_t lba1; // LBA mid register, 15:8
|
||
uint8_t lba2; // LBA high register, 23:16
|
||
uint8_t device; // Device register
|
||
|
||
// DWORD 2
|
||
uint8_t lba3; // LBA register, 31:24
|
||
uint8_t lba4; // LBA register, 39:32
|
||
uint8_t lba5; // LBA register, 47:40
|
||
uint8_t rsv2; // Reserved
|
||
|
||
// DWORD 3
|
||
uint8_t countl; // Count register, 7:0
|
||
uint8_t counth; // Count register, 15:8
|
||
uint8_t rsv3; // Reserved
|
||
uint8_t e_status; // New value of status register
|
||
|
||
// DWORD 4
|
||
uint16_t tc; // Transfer count
|
||
uint8_t rsv4[2]; // Reserved
|
||
} FIS_PIO_SETUP;
|
||
|
||
typedef struct tagFIS_DMA_SETUP
|
||
{
|
||
// DWORD 0
|
||
uint8_t fis_type; // FIS_TYPE_DMA_SETUP
|
||
|
||
uint8_t pmport : 4; // Port multiplier
|
||
uint8_t rsv0 : 1; // Reserved
|
||
uint8_t d : 1; // Data transfer direction, 1 - device to host
|
||
uint8_t i : 1; // Interrupt bit
|
||
uint8_t a : 1; // Auto-activate. Specifies if DMA Activate FIS is needed
|
||
|
||
uint8_t rsved[2]; // Reserved
|
||
|
||
// DWORD 1&2
|
||
|
||
uint64_t DMAbufferID; // DMA Buffer Identifier. Used to Identify DMA buffer in host memory.
|
||
// SATA Spec says host specific and not in Spec. Trying AHCI spec might work.
|
||
|
||
// DWORD 3
|
||
uint32_t rsvd; // More reserved
|
||
|
||
// DWORD 4
|
||
uint32_t DMAbufOffset; // Byte offset into buffer. First 2 bits must be 0
|
||
|
||
// DWORD 5
|
||
uint32_t TransferCount; // Number of bytes to transfer. Bit 0 must be 0
|
||
|
||
// DWORD 6
|
||
uint32_t resvd; // Reserved
|
||
|
||
} FIS_DMA_SETUP;
|
||
|
||
typedef volatile struct tagHBA_PORT
|
||
{
|
||
uint64_t clb; // 0x00, command list base address, 1K-byte aligned
|
||
uint64_t fb; // 0x08, FIS base address, 256-byte aligned
|
||
uint32_t is; // 0x10, interrupt status
|
||
uint32_t ie; // 0x14, interrupt enable
|
||
uint32_t cmd; // 0x18, command and status
|
||
uint32_t rsv0; // 0x1C, Reserved
|
||
uint32_t tfd; // 0x20, task file data
|
||
uint32_t sig; // 0x24, signature
|
||
uint32_t ssts; // 0x28, SATA status (SCR0:SStatus)
|
||
uint32_t sctl; // 0x2C, SATA control (SCR2:SControl)
|
||
uint32_t serr; // 0x30, SATA error (SCR1:SError)
|
||
uint32_t sact; // 0x34, SATA active (SCR3:SActive)
|
||
uint32_t ci; // 0x38, command issue
|
||
uint32_t sntf; // 0x3C, SATA notification (SCR4:SNotification)
|
||
uint32_t fbs; // 0x40, FIS-based switch control
|
||
uint32_t rsv1[11]; // 0x44 ~ 0x6F, Reserved
|
||
uint32_t vendor[4]; // 0x70 ~ 0x7F, vendor specific
|
||
} HBA_PORT;
|
||
typedef volatile struct tagHBA_MEM
|
||
{
|
||
// 0x00 - 0x2B, Generic Host Control
|
||
uint32_t cap; // 0x00, Host capability
|
||
uint32_t ghc; // 0x04, Global host control
|
||
uint32_t is; // 0x08, Interrupt status
|
||
uint32_t pi; // 0x0C, Port implemented
|
||
uint32_t vs; // 0x10, Version
|
||
uint32_t ccc_ctl; // 0x14, Command completion coalescing control
|
||
uint32_t ccc_pts; // 0x18, Command completion coalescing ports
|
||
uint32_t em_loc; // 0x1C, Enclosure management location
|
||
uint32_t em_ctl; // 0x20, Enclosure management control
|
||
uint32_t cap2; // 0x24, Host capabilities extended
|
||
uint32_t bohc; // 0x28, BIOS/OS handoff control and status
|
||
|
||
// 0x2C - 0x9F, Reserved
|
||
uint8_t rsv[0xA0 - 0x2C];
|
||
|
||
// 0xA0 - 0xFF, Vendor specific registers
|
||
uint8_t vendor[0x100 - 0xA0];
|
||
|
||
// 0x100 - 0x10FF, Port control registers
|
||
HBA_PORT ports[32]; // 1 ~ 32
|
||
} HBA_MEM;
|
||
|
||
// There are four kinds of FIS which may be sent to the host by the device as indicated in the following structure declaration.
|
||
//
|
||
typedef volatile struct tagHBA_FIS
|
||
{
|
||
// 0x00
|
||
FIS_DMA_SETUP dsfis; // DMA Setup FIS
|
||
uint8_t pad0[4];
|
||
|
||
// 0x20
|
||
FIS_PIO_SETUP psfis; // PIO Setup FIS
|
||
uint8_t pad1[12];
|
||
|
||
// 0x40
|
||
FIS_REG_D2H rfis; // Register – Device to Host FIS
|
||
uint8_t pad2[4];
|
||
|
||
// 0x58
|
||
// FIS_DEV_BITS sdbfis; // Set Device Bit FIS
|
||
|
||
// 0x60
|
||
uint8_t ufis[64];
|
||
|
||
// 0xA0
|
||
uint8_t rsv[0x100 - 0xA0];
|
||
} HBA_FIS;
|
||
|
||
typedef struct tagHBA_CMD_HEADER
|
||
{
|
||
// DW0
|
||
uint8_t cfl : 5; // Command FIS length in DWORDS, 2 ~ 16
|
||
uint8_t a : 1; // ATAPI
|
||
uint8_t w : 1; // Write, 1: H2D, 0: D2H
|
||
uint8_t p : 1; // Prefetchable
|
||
|
||
uint8_t r : 1; // Reset
|
||
uint8_t b : 1; // BIST
|
||
uint8_t c : 1; // Clear busy upon R_OK
|
||
uint8_t rsv0 : 1; // Reserved
|
||
uint8_t pmp : 4; // Port multiplier port
|
||
|
||
uint16_t prdtl; // Physical region descriptor table length in entries
|
||
|
||
// DW1
|
||
volatile uint32_t prdbc; // Physical region descriptor byte count transferred
|
||
|
||
// DW2, 3
|
||
uint64_t ctba; // Command table descriptor base address
|
||
|
||
// DW4 - 7
|
||
uint32_t rsv1[4]; // Reserved
|
||
} HBA_CMD_HEADER;
|
||
|
||
typedef struct tagHBA_PRDT_ENTRY
|
||
{
|
||
uint64_t dba; // Data base address
|
||
uint32_t rsv0; // Reserved
|
||
|
||
// DW3
|
||
uint32_t dbc : 22; // Byte count, 4M max
|
||
uint32_t rsv1 : 9; // Reserved
|
||
uint32_t i : 1; // Interrupt on completion
|
||
} HBA_PRDT_ENTRY;
|
||
|
||
typedef struct tagHBA_CMD_TBL
|
||
{
|
||
// 0x00
|
||
uint8_t cfis[64]; // Command FIS
|
||
|
||
// 0x40
|
||
uint8_t acmd[16]; // ATAPI command, 12 or 16 bytes
|
||
|
||
// 0x50
|
||
uint8_t rsv[48]; // Reserved
|
||
|
||
// 0x80
|
||
HBA_PRDT_ENTRY prdt_entry[1]; // Physical region descriptor table entries, 0 ~ 65535
|
||
} HBA_CMD_TBL;
|
||
|
||
struct ahci_device_t
|
||
{
|
||
uint32_t type; // 设备类型
|
||
struct pci_device_structure_header_t *dev_struct;
|
||
HBA_MEM *hba_mem;
|
||
} ahci_devices[MAX_AHCI_DEVICES];
|
||
|
||
#define SATA_SIG_ATA 0x00000101 // SATA drive
|
||
#define SATA_SIG_ATAPI 0xEB140101 // SATAPI drive
|
||
#define SATA_SIG_SEMB 0xC33C0101 // Enclosure management bridge
|
||
#define SATA_SIG_PM 0x96690101 // Port multiplier
|
||
|
||
#define AHCI_DEV_NULL 0
|
||
#define AHCI_DEV_SATA 1
|
||
#define AHCI_DEV_SEMB 2
|
||
#define AHCI_DEV_PM 3
|
||
#define AHCI_DEV_SATAPI 4
|
||
|
||
#define HBA_PORT_IPM_ACTIVE 1
|
||
#define HBA_PORT_DET_PRESENT 3
|
||
|
||
struct ahci_request_packet_t
|
||
{
|
||
struct block_device_request_packet blk_pak; // 块设备请求包
|
||
uint8_t ahci_ctrl_num; // ahci控制器号, 默认应为0
|
||
uint8_t port_num; // ahci的设备端口号
|
||
};
|
||
|
||
/**
|
||
* @brief 初始化ahci模块
|
||
*
|
||
*/
|
||
void ahci_init();
|
||
|
||
/**
|
||
* @brief 检测端口连接的设备的类型
|
||
*
|
||
* @param device_num ahci设备号
|
||
*/
|
||
static void ahci_probe_port(const uint32_t device_num);
|
||
|
||
/**
|
||
* @brief read data from SATA device using 48bit LBA address
|
||
*
|
||
* @param port HBA PORT
|
||
* @param startl low 32bits of start addr
|
||
* @param starth high 32bits of start addr
|
||
* @param count total sectors to read
|
||
* @param buf buffer
|
||
* @return true done
|
||
* @return false failed
|
||
*/
|
||
static bool ahci_read(HBA_PORT *port, uint32_t startl, uint32_t starth, uint32_t count, uint64_t buf);
|
||
|
||
/**
|
||
* @brief write data to SATA device using 48bit LBA address
|
||
*
|
||
* @param port HBA PORT
|
||
* @param startl low 32bits of start addr
|
||
* @param starth high 32bits of start addr
|
||
* @param count total sectors to read
|
||
* @param buf buffer
|
||
* @return true done
|
||
* @return false failed
|
||
*/
|
||
static bool ahci_write(HBA_PORT *port, uint32_t startl, uint32_t starth, uint32_t count,
|
||
uint64_t buf);
|
||
|
||
void ahci_end_request(); |