DragonOS/kernel/driver/pci/pci.h

#pragma once

#include <common/glib.h>
#include "stdint.h"

#define PORT_PCI_CONFIG_ADDRESS 0xcf8
#define PORT_PCI_CONFIG_DATA 0xcfc

#define E_DEVICE_INVALID -1
#define E_WRONG_HEADER_TYPE -2
#define E_NOT_SUPPORT_MSI -3    // 设备不支持msi

// pci设备结构信息的链表
struct List * pci_device_structure_list = NULL;

/**
 * @brief 初始化pci驱动
 *
 */
void pci_init();

// pci设备结构的通用标题字段
struct pci_device_structure_header_t
{
    struct List list;
    // ==== 以下三个变量表示该结构体所处的位置
    uint8_t bus;
    uint8_t device;
    uint8_t func;

    uint16_t Vendor_ID; // 供应商ID 0xffff是一个无效值，在读取访问不存在的设备的配置空间寄存器时返回
    uint16_t Device_ID; // 设备ID，标志特定设备

    uint16_t Command; // 提供对设备生成和响应pci周期的能力的控制 向该寄存器写入0时，设备与pci总线断开除配置空间访问以外的所有连接
    uint16_t Status;  // 用于记录pci总线相关时间的状态信息寄存器

    uint8_t RevisionID; // 修订ID，指定特定设备的修订标志符
    uint8_t ProgIF;     // 编程接口字节，一个只读寄存器，指定设备具有的寄存器级别的编程接口（如果有的话）
    uint8_t SubClass;   // 子类。指定设备执行的特定功能的只读寄存器
    uint8_t Class_code; // 类代码，一个只读寄存器，指定设备执行的功能类型

    uint8_t CacheLineSize; // 缓存线大小：以 32 位为单位指定系统缓存线大小。设备可以限制它可以支持的缓存线大小的数量，如果不支持的值写入该字段，设备将表现得好像写入了 0 值
    uint8_t LatencyTimer;  // 延迟计时器：以 PCI 总线时钟为单位指定延迟计时器。
    uint8_t HeaderType;    // 标头类型 a value of 0x0 specifies a general device, a value of 0x1 specifies a PCI-to-PCI bridge, and a value of 0x2 specifies a CardBus bridge. If bit 7 of this register is set, the device has multiple functions; otherwise, it is a single function device.
    uint8_t BIST;          // Represents that status and allows control of a devices BIST (built-in self test).
                           // Here is the layout of the BIST register:
                           // |     bit7     |    bit6    | Bits 5-4 |     Bits 3-0    |
                           // | BIST Capable | Start BIST | Reserved | Completion Code |
                           // for more details, please visit https://wiki.osdev.org/PCI
} __attribute__((packed));

/**
 * @brief 表头类型为0x0的pci设备结构
 *
 */
struct pci_device_structure_general_device_t
{
    struct pci_device_structure_header_t header;
    uint32_t BAR0;
    uint32_t BAR1;
    uint32_t BAR2;
    uint32_t BAR3;
    uint32_t BAR4;
    uint32_t BAR5;
    uint32_t Cardbus_CIS_Pointer; // 指向卡信息结构，供在 CardBus 和 PCI 之间共享芯片的设备使用。

    uint16_t Subsystem_Vendor_ID;
    uint16_t Subsystem_ID;

    uint32_t Expansion_ROM_base_address;

    uint8_t Capabilities_Pointer;
    uint8_t reserved0;
    uint16_t reserved1;

    uint32_t reserved2;

    uint8_t Interrupt_Line; // 指定设备的中断引脚连接到系统中断控制器的哪个输入，并由任何使用中断引脚的设备实现。对于 x86 架构，此寄存器对应于 PIC IRQ 编号 0-15（而不是 I/O APIC IRQ 编号），并且值0xFF定义为无连接。
    uint8_t Interrupt_PIN;  // 指定设备使用的中断引脚。其中值为0x1INTA#、0x2INTB#、0x3INTC#、0x4INTD#，0x0表示设备不使用中断引脚。
    uint8_t Min_Grant;      // 一个只读寄存器，用于指定设备所需的突发周期长度（以 1/4 微秒为单位）（假设时钟速率为 33 MHz）
    uint8_t Max_Latency;    // 一个只读寄存器，指定设备需要多长时间访问一次 PCI 总线（以 1/4 微秒为单位）。
} __attribute__((packed));

