Skip to content
charmOS docs

PCI

include/drivers/pci.h

Section titled “include/drivers/pci.h”

struct pci_device

Section titled “struct pci_device”
struct pci_device {
    struct device  device;
    uint8_t        bus;
    uint8_t        dev;
    uint8_t        function;
    uint16_t       vendor_id;
    uint16_t       device_id;
    uint8_t        class_code;
    uint8_t        subclass;
    uint8_t        prog_if;
    uint8_t        revision;
};

struct pci_device referenced types:

struct pci_driver

Section titled “struct pci_driver”
struct pci_driver {
    struct device_driver  driver;
    uint8_t               class_code;
    uint8_t               subclass;
    uint8_t               prog_if;
    uint16_t              vendor_id;
};

struct pci_driver referenced types:

union pci_command_reg

Section titled “union pci_command_reg”
union pci_command_reg {
    uint16_t  value;
    struct {
        uint16_t  io_space;
        uint16_t  memory_space;
        uint16_t  bus_master;
        uint16_t  special_cycles;
        uint16_t  mem_write_inv;
        uint16_t  vga_snoop;
        uint16_t  parity_error;
        uint16_t  reserved0;
        uint16_t  serr_enable;
        uint16_t  fast_back;
        uint16_t  interrupt_disable;
        uint16_t  reserved1;
    };
};

struct pci_msix_table_entry

Section titled “struct pci_msix_table_entry”
struct pci_msix_table_entry {
    uint32_t  msg_addr_low;
    uint32_t  msg_addr_high;
    uint32_t  msg_data;
    uint32_t  vector_ctrl;
};

struct pci_msix_cap

Section titled “struct pci_msix_cap”
struct pci_msix_cap {
    uint8_t   cap_id;
    uint8_t   next_ptr;
    uint16_t  msg_ctl;
    uint32_t  table_offset_bir;
    uint32_t  pba_offset_bir;
};

pci_read_config16

Section titled “pci_read_config16”
uint16_t pci_read_config16(uint8_t bus, uint8_t device, uint8_t function, uint8_t offset);

pci_read_config8

Section titled “pci_read_config8”
uint8_t pci_read_config8(uint8_t bus, uint8_t device, uint8_t function, uint8_t offset);

pci_write_config16

Section titled “pci_write_config16”
void pci_write_config16(uint8_t bus, uint8_t device, uint8_t function, uint8_t offset, uint16_t value);

pci_config_address

Section titled “pci_config_address”
uint32_t pci_config_address(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset);

pci_read

Section titled “pci_read”
uint32_t pci_read(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset);

pci_read_word

Section titled “pci_read_word”
uint16_t pci_read_word(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset);

pci_read_byte

Section titled “pci_read_byte”
uint8_t pci_read_byte(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset);

pci_write

Section titled “pci_write”
void pci_write(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset, uint32_t value);

pci_write_word

Section titled “pci_write_word”
void pci_write_word(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset, uint16_t value);

pci_write_byte

Section titled “pci_write_byte”
void pci_write_byte(uint8_t bus, uint8_t slot, uint8_t func, uint8_t offset, uint8_t value);

pci_class_name

Section titled “pci_class_name”
char * pci_class_name(uint8_t class_code, uint8_t subclass);

pci_scan_devices

Section titled “pci_scan_devices”
void pci_scan_devices(struct pci_device **devices_out, uint64_t *count_out);

pci_scan_devices referenced types:

pci_read_bar

Section titled “pci_read_bar”
uint32_t pci_read_bar(uint8_t bus, uint8_t device, uint8_t function, uint8_t bar_index);

pci_enable_msix

Section titled “pci_enable_msix”
void pci_enable_msix(uint8_t bus, uint8_t slot, uint8_t func);

pci_enable_msix_on_core

Section titled “pci_enable_msix_on_core”
void pci_enable_msix_on_core(uint8_t bus, uint8_t slot, uint8_t func, uint8_t vector, uint8_t core);

pci_init_devices

Section titled “pci_init_devices”
void pci_init_devices(struct pci_device *devices, uint64_t count);

pci_init_devices referenced types:

pci_find_capability

Section titled “pci_find_capability”
uint8_t pci_find_capability(uint8_t bus, uint8_t slot, uint8_t func, uint8_t cap_id);

pci_program_msix_entry

Section titled “pci_program_msix_entry”
void pci_program_msix_entry(uint8_t bus, uint8_t slot, uint8_t func, uint32_t table_index, uint8_t vector, uint8_t apic_id);

Defines

Section titled “Defines”

PCI_CLASS_MASS_STORAGE

Section titled “PCI_CLASS_MASS_STORAGE”
#define PCI_CLASS_MASS_STORAGE 0x01

PCI_SUBCLASS_NVM

Section titled “PCI_SUBCLASS_NVM”
#define PCI_SUBCLASS_NVM 0x08

PCI_PROGIF_NVME

Section titled “PCI_PROGIF_NVME”
#define PCI_PROGIF_NVME 0x02

PCI_DEV_REGISTER(n, cc, sc, pi, vi, init)

Section titled “PCI_DEV_REGISTER(n, cc, sc, pi, vi, init)”
#define PCI_DEV_REGISTER(n, cc, sc, pi, vi, init)                              \ static struct pci_driver pci_device_##n __attribute__((                    \ section(".kernel_pci_devices"), used)) = {.driver.name = #n,           \ .class_code = cc,            \ .subclass = sc,              \ .prog_if = pi,               \ .vendor_id = vi,             \ .driver.probe = init};

PCI_BAR0

Section titled “PCI_BAR0”
#define PCI_BAR0 0x10

PCI_BAR1

Section titled “PCI_BAR1”
#define PCI_BAR1 0x14

PCI_BAR2

Section titled “PCI_BAR2”
#define PCI_BAR2 0x18

PCI_BAR3

Section titled “PCI_BAR3”
#define PCI_BAR3 0x1C

PCI_BAR4

Section titled “PCI_BAR4”
#define PCI_BAR4 0x20

PCI_BAR5

Section titled “PCI_BAR5”
#define PCI_BAR5 0x24

PCI_CAP_PTR

Section titled “PCI_CAP_PTR”
#define PCI_CAP_PTR 0x34

PCI_CAP_ID_MSIX

Section titled “PCI_CAP_ID_MSIX”
#define PCI_CAP_ID_MSIX 0x11

PCI_CONFIG_ADDRESS

Section titled “PCI_CONFIG_ADDRESS”
#define PCI_CONFIG_ADDRESS 0xCF8

PCI_CONFIG_DATA

Section titled “PCI_CONFIG_DATA”
#define PCI_CONFIG_DATA 0xCFC

PCI_INTERRUPT_LINE

Section titled “PCI_INTERRUPT_LINE”
#define PCI_INTERRUPT_LINE 0x3C

PCI_PROG_IF

Section titled “PCI_PROG_IF”
#define PCI_PROG_IF 0x09

pci_log(log_level, fmt, ...)

Section titled “pci_log(log_level, fmt, ...)”
#define pci_log(log_level, fmt, ...)                                           \ log(LOG_SITE(pci), LOG_HANDLE(pci), log_level, fmt, ##__VA_ARGS__)