unifying: interface with HID++ 2.0 features

Prepare for adding more HID++ 2.0 features.

4 files changed, 95 insertions, 2 deletions

diff --git a/hw/usb/Makefile.objs b/hw/usb/Makefile.objs
index f735867bd1..477589f7c5 100644
--- a/hw/usb/Makefile.objs
+++ b/hw/usb/Makefile.objs
@@ -15,6 +15,7 @@ common-obj-y += dev-hid.o
 common-obj-$(CONFIG_USB_TABLET_WACOM) += dev-wacom.o
 common-obj-$(CONFIG_USB_LG_UNIFYING)  += dump.o
 common-obj-$(CONFIG_USB_LG_UNIFYING)  += dev-unifying.o hid-logitech-dj.o
+common-obj-$(CONFIG_USB_LG_UNIFYING)  += hid-logitech-hidpp20.o
 common-obj-$(CONFIG_USB_STORAGE_BOT)  += dev-storage.o
 common-obj-$(CONFIG_USB_STORAGE_UAS)  += dev-uas.o
 common-obj-$(CONFIG_USB_AUDIO)        += dev-audio.o
diff --git a/hw/usb/hid-logitech-dj.c b/hw/usb/hid-logitech-dj.c
index caa0383bc9..6de5fa4ba1 100644
--- a/hw/usb/hid-logitech-dj.c
+++ b/hw/usb/hid-logitech-dj.c
@@ -400,6 +400,7 @@ static void hidpp_process_device_hidpp20(USBLtunifyState *s, HidppMsg *msg)
     LHidDevice *hd = &s->devices[msg->device_index - 1];
     Hidpp20Msg *func = (Hidpp20Msg *) msg;
     uint8_t fn = func->func >> 4;
+    int r;
 
     if (func->feat_index == 0) { /* IRoot */
         if (fn == 1) { /* GetProtocolVersion */
@@ -411,7 +412,14 @@ static void hidpp_process_device_hidpp20(USBLtunifyState *s, HidppMsg *msg)
         }
         return;
     }
-    /* TODO: implement features and more functions */
+
+    r = hidpp20_feature_call(hd, func);
+    /* note: if r == 0, then the function is void and there is no output */
+    if (r > 0) {
+        hidpp_queue_output_report(s, msg);
+    } else if (r < 0) {
+        hidpp20_queue_error(s, func, -r);
+    }
 }
 
 
@@ -622,6 +630,7 @@ static void hidpp_init_device(USBLtunifyState *s, int device_index, int devtype)
         hd->report_interval = 8;
         break;
     }
+    hidpp20_init_features(hd);
     hd->info.protocol_version = 0x0200; /* HID++ 2.0 */
     hd->mode = LTUNIFY_MODE_HID;
     hd->powered_on = true;
diff --git a/hw/usb/hid-logitech-dj.h b/hw/usb/hid-logitech-dj.h
index de46a74453..83cb33b8aa 100644
--- a/hw/usb/hid-logitech-dj.h
+++ b/hw/usb/hid-logitech-dj.h
@@ -163,6 +163,9 @@ typedef struct {
     /* TODO: device firmware upgrade things? */
 } LHidReceiver;
 
+/* defined in hid-logitech-hidpp20.c */
+typedef struct HidppFeature HidppFeature;
+
 typedef struct {
     struct {
         enum {
@@ -185,7 +188,9 @@ typedef struct {
         char name[15];
         uint8_t usability_info; /* bits 0..3 power switch location */
         uint32_t report_types; /* supported report types (e.g. mouse) */
-        /* TODO: feature set */
+
+        const HidppFeature *features; /* Note: feature_index is index - 1 */
+        unsigned features_count; /* features count not including root */
         /* TODO: special mouse and key button mappings */
     } info; /* static information */
 
@@ -258,4 +263,9 @@ void usb_ltunify_handle_datain_hidpp(USBDevice *dev, USBPacket *p);
 
 void hidpp_reset(USBLtunifyState *s);
 void hidpp_init(USBLtunifyState *s);
+
+/* hid-logitech-hidpp20.c */
+void hidpp20_init_features(LHidDevice *hd);
+/* return codes: negative: send error; 0: send nothing; positive: send output */
+int hidpp20_feature_call(LHidDevice *hd, Hidpp20Msg *func);
 #endif
diff --git a/hw/usb/hid-logitech-hidpp20.c b/hw/usb/hid-logitech-hidpp20.c
new file mode 100644
index 0000000000..371eaa6bdd
--- /dev/null
+++ b/hw/usb/hid-logitech-hidpp20.c
@@ -0,0 +1,73 @@
+/*
+ * Logitech Unifying receiver emulation (HID++ 2.0 features).
+ *
+ * Copyright (c) 2014 Peter Wu <peter@lekensteyn.nl>
+ *
+ * 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, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 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. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+#include "hw/hw.h"
+#include "ui/console.h"
+#include "hw/usb.h"
+#include "dump.h"
+#include "hw/input/hid.h"
+#include "hw/usb/hid-logitech-dj.h"
+
+/* hd - subject device; msg - input/output msg; fn - Function ID; params -
+ * function parameters (in/out).
+ * If the return value is negative, an error report must be returned. If 0, then
+ * no output report must be generated. Higher values signify the number of
+ * parameters that must not be cleared when outputting a response */
+typedef int (*hidpp_feature_cb_t)(LHidDevice *hd, Hidpp20Msg *msg,
+                                  uint8_t fn, uint8_t *params);
+struct HidppFeature {
+    uint16_t id;
+#define HIDPP20_FEAT_TYPE_OBSOLETE  (1 << 7)
+#define HIDPP20_FEAT_TYPE_HIDDEN    (1 << 6)
+#define HIDPP20_FEAT_TYPE_INTERNAL  (1 << 5)
+    uint8_t type;
+    hidpp_feature_cb_t callback;
+};
+
+void hidpp20_init_features(LHidDevice *hd) {
+    switch (hd->info.wireless_pid) {
+    }
+}
+
+int hidpp20_feature_call(LHidDevice *hd, Hidpp20Msg *func)
+{
+    uint8_t fn = func->func >> 4;
+    const HidppFeature *feat;
+    int r;
+
+    if (func->feat_index > hd->info.features_count) {
+        return -HIDPP20_ERR_CODE_INVALID_FEATURE_INDEX;
+    }
+
+    assert(hd->info.features != NULL);
+
+    feat = &hd->info.features[func->feat_index - 1];
+    r = feat->callback(hd, func, fn, func->params);
+    if (r > 0) {
+        // r are the parameters that must be kept, the others are cleared.
+        assert(r <= sizeof(func->params));
+        memset(func->params + r, 0, sizeof(func->params) - r);
+    }
+
+    return r;
+}