Bring LinuxPacDrive back as GenericHID lights driver
This is actually generalized old LinuxPacDrive driver. It kept here for backward compatibility. So people have time to migrate on better new implementation. Set LightsDriver to "PacDrive" to test the new driver. GenericHID uses USB libusb_control_transfer to send data (4 bytes) over the wire where first 2 are lights state. So any HID-like usb device can read the data and control lights.
This commit is contained in:
Yauhen Artsiukhou
committed by
teejusb
teejusb
parent
b77a6af416
commit
36e2dcbce8
@@ -183,7 +183,7 @@ list(APPEND SMDATA_ARCH_LIGHTS_SRC "arch/Lights/LightsDriver.cpp"
|
||||
"arch/Lights/LightsDriver_stac.cpp"
|
||||
"arch/Lights/LightsDriver_snek.cpp"
|
||||
"arch/Lights/LightsDriver_PacDrive.cpp"
|
||||
"arch/Lights/LightsDriver_HidBlueDot.cpp")
|
||||
"arch/Lights/LightsDriver_HidBlueDot.cpp")
|
||||
list(APPEND SMDATA_ARCH_LIGHTS_HPP "arch/Lights/LightsDriver.h"
|
||||
"arch/Lights/LightsDriver_Export.h"
|
||||
"arch/Lights/LightsDriver_SextetStream.h"
|
||||
@@ -218,6 +218,7 @@ if(NOT APPLE)
|
||||
"arch/Lights/LightsDriver_Linux_PIUIO_Leds.cpp"
|
||||
"arch/Lights/LightsDriver_Linux_PIUIOBTN_Leds.cpp"
|
||||
"arch/Lights/LightsDriver_Linux_ITGIO.cpp"
|
||||
"arch/Lights/LightsDriver_GenericHID.cpp"
|
||||
"arch/Lights/LightsDriver_LinuxWeedTech.cpp")
|
||||
list(APPEND SMDATA_ARCH_LIGHTS_HPP
|
||||
"arch/Lights/LightsDriver_Linux_Leds.h"
|
||||
@@ -225,6 +226,7 @@ if(NOT APPLE)
|
||||
"arch/Lights/LightsDriver_Linux_PIUIO_Leds.h"
|
||||
"arch/Lights/LightsDriver_Linux_PIUIOBTN_Leds.h"
|
||||
"arch/Lights/LightsDriver_Linux_ITGIO.h"
|
||||
"arch/Lights/LightsDriver_GenericHID.h"
|
||||
"arch/Lights/LightsDriver_LinuxWeedTech.h")
|
||||
if(WITH_MINIMAID)
|
||||
list(APPEND SMDATA_ARCH_LIGHTS_SRC
|
||||
|
||||
@@ -0,0 +1,292 @@
|
||||
#include "global.h"
|
||||
#include "LightsDriver.h"
|
||||
#include "LightsDriver_GenericHID.h"
|
||||
#include "Preference.h"
|
||||
#include "RageLog.h"
|
||||
|
||||
#include <cstdint>
|
||||
#include <libusb.h>
|
||||
|
||||
REGISTER_LIGHTS_DRIVER_CLASS(GenericHID);
|
||||
|
||||
// Register GenericHID under alias name: LinuxPacDrive for backward compatibility
|
||||
static RegisterRageDriver
|
||||
register_LinuxPacDrive(&LightsDriver::m_pDriverList, "LinuxPacDrive",
|
||||
CreateClass<LightsDriver_GenericHID, RageDriver>);
|
||||
|
||||
// HID Class-Specific Requests values. See section 7.2 of the HID specifications
|
||||
#define HID_GET_REPORT 0x01
|
||||
#define HID_GET_IDLE 0x02
|
||||
#define HID_GET_PROTOCOL 0x03
|
||||
#define HID_SET_REPORT 0x09
|
||||
#define HID_SET_IDLE 0x0A
|
||||
#define HID_SET_PROTOCOL 0x0B
|
||||
#define HID_REPORT_TYPE_INPUT 0x01
|
||||
#define HID_REPORT_TYPE_OUTPUT 0x02
|
||||
#define HID_REPORT_TYPE_FEATURE 0x03
|
||||
|
||||
#define HID_IFACE_IN 256
|
||||
#define HID_IFACE_OUT 512
|
||||
|
||||
// PacDrives have PIDs 1500 - 1507, but we'll handle that later.
|
||||
const unsigned GENERICHID_TIMEOUT = 10000;
|
||||
|
||||
static Preference<RString> g_sGenericHIDLightsOrdering("PacDriveLightOrdering", "openitg");
|
||||
static Preference<int> g_sGenericHIDLightsVID("GenericHIDLightsVID", 0xD209);
|
||||
static Preference<int> g_sGenericHIDLightsPID("GenericHIDLightsPID", 0x1500);
|
||||
|
||||
LightsDriver_GenericHID::LightsDriver_GenericHID()
|
||||
{
|
||||
LOG->Warn("LinuxPacDrive is now GenericHID.\n"
|
||||
"Better implementation of the PacDrive driver is now available.\n"
|
||||
"Try it out. Set LightsDriver=PacDrive in Preferences.ini.");
|
||||
|
||||
DeviceHandle = NULL;
|
||||
iLightsOrder = 0;
|
||||
|
||||
OpenDevice();
|
||||
|
||||
// clear all lights
|
||||
WriteDevice( 0 );
|
||||
|
||||
RString lightOrder = g_sGenericHIDLightsOrdering.Get();
|
||||
if (CompareNoCase(lightOrder, "lumenar") == 0 || CompareNoCase(lightOrder, "openitg") == 0) {
|
||||
iLightsOrder = 1;
|
||||
}
|
||||
}
|
||||
|
||||
LightsDriver_GenericHID::~LightsDriver_GenericHID()
|
||||
{
|
||||
// clear all lights and close the connection
|
||||
WriteDevice( 0 );
|
||||
CloseDevice();
|
||||
}
|
||||
|
||||
void LightsDriver_GenericHID::Set( const LightsState *ls )
|
||||
{
|
||||
if ( !DeviceHandle ) return;
|
||||
|
||||
uint16_t outb = 0;
|
||||
|
||||
switch (iLightsOrder) {
|
||||
case 1:
|
||||
//Sets the cabinet light values to follow LumenAR/OpenITG wiring standards
|
||||
|
||||
/*
|
||||
* OpenITG GenericHID Order:
|
||||
* Taken from LightsDriver_PacDrive::SetLightsMappings() in openitg.
|
||||
*
|
||||
* 0: Marquee UL
|
||||
* 1: Marquee UR
|
||||
* 2: Marquee DL
|
||||
* 3: Marquee DR
|
||||
*
|
||||
* 4: P1 Button
|
||||
* 5: P2 Button
|
||||
*
|
||||
* 6: Bass Left
|
||||
* 7: Bass Right
|
||||
*
|
||||
* 8,9,10,11: P1 L R U D
|
||||
* 12,13,14,15: P2 L R U D
|
||||
*/
|
||||
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_UP_LEFT]) outb |= BIT(0);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_UP_RIGHT]) outb |= BIT(1);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_LR_LEFT]) outb |= BIT(2);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_LR_RIGHT]) outb |= BIT(3);
|
||||
|
||||
if (ls->m_bGameButtonLights[GameController_1][GAME_BUTTON_START]) outb |= BIT(4);
|
||||
if (ls->m_bGameButtonLights[GameController_2][GAME_BUTTON_START]) outb |= BIT(5);
|
||||
|
||||
//Most PacDrive/Cabinet setups only have *one* bass light, so mux them together here.
|
||||
if (ls->m_bCabinetLights[LIGHT_BASS_LEFT] || ls->m_bCabinetLights[LIGHT_BASS_RIGHT]) outb |= BIT(6);
|
||||
if (ls->m_bCabinetLights[LIGHT_BASS_LEFT] || ls->m_bCabinetLights[LIGHT_BASS_RIGHT]) outb |= BIT(7);
|
||||
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_LEFT]) outb |= BIT(8);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_RIGHT]) outb |= BIT(9);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_UP]) outb |= BIT(10);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_DOWN]) outb |= BIT(11);
|
||||
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_LEFT]) outb |= BIT(12);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_RIGHT]) outb |= BIT(13);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_UP]) outb |= BIT(14);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_DOWN]) outb |= BIT(15);
|
||||
|
||||
break;
|
||||
|
||||
case 0:
|
||||
default:
|
||||
//If all else fails, falls back to original order
|
||||
//reference page 7
|
||||
//http://www.peeweepower.com/stepmania/sm509pacdriveinfo.pdf
|
||||
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_UP_LEFT]) outb |= BIT(0);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_UP_RIGHT]) outb |= BIT(1);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_LR_LEFT]) outb |= BIT(2);
|
||||
if (ls->m_bCabinetLights[LIGHT_MARQUEE_LR_RIGHT]) outb |= BIT(3);
|
||||
|
||||
if (ls->m_bCabinetLights[LIGHT_BASS_LEFT] || ls->m_bCabinetLights[LIGHT_BASS_RIGHT]) outb |= BIT(4);
|
||||
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_LEFT]) outb |= BIT(5);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_RIGHT]) outb |= BIT(6);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_UP]) outb |= BIT(7);
|
||||
if (ls->m_bGameButtonLights[GameController_1][DANCE_BUTTON_DOWN]) outb |= BIT(8);
|
||||
if (ls->m_bGameButtonLights[GameController_1][GAME_BUTTON_START]) outb |= BIT(9);
|
||||
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_LEFT]) outb |= BIT(10);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_RIGHT]) outb |= BIT(11);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_UP]) outb |= BIT(12);
|
||||
if (ls->m_bGameButtonLights[GameController_2][DANCE_BUTTON_DOWN]) outb |= BIT(13);
|
||||
if (ls->m_bGameButtonLights[GameController_2][GAME_BUTTON_START]) outb |= BIT(14);
|
||||
//Bit index 15 is unused.
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
WriteDevice(outb);
|
||||
}
|
||||
|
||||
void LightsDriver_GenericHID::OpenDevice()
|
||||
{
|
||||
libusb_device **devs;
|
||||
libusb_device *dev = NULL;
|
||||
ssize_t result;
|
||||
int i = 0;
|
||||
|
||||
CloseDevice(); // Ensure any previously opened device is closed first to prevent conflicts
|
||||
|
||||
libusb_context* context = USBContext::getInstance().getContext();
|
||||
if (!context)
|
||||
{
|
||||
LOG->Warn("libusb: Failed to initialize context");
|
||||
return;
|
||||
}
|
||||
|
||||
libusb_set_option(context, LIBUSB_OPTION_LOG_LEVEL, LIBUSB_LOG_LEVEL_INFO);
|
||||
|
||||
result = libusb_get_device_list(context, &devs);
|
||||
if (result < 0)
|
||||
{
|
||||
LOG->Warn("libusb_get_device_list failed: %s", libusb_error_name(result));
|
||||
return;
|
||||
}
|
||||
|
||||
while ((dev = devs[i++]) != NULL)
|
||||
{
|
||||
libusb_device_descriptor desc;
|
||||
// Note since libusb-1.0.16, LIBUSBX_API_VERSION >= 0x01000102, this function always succeeds:
|
||||
libusb_get_device_descriptor(dev, &desc);
|
||||
|
||||
if (g_sGenericHIDLightsVID.Get() == desc.idVendor &&
|
||||
g_sGenericHIDLightsPID.Get() <= desc.idProduct &&
|
||||
g_sGenericHIDLightsPID.Get() + 8 > desc.idProduct)
|
||||
{
|
||||
LOG->Info("GenericHID device was found vid: 0x%04x pid: 0x%04x", desc.idVendor, desc.idProduct);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!dev)
|
||||
{
|
||||
LOG->Warn("GenericHID device was not found");
|
||||
libusb_free_device_list(devs, 1);
|
||||
return;
|
||||
}
|
||||
|
||||
result = libusb_open(dev, &DeviceHandle);
|
||||
if (result < 0)
|
||||
{
|
||||
LOG->Warn("libusb_open failed: %s", libusb_error_name(result));
|
||||
DeviceHandle = NULL;
|
||||
libusb_free_device_list(devs, 1);
|
||||
return;
|
||||
}
|
||||
|
||||
libusb_free_device_list(devs, 1);
|
||||
|
||||
if (libusb_kernel_driver_active(DeviceHandle, 0) == 1)
|
||||
{
|
||||
LOG->Warn("Kernel Driver Active");
|
||||
if (libusb_detach_kernel_driver(DeviceHandle, 0) == 0)
|
||||
LOG->Warn("Kernel Driver Detached!");
|
||||
}
|
||||
|
||||
result = libusb_claim_interface(DeviceHandle, 0);
|
||||
if (result < 0)
|
||||
{
|
||||
LOG->Warn("libusb_claim_interface: cannot claim interface: %s", libusb_error_name(result));
|
||||
libusb_close(DeviceHandle);
|
||||
return;
|
||||
}
|
||||
|
||||
LOG->Info("Device claimed");
|
||||
}
|
||||
|
||||
void LightsDriver_GenericHID::CloseDevice()
|
||||
{
|
||||
if (!DeviceHandle)
|
||||
return;
|
||||
|
||||
ssize_t result;
|
||||
|
||||
result = libusb_release_interface(DeviceHandle, 0);
|
||||
if (result != 0)
|
||||
{
|
||||
LOG->Warn("libusb_release_interface: %s", libusb_error_name(result));
|
||||
}
|
||||
|
||||
libusb_close(DeviceHandle);
|
||||
DeviceHandle = NULL;
|
||||
}
|
||||
|
||||
void LightsDriver_GenericHID::WriteDevice(uint16_t out)
|
||||
{
|
||||
if (!DeviceHandle) return;
|
||||
|
||||
// output is within the first 16 bits - accept a
|
||||
// 16-bit arg and cast it, for simplicity's sake.
|
||||
uint32_t data = (out << 16);
|
||||
int expected = sizeof(data);
|
||||
|
||||
ssize_t result = libusb_control_transfer(DeviceHandle,
|
||||
LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE,
|
||||
HID_SET_REPORT,
|
||||
HID_IFACE_OUT,
|
||||
0,
|
||||
(unsigned char*)&data,
|
||||
expected,
|
||||
GENERICHID_TIMEOUT);
|
||||
|
||||
if(result != expected) {
|
||||
LOG->Warn("GenericHID writing failed: %li (%s)\n", result, libusb_error_name(result));
|
||||
CloseDevice();
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Rewritten for libusb 1.0 2024 sirex
|
||||
* Rewritten for libusb 1.0 2024 sukibaby
|
||||
* Original libusb 0.1 file Copyright (c) 2008 BoXoRRoXoRs
|
||||
* All rights reserved.
|
||||
*
|
||||
* 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, and/or sell copies of the Software, and to permit persons to
|
||||
* whom the Software is furnished to do so, provided that the above
|
||||
* copyright notice(s) and this permission notice appear in all copies of
|
||||
* the Software and that both the above copyright notice(s) and this
|
||||
* permission notice appear in supporting documentation.
|
||||
*
|
||||
* 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 OF
|
||||
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
||||
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
||||
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
||||
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
* PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
@@ -0,0 +1,90 @@
|
||||
#ifndef LIGHTSDRIVER_LINUXPACDRIVE_H
|
||||
#define LIGHTSDRIVER_LINUXPACDRIVE_H
|
||||
|
||||
#include "LightsDriver.h"
|
||||
|
||||
#include <cstdint>
|
||||
#include <libusb.h>
|
||||
|
||||
#define BIT(i) (1<<(i))
|
||||
|
||||
class USBContext
|
||||
{
|
||||
public:
|
||||
static USBContext& getInstance()
|
||||
{
|
||||
static USBContext instance;
|
||||
return instance;
|
||||
}
|
||||
|
||||
libusb_context* getContext() { return context; }
|
||||
|
||||
private:
|
||||
USBContext()
|
||||
{
|
||||
int result = libusb_init_context(&context, NULL, 0);
|
||||
if (result < 0)
|
||||
{
|
||||
// initialization error
|
||||
context = nullptr;
|
||||
}
|
||||
}
|
||||
|
||||
~USBContext()
|
||||
{
|
||||
if (context)
|
||||
{
|
||||
libusb_exit(context);
|
||||
}
|
||||
}
|
||||
|
||||
libusb_context* context;
|
||||
|
||||
// prevent copying
|
||||
USBContext(const USBContext&) = delete;
|
||||
USBContext& operator=(const USBContext&) = delete;
|
||||
};
|
||||
|
||||
class LightsDriver_GenericHID: public LightsDriver
|
||||
{
|
||||
public:
|
||||
LightsDriver_GenericHID();
|
||||
~LightsDriver_GenericHID();
|
||||
|
||||
void Set( const LightsState *ls );
|
||||
private:
|
||||
|
||||
void OpenDevice();
|
||||
void WriteDevice(uint16_t out);
|
||||
void CloseDevice();
|
||||
|
||||
libusb_device_handle *DeviceHandle;
|
||||
int iLightsOrder;
|
||||
};
|
||||
|
||||
#endif // LIGHTSDRIVER_LINUXPACDRIVE_H
|
||||
|
||||
/*
|
||||
* Copyright (c) 2008 BoXoRRoXoRs
|
||||
* All rights reserved.
|
||||
*
|
||||
* 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, and/or sell copies of the Software, and to permit persons to
|
||||
* whom the Software is furnished to do so, provided that the above
|
||||
* copyright notice(s) and this permission notice appear in all copies of
|
||||
* the Software and that both the above copyright notice(s) and this
|
||||
* permission notice appear in supporting documentation.
|
||||
*
|
||||
* 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 OF
|
||||
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
||||
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
||||
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
||||
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
* PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
Reference in New Issue
Block a user