From c318a4c80b4b6eef9f8020f452573ef5c80f6716 Mon Sep 17 00:00:00 2001
From: Narr the Reg <juangerman-13@hotmail.com>
Date: Fri, 27 Jan 2023 22:30:44 -0600
Subject: input_common: joycon: Remove Magic numbers from common protocol

---
 .../helpers/joycon_protocol/joycon_types.h         | 74 +++++++++++++++++-----
 1 file changed, 57 insertions(+), 17 deletions(-)

(limited to 'src/input_common/helpers/joycon_protocol/joycon_types.h')

diff --git a/src/input_common/helpers/joycon_protocol/joycon_types.h b/src/input_common/helpers/joycon_protocol/joycon_types.h
index ddb48a553..b91934990 100644
--- a/src/input_common/helpers/joycon_protocol/joycon_types.h
+++ b/src/input_common/helpers/joycon_protocol/joycon_types.h
@@ -19,8 +19,6 @@
 namespace InputCommon::Joycon {
 constexpr u32 MaxErrorCount = 50;
 constexpr u32 MaxBufferSize = 368;
-constexpr u32 MaxResponseSize = 49;
-constexpr u32 MaxSubCommandResponseSize = 64;
 constexpr std::array<u8, 8> DefaultVibrationBuffer{0x0, 0x1, 0x40, 0x40, 0x0, 0x1, 0x40, 0x40};
 
 using MacAddress = std::array<u8, 6>;
@@ -105,14 +103,6 @@ enum class OutputReport : u8 {
     USB_CMD = 0x80,
 };
 
-enum class InputReport : u8 {
-    SUBCMD_REPLY = 0x21,
-    STANDARD_FULL_60HZ = 0x30,
-    NFC_IR_MODE_60HZ = 0x31,
-    SIMPLE_HID_MODE = 0x3F,
-    INPUT_USB_RESPONSE = 0x81,
-};
-
 enum class FeatureReport : u8 {
     Last_SUBCMD = 0x02,
     OTA_GW_UPGRADE = 0x70,
@@ -171,7 +161,7 @@ enum class CalibrationMagic : u8 {
     USR_MAGIC_1 = 0xA1,
 };
 
-enum class SpiAddress {
+enum class SpiAddress : u16 {
     MAGIC = 0x0000,
     MAC_ADDRESS = 0x0015,
     PAIRING_INFO = 0x2000,
@@ -198,10 +188,12 @@ enum class ReportMode : u8 {
     ACTIVE_POLLING_NFC_IR_CAMERA_CONFIGURATION = 0x01,
     ACTIVE_POLLING_NFC_IR_CAMERA_DATA_CONFIGURATION = 0x02,
     ACTIVE_POLLING_IR_CAMERA_DATA = 0x03,
+    SUBCMD_REPLY = 0x21,
     MCU_UPDATE_STATE = 0x23,
     STANDARD_FULL_60HZ = 0x30,
     NFC_IR_MODE_60HZ = 0x31,
     SIMPLE_HID_MODE = 0x3F,
+    INPUT_USB_RESPONSE = 0x81,
 };
 
 enum class GyroSensitivity : u8 {
@@ -372,15 +364,16 @@ enum class IrRegistersAddress : u16 {
     DenoiseColor = 0x6901,
 };
 
-enum class ExternalDeviceId : u8 {
-    RingController = 0x20,
-    Starlink = 0x28,
+enum class ExternalDeviceId : u16 {
+    RingController = 0x2000,
+    Starlink = 0x2800,
 };
 
 enum class DriverResult {
     Success,
     WrongReply,
     Timeout,
+    InvalidParameters,
     UnsupportedControllerType,
     HandleInUse,
     ErrorReadingData,
@@ -503,7 +496,7 @@ static_assert(sizeof(MCUConfig) == 0x26, "MCUConfig is an invalid size");
 
 #pragma pack(push, 1)
 struct InputReportPassive {
-    InputReport report_mode;
+    ReportMode report_mode;
     u16 button_input;
     u8 stick_state;
     std::array<u8, 10> unknown_data;
@@ -511,7 +504,7 @@ struct InputReportPassive {
 static_assert(sizeof(InputReportPassive) == 0xE, "InputReportPassive is an invalid size");
 
 struct InputReportActive {
-    InputReport report_mode;
+    ReportMode report_mode;
     u8 packet_id;
     Battery battery_status;
     std::array<u8, 3> button_input;
@@ -525,7 +518,7 @@ struct InputReportActive {
 static_assert(sizeof(InputReportActive) == 0x29, "InputReportActive is an invalid size");
 
 struct InputReportNfcIr {
-    InputReport report_mode;
+    ReportMode report_mode;
     u8 packet_id;
     Battery battery_status;
     std::array<u8, 3> button_input;
@@ -643,6 +636,53 @@ struct RingStatus {
     s16 min_value;
 };
 
+struct VibrationPacket {
+    OutputReport output_report;
+    u8 packet_counter;
+    std::array<u8, 0x8> vibration_data;
+};
+static_assert(sizeof(VibrationPacket) == 0xA, "VibrationPacket is an invalid size");
+
+struct SubCommandPacket {
+    OutputReport output_report;
+    u8 packet_counter;
+    INSERT_PADDING_BYTES(0x8); // This contains vibration data
+    SubCommand sub_command;
+    std::array<u8, 0x26> command_data;
+};
+static_assert(sizeof(SubCommandPacket) == 0x31, "SubCommandPacket is an invalid size");
+
+#pragma pack(push, 1)
+struct ReadSpiPacket {
+    SpiAddress spi_address;
+    INSERT_PADDING_BYTES(0x2);
+    u8 size;
+};
+static_assert(sizeof(ReadSpiPacket) == 0x5, "ReadSpiPacket is an invalid size");
+
+struct SubCommandResponse {
+    InputReportPassive input_report;
+    SubCommand sub_command;
+    union {
+        std::array<u8, 0x30> command_data;
+        SpiAddress spi_address;              // Reply from SPI_FLASH_READ subcommand
+        ExternalDeviceId external_device_id; // Reply from GET_EXTERNAL_DEVICE_INFO subcommand
+        DeviceInfo device_info;              // Reply from REQ_DEV_INFO subcommand
+    };
+    u8 crc; // This is never used
+};
+static_assert(sizeof(SubCommandResponse) == 0x40, "SubCommandResponse is an invalid size");
+#pragma pack(pop)
+
+struct MCUCommandResponse {
+    InputReportNfcIr input_report;
+    INSERT_PADDING_BYTES(0x8);
+    MCUReport mcu_report;
+    std::array<u8, 0x13D> mcu_data;
+    u8 crc;
+};
+static_assert(sizeof(MCUCommandResponse) == 0x170, "MCUCommandResponse is an invalid size");
+
 struct JoyconCallbacks {
     std::function<void(Battery)> on_battery_data;
     std::function<void(Color)> on_color_data;
-- 
cgit v1.2.3