advancedpad.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2025 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <EASTL/functional.h>
#include <stdint.h>
 
#include "psyqo/utility-polyfill.h"
 
namespace psyqo {
 
class AdvancedPad {
  public:
    enum class Pad : unsigned { Pad1a, Pad1b, Pad1c, Pad1d, Pad2a, Pad2b, Pad2c, Pad2d };
 
    enum Button {
        Select = 0,
        L3 = 1,
        R3 = 2,
        Start = 3,
        Up = 4,
        Right = 5,
        Down = 6,
        Left = 7,
        L2 = 8,
        R2 = 9,
        L1 = 10,
        R1 = 11,
        Triangle = 12,
        Circle = 13,
        Cross = 14,
        Square = 15,
    };
 
    enum PadType : uint8_t {
        Mouse = 0x12,           // (two button mouse)
        NegCon = 0x23,          // (steering twist/wheel/paddle)
        KonamiLightgun = 0x31,  // (IRQ10-type)
        DigitalPad = 0x41,      // (or analog pad/stick in digital mode; LED=Off)
        AnalogStick = 0x53,     // (or analog pad in "flight mode"; LED=Green)
        NamcoLightGun = 0x63,   // (Cinch-type)
        AnalogPad = 0x73,       // (in normal analog mode; LED=Red)
        Multitap = 0x80,        // (multiplayer adaptor) (when activated)
        JogCon = 0xe3,          // (steering dial)
        FishingCon = 0xe5,      // (fishing rod)
        ConfigMode = 0xf3,      // (when in config mode; see rumble command 43h)
        None = 0xff             // (no controller connected, pins floating High-Z)
    };
 
    struct Event {
        enum { PadConnected, PadDisconnected, ButtonPressed, ButtonReleased } type;
        Pad pad;
        Button button;
    };
 
    enum class PollingMode { Normal, Fast };
    void initialize(PollingMode mode = PollingMode::Normal);
 
    void setOnEvent(eastl::function<void(Event)>&& callback) { m_callback = eastl::move(callback); }
 
    bool isPadConnected(Pad pad) const { return m_padData[toUnderlying(pad)].connected == 0; }
 
    bool isButtonPressed(Pad pad, Button button) const {
        return (m_padData[toUnderlying(pad)].buttons & (1 << button)) == 0;
    }
 
    uint8_t getAdc(Pad pad, unsigned int index) const {
        const unsigned padIndex = toUnderlying(pad);
 
        return index <= 7 ? m_padData[padIndex].adc[index] : 0;
    }
 
    uint16_t getHalfword(Pad pad, unsigned int index) const { return m_padData[toUnderlying(pad)].packed[index % 4]; }
 
    uint8_t getPadType(Pad pad) const { return m_padData[toUnderlying(pad)].padType; }
 
  private:
    enum Command : uint8_t {
        PadSelect = 0x01,
        ReadPad = 0x42,  // 'B' Read Buttons AND analog inputs
        // Config mode commands
        ToggleConfigMode = 0x43,      // 'C' Enter/Exit Configuration Mode
        SetLED = 0x44,                // 'D' Set LED State (analog mode on/off)
        GetLED = 0x45,                // 'E' Get LED State (and whatever values)
        GetMotorInfo = 0x46,          // 'F' Allegedly get info about a motor
        GetMotorList = 0x47,          // 'G' Allegedly get list of motors
        GetMotorState = 0x48,         // 'H' Allegedly get motor state
        GetSupportedModes = 0x4c,     // 'L' Allegedly get supported modes
        ConfigRequestFormat = 0x4d,   // 'M' Allegedly configure poll request format
        ConfigResponseFormat = 0x4f,  // 'O' Allegedly configure poll response format
    };
 
    void busyLoop(unsigned delay) {
        unsigned cycles = 0;
        while (++cycles < delay) asm("");
    };
 
    void configurePort(uint8_t port);
 
    void flushRxBuffer();
    uint8_t outputDefault(unsigned ticks);
    uint8_t outputMultitap(unsigned ticks);
    void processChanges(Pad pad);
    void readPad();
    uint8_t transceive(uint8_t dataOut);
    bool waitForAck();  // true if ack received, false if timeout
 
    union PadData {
        struct {
            uint8_t connected;
            uint8_t padType;
            uint16_t buttons;
            uint8_t adc[8];
        };
        uint16_t packed[6];
    };
 
    PadData m_padData[8];
    eastl::function<void(Event)> m_callback;
    bool m_connected[8] = {false, false, false, false, false, false, false, false};
    uint16_t m_buttons[8] = {
        0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff,
    };
    uint8_t m_portToProbe = 0;
    uint8_t m_portsToProbeByVSync = 0;
};
 
// prefix increment operator
inline psyqo::AdvancedPad::Pad& operator++(psyqo::AdvancedPad::Pad& pad) {
    return pad = static_cast<psyqo::AdvancedPad::Pad>((toUnderlying(pad) + 1) & 7);
}
 
// postfix increment operator
inline psyqo::AdvancedPad::Pad operator++(psyqo::AdvancedPad::Pad& pad, int) {
    psyqo::AdvancedPad::Pad copy(pad);
    pad = static_cast<psyqo::AdvancedPad::Pad>((toUnderlying(pad) + 1) & 7);
    return copy;
}
 
// prefix decrement operator
inline psyqo::AdvancedPad::Pad& operator--(psyqo::AdvancedPad::Pad& pad) {
    return pad = static_cast<psyqo::AdvancedPad::Pad>((toUnderlying(pad) - 1) & 7);
}
 
// postfix decrement operator
inline psyqo::AdvancedPad::Pad operator--(psyqo::AdvancedPad::Pad& pad, int) {
    psyqo::AdvancedPad::Pad copy(pad);
    pad = static_cast<psyqo::AdvancedPad::Pad>((toUnderlying(pad) - 1) & 7);
    return copy;
}
 
}  // namespace psyqo