Extend device support

RedFantom · RedFantom · commit 6edf5197ab28 · 2019-01-08T18:48:40.000+01:00
diff --git a/README.md b/README.md
@@ -96,3 +96,9 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 ```
+
+## Credits
+Part of the implementation of this library is based on the more
+extensive protocol description written by [`chmod222`](https://github.com/chmod222),
+available under the LGPLv3 license in [`libcmmk`](https://github.com/chmod222/libcmmk),
+which has the same goal as this project.
diff --git a/libmk/libmk.c b/libmk/libmk.c
@@ -35,13 +35,11 @@
 static libusb_context* Context;
 static LibMK_Handle* DeviceHandle;
 
-
 typedef enum LibMK_Model LibMK_Model;
 typedef enum LibMK_Result LibMK_Result;
 typedef enum LibMK_Effect LibMK_Effect;
 typedef struct LibMK_Device LibMK_Device;
 
-
 /** Constants */
 const unsigned char HEADER_DEFAULT = 0x41;        // 0100 0001
 const unsigned char HEADER_EFFECT = 0x50;         // 0101 0000
@@ -67,38 +65,108 @@ const unsigned char LAYOUT_ISO = 1;
  * keyboard. The matrix is in [row][column] format. A value of 0xFF
  * indicates an unknown value.
 */
-const unsigned char LIBMK_LAYOUT_ANSI[LIBMK_MAX_ROWS][LIBMK_MAX_COLS] =
-    {{0x0b, 0x16, 0x1e, 0x19, 0x1b, 0xff, 0x07, 0x33, 0x39, 0x3e, 0xff, 0x56,
-         0x57, 0x53, 0x55, 0x4f, 0x48, 0x00, 0x65, 0x6d, 0x75, 0x77, 0xff, 0xff},
-     {0x0e, 0x0f, 0x17, 0x1f, 0x27, 0x26, 0x2e, 0x2f, 0x37, 0x3f, 0x47, 0x46,
-         0x36, 0xff, 0x51, 0x03, 0x01, 0x02, 0x64, 0x6c, 0x74, 0x76, 0xff, 0xff},
-     {0x09, 0x08, 0x10, 0x18, 0x20, 0x21, 0x29, 0x28, 0x30, 0x38, 0x40, 0x41,
-         0x31, 0xff, 0x52, 0x5e, 0x5c, 0x58, 0x60, 0x68, 0x70, 0x6e, 0xff, 0xff},
-     {0x11, 0x0a, 0x12, 0x1a, 0x22, 0x23, 0x2b, 0x2a, 0x32, 0x3a, 0x42, 0x43,
-         0xff, 0xff, 0x54, 0xff, 0xff, 0xff, 0x61, 0x69, 0x71, 0xff, 0xff, 0xff},
-     {0x49, 0xff, 0x0c, 0x14, 0x1c, 0x24, 0x25, 0x2d, 0x2c, 0x34, 0x3c, 0x45,
-         0xff, 0xff, 0x4a, 0xff, 0x50, 0xff, 0x62, 0x6a, 0x72, 0x6f, 0xff, 0xff},
-     {0x06, 0x5a, 0x4b, 0xff, 0xff, 0xff, 0x5b, 0xff, 0xff, 0xff, 0x4d, 0x4e,
-         0x3d, 0xff, 0x04, 0x5f, 0x5d, 0x05, 0x6b, 0xff, 0x73, 0xff, 0xff, 0xff},
-     {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
-         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
-    };
-
-const unsigned char LIBMK_LAYOUT_ISO[LIBMK_MAX_ROWS][LIBMK_MAX_COLS] =
-    {{0x0B, 0x16, 0x1E, 0x19, 0x1B, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
-     {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
-         0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}};
+const unsigned char LIBMK_LAYOUT[2][3][LIBMK_MAX_ROWS][LIBMK_MAX_COLS] = {
+    { // ANSI Layouts
+        // Layout size L
+        {{0x0b, 0x16, 0x1e, 0x19, 0x1b, 0xff, 0x07, 0x33, 0x39, 0x3e, 0xff, 0x56,
+          0x57, 0x53, 0x55, 0x4f, 0x48, 0x00, 0x65, 0x6d, 0x75, 0x77, 0xff, 0xff},
+         {0x0e, 0x0f, 0x17, 0x1f, 0x27, 0x26, 0x2e, 0x2f, 0x37, 0x3f, 0x47, 0x46,
+          0x36, 0xff, 0x51, 0x03, 0x01, 0x02, 0x64, 0x6c, 0x74, 0x76, 0xff, 0xff},
+         {0x09, 0x08, 0x10, 0x18, 0x20, 0x21, 0x29, 0x28, 0x30, 0x38, 0x40, 0x41,
+          0x31, 0xff, 0x52, 0x5e, 0x5c, 0x58, 0x60, 0x68, 0x70, 0x6e, 0xff, 0xff},
+         {0x11, 0x0a, 0x12, 0x1a, 0x22, 0x23, 0x2b, 0x2a, 0x32, 0x3a, 0x42, 0x43,
+          0xff, 0xff, 0x54, 0xff, 0xff, 0xff, 0x61, 0x69, 0x71, 0xff, 0xff, 0xff},
+         {0x49, 0xff, 0x0c, 0x14, 0x1c, 0x24, 0x25, 0x2d, 0x2c, 0x34, 0x3c, 0x45,
+          0xff, 0xff, 0x4a, 0xff, 0x50, 0xff, 0x62, 0x6a, 0x72, 0x6f, 0xff, 0xff},
+         {0x06, 0x5a, 0x4b, 0xff, 0xff, 0xff, 0x5b, 0xff, 0xff, 0xff, 0x4d, 0x4e,
+          0x3d, 0xff, 0x04, 0x5f, 0x5d, 0x05, 0x6b, 0xff, 0x73, 0xff, 0xff, 0xff},
+         {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+          0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}},
+        // Layout size M
+        // TODO: Find the key layout matrix of an ANSI M keyboard
+        {{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}},
+        // Layout size S
+        {{0x60, 0x61, 0x62, 0x63, 0x68, 0xFF, 0x69, 0x6A, 0x70, 0x71, 0xFF, 0x72,
+          0x43, 0x44, 0x45, 0x66, 0x67, 0x6B, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0x00, 0x01, 0x08, 0x09, 0x10, 0x11, 0x18, 0x19, 0x20, 0x21, 0x28, 0x29,
+          0x30, 0xFF, 0x31, 0x38, 0x39, 0x40, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0x02, 0x03, 0x0A, 0x0B, 0x12, 0x13, 0x1A, 0x1B, 0x22, 0x23, 0x2A, 0x2B,
+          0x32, 0xFF, 0x33, 0x3A, 0x3B, 0x42, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0x04, 0x05, 0x0C, 0x0D, 0x14, 0x15, 0x1C, 0x1D, 0x24, 0x25, 0x2C, 0x2D,
+          0xFF, 0xFF, 0x34, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0x06, 0xFF, 0x07, 0x0E, 0x0F, 0x16, 0x17, 0x1E, 0x1F, 0x26, 0x27, 0x2E,
+          0x01, 0xFF, 0x2F, 0xFF, 0x3D, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0x5B, 0x5A, 0x5C, 0xFF, 0xFF, 0xFF, 0x5D, 0xFF, 0xFF, 0xFF, 0x5E, 0x3C,
+          0x5F, 0xFF, 0x36, 0x3F, 0x3E, 0x46, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}},
+    }, { // ISO Layouts
+        // Layout size L
+        // This key layout matrix was copied from libcmmk, GNU GPLv3
+        {{0x0B, 0x16, 0x1E, 0x19, 0x1B, 0xFF, 0x07, 0x33, 0x39, 0x3E, 0xFF, 0x56,
+          0x57, 0x53, 0x55, 0x4F, 0x48, 0x00, 0x65, 0x6D, 0x75, 0x77, 0xFF, 0xFF},
+         {0x0E, 0x0F, 0x17, 0x1F, 0x27, 0x26, 0x2E, 0x2F, 0x37, 0x3F, 0x47, 0x46,
+          0x36, 0xFF, 0x51, 0x03, 0x01, 0x02, 0x64, 0x6C, 0x74, 0x76, 0xFF, 0xFF},
+         {0x09, 0x08, 0x10, 0x18, 0x20, 0x21, 0x29, 0x28, 0x30, 0x38, 0x40, 0x41,
+          0x31, 0xFF, 0x54, 0x5E, 0x5C, 0x58, 0x60, 0x68, 0x70, 0x6E, 0xFF, 0xFF},
+         {0x11, 0x0A, 0x12, 0x1A, 0x22, 0x23, 0x2B, 0x2A, 0x32, 0x3A, 0x42, 0x43,
+          0x44, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x61, 0x69, 0x71, 0xFF, 0xFF, 0xFF},
+         {0x49, 0x13, 0x0C, 0x14, 0x1C, 0x24, 0x25, 0x2D, 0x2C, 0x34, 0x3C, 0x45,
+          0xFF, 0xFF, 0x4A, 0xFF, 0x50, 0xFF, 0x62, 0x6A, 0x72, 0x6F, 0xFF, 0xFF},
+         {0x06, 0x5A, 0x4B, 0xFF, 0xFF, 0xFF, 0x5B, 0xFF, 0xFF, 0xFF, 0x4D, 0x4E,
+          0x3D, 0xFF, 0x04, 0x5F, 0x5D, 0x05, 0x6B, 0xFF, 0x73, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}},
+        // Layout size M
+        // TODO: Find the key layout matrix of an ISO M keyboard
+        {{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}},
+        // Layout size S
+        // TODO: Find the key layout matrix of an ISO S keyboard
+        {{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF},
+         {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+          0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}}
+    },
+    // TODO: If required, Japanese layouts may be added at index 2 of this array
+    // TODO: so that it remains compatible with the LibMK_Layout enum and the
+    // TODO: firmware defined layout
+};
 
 
 bool libmk_init(void) {
@@ -289,16 +357,34 @@ int libmk_create_handle(LibMK_Handle** handle, LibMK_Device* device) {
      * A LibMK_Handle must be created from a LibMK_Device struct, as
      * the LibMK_Handle requires special attributes.
     */
-    unsigned char layout = libmk_get_layout(device->bDevice);
     *handle = (LibMK_Handle*) malloc(sizeof(LibMK_Handle));
+    if (*handle == NULL)
+        return LIBMK_ERR_DEV_OPEN_FAILED;
     int r = libusb_open(device->device, &(*handle)->handle);
     if (r != 0)
         return LIBMK_ERR_DEV_OPEN_FAILED;
     (*handle)->open = true;
     (*handle)->model = device->model;
-    (*handle)->layout = layout;
     (*handle)->bDevice = device->bDevice;
     (*handle)->bVendor = device->bVendor;
+    LibMK_Model model = device->model;
+    if (model == DEV_RGB_L || model == DEV_WHITE_L)
+        (*handle)->size = LIBMK_L;
+    else if (model == DEV_RGB_M || model == DEV_WHITE_M)
+        (*handle)->size = LIBMK_M;
+    else if (model == DEV_RGB_S || model == DEV_WHITE_S)
+        (*handle)->size = LIBMK_S;
+    else {
+        libusb_close((*handle)->handle);
+        return LIBMK_ERR_UNKNOWN_LAYOUT;
+    }
+    LibMK_Firmware* fw;
+    r = libmk_get_firmware_version(*handle, &fw);
+    if (r != LIBMK_SUCCESS) {
+        libusb_close((*handle)->handle);
+        return r;
+    }
+    (*handle)->layout = fw->layout;
     return LIBMK_SUCCESS;
 }
 
@@ -590,7 +676,7 @@ int libmk_send_packet(LibMK_Handle* handle, unsigned char* packet) {
             handle->handle, LIBMK_EP_IN | LIBUSB_ENDPOINT_IN,
             packet, LIBMK_PACKET_SIZE, &t, LIBMK_PACKET_TIMEOUT);
     if (r != LIBUSB_SUCCESS) {
-        result = LIBMK_SUCCESS;
+        result = LIBMK_ERR_TRANSFER;
     } else if (t != LIBMK_PACKET_SIZE) {
         result = LIBMK_ERR_TRANSFER;
     } else if (packet[0] == HEADER_ERROR) {
@@ -603,6 +689,30 @@ int libmk_send_packet(LibMK_Handle* handle, unsigned char* packet) {
 }
 
 
+int libmk_exch_packet(LibMK_Handle* handle, unsigned char* packet) {
+    /** Send a single packet to the keyboard and receive the response
+     *
+     * The response is put in the memory allocated for the packet to be
+     * sent. If the function encounters an error, the memory is freed
+     * and no response is available (except for a return code).
+    */
+    int t;
+    int r = libusb_interrupt_transfer(
+        handle->handle, LIBMK_EP_OUT | LIBUSB_ENDPOINT_OUT,
+        packet, LIBMK_PACKET_SIZE, &t, LIBMK_PACKET_TIMEOUT);
+    if (r != LIBUSB_SUCCESS || t != LIBMK_PACKET_SIZE) {
+        free(packet);
+        return LIBMK_ERR_TRANSFER;
+    }
+    r = libusb_interrupt_transfer(
+        handle->handle, LIBMK_EP_IN | LIBUSB_ENDPOINT_IN,
+        packet, LIBMK_PACKET_SIZE, &t, LIBMK_PACKET_TIMEOUT);
+    if (r != LIBUSB_SUCCESS || t != LIBMK_PACKET_SIZE)
+        return LIBMK_ERR_TRANSFER;
+    return LIBMK_SUCCESS;
+}
+
+
 unsigned char* libmk_build_packet(unsigned char predef, ...) {
     /** Return a pointer to a packet filled with zeros */
     unsigned char* packet = (unsigned char*)
@@ -688,26 +798,7 @@ int libmk_set_all_led_color(
 }
 
 
-unsigned char libmk_get_layout(int bProduct) {
-    short i = 0;
-    while (true) {
-        if (ANSI[i] == bProduct)
-            return LAYOUT_ANSI;
-        else if (ANSI[i] == 0)
-            break;
-        i++;
-    }
-    i = 0;
-    while (ISO[i] != 0x0000) {
-        if (ISO[i] == bProduct)
-            return LAYOUT_ISO;
-        i++;
-    }
-    return LIBMK_ERR_UNKNOWN_LAYOUT;
-}
-
-
-void libmk_print_packet(unsigned char* packet) {
+inline void libmk_print_packet(unsigned char* packet) {
     /** Pretty print a keyboard communication packet */
 #ifdef LIBMK_DEBUG
     printf("Packet:\n");
@@ -731,12 +822,9 @@ int libmk_get_offset(
      * keyboard. This function returns the hexadecimal offset for the
      * appropriate layout into the offset pointer.
      */
-    if (handle->layout == LAYOUT_ANSI)
-        *offset = LIBMK_LAYOUT_ANSI[row][col];
-    else if (handle->layout == LAYOUT_ISO)
-        *offset = LIBMK_LAYOUT_ISO[row][col];
-    else
+    if (handle->layout != LAYOUT_ISO && handle->layout != LAYOUT_ANSI)
         return LIBMK_ERR_UNKNOWN_LAYOUT;
+    *offset = LIBMK_LAYOUT[handle->layout - 1][handle->size][row][col];
     return LIBMK_SUCCESS;
 }
 
@@ -795,3 +883,29 @@ int libmk_set_effect_details(
         return r;
     return libmk_send_packet(handle, packet);
 }
+
+
+int libmk_get_firmware_version(LibMK_Handle* handle, LibMK_Firmware** fw) {
+    /** Return the firmware details
+     *
+     * TODO: Determine whether the version number encodes the layout
+     * TODO: See libcmmk issue #10 for more information
+    */
+    if (handle == NULL)
+        handle = DeviceHandle;
+    if (handle == NULL)
+        return LIBMK_ERR_DEV_NOT_SET;
+    unsigned char* p = libmk_build_packet(2, 0x01, 0x02);
+    int r = libmk_exch_packet(handle, p);
+    if (r != LIBMK_SUCCESS)
+        return r;
+    (*fw) = (LibMK_Firmware*) malloc(sizeof(LibMK_Firmware));
+    for (unsigned char i=0; i<5; i++)
+        (*fw)->string[i] = p[0x04 + i];
+    (*fw)->string[5] = (char) NULL;
+    (*fw)->major = p[0x04] & 0x0F;
+    (*fw)->minor = p[0x06] & 0x0F;
+    (*fw)->patch = p[0x08] & 0x0F;
+    (*fw)->layout = p[0x04] & 0x0F;
+    return LIBMK_SUCCESS;
+}
diff --git a/libmk/libmk.h b/libmk/libmk.h
@@ -78,12 +78,46 @@ typedef enum LibMK_Effect {
 } LibMK_Effect;
 
 
+typedef enum LibMK_ControlMode {
+    /** Describes keyboard control modes */
+    LIBMK_FIRMWARE_CTRL = 0x00,
+    LIBMK_EFFECT_CTRL = 0x01,
+    LIBMK_CUSTOM_CTRL = 0x02,
+    LIBMK_PROFILE_CTRL = 0x03,
+} LibMK_ControlMode;
+
+
+typedef enum LibMK_Layout {
+    LIBMK_LAYOUT_UNKNOWN = 0,
+    LIBMK_LAYOUT_ANSI = 1,
+    LIBMK_LAYOUT_ISO = 2,
+    LIBMK_LAYOUT_JP = 3
+} LibMK_Layout;
+
+
+typedef struct LibMK_Firmware {
+    /** Describes keyboard firmware details */
+    unsigned char major;
+    unsigned char minor;
+    unsigned char patch;
+    unsigned char layout;
+    char string[6];
+} LibMK_Firmware;
+
+
+typedef enum LibMK_Size {
+    LIBMK_L = 0,
+    LIBMK_M = 1,
+    LIBMK_S = 2
+} LibMK_Size;
+
+
 typedef enum LibMK_Model {
     /** Describes models available for use with this library
      *
      * The device indices are the same as the ones used in the official
      * Cooler Master (Windows-only) SDK. Not all these devices are
-     * supported. For white devices, the
+     * supported.
      */
     DEV_RGB_L = 0,
     DEV_RGB_M = 5,
@@ -122,6 +156,7 @@ typedef struct LibMK_Handle {
     int bVendor;
     int bDevice;
     int layout;
+    int size;
     libusb_device_handle* handle;
     bool open;
 } LibMK_Handle;
@@ -136,6 +171,7 @@ typedef struct LibMK_Effect_Details {
     unsigned char background[3];
 } LibMK_Effect_Details;
 
+
 /** Library management and initialization */
 bool libmk_init();
 int libmk_exit();
@@ -150,7 +186,6 @@ LibMK_Device* libmk_create_device(
 void libmk_free_device(LibMK_Device* device);
 LibMK_Device* libmk_append_device(LibMK_Device* first, LibMK_Device* device);
 LibMK_Model libmk_ident_model(char* product);
-unsigned char libmk_get_layout(int bProduct);
 
 
 /** Handle management */
@@ -166,6 +201,7 @@ int libmk_claim_interface(LibMK_Handle* handle);
 int libmk_send_control_packet(LibMK_Handle* handle);
 int libmk_reset(LibMK_Handle* handle);
 int libmk_get_device_ident(LibMK_Handle* handle);
+int libmk_get_firmware_version(LibMK_Handle* handle, LibMK_Firmware** fw);
 
 
 /** Communication */
diff --git a/utils/main.c b/utils/main.c
