/*---------------------------------------------------------*\ | MSILaptopControllerDetect.cpp | | | | Detector for MSI laptop SteelSeries RGB devices | | | | This file is part of the OpenRGB project | | SPDX-License-Identifier: GPL-2.0-or-later | \*---------------------------------------------------------*/ #include "DetectionManager.h" #include "RGBControllerKeyNames.h" #include "RGBController_MSILaptop.h" #include "MSILaptopController.h" #include "dmiinfo.h" #define MSI_LAPTOP_ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) #define STEELSERIES_VID 0x1038 #define STEELSERIES_MSI_RAIDER_A18_KLC_PID 0x1122 #define STEELSERIES_MSI_RAIDER_A18_ALC_PID 0x1161 #define STEELSERIES_GE68HX_KEYBOARD_PID 0x113a #define STEELSERIES_GE68HX_LIGHTBAR_PID 0x114b #define NA 0xFFFFFFFF #define MSI_LAPTOP_KLC_MATRIX_HEIGHT 6 #define MSI_LAPTOP_KLC_MATRIX_WIDTH 23 #define MSI_LAPTOP_ALC_LIGHTBAR_LEDS 3 static const msi_laptop_led msi_raider_a18_klc_leds[] = { { KEY_EN_A, 0x04 }, { KEY_EN_B, 0x05 }, { KEY_EN_C, 0x06 }, { KEY_EN_D, 0x07 }, { KEY_EN_E, 0x08 }, { KEY_EN_F, 0x09 }, { KEY_EN_G, 0x0A }, { KEY_EN_H, 0x0B }, { KEY_EN_I, 0x0C }, { KEY_EN_J, 0x0D }, { KEY_EN_K, 0x0E }, { KEY_EN_L, 0x0F }, { KEY_EN_M, 0x10 }, { KEY_EN_N, 0x11 }, { KEY_EN_O, 0x12 }, { KEY_EN_P, 0x13 }, { KEY_EN_Q, 0x14 }, { KEY_EN_R, 0x15 }, { KEY_EN_S, 0x16 }, { KEY_EN_T, 0x17 }, { KEY_EN_U, 0x18 }, { KEY_EN_V, 0x19 }, { KEY_EN_W, 0x1A }, { KEY_EN_X, 0x1B }, { KEY_EN_Y, 0x1C }, { KEY_EN_Z, 0x1D }, { KEY_EN_1, 0x1E }, { KEY_EN_2, 0x1F }, { KEY_EN_3, 0x20 }, { KEY_EN_4, 0x21 }, { KEY_EN_5, 0x22 }, { KEY_EN_6, 0x23 }, { KEY_EN_7, 0x24 }, { KEY_EN_8, 0x25 }, { KEY_EN_9, 0x26 }, { KEY_EN_0, 0x27 }, { KEY_EN_ESCAPE, 0x29 }, { KEY_EN_TAB, 0x2B }, { KEY_EN_SPACE, 0x2C }, { KEY_EN_MINUS, 0x2D }, { KEY_EN_EQUALS, 0x2E }, { KEY_EN_LEFT_BRACKET, 0x2F }, { KEY_EN_RIGHT_BRACKET, 0x30 }, { KEY_EN_SEMICOLON, 0x33 }, { KEY_EN_QUOTE, 0x34 }, { KEY_EN_BACK_TICK, 0x35 }, { KEY_EN_COMMA, 0x36 }, { KEY_EN_PERIOD, 0x37 }, { KEY_EN_FORWARD_SLASH, 0x38 }, { KEY_EN_CAPS_LOCK, 0x39 }, { KEY_EN_F1, 0x3A }, { KEY_EN_F2, 0x3B }, { KEY_EN_F3, 0x3C }, { KEY_EN_F4, 0x3D }, { KEY_EN_F5, 0x3E }, { KEY_EN_F6, 0x3F }, { KEY_EN_F7, 0x40 }, { KEY_EN_F8, 0x41 }, { KEY_EN_F9, 0x42 }, { KEY_EN_F10, 0x43 }, { KEY_EN_F11, 0x44 }, { KEY_EN_F12, 0x45 }, { KEY_EN_PRINT_SCREEN, 0x46 }, { KEY_EN_SCROLL_LOCK, 0x47 }, { KEY_EN_INSERT, 0x49 }, { "Home/Page Up", 0x4B }, { KEY_EN_DELETE, 0x4C }, { KEY_EN_PAGE_DOWN, 0x4E }, { KEY_EN_RIGHT_ARROW, 0x4F }, { KEY_EN_LEFT_ARROW, 0x50 }, { KEY_EN_DOWN_ARROW, 0x51 }, { KEY_EN_UP_ARROW, 0x52 }, { KEY_EN_NUMPAD_LOCK, 0x53 }, { KEY_EN_NUMPAD_DIVIDE, 0x54 }, { KEY_EN_NUMPAD_TIMES, 0x55 }, { KEY_EN_NUMPAD_MINUS, 0x56 }, { KEY_EN_NUMPAD_PLUS, 0x57 }, { KEY_EN_NUMPAD_ENTER, 0x58 }, { KEY_EN_NUMPAD_1, 0x59 }, { KEY_EN_NUMPAD_2, 0x5A }, { KEY_EN_NUMPAD_3, 0x5B }, { KEY_EN_NUMPAD_4, 0x5C }, { KEY_EN_NUMPAD_5, 0x5D }, { KEY_EN_NUMPAD_6, 0x5E }, { KEY_EN_NUMPAD_7, 0x5F }, { KEY_EN_NUMPAD_8, 0x60 }, { KEY_EN_NUMPAD_9, 0x61 }, { KEY_EN_NUMPAD_0, 0x62 }, { KEY_EN_NUMPAD_PERIOD, 0x63 }, { KEY_EN_POWER, 0x66 }, { KEY_EN_LEFT_CONTROL, 0xE0 }, { KEY_EN_LEFT_SHIFT, 0xE1 }, { KEY_EN_LEFT_ALT, 0xE2 }, { KEY_EN_LEFT_WINDOWS, 0xE3 }, { KEY_EN_RIGHT_WINDOWS, 0xE4 }, { KEY_EN_RIGHT_FUNCTION, 0xF0 }, { KEY_EN_ANSI_ENTER, 0x28 }, { KEY_EN_BACKSPACE, 0x2A }, { KEY_EN_BACK_SLASH, 0x31 }, { KEY_EN_ISO_BACK_SLASH, 0x64 }, { KEY_EN_RIGHT_SHIFT, 0xE5 }, { KEY_EN_RIGHT_ALT, 0xE6 }, }; static unsigned int msi_raider_a18_klc_matrix_map[MSI_LAPTOP_KLC_MATRIX_HEIGHT][MSI_LAPTOP_KLC_MATRIX_WIDTH] = { { 36, NA, 50, 51, 52, 53, NA, 54, 55, 56, 57, NA, 58, 59, 60, 61, 62, 63, NA, NA, NA, NA, 89 }, { 45, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 39, 40, 97, NA, 64, 65, NA, 72, 73, 74, 75, NA }, { 37, 16, 22, 4, 17, 19, 24, 20, 8, 14, 15, 41, 42, 98, NA, 66, 67, NA, 84, 85, 86, 76, NA }, { 49, 0, 18, 3, 5, 6, 7, 9, 10, 11, 43, 44, 96, NA, NA, NA, NA, NA, 81, 82, 83, NA, NA }, { 91, 25, 23, 2, 21, 1, 13, 12, 46, 47, 48,100, NA, NA, NA, NA, 71, NA, 78, 79, 80, 77, NA }, { 90, 93, 92, NA, NA, NA, 38, NA, NA, NA,101, 94, 95, NA, 69, 70, 68, NA, 87, NA, 88, NA, NA }, }; /*---------------------------------------------------------*\ | Note on Raider A18 HX ALC (Lightbar) LED mappings: | | Initial reverse engineering packet captures showed 6 zones| | being updated (indexes 0x00 to 0x05). | | However, indexes 0x04 (L4) and 0x05 (L5) are "dummy" zones| | on this specific model and do not correspond to physical | | LEDs. To avoid user confusion, they are omitted from the | | UI profile here. | | The SetLEDs function handles zero-padding the unused | | payload slots with 0xFF so that omitting these zones | | doesn't accidentally overwrite the 0x00 index (L1). | \*---------------------------------------------------------*/ static const msi_laptop_led msi_raider_a18_alc_leds[] = { { "Lightbar 1", 0x00 }, { "Lightbar 2", 0x01 }, { "Lightbar 3", 0x02 }, { "Logo", 0x03 }, }; static const msi_laptop_led msi_ge68hx_alc_leds[] = { { "Logo", 0x00 }, { "Lightbar 1", 0x01 }, { "Lightbar 2", 0x02 }, { "Lightbar 3", 0x03 }, { "Lightbar 4", 0x04 }, { "Lightbar 5", 0x05 }, { "Lightbar 6", 0x06 }, { "Lightbar 7", 0x07 }, { "Lightbar 8", 0x08 }, { "Lightbar 9", 0x09 }, { "Lightbar 10", 0x0a }, { "Lightbar 11", 0x0b }, { "Lightbar 12", 0x0c }, { "Lightbar 13", 0x0d }, { "Lightbar 14", 0x0e }, { "Lightbar 15", 0x0f }, { "Lightbar 16", 0x10 }, { "Lightbar 17", 0x11 }, { "Lightbar 18", 0x12 }, { "Lightbar 19", 0x13 }, { "Lightbar 20", 0x14 }, { "Lightbar 21", 0x15 }, { "Lightbar 22", 0x16 }, { "Lightbar 23", 0x17 }, { "Lightbar 24", 0x18 }, { "Lightbar 25", 0x19 }, { "Lightbar 26", 0x1a }, { "Lightbar 27", 0x1b }, { "Lightbar 28", 0x1c }, { "Lightbar 29", 0x1d }, { "Lightbar 30", 0x1e }, { "Lightbar 31", 0x1f }, { "Lightbar 32", 0x20 }, { "Lightbar 33", 0x21 }, { "Lightbar 34", 0x22 }, { "Lightbar 35", 0x23 }, { "Lightbar 36", 0x24 }, { "Lightbar 37", 0x25 }, { "Lightbar 38", 0x26 }, { "Lightbar 39", 0x27 }, { "Lightbar 40", 0x28 }, { "Lightbar 41", 0x29 }, { "Lightbar 42", 0x2a }, { "Lightbar 43", 0x2b }, { "Lightbar 44", 0x2c }, { "Lightbar 45", 0x2d }, { "Lightbar 46", 0x2e }, { "Lightbar 47", 0x2f }, { "Lightbar 48", 0x30 }, { "Lightbar 49", 0x31 }, { "Lightbar 50", 0x32 }, { "Lightbar 51", 0x33 }, { "Lightbar 52", 0x34 }, }; static const MSILaptopModel msi_laptop_models[] = { { "Micro-Star International Co., Ltd.", "Raider A18 HX A9WJG", /* Keyboard layout */ msi_raider_a18_klc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_raider_a18_klc_leds), MSI_LAPTOP_KLC_MATRIX_HEIGHT, MSI_LAPTOP_KLC_MATRIX_WIDTH, (const unsigned int*)msi_raider_a18_klc_matrix_map, /* Lightbar layout */ msi_raider_a18_alc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_raider_a18_alc_leds), MSI_LAPTOP_ALC_LIGHTBAR_LEDS, }, { "Micro-Star International Co., Ltd.", "Raider 18 HX AI A2XWIG", /* Keyboard layout (shares the Raider 18 chassis / keyboard) */ msi_raider_a18_klc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_raider_a18_klc_leds), MSI_LAPTOP_KLC_MATRIX_HEIGHT, MSI_LAPTOP_KLC_MATRIX_WIDTH, (const unsigned int*)msi_raider_a18_klc_matrix_map, /* Lightbar layout */ msi_raider_a18_alc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_raider_a18_alc_leds), MSI_LAPTOP_ALC_LIGHTBAR_LEDS, }, { "Micro-Star International Co., Ltd.", "Raider GE68HX 13VF", /* Keyboard layout */ msi_raider_a18_klc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_raider_a18_klc_leds), MSI_LAPTOP_KLC_MATRIX_HEIGHT, MSI_LAPTOP_KLC_MATRIX_WIDTH, (const unsigned int*)msi_raider_a18_klc_matrix_map, /* Lightbar layout */ msi_ge68hx_alc_leds, MSI_LAPTOP_ARRAY_SIZE(msi_ge68hx_alc_leds), 52, }, }; static const MSILaptopModel* GetMSILaptopModelDMI() { DMIInfo dmi; for(unsigned int i = 0; i < MSI_LAPTOP_ARRAY_SIZE(msi_laptop_models); i++) { if((dmi.getManufacturer() == msi_laptop_models[i].sys_vendor) && (dmi.getProductName() == msi_laptop_models[i].product_name)) { return &msi_laptop_models[i]; } } return nullptr; } DetectedControllers DetectMSILaptop(hid_device_info* info, const std::string& name) { DetectedControllers detected_controllers; const MSILaptopModel* model = GetMSILaptopModelDMI(); if(model) { msi_laptop_device device_type; if(info->product_id == STEELSERIES_MSI_RAIDER_A18_KLC_PID || info->product_id == STEELSERIES_GE68HX_KEYBOARD_PID) { device_type = MSI_LAPTOP_KLC; } else if(info->product_id == STEELSERIES_MSI_RAIDER_A18_ALC_PID) { device_type = MSI_LAPTOP_ALC; } else if(info->product_id == STEELSERIES_GE68HX_LIGHTBAR_PID) { device_type = MSI_LAPTOP_KLC_LIGHTBAR; } else { return(detected_controllers); } hid_device* dev = hid_open_path(info->path); if(dev) { MSILaptopController* controller = new MSILaptopController(dev, info->path, name, device_type); RGBController_MSILaptop* rgb_controller = new RGBController_MSILaptop(controller, model); detected_controllers.push_back(rgb_controller); } } return(detected_controllers); } REGISTER_HID_DETECTOR("MSI Laptop Keyboard", DetectMSILaptop, STEELSERIES_VID, STEELSERIES_MSI_RAIDER_A18_KLC_PID); REGISTER_HID_DETECTOR_I("MSI Laptop Lightbar", DetectMSILaptop, STEELSERIES_VID, STEELSERIES_MSI_RAIDER_A18_ALC_PID, 0); REGISTER_HID_DETECTOR_I("MSI GE68HX Keyboard", DetectMSILaptop, STEELSERIES_VID, STEELSERIES_GE68HX_KEYBOARD_PID, 0); REGISTER_HID_DETECTOR_I("MSI GE68HX Lightbar", DetectMSILaptop, STEELSERIES_VID, STEELSERIES_GE68HX_LIGHTBAR_PID, 0);