Replace libusb with libhidapi to get MSI SteelSeries 3-zone laptop keyboards working in Linux

Author: CalcProgrammer1

KeyboardVisualizer.pro

@@ -11,7 +11,17 @@ greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
 TARGET = KeyboardVisualizer
 TEMPLATE = app
 
-LIBS      += -lopenal -lusb
+LIBS      += -lopenal
+
+packagesExist(hidapi-libusb) {
+  unix:LIBS += -lhidapi-libusb
+} else {
+  packagesExist(hidapi) {
+    unix:LIBS += -lhidapi
+  } else {
+    unix:LIBS += -lhidapi-libusb
+  }
+}
 
 DISTFILES +=
 

KeyboardVisualizerCommon/CorsairCKBLinux.cpp

@@ -6,24 +6,14 @@
 #include <string.h>
 #include <unistd.h>
 
-const static int led_matrix_c[7][22]
-{//Col Pos:   0    1    2    3    4    5    6    7    8    9    10   11   12   13   14   15   16   17   18   19   20   21
-/*Row 0*/   { 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 137, 8,   255, 255, 20,  255, 255 },
-/*Row 1*/   { 255, 0,   255, 12,  24,  36,  48,  60,  72,  84,  96,  108, 120, 132, 6,   18,  30,  42,  32,  44,  56,  68  }, //68
-/*Row 2*/   { 255, 1,   13,  25,  37,  49,  61,  73,  85,  97,  109, 121, 133, 7,   31,  54,  66,  78,  80,  92,  104, 116 }, //116
-/*Row 3*/   { 255, 2,   14,  26,  38,  50,  62,  74,  86,  98,  110, 122, 134, 90,  102, 43,  55,  67,  9,   21,  33,  128 }, //128
-/*Row 4*/   { 255, 3,   15,  27,  39,  51,  63,  75,  87,  99,  111, 123, 135, 114, 126, 255, 255, 255, 57,  69,  81,  128 },
-/*Row 5*/   { 255, 4,   16,  28,  40,  52,  64,  76,  88,  100, 112, 124, 136, 255, 79,  255, 103, 255, 93,  105, 117, 140 },
-/*Row 6*/   { 255, 5,   17,  29,  255, 255, 255, 53,  255, 255, 255, 89,  101, 113, 91,  115, 127, 139, 255, 129, 141, 140 }
-};
-
 CorsairCKB::CorsairCKB()
 {
 
 }
 
 void CorsairCKB::Initialize()
 {
+/*
     char activate_cmd[] = "activate\n";
     char dither_cmd[] = "dither 1\n";
 
@@ -34,6 +24,7 @@ void CorsairCKB::Initialize()
         write(corsair_fd, activate_cmd, strlen(activate_cmd));
         write(corsair_fd, dither_cmd, strlen(dither_cmd));
     }
+*/
 }
 
 bool CorsairCKB::SetLEDs(COLORREF pixels[64][256])

KeyboardVisualizerCommon/MSIKeyboard.cpp

@@ -39,6 +39,11 @@ bool MSIKeyboard::SetLEDs(COLORREF pixels[64][256])
     //Shout out to bparker06 for reverse engineering the MSI keyboard USB protocol!
     // https://github.com/bparker06/msi-keyboard/blob/master/keyboard.cpp for original implementation
 
+    if(!init_ok)
+    {
+        return false;
+    }
+
     unsigned char buf[8] = { 0 };
 
     buf[0] = 1;

KeyboardVisualizerCommon/RazerChromaLinux.cpp

@@ -84,6 +84,7 @@ void RazerChroma::Initialize()
 
         if(dir == NULL)
         {
+            driver_to_read++;
             continue;
         }
 

KeyboardVisualizerCommon/UsbDevice.cpp

@@ -2,7 +2,7 @@
 
 //Helper functions for native Windows USB
 //These functions courtesy of http://www.reddit.com/user/chrisgzy
-#if defined(WIN32) && !defined(LIBUSB)
+#if defined(WIN32) && !defined(HIDAPI)
 #pragma comment(lib, "hid.lib")
 #pragma comment(lib, "setupapi.lib")
 
