VERY experimental Nintendo Switch 2 emulator
C++
input_common: Add joycon low level functions
Narr the Reg147faa16ef1e
diff --git a/src/input_common/CMakeLists.txt b/src/input_common/CMakeLists.txtindex 41885d0d26..566be9f90c 100644--- a/src/input_common/CMakeLists.txt+++ b/src/input_common/CMakeLists.txt@@ -57,6 +57,8 @@ if (ENABLE_SDL2)drivers/sdl_driver.hhelpers/joycon_driver.cpphelpers/joycon_driver.h+ helpers/joycon_protocol/common_protocol.cpp+ helpers/joycon_protocol/common_protocol.hhelpers/joycon_protocol/joycon_types.h)target_link_libraries(input_common PRIVATE SDL2::SDL2)diff --git a/src/input_common/helpers/joycon_protocol/common_protocol.cpp b/src/input_common/helpers/joycon_protocol/common_protocol.cppnew file mode 100644index 0000000000..43a036e027--- /dev/null+++ b/src/input_common/helpers/joycon_protocol/common_protocol.cpp@@ -0,0 +1,286 @@+// SPDX-FileCopyrightText: Copyright 2022 yuzu Emulator Project+// SPDX-License-Identifier: GPL-2.0-or-later++#include "common/logging/log.h"+#include "input_common/helpers/joycon_protocol/common_protocol.h"++namespace InputCommon::Joycon {+JoyconCommonProtocol::JoyconCommonProtocol(std::shared_ptr<JoyconHandle> hidapi_handle_)+ : hidapi_handle{hidapi_handle_} {}++u8 JoyconCommonProtocol::GetCounter() {+ hidapi_handle->packet_counter = (hidapi_handle->packet_counter + 1) & 0x0F;+ return hidapi_handle->packet_counter;+}++void JoyconCommonProtocol::SetBlocking() {+ SDL_hid_set_nonblocking(hidapi_handle->handle, 0);+}++void JoyconCommonProtocol::SetNonBlocking() {+ SDL_hid_set_nonblocking(hidapi_handle->handle, 1);+}++DriverResult JoyconCommonProtocol::GetDeviceType(ControllerType& controller_type) {+ std::vector<u8> buffer;+ const auto result = ReadSPI(CalAddr::DEVICE_TYPE, 1, buffer);+ controller_type = ControllerType::None;++ if (result == DriverResult::Success) {+ controller_type = static_cast<ControllerType>(buffer[0]);+ // Fallback to 3rd party pro controllers+ if (controller_type == ControllerType::None) {+ controller_type = ControllerType::Pro;+ }+ }++ return result;+}++DriverResult JoyconCommonProtocol::CheckDeviceAccess(SDL_hid_device_info* device_info) {+ ControllerType controller_type{ControllerType::None};+ const auto result = GetDeviceType(controller_type);+ if (result != DriverResult::Success || controller_type == ControllerType::None) {+ return DriverResult::UnsupportedControllerType;+ }++ hidapi_handle->handle =+ SDL_hid_open(device_info->vendor_id, device_info->product_id, device_info->serial_number);++ if (!hidapi_handle->handle) {+ LOG_ERROR(Input, "Yuzu can't gain access to this device: ID {:04X}:{:04X}.",+ device_info->vendor_id, device_info->product_id);+ return DriverResult::HandleInUse;+ }++ SetNonBlocking();+ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::SetReportMode(ReportMode report_mode) {+ const std::vector<u8> buffer{static_cast<u8>(report_mode)};+ std::vector<u8> output;+ return SendSubCommand(SubCommand::SET_REPORT_MODE, buffer, output);+}++DriverResult JoyconCommonProtocol::SendData(std::span<const u8> buffer) {+ const auto result = SDL_hid_write(hidapi_handle->handle, buffer.data(), buffer.size());++ if (result == -1) {+ return DriverResult::ErrorWritingData;+ }++ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::GetSubCommandResponse(SubCommand sc, std::vector<u8>& output) {+ constexpr int timeout_mili = 100;+ constexpr int MaxTries = 10;+ int tries = 0;+ output.resize(MaxSubCommandResponseSize);++ do {+ int result = SDL_hid_read_timeout(hidapi_handle->handle, output.data(),+ MaxSubCommandResponseSize, timeout_mili);++ if (result < 1) {+ LOG_ERROR(Input, "No response from joycon");+ }+ if (tries++ > MaxTries) {+ return DriverResult::Timeout;+ }+ } while (output[0] != 0x21 && output[14] != static_cast<u8>(sc));++ if (output[0] != 0x21 && output[14] != static_cast<u8>(sc)) {+ return DriverResult::WrongReply;+ }++ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::SendSubCommand(SubCommand sc, std::span<const u8> buffer,+ std::vector<u8>& output) {+ std::vector<u8> local_buffer(MaxResponseSize);++ local_buffer[0] = static_cast<u8>(OutputReport::RUMBLE_AND_SUBCMD);+ local_buffer[1] = GetCounter();+ local_buffer[10] = static_cast<u8>(sc);+ for (std::size_t i = 0; i < buffer.size(); ++i) {+ local_buffer[11 + i] = buffer[i];+ }++ auto result = SendData(local_buffer);++ if (result != DriverResult::Success) {+ return result;+ }++ result = GetSubCommandResponse(sc, output);++ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::SendVibrationReport(std::span<const u8> buffer) {+ std::vector<u8> local_buffer(MaxResponseSize);++ local_buffer[0] = static_cast<u8>(Joycon::OutputReport::RUMBLE_ONLY);+ local_buffer[1] = GetCounter();++ memcpy(local_buffer.data() + 2, buffer.data(), buffer.size());++ return SendData(local_buffer);+}++DriverResult JoyconCommonProtocol::ReadSPI(CalAddr addr, u8 size, std::vector<u8>& output) {+ constexpr std::size_t MaxTries = 10;+ std::size_t tries = 0;+ std::vector<u8> buffer = {0x00, 0x00, 0x00, 0x00, size};+ std::vector<u8> local_buffer(size + 20);++ buffer[0] = static_cast<u8>(static_cast<u16>(addr) & 0x00FF);+ buffer[1] = static_cast<u8>((static_cast<u16>(addr) & 0xFF00) >> 8);+ do {+ const auto result = SendSubCommand(SubCommand::SPI_FLASH_READ, buffer, local_buffer);+ if (result != DriverResult::Success) {+ return result;+ }++ if (tries++ > MaxTries) {+ return DriverResult::Timeout;+ }+ } while (local_buffer[15] != buffer[0] || local_buffer[16] != buffer[1]);++ // Remove header from output+ output = std::vector<u8>(local_buffer.begin() + 20, local_buffer.begin() + 20 + size);+ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::EnableMCU(bool enable) {+ std::vector<u8> output;++ const std::vector<u8> mcu_state{static_cast<u8>(enable ? 1 : 0)};+ const auto result = SendSubCommand(SubCommand::SET_MCU_STATE, mcu_state, output);++ if (result != DriverResult::Success) {+ LOG_ERROR(Input, "SendMCUData failed with error {}", result);+ }++ return result;+}++DriverResult JoyconCommonProtocol::ConfigureMCU(const MCUConfig& config) {+ LOG_DEBUG(Input, "ConfigureMCU");+ std::vector<u8> output;++ std::array<u8, sizeof(MCUConfig)> config_buffer;+ memcpy(config_buffer.data(), &config, sizeof(MCUConfig));+ config_buffer[37] = CalculateMCU_CRC8(config_buffer.data() + 1, 36);++ const auto result = SendSubCommand(SubCommand::SET_MCU_CONFIG, config_buffer, output);++ if (result != DriverResult::Success) {+ LOG_ERROR(Input, "Set MCU config failed with error {}", result);+ }++ return result;+}++DriverResult JoyconCommonProtocol::GetMCUDataResponse(ReportMode report_mode_,+ std::vector<u8>& output) {+ const int report_mode = static_cast<u8>(report_mode_);+ constexpr int TimeoutMili = 200;+ constexpr int MaxTries = 9;+ int tries = 0;+ output.resize(0x170);++ do {+ int result = SDL_hid_read_timeout(hidapi_handle->handle, output.data(), 0x170, TimeoutMili);++ if (result < 1) {+ LOG_ERROR(Input, "No response from joycon attempt {}", tries);+ }+ if (tries++ > MaxTries) {+ return DriverResult::Timeout;+ }+ } while (output[0] != report_mode || output[49] == 0xFF);++ if (output[0] != report_mode || output[49] == 0xFF) {+ return DriverResult::WrongReply;+ }++ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::SendMCUData(ReportMode report_mode, SubCommand sc,+ std::span<const u8> buffer,+ std::vector<u8>& output) {+ std::vector<u8> local_buffer(MaxResponseSize);++ local_buffer[0] = static_cast<u8>(OutputReport::MCU_DATA);+ local_buffer[1] = GetCounter();+ local_buffer[9] = static_cast<u8>(sc);+ for (std::size_t i = 0; i < buffer.size(); ++i) {+ local_buffer[10 + i] = buffer[i];+ }++ auto result = SendData(local_buffer);++ if (result != DriverResult::Success) {+ return result;+ }++ result = GetMCUDataResponse(report_mode, output);++ return DriverResult::Success;+}++DriverResult JoyconCommonProtocol::WaitSetMCUMode(ReportMode report_mode, MCUMode mode) {+ std::vector<u8> output;+ constexpr std::size_t MaxTries{8};+ std::size_t tries{};++ do {+ const std::vector<u8> mcu_data{static_cast<u8>(MCUMode::Standby)};+ const auto result = SendMCUData(report_mode, SubCommand::STATE, mcu_data, output);++ if (result != DriverResult::Success) {+ return result;+ }++ if (tries++ > MaxTries) {+ return DriverResult::WrongReply;+ }+ } while (output[49] != 1 || output[56] != static_cast<u8>(mode));++ return DriverResult::Success;+}++// crc-8-ccitt / polynomial 0x07 look up table+static constexpr uint8_t mcu_crc8_table[256] = {+ 0x00, 0x07, 0x0E, 0x09, 0x1C, 0x1B, 0x12, 0x15, 0x38, 0x3F, 0x36, 0x31, 0x24, 0x23, 0x2A, 0x2D,+ 0x70, 0x77, 0x7E, 0x79, 0x6C, 0x6B, 0x62, 0x65, 0x48, 0x4F, 0x46, 0x41, 0x54, 0x53, 0x5A, 0x5D,+ 0xE0, 0xE7, 0xEE, 0xE9, 0xFC, 0xFB, 0xF2, 0xF5, 0xD8, 0xDF, 0xD6, 0xD1, 0xC4, 0xC3, 0xCA, 0xCD,+ 0x90, 0x97, 0x9E, 0x99, 0x8C, 0x8B, 0x82, 0x85, 0xA8, 0xAF, 0xA6, 0xA1, 0xB4, 0xB3, 0xBA, 0xBD,+ 0xC7, 0xC0, 0xC9, 0xCE, 0xDB, 0xDC, 0xD5, 0xD2, 0xFF, 0xF8, 0xF1, 0xF6, 0xE3, 0xE4, 0xED, 0xEA,+ 0xB7, 0xB0, 0xB9, 0xBE, 0xAB, 0xAC, 0xA5, 0xA2, 0x8F, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9D, 0x9A,+ 0x27, 0x20, 0x29, 0x2E, 0x3B, 0x3C, 0x35, 0x32, 0x1F, 0x18, 0x11, 0x16, 0x03, 0x04, 0x0D, 0x0A,+ 0x57, 0x50, 0x59, 0x5E, 0x4B, 0x4C, 0x45, 0x42, 0x6F, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7D, 0x7A,+ 0x89, 0x8E, 0x87, 0x80, 0x95, 0x92, 0x9B, 0x9C, 0xB1, 0xB6, 0xBF, 0xB8, 0xAD, 0xAA, 0xA3, 0xA4,+ 0xF9, 0xFE, 0xF7, 0xF0, 0xE5, 0xE2, 0xEB, 0xEC, 0xC1, 0xC6, 0xCF, 0xC8, 0xDD, 0xDA, 0xD3, 0xD4,+ 0x69, 0x6E, 0x67, 0x60, 0x75, 0x72, 0x7B, 0x7C, 0x51, 0x56, 0x5F, 0x58, 0x4D, 0x4A, 0x43, 0x44,+ 0x19, 0x1E, 0x17, 0x10, 0x05, 0x02, 0x0B, 0x0C, 0x21, 0x26, 0x2F, 0x28, 0x3D, 0x3A, 0x33, 0x34,+ 0x4E, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5C, 0x5B, 0x76, 0x71, 0x78, 0x7F, 0x6A, 0x6D, 0x64, 0x63,+ 0x3E, 0x39, 0x30, 0x37, 0x22, 0x25, 0x2C, 0x2B, 0x06, 0x01, 0x08, 0x0F, 0x1A, 0x1D, 0x14, 0x13,+ 0xAE, 0xA9, 0xA0, 0xA7, 0xB2, 0xB5, 0xBC, 0xBB, 0x96, 0x91, 0x98, 0x9F, 0x8A, 0x8D, 0x84, 0x83,+ 0xDE, 0xD9, 0xD0, 0xD7, 0xC2, 0xC5, 0xCC, 0xCB, 0xE6, 0xE1, 0xE8, 0xEF, 0xFA, 0xFD, 0xF4, 0xF3};++u8 JoyconCommonProtocol::CalculateMCU_CRC8(u8* buffer, u8 size) const {+ u8 crc8 = 0x0;++ for (int i = 0; i < size; ++i) {+ crc8 = mcu_crc8_table[(u8)(crc8 ^ buffer[i])];+ }+ return crc8;+}++} // namespace InputCommon::Joycondiff --git a/src/input_common/helpers/joycon_protocol/common_protocol.h b/src/input_common/helpers/joycon_protocol/common_protocol.hnew file mode 100644index 0000000000..a65e4aa76a--- /dev/null+++ b/src/input_common/helpers/joycon_protocol/common_protocol.h@@ -0,0 +1,146 @@+// SPDX-FileCopyrightText: Copyright 2022 yuzu Emulator Project+// SPDX-License-Identifier: GPL-2.0-or-later++// Based on dkms-hid-nintendo implementation, CTCaer joycon toolkit and dekuNukem reverse+// engineering https://github.com/nicman23/dkms-hid-nintendo/blob/master/src/hid-nintendo.c+// https://github.com/CTCaer/jc_toolkit+// https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering++#pragma once++#include <memory>+#include <span>+#include <vector>++#include "common/common_types.h"+#include "input_common/helpers/joycon_protocol/joycon_types.h"++namespace InputCommon::Joycon {++/// Joycon driver functions that handle low level communication+class JoyconCommonProtocol {+public:+ explicit JoyconCommonProtocol(std::shared_ptr<JoyconHandle> hidapi_handle_);++ /**+ * Sets handle to blocking. In blocking mode, SDL_hid_read() will wait (block) until there is+ * data to read before returning.+ */+ void SetBlocking();++ /**+ * Sets handle to non blocking. In non-blocking mode calls to SDL_hid_read() will return+ * immediately with a value of 0 if there is no data to be read+ */+ void SetNonBlocking();++ /**+ * Sends a request to obtain the joycon type from device+ * @returns controller type of the joycon+ */+ DriverResult GetDeviceType(ControllerType& controller_type);++ /**+ * Verifies and sets the joycon_handle if device is valid+ * @param device info from the driver+ * @returns success if the device is valid+ */+ DriverResult CheckDeviceAccess(SDL_hid_device_info* device);++ /**+ * Sends a request to set the polling mode of the joycon+ * @param report_mode polling mode to be set+ */+ DriverResult SetReportMode(Joycon::ReportMode report_mode);++ /**+ * Sends data to the joycon device+ * @param buffer data to be send+ */+ DriverResult SendData(std::span<const u8> buffer);++ /**+ * Waits for incoming data of the joycon device that matchs the subcommand+ * @param sub_command type of data to be returned+ * @returns a buffer containing the responce+ */+ DriverResult GetSubCommandResponse(SubCommand sub_command, std::vector<u8>& output);++ /**+ * Sends a sub command to the device and waits for it's reply+ * @param sc sub command to be send+ * @param buffer data to be send+ * @returns output buffer containing the responce+ */+ DriverResult SendSubCommand(SubCommand sc, std::span<const u8> buffer, std::vector<u8>& output);++ /**+ * Sends vibration data to the joycon+ * @param buffer data to be send+ */+ DriverResult SendVibrationReport(std::span<const u8> buffer);++ /**+ * Reads the SPI memory stored on the joycon+ * @param Initial address location+ * @param size in bytes to be read+ * @returns output buffer containing the responce+ */+ DriverResult ReadSPI(CalAddr addr, u8 size, std::vector<u8>& output);++ /**+ * Enables MCU chip on the joycon+ * @param enable if true the chip will be enabled+ */+ DriverResult EnableMCU(bool enable);++ /**+ * Configures the MCU to the correspoinding mode+ * @param MCUConfig configuration+ */+ DriverResult ConfigureMCU(const MCUConfig& config);++ /**+ * Waits until there's MCU data available. On timeout returns error+ * @param report mode of the expected reply+ * @returns a buffer containing the responce+ */+ DriverResult GetMCUDataResponse(ReportMode report_mode_, std::vector<u8>& output);++ /**+ * Sends data to the MCU chip and waits for it's reply+ * @param report mode of the expected reply+ * @param sub command to be send+ * @param buffer data to be send+ * @returns output buffer containing the responce+ */+ DriverResult SendMCUData(ReportMode report_mode, SubCommand sc, std::span<const u8> buffer,+ std::vector<u8>& output);++ /**+ * Wait's until the MCU chip is on the specified mode+ * @param report mode of the expected reply+ * @param MCUMode configuration+ */+ DriverResult WaitSetMCUMode(ReportMode report_mode, MCUMode mode);++ /**+ * Calculates the checksum from the MCU data+ * @param buffer containing the data to be send+ * @param size of the buffer in bytes+ * @returns byte with the correct checksum+ */+ u8 CalculateMCU_CRC8(u8* buffer, u8 size) const;++private:+ /**+ * Increments and returns the packet counter of the handle+ * @param joycon_handle device to send the data+ * @returns packet counter value+ */+ u8 GetCounter();++ std::shared_ptr<JoyconHandle> hidapi_handle;+};++} // namespace InputCommon::Joycon