/**
 * @brief 表头类型为0x1的pci设备结构（PCI to PCI Bridge）
 *
 */
struct pci_device_structure_pci_to_pci_bridge_t
{
    struct pci_device_structure_header_t header;

    uint32_t BAR0;
    uint32_t BAR1;

    uint8_t Primary_Bus_Number;
    uint8_t Secondary_Bus_Number;
    uint8_t Subordinate_Bus_Number;
    uint8_t Secondary_Latency_Timer;

    uint8_t io_base;
    uint8_t io_limit;
    uint16_t Secondary_Status;

    uint16_t Memory_Base;
    uint16_t Memory_Limit;

    uint16_t Prefetchable_Memory_Base;
    uint16_t Prefetchable_Memory_Limit;

    uint32_t Prefetchable_Base_Upper_32_Bits;
    uint32_t Prefetchable_Limit_Upper_32_Bits;

    uint16_t io_Base_Upper_16_Bits;
    uint16_t io_Limit_Upper_16_Bits;

    uint8_t Capability_Pointer;
    uint8_t reserved0;
    uint16_t reserved1;

    uint32_t Expansion_ROM_base_address;

    uint8_t Interrupt_Line;
    uint8_t Interrupt_PIN;
    uint16_t Bridge_Control;

} __attribute__((packed));


/**
 * @brief 表头类型为0x2的pci设备结构（PCI to CardBus Bridge）
 *
 */
struct pci_device_structure_pci_to_cardbus_bridge_t
{
    struct pci_device_structure_header_t header;

    uint32_t CardBus_Socket_ExCa_base_address;

    uint8_t Offset_of_capabilities_list;
    uint8_t Reserved;
    uint16_t Secondary_status;

    uint8_t PCI_bus_number;
    uint8_t CardBus_bus_number;
    uint8_t Subordinate_bus_number;
    uint8_t CardBus_latency_timer;

    uint32_t Memory_Base_Address0;
    uint32_t Memory_Limit0;
    uint32_t Memory_Base_Address1;
    uint32_t Memory_Limit1;
    uint32_t IO_Base_Address0;
    uint32_t IO_Limit0;
    uint32_t IO_Base_Address1;
    uint32_t IO_Limit1;

    uint8_t Interrupt_Line;
    uint8_t Interrupt_PIN;
    uint16_t Bridge_Control;

    uint16_t Subsystem_Device_ID;
    uint16_t Subsystem_Vendor_ID;

    uint32_t PC_Card_legacy_mode_base_address_16_bit;

} __attribute__((packed));


/**
 * @brief 从pci配置空间读取信息
 *
 * @param bus 总线号
 * @param slot 插槽号
 * @param func 功能号
 * @param offset 字节偏移量
 * @return uint 寄存器值
 */
uint32_t pci_read_config(uchar bus, uchar slot, uchar func, uchar offset);

/**
 * @brief 向pci配置空间写入信息
 *
 * @param bus 总线号
 * @param slot 设备号
 * @param func 功能号
 * @param offset 字节偏移量
 * @return uint 寄存器值
 */
uint pci_write_config(uchar bus, uchar slot, uchar func, uchar offset, uint32_t data);

/**
 * @brief 读取pci设备标头
 *
 * @param type 标头类型
 * @param bus 总线号
 * @param slot 插槽号
 * @param func 功能号
 * @return 返回的header的指针
 */
void* pci_read_header(int *type, uchar bus, uchar slot, uchar func, bool add_to_list);

/**
 * @brief 扫描所有pci总线上的所有设备
 * 
 */
void pci_checkAllBuses();

/**
 * @brief 启用 Message Signaled Interrupts
 * 
 * @param header 设备header
 * @param vector 中断向量号
 * @param processor 要投递到的处理器
 * @param edge_trigger 是否边缘触发
 * @param assert 是否高电平触发
 * 
 * @return 返回码
 */
int pci_enable_msi(void * header, uint8_t vector, uint32_t processor, uint8_t edge_trigger, uint8_t assert);

/**
 * @brief 禁用指定设备的msi
 *
 * @param header pci header
 * @return int
 */
int pci_disable_msi(void *header);

/**
 * @brief 获取 device structure
 * 
 * @param class_code 
 * @param sub_class 
 * @param res 返回的结果数组
 */
void pci_get_device_structure(uint8_t class_code, uint8_t sub_class, struct pci_device_structure_header_t* res[], uint32_t* count_res);