PS5Parser.h

Go to the documentation of this file.

/* Copyright (C) 2021 Kristian Sloth Lauszus. All rights reserved.
 
 This software may be distributed and modified under the terms of the GNU
 General Public License version 2 (GPL2) as published by the Free Software
 Foundation and appearing in the file GPL2.TXT included in the packaging of
 this file. Please note that GPL2 Section 2[b] requires that all works based
 on this software must also be made publicly available under the terms of
 the GPL2 ("Copyleft").
 
 Contact information
 -------------------
 
 Kristian Sloth Lauszus
 Web      :  https://lauszus.com
 e-mail   :  lauszus@gmail.com
 
 Thanks to Joseph Duchesne for the initial code.
 Based on Ludwig Füchsl's https://github.com/Ohjurot/DualSense-Windows PS5 port
 and the series of patches found here: https://patchwork.kernel.org/project/linux-input/cover/20201219062336.72568-1-roderick@gaikai.com/
 */
 
#ifndef _ps5parser_h_
#define _ps5parser_h_
 
#include "Usb.h"
#include "controllerEnums.h"
#include "PS5Trigger.h"
 
const uint8_t PS5_BUTTONS[] PROGMEM = {
        UP, // UP
        RIGHT, // RIGHT
        DOWN, // DOWN
        LEFT, // LEFT
 
        0x0C, // CREATE
        0x0D, // OPTIONS
        0x0E, // L3
        0x0F, // R3
 
        0x0A, // L2
        0x0B, // R2
        0x08, // L1
        0x09, // R1
 
        0x07, // TRIANGLE
        0x06, // CIRCLE
        0x05, // CROSS
        0x04, // SQUARE
 
        0x10, // PS
        0x11, // TOUCHPAD
        0x12, // MICROPHONE
};
 
union PS5Buttons {
        struct {
                uint8_t dpad : 4;
                uint8_t square : 1;
                uint8_t cross : 1;
                uint8_t circle : 1;
                uint8_t triangle : 1;
 
                uint8_t l1 : 1;
                uint8_t r1 : 1;
                uint8_t l2 : 1;
                uint8_t r2 : 1;
                uint8_t create : 1;
                uint8_t menu : 1;
                uint8_t l3 : 1;
                uint8_t r3 : 1;
 
                uint8_t ps : 1;
                uint8_t touchpad : 1;
                uint8_t mic : 1;
                uint8_t dummy : 5;
        } __attribute__((packed));
        uint32_t val : 24;
} __attribute__((packed));
 
struct ps5TouchpadXY {
        struct {
                uint8_t counter : 7; // Increments every time a finger is touching the touchpad
                uint8_t touching : 1; // The top bit is cleared if the finger is touching the touchpad
                uint16_t x : 12;
                uint16_t y : 12;
        } __attribute__((packed)) finger[2]; // 0 = first finger, 1 = second finger
} __attribute__((packed));
 
union PS5Status {
        struct {
                // first byte
                uint8_t headphone : 1;
                uint8_t dummy : 2; // Seems to change when a jack is plugged in. First bit stays on when a mic is plugged in.
                uint8_t usb : 1; // charging
                uint8_t dummy2: 4;
 
                // second byte
                uint8_t mic : 1;
                uint8_t dummy3 : 3;
        } __attribute__((packed));
        uint16_t val;
} __attribute__((packed));
 
struct PS5Data {
        /* Button and joystick values */
        uint8_t hatValue[4]; // 0-3 bytes
        uint8_t trigger[2]; // 4-5
 
        uint8_t sequence_number; // 6
 
        PS5Buttons btn; // 7-9
 
        uint8_t reserved[5]; // 0xA-0xD
 
        /* Gyro and accelerometer values */
        int16_t gyroX, gyroZ, gyroY; // 0x0F - 0x14
        int16_t accX, accZ, accY; // 0x15-0x1A
        int32_t sensor_timestamp;
 
        uint8_t reserved2;
 
        // 0x20 - 0x23 touchpad point 1
        // 0x24 - 0x27 touchpad point 2
        ps5TouchpadXY xy;
 
#if 0 // The status byte depends on if it's sent via USB or Bluetooth, so is not parsed for now
        uint8_t reserved3; // 0x28
 
        uint8_t rightTriggerFeedback; // 0x29
        uint8_t leftTriggerFeedback; // 0x2A
        uint8_t reserved4[10]; // 0x2B - 0x34
 
        // status bytes 0x35-0x36
        PS5Status status;
#endif
} __attribute__((packed));
 
