dingusppc/devices/common/pci/pcidevice.h

/*
DingusPPC - The Experimental PowerPC Macintosh emulator
Copyright (C) 2018-21 divingkatae and maximum
                      (theweirdo)     spatium

(Contact divingkatae#1017 or powermax#2286 on Discord for more info)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef PCI_DEVICE_H
#define PCI_DEVICE_H

#include <devices/common/mmiodevice.h>
#include <devices/common/pci/pcihost.h>

#include <cinttypes>
#include <string>

/* convert little-endian DWORD to big-endian DWORD */
#define LE2BE(x) (x >> 24) | ((x & 0x00FF0000) >> 8) | ((x & 0x0000FF00) << 8) | (x << 24)

/** PCI configuration space registers offsets */
enum {
    CFG_REG_CMD  = 0x04,    // command/status register
    CFG_REG_BAR0 = 0x10,    // base address register 0
    CFG_REG_BAR1 = 0x14,    // base address register 1
    CFG_REG_BAR2 = 0x18,    // base address register 2
    CFG_REG_BAR3 = 0x1C,    // base address register 3
    CFG_REG_BAR4 = 0x20,    // base address register 4
    CFG_REG_BAR5 = 0x24,    // base address register 5
    CFG_EXP_BASE = 0x30,    // expansion ROM base
};


class PCIDevice : public MMIODevice {
public:
    PCIDevice(std::string name) {
        this->pci_name = name;
    };
    virtual ~PCIDevice() = default;

    virtual bool supports_io_space(void) = 0;

    /* I/O space access methods */
    virtual bool pci_io_read(uint32_t offset, uint32_t size, uint32_t* res) {
        return false;
    };

    virtual bool pci_io_write(uint32_t offset, uint32_t value, uint32_t size) {
        return false;
    };

    /* configuration space access methods */
    virtual uint32_t pci_cfg_read(uint32_t reg_offs, uint32_t size)              = 0;
    virtual void pci_cfg_write(uint32_t reg_offs, uint32_t value, uint32_t size) = 0;

    virtual void set_host(PCIHost* host_instance) {
        this->host_instance = host_instance;
    };

protected:
    std::string pci_name;      // human-readable device name
    PCIHost* host_instance;    // host bridge instance to call back
    uint32_t base_addr;        // base address register 0
};

#endif /* PCI_DEVICE_H */