@@ -94,32 +94,6 @@ HANDLE GetDeviceHandle(unsigned int uiVID, unsigned int uiPID, unsigned int uiMI
 
     return hReturn;
 }
-#elif defined(LIBUSB)
-static struct usb_device *find_device(uint16_t vendor, uint16_t product)
-{
-    struct usb_bus *bus;
-    struct usb_device *dev;
-    struct usb_bus *busses;
-
-    usb_init();
-    usb_find_busses();
-    usb_find_devices();
-
-    busses = usb_get_busses();
-
-    for (bus = busses; bus; bus = bus->next)
-    {
-        for (dev = bus->devices; dev; dev = dev->next)
-        {
-            if ((dev->descriptor.idVendor == vendor) && (dev->descriptor.idProduct == product))
-            {
-                return dev;
-            }
-        }
-    }
-
-    return NULL;
-}
 #endif
 
 UsbDevice::UsbDevice()
@@ -129,48 +103,31 @@ UsbDevice::UsbDevice()
 
 bool UsbDevice::OpenDevice(unsigned short vendor, unsigned short product, unsigned int MI)
 {
-#ifdef LIBUSB
-    device = find_device(vendor, product);
+#ifdef HIDAPI
+    device = hid_open(vendor, product, 0);
 
     if (device == NULL)
     {
-        return FALSE;
-    }
-
-    handle = usb_open(device);
-
-    if (handle == NULL)
-    {
-        return FALSE;
-    }
-
-#ifndef WIN32
-    status = usb_claim_interface(handle, MI);
-    status = usb_detach_kernel_driver_np(handle, MI);
-
-    if (status != 0)
-    {
-        return FALSE;
+        return false;
     }
-#endif //WIN32
 
-    return TRUE;
+    return true;
 #elif defined(WIN32)
     handle = GetDeviceHandle(vendor, product, MI);
 
     if (handle == NULL)
     {
-        return FALSE;
+        return false;
     }
 #endif
 }
 
 bool UsbDevice::SendToDevice(unsigned char* data, unsigned int length)
 {
-#ifdef LIBUSB
-    usb_control_msg(handle, 0x21, 0x09 0x0300, 0x03, data, length, 1000);
-    return TRUE;
+#ifdef HIDAPI
+    hid_send_feature_report(device, data, length);
+    return true;
 #elif defined(WIN32)
     return(HidD_SetFeature(handle, data, length));
 #endif
-}
+}

KeyboardVisualizerCommon/UsbDevice.h

@@ -1,8 +1,11 @@
 #ifndef USB_DEVICE_H
 #define USB_DEVICE_H
 
-#ifdef LIBUSB
-#include <usb.h>
+#define HIDAPI
+
+#include <cstdio>
+#ifdef HIDAPI
+#include <hidapi/hidapi.h>
 #elif defined(WIN32)
 #include <sstream>
 #include <wchar.h>
@@ -26,12 +29,11 @@ class UsbDevice
     bool SendToDevice(unsigned char* data, unsigned int length);
 
 private:
-#ifdef LIBUSB
-    struct usb_device*        device
-    struct usb_device_handle* handle;
+#ifdef HIDAPI
+    hid_device*        device;
 #elif defined(WIN32)
-    HANDLE                    handle;
+    HANDLE             handle;
 #endif
 
 };
-#endif
+#endif

KeyboardVisualizerCommon/Visualizer.cpp

@@ -28,7 +28,7 @@
 //Includes for devices supported only under Linux
 #else
 #include "RazerChromaLinux.h"
-//#include "CorsairCKBLinux.h"
+#include "CorsairCKBLinux.h"
 #endif
 
 //Includes for devices supported on both Windows and Linux
@@ -43,7 +43,7 @@ CmKeyboard              cmkb;
 
 //Devices supported only under Linux
 #else
-//CorsairCKB              ckb;
+CorsairCKB              ckb;
 #endif
 
 //Devices supported on both Windows and Linux