struct PS5Output {
        uint8_t bigRumble, smallRumble; // Rumble
        uint8_t microphoneLed;
        uint8_t disableLeds;
        uint8_t playerLeds;
        uint8_t r, g, b; // RGB for lightbar
        bool reportChanged; // The data is send when data is received from the controller
} __attribute__((packed));
 
class PS5Parser {
public:
        PS5Parser() : leftTrigger(), rightTrigger() {
                Reset();
        };
 
        PS5Trigger leftTrigger, rightTrigger;
 
        bool getButtonPress(ButtonEnum b);
        bool getButtonClick(ButtonEnum b);
        uint8_t getAnalogButton(ButtonEnum b);
 
        uint8_t getAnalogHat(AnalogHatEnum a);
 
        uint16_t getX(uint8_t finger = 0) {
                return ps5Data.xy.finger[finger].x;
        };
 
        uint16_t getY(uint8_t finger = 0) {
                return ps5Data.xy.finger[finger].y;
        };
 
        bool isTouching(uint8_t finger = 0) {
                return !(ps5Data.xy.finger[finger].touching); // The bit is cleared when a finger is touching the touchpad
        };
 
        uint8_t getTouchCounter(uint8_t finger = 0) {
                return ps5Data.xy.finger[finger].counter;
        };
 
        float getAngle(AngleEnum a) {
                if (a == Pitch)
                        return (atan2f(-ps5Data.accY, -ps5Data.accZ) + PI) * RAD_TO_DEG;
                else
                        return (atan2f(ps5Data.accX, -ps5Data.accZ) + PI) * RAD_TO_DEG;
        };
 
        int16_t getSensor(SensorEnum s) {
                switch(s) {
                        case gX:
                                return ps5Data.gyroX;
                        case gY:
                                return ps5Data.gyroY;
                        case gZ:
                                return ps5Data.gyroZ;
                        case aX:
                                return ps5Data.accX;
                        case aY:
                                return ps5Data.accY;
                        case aZ:
                                return ps5Data.accZ;
                        default:
                                return 0;
                }
        };
 
#if 0 // Seems to only be available via Bluetooth, so have been disabled for now
        uint8_t getBatteryLevel() {
                return ps5Data.status.battery;
        };
#endif
 
#if 0 // These are only valid via USB, so have been commented out for now
        bool getUsbStatus() {
                return ps5Data.status.usb;
        };
 
        bool getAudioStatus() {
                return ps5Data.status.headphone;
        };
 
        bool getMicStatus() {
                return ps5Data.status.mic;
        };
#endif
 
        void setAllOff() {
                setRumbleOff();
                setLedOff();
        };
 
        void setRumbleOff() {
                setRumbleOn(0, 0);
        };
 
        void setRumbleOn(RumbleEnum mode) {
                if (mode == RumbleLow)
                        setRumbleOn(0x00, 0xFF);
                else
                        setRumbleOn(0xFF, 0x00);
        };
 
        void setRumbleOn(uint8_t bigRumble, uint8_t smallRumble) {
                ps5Output.bigRumble = bigRumble;
                ps5Output.smallRumble = smallRumble;
                ps5Output.reportChanged = true;
        };
 
        void setLedOff() {
                setLed(0, 0, 0);
        };
 
        void setLed(uint8_t r, uint8_t g, uint8_t b) {
                ps5Output.r = r;
                ps5Output.g = g;
                ps5Output.b = b;
                ps5Output.reportChanged = true;
        };
 
        void setLed(ColorsEnum color) {
                setLed((uint8_t)(color >> 16), (uint8_t)(color >> 8), (uint8_t)(color));
        };
 
        void setPlayerLedOff() {
                setPlayerLed(0);
        }
 
        void setPlayerLed(uint8_t mask) {
                ps5Output.playerLeds = mask;
                ps5Output.reportChanged = true;
        }
 
        void setMicLedOff() {
                setMicLed(0);
        }
 
        void setMicLed(bool on) {
                ps5Output.microphoneLed = on ? 1 : 0;
                ps5Output.reportChanged = true;
        }
 
        uint16_t getMessageCounter(){
                return message_counter;
        }
 
protected:
        void Parse(uint8_t len, uint8_t *buf);
 
        void Reset();
 
        virtual void sendOutputReport(PS5Output *output) = 0;
 
 
private:
        static int8_t getButtonIndexPS5(ButtonEnum b);
        bool checkDpad(ButtonEnum b); // Used to check PS5 DPAD buttons
 
        PS5Data ps5Data;
        PS5Buttons oldButtonState, buttonClickState;
        PS5Output ps5Output;
        uint8_t oldDpad;
        uint16_t message_counter = 0;
};
#endif