dingusppc/devices/common/dbdma.h

/*
DingusPPC - The Experimental PowerPC Macintosh emulator
Copyright (C) 2018-23 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/>.
*/

/** @file Descriptor-based direct memory access emulation.

    Official documentation can be found in the fifth chapter of the book
    "Macintosh Technology in the Common Hardware Reference Platform"
    by Apple Computer, Inc.
 */

#ifndef DB_DMA_H
#define DB_DMA_H

#include <devices/common/dmacore.h>

#include <cinttypes>
#include <functional>

class InterruptCtrl;

/** DBDMA Channel registers offsets */
enum DMAReg : uint32_t {
    CH_CTRL         = 0,
    CH_STAT         = 4,
    CMD_PTR_HI      = 8, // not implemented
    CMD_PTR_LO      = 12,
    INT_SELECT      = 16,
    BRANCH_SELECT   = 20,
    WAIT_SELECT     = 24,
//  TANSFER_MODES   = 28,
//  DATA_2_PTR_HI   = 32, // not implemented
//  DATA_2_PTR_LO   = 36,
//  RESERVED_1      = 40,
//  ADDRESS_HI      = 44,
//  RESERVED_2_0    = 48,
//  RESERVED_2_1    = 52,
//  RESERVED_2_2    = 56,
//  RESERVED_2_3    = 60,
//  UNIMPLEMENTED   = 64,
//  UNDEFINED       = 128,
};

/** Channel Status bits (DBDMA spec, 5.5.3) */
enum : uint16_t {
    CH_STAT_S0     = 0x0001, // general purpose status and control
    CH_STAT_S1     = 0x0002, // general purpose status and control
    CH_STAT_S2     = 0x0004, // general purpose status and control
    CH_STAT_S3     = 0x0008, // general purpose status and control
    CH_STAT_S4     = 0x0010, // general purpose status and control
    CH_STAT_S5     = 0x0020, // general purpose status and control
    CH_STAT_S6     = 0x0040, // general purpose status and control
    CH_STAT_S7     = 0x0080, // general purpose status and control
    CH_STAT_BT     = 0x0100, // hardware status bit
    CH_STAT_ACTIVE = 0x0400, // hardware status bit
    CH_STAT_DEAD   = 0x0800, // hardware status bit
    CH_STAT_WAKE   = 0x1000, // command bit set by software and cleared by hardware once the action has been performed
    CH_STAT_FLUSH  = 0x2000, // command bit set by software and cleared by hardware once the action has been performed
    CH_STAT_PAUSE  = 0x4000, // control bit set and cleared by software
    CH_STAT_RUN    = 0x8000  // control bit set and cleared by software
};

/** DBDMA command (DBDMA spec, 5.6.1) - all fields are little-endian! */
typedef struct DMACmd {
    uint16_t    req_count;
    uint8_t     cmd_bits; // wait: & 3, branch: & 0xC, interrupt: & 0x30, reserved: & 0xc0
    uint8_t     cmd_key; // key: & 7, reserved: & 8, cmd: >> 4
    uint32_t    address;
    uint32_t    cmd_arg;
    uint16_t    res_count;
    uint16_t    xfer_stat;
} DMACmd;

namespace DBDMA_Cmd {
    enum : uint8_t {
        OUTPUT_MORE = 0,
        OUTPUT_LAST = 1,
        INPUT_MORE  = 2,
        INPUT_LAST  = 3,
        STORE_QUAD  = 4,
        LOAD_QUAD   = 5,
        NOP         = 6,
        STOP        = 7
    };
};

typedef std::function<void(void)> DbdmaCallback;

class DMAChannel : public DmaBidirChannel {
public:
    DMAChannel(std::string name) : DmaBidirChannel(name) {}
    ~DMAChannel() = default;

    void set_callbacks(DbdmaCallback start_cb, DbdmaCallback stop_cb);
    void set_data_callbacks(DbdmaCallback in_cb, DbdmaCallback out_cb, DbdmaCallback flush_cb);
    uint32_t reg_read(uint32_t offset, int size);
    void reg_write(uint32_t offset, uint32_t value, int size);
    void set_stat(uint8_t new_stat) { this->ch_stat = (this->ch_stat & 0xff00) | new_stat; }

    bool            is_out_active();
    bool            is_in_active();
    DmaPullResult   pull_data(uint32_t req_len, uint32_t *avail_len, uint8_t **p_data);
    int             push_data(const char* src_ptr, int len);
    int             get_pull_data_remaining() { return this->queue_len; }
    int             get_push_data_remaining() { return this->queue_len; }
    void            end_pull_data();
    void            end_push_data();

    void register_dma_int(InterruptCtrl* int_ctrl_obj, uint32_t irq_id) {
        this->int_ctrl = int_ctrl_obj;
        this->irq_id   = irq_id;
    };

protected:
    DMACmd* fetch_cmd(uint32_t cmd_addr, DMACmd* p_cmd, bool *is_writable);
    uint8_t interpret_cmd(void);
    void finish_cmd();
    void xfer_quad(const DMACmd *cmd_desc, DMACmd *cmd_host);
    void update_irq();

    void start(void);
    void resume(void);
    void abort(void);
    void pause(void);

private:
    std::function<void(void)> start_cb = nullptr; // DMA channel start callback
    std::function<void(void)> stop_cb  = nullptr; // DMA channel stop callback
    std::function<void(void)> in_cb    = nullptr; // DMA channel in callback
    std::function<void(void)> out_cb   = nullptr; // DMA channel out callback
    std::function<void(void)> flush_cb = nullptr; // DMA channel flush callback

    uint16_t ch_stat        = 0;
    uint32_t cmd_ptr        = 0;
    uint32_t queue_len      = 0;
    uint8_t* queue_data     = 0;
    uint32_t res_count      = 0;
    uint32_t int_select     = 0;
    uint32_t branch_select  = 0;
    uint32_t wait_select    = 0;

    bool     cmd_in_progress = false;
    uint8_t  cur_cmd;

    // Interrupt related stuff
    InterruptCtrl* int_ctrl = nullptr;
    uint32_t       irq_id   = 0;
};

#endif /* DB_DMA_H */