@@ -218,7 +218,7 @@ void Visualizer::Initialize()
 
     //Initialize devices supported by both Windows and Linux
     rkb.Initialize();
-    //ckb.Initialize();
+    ckb.Initialize();
     skb.Initialize();
     mkb.Initialize();
 

KeyboardVisualizerQT/KeyboardVisDlg.cpp

@@ -29,43 +29,43 @@ void KeyboardVisDlg::show()
     ui->lineEdit_Decay->setText(QString::number(vis_ptr->decay));
     ui->lineEdit_Delay->setText(QString::number(vis_ptr->delay));
 
-    ui->comboBox_FFT_Window_Mode->blockSignals(TRUE);
+    ui->comboBox_FFT_Window_Mode->blockSignals(true);
     ui->comboBox_FFT_Window_Mode->addItem("None");
     ui->comboBox_FFT_Window_Mode->addItem("Hanning");
     ui->comboBox_FFT_Window_Mode->addItem("Hamming");
     ui->comboBox_FFT_Window_Mode->addItem("Blackman");
     ui->comboBox_FFT_Window_Mode->setCurrentIndex(vis_ptr->window_mode);
-    ui->comboBox_FFT_Window_Mode->blockSignals(FALSE);
+    ui->comboBox_FFT_Window_Mode->blockSignals(false);
 
-    ui->comboBox_Background_Mode->blockSignals(TRUE);
+    ui->comboBox_Background_Mode->blockSignals(true);
     for(int i = 0; i < VISUALIZER_NUM_PATTERNS; i++)
     {
         ui->comboBox_Background_Mode->addItem(visualizer_pattern_labels[i]);
     }
     ui->comboBox_Background_Mode->setCurrentIndex(vis_ptr->bkgd_mode);
-    ui->comboBox_Background_Mode->blockSignals(FALSE);
+    ui->comboBox_Background_Mode->blockSignals(false);
 
-    ui->comboBox_Foreground_Mode->blockSignals(TRUE);
+    ui->comboBox_Foreground_Mode->blockSignals(true);
     for(int i = 0; i < VISUALIZER_NUM_PATTERNS; i++)
     {
         ui->comboBox_Foreground_Mode->addItem(visualizer_pattern_labels[i]);
     }
     ui->comboBox_Foreground_Mode->setCurrentIndex(vis_ptr->frgd_mode);
-    ui->comboBox_Foreground_Mode->blockSignals(FALSE);
+    ui->comboBox_Foreground_Mode->blockSignals(false);
 
-    ui->comboBox_Single_Color_Mode->blockSignals(TRUE);
+    ui->comboBox_Single_Color_Mode->blockSignals(true);
     for(int i = 0; i < VISUALIZER_NUM_SINGLE_COLOR; i++)
     {
         ui->comboBox_Single_Color_Mode->addItem(visualizer_single_color_labels[i]);
     }
     ui->comboBox_Single_Color_Mode->setCurrentIndex(vis_ptr->single_color_mode);
-    ui->comboBox_Single_Color_Mode->blockSignals(FALSE);
+    ui->comboBox_Single_Color_Mode->blockSignals(false);
 
-    ui->comboBox_Average_Mode->blockSignals(TRUE);
+    ui->comboBox_Average_Mode->blockSignals(true);
     ui->comboBox_Average_Mode->addItem("Binning");
     ui->comboBox_Average_Mode->addItem("Low Pass");
     ui->comboBox_Average_Mode->setCurrentIndex(vis_ptr->avg_mode);
-    ui->comboBox_Average_Mode->blockSignals(FALSE);
+    ui->comboBox_Average_Mode->blockSignals(false);
 
     timer = new QTimer(this);
     connect(timer, SIGNAL(timeout()), this, SLOT(update()));

KeyboardVisualizerQT/main.cpp

@@ -15,7 +15,7 @@ void parse_argument_string(char * argument, char * value)
 {
     if (strcmp(argument, "startminimized") == 0)
     {
-        startminimized = TRUE;
+        startminimized = true;
     }
 
     if (strcmp(argument, "amplitude") == 0)