eden/src/hid_core/hidbus/ringcon.cpp

// SPDX-FileCopyrightText: Copyright 2026 Eden Emulator Project
// SPDX-License-Identifier: GPL-3.0-or-later

// SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#include "core/core.h"
#include "core/hle/kernel/k_event.h"
#include "core/hle/kernel/k_process.h"
#include "core/hle/kernel/k_readable_event.h"
#include "core/memory.h"
#include "hid_core/frontend/emulated_controller.h"
#include "hid_core/hid_core.h"
#include "hid_core/hidbus/ringcon.h"

namespace Service::HID {

RingController::RingController(Core::System& system_,
                               KernelHelpers::ServiceContext& service_context_)
    : HidbusBase(system_, service_context_) {
    input = system.HIDCore().GetEmulatedController(Core::HID::NpadIdType::Player1);
}

RingController::~RingController() = default;

void RingController::OnInit() {
    input->SetPollingMode(Core::HID::EmulatedDeviceIndex::RightIndex,
                          Common::Input::PollingMode::Ring);
    return;
}

void RingController::OnRelease() {
    input->SetPollingMode(Core::HID::EmulatedDeviceIndex::RightIndex,
                          Common::Input::PollingMode::Active);
    return;
};

void RingController::OnUpdate() {
    if (!is_activated) {
        return;
    }

    if (!device_enabled) {
        return;
    }

    if (!polling_mode_enabled || transfer_memory == 0) {
        return;
    }

    // TODO: Increment multitasking counters from motion and sensor data

    switch (polling_mode) {
    case JoyPollingMode::SixAxisSensorEnable: {
        enable_sixaxis_data.header.total_entries = 10;
        enable_sixaxis_data.header.result = ResultSuccess;
        const auto& last_entry =
            enable_sixaxis_data.entries[enable_sixaxis_data.header.latest_entry];

        enable_sixaxis_data.header.latest_entry =
            (enable_sixaxis_data.header.latest_entry + 1) % 10;
        auto& curr_entry = enable_sixaxis_data.entries[enable_sixaxis_data.header.latest_entry];

        curr_entry.sampling_number = last_entry.sampling_number + 1;
        curr_entry.polling_data.sampling_number = curr_entry.sampling_number;

        const RingConData ringcon_value = GetSensorValue();
        curr_entry.polling_data.out_size = sizeof(ringcon_value);
        std::memcpy(curr_entry.polling_data.data.data(), &ringcon_value, sizeof(ringcon_value));

        if (transfer_memory_owner != nullptr) {
            transfer_memory_owner->GetMemory().WriteBlock(transfer_memory, &enable_sixaxis_data,
                                                          sizeof(enable_sixaxis_data));
        }
        break;
    }
    default:
        LOG_ERROR(Service_HID, "Polling mode not supported {}", polling_mode);
        break;
    }
}

RingController::RingConData RingController::GetSensorValue() const {
    RingConData ringcon_sensor_value{
        .status = DataValid::Valid,
        .data = 0,
    };

    const f32 force_value = input->GetRingSensorForce().force * range;
    ringcon_sensor_value.data = static_cast<s16>(force_value) + idle_value;

    return ringcon_sensor_value;
}

u8 RingController::GetDeviceId() const {
    return device_id;
}

u64 RingController::GetReply(std::span<u8> out_data) const {
    const RingConCommands current_command = command;

    switch (current_command) {
    case RingConCommands::GetFirmwareVersion:
        return GetFirmwareVersionReply(out_data);
    case RingConCommands::ReadId:
        return GetReadIdReply(out_data);
    case RingConCommands::c20105:
        return GetC020105Reply(out_data);
    case RingConCommands::ReadUnkCal:
        return GetReadUnkCalReply(out_data);
    case RingConCommands::ReadFactoryCal:
        return GetReadFactoryCalReply(out_data);
    case RingConCommands::ReadUserCal:
        return GetReadUserCalReply(out_data);
    case RingConCommands::ReadRepCount:
        return GetReadRepCountReply(out_data);
    case RingConCommands::ReadTotalPushCount:
        return GetReadTotalPushCountReply(out_data);
    case RingConCommands::ResetRepCount:
        return GetResetRepCountReply(out_data);
    case RingConCommands::SaveCalData:
        return GetSaveDataReply(out_data);
    default:
        return GetErrorReply(out_data);
    }
}

bool RingController::SetCommand(std::span<const u8> data) {
    if (data.size() < 4) {
        LOG_ERROR(Service_HID, "Command size not supported {}", data.size());
        command = RingConCommands::Error;
        return false;
    }

    std::memcpy(&command, data.data(), sizeof(RingConCommands));

    switch (command) {
    case RingConCommands::GetFirmwareVersion:
    case RingConCommands::ReadId:
    case RingConCommands::c20105:
    case RingConCommands::ReadUnkCal:
    case RingConCommands::ReadFactoryCal:
    case RingConCommands::ReadUserCal:
    case RingConCommands::ReadRepCount:
    case RingConCommands::ReadTotalPushCount:
        ASSERT_MSG(data.size() == 0x4, "data.size is not 0x4 bytes");
        send_command_async_event->Signal(system.Kernel());
        return true;
    case RingConCommands::ResetRepCount:
        ASSERT_MSG(data.size() == 0x4, "data.size is not 0x4 bytes");
        total_rep_count = 0;
        send_command_async_event->Signal(system.Kernel());
        return true;
    case RingConCommands::SaveCalData: {
        ASSERT_MSG(data.size() == 0x14, "data.size is not 0x14 bytes");

        SaveCalData save_info{};
        std::memcpy(&save_info, data.data(), sizeof(SaveCalData));
        user_calibration = save_info.calibration;
        send_command_async_event->Signal(system.Kernel());
        return true;
    }
    default:
        LOG_ERROR(Service_HID, "Command not implemented {}", command);
        command = RingConCommands::Error;
        // Signal a reply to avoid softlocking the game
        send_command_async_event->Signal(system.Kernel());
        return false;
    }
}

u64 RingController::GetFirmwareVersionReply(std::span<u8> out_data) const {
    const FirmwareVersionReply reply{
        .status = DataValid::Valid,
        .firmware = version,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadIdReply(std::span<u8> out_data) const {
    // The values are hardcoded from a real joycon
    const ReadIdReply reply{
        .status = DataValid::Valid,
        .id_l_x0 = 8,
        .id_l_x0_2 = 41,
        .id_l_x4 = 22294,
        .id_h_x0 = 19777,
        .id_h_x0_2 = 13621,
        .id_h_x4 = 8245,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetC020105Reply(std::span<u8> out_data) const {
    const Cmd020105Reply reply{
        .status = DataValid::Valid,
        .data = 1,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadUnkCalReply(std::span<u8> out_data) const {
    const ReadUnkCalReply reply{
        .status = DataValid::Valid,
        .data = 0,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadFactoryCalReply(std::span<u8> out_data) const {
    const ReadFactoryCalReply reply{
        .status = DataValid::Valid,
        .calibration = factory_calibration,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadUserCalReply(std::span<u8> out_data) const {
    const ReadUserCalReply reply{
        .status = DataValid::Valid,
        .calibration = user_calibration,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadRepCountReply(std::span<u8> out_data) const {
    const GetThreeByteReply reply{
        .status = DataValid::Valid,
        .data = {total_rep_count, 0, 0},
        .crc = GetCrcValue({total_rep_count, 0, 0, 0}),
    };

    return GetData(reply, out_data);
}

u64 RingController::GetReadTotalPushCountReply(std::span<u8> out_data) const {
    const GetThreeByteReply reply{
        .status = DataValid::Valid,
        .data = {total_push_count, 0, 0},
        .crc = GetCrcValue({total_push_count, 0, 0, 0}),
    };

    return GetData(reply, out_data);
}

u64 RingController::GetResetRepCountReply(std::span<u8> out_data) const {
    return GetReadRepCountReply(out_data);
}

u64 RingController::GetSaveDataReply(std::span<u8> out_data) const {
    const StatusReply reply{
        .status = DataValid::Valid,
    };

    return GetData(reply, out_data);
}

u64 RingController::GetErrorReply(std::span<u8> out_data) const {
    const ErrorReply reply{
        .status = DataValid::BadCRC,
    };

    return GetData(reply, out_data);
}

u8 RingController::GetCrcValue(const std::vector<u8>& data) const {
    u8 crc = 0;
    for (std::size_t index = 0; index < data.size(); index++) {
        for (u8 i = 0x80; i > 0; i >>= 1) {
            bool bit = (crc & 0x80) != 0;
            if ((data[index] & i) != 0) {
                bit = !bit;
            }
            crc <<= 1;
            if (bit) {
                crc ^= 0x8d;
            }
        }
    }
    return crc;
}

template <typename T>
    requires std::is_trivially_copyable_v<T>
u64 RingController::GetData(const T& reply, std::span<u8> out_data) const {
    const auto data_size = u64((std::min)(sizeof(reply), out_data.size()));
    std::memcpy(out_data.data(), &reply, data_size);
    return data_size;
}

} // namespace Service::HID