OSDN Git Service

Merge branches 'for-4.11/upstream-fixes', 'for-4.12/accutouch', 'for-4.12/cp2112...
[android-x86/kernel.git] / drivers / hid / i2c-hid / i2c-hid.c
index 2e021ba..8daa8ce 100644 (file)
@@ -22,6 +22,7 @@
 #include <linux/i2c.h>
 #include <linux/interrupt.h>
 #include <linux/input.h>
+#include <linux/irq.h>
 #include <linux/delay.h>
 #include <linux/slab.h>
 #include <linux/pm.h>
 #include <linux/mutex.h>
 #include <linux/acpi.h>
 #include <linux/of.h>
-#include <linux/gpio/consumer.h>
+#include <linux/regulator/consumer.h>
 
 #include <linux/i2c/i2c-hid.h>
 
+#include "../hid-ids.h"
+
+/* quirks to control the device */
+#define I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV       BIT(0)
+
 /* flags */
 #define I2C_HID_STARTED                0
 #define I2C_HID_RESET_PENDING  1
@@ -143,10 +149,9 @@ struct i2c_hid {
        char                    *argsbuf;       /* Command arguments buffer */
 
        unsigned long           flags;          /* device flags */
+       unsigned long           quirks;         /* Various quirks */
 
        wait_queue_head_t       wait;           /* For waiting the interrupt */
-       struct gpio_desc        *desc;
-       int                     irq;
 
        struct i2c_hid_platform_data pdata;
 
@@ -154,6 +159,39 @@ struct i2c_hid {
        struct mutex            reset_lock;
 };
 
+static const struct i2c_hid_quirks {
+       __u16 idVendor;
+       __u16 idProduct;
+       __u32 quirks;
+} i2c_hid_quirks[] = {
+       { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8752,
+               I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
+       { USB_VENDOR_ID_WEIDA, USB_DEVICE_ID_WEIDA_8755,
+               I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV },
+       { 0, 0 }
+};
+
+/*
+ * i2c_hid_lookup_quirk: return any quirks associated with a I2C HID device
+ * @idVendor: the 16-bit vendor ID
+ * @idProduct: the 16-bit product ID
+ *
+ * Returns: a u32 quirks value.
+ */
+static u32 i2c_hid_lookup_quirk(const u16 idVendor, const u16 idProduct)
+{
+       u32 quirks = 0;
+       int n;
+
+       for (n = 0; i2c_hid_quirks[n].idVendor; n++)
+               if (i2c_hid_quirks[n].idVendor == idVendor &&
+                   (i2c_hid_quirks[n].idProduct == (__u16)HID_ANY_ID ||
+                    i2c_hid_quirks[n].idProduct == idProduct))
+                       quirks = i2c_hid_quirks[n].quirks;
+
+       return quirks;
+}
+
 static int __i2c_hid_command(struct i2c_client *client,
                const struct i2c_hid_cmd *command, u8 reportID,
                u8 reportType, u8 *args, int args_len,
@@ -346,11 +384,27 @@ static int i2c_hid_set_power(struct i2c_client *client, int power_state)
 
        i2c_hid_dbg(ihid, "%s\n", __func__);
 
+       /*
+        * Some devices require to send a command to wakeup before power on.
+        * The call will get a return value (EREMOTEIO) but device will be
+        * triggered and activated. After that, it goes like a normal device.
+        */
+       if (power_state == I2C_HID_PWR_ON &&
+           ihid->quirks & I2C_HID_QUIRK_SET_PWR_WAKEUP_DEV) {
+               ret = i2c_hid_command(client, &hid_set_power_cmd, NULL, 0);
+
+               /* Device was already activated */
+               if (!ret)
+                       goto set_pwr_exit;
+       }
+
        ret = __i2c_hid_command(client, &hid_set_power_cmd, power_state,
                0, NULL, 0, NULL, 0);
+
        if (ret)
                dev_err(&client->dev, "failed to change power setting.\n");
 
+set_pwr_exit:
        return ret;
 }
 
@@ -372,6 +426,15 @@ static int i2c_hid_hwreset(struct i2c_client *client)
        if (ret)
                goto out_unlock;
 
+       /*
+        * The HID over I2C specification states that if a DEVICE needs time
+        * after the PWR_ON request, it should utilise CLOCK stretching.
+        * However, it has been observered that the Windows driver provides a
+        * 1ms sleep between the PWR_ON and RESET requests and that some devices
+        * rely on this.
+        */
+       usleep_range(1000, 5000);
+
        i2c_hid_dbg(ihid, "resetting...\n");
 
        ret = i2c_hid_command(client, &hid_reset_cmd, NULL, 0);
@@ -445,66 +508,6 @@ static int i2c_hid_get_report_length(struct hid_report *report)
                report->device->report_enum[report->type].numbered + 2;
 }
 
-static void i2c_hid_init_report(struct hid_report *report, u8 *buffer,
-       size_t bufsize)
-{
-       struct hid_device *hid = report->device;
-       struct i2c_client *client = hid->driver_data;
-       struct i2c_hid *ihid = i2c_get_clientdata(client);
-       unsigned int size, ret_size;
-
-       size = i2c_hid_get_report_length(report);
-       if (i2c_hid_get_report(client,
-                       report->type == HID_FEATURE_REPORT ? 0x03 : 0x01,
-                       report->id, buffer, size))
-               return;
-
-       i2c_hid_dbg(ihid, "report (len=%d): %*ph\n", size, size, buffer);
-
-       ret_size = buffer[0] | (buffer[1] << 8);
-
-       if (ret_size != size) {
-               dev_err(&client->dev, "error in %s size:%d / ret_size:%d\n",
-                       __func__, size, ret_size);
-               return;
-       }
-
-       /* hid->driver_lock is held as we are in probe function,
-        * we just need to setup the input fields, so using
-        * hid_report_raw_event is safe. */
-       hid_report_raw_event(hid, report->type, buffer + 2, size - 2, 1);
-}
-
-/*
- * Initialize all reports
- */
-static void i2c_hid_init_reports(struct hid_device *hid)
-{
-       struct hid_report *report;
-       struct i2c_client *client = hid->driver_data;
-       struct i2c_hid *ihid = i2c_get_clientdata(client);
-       u8 *inbuf = kzalloc(ihid->bufsize, GFP_KERNEL);
-
-       if (!inbuf) {
-               dev_err(&client->dev, "can not retrieve initial reports\n");
-               return;
-       }
-
-       /*
-        * The device must be powered on while we fetch initial reports
-        * from it.
-        */
-       pm_runtime_get_sync(&client->dev);
-
-       list_for_each_entry(report,
-               &hid->report_enum[HID_FEATURE_REPORT].report_list, list)
-               i2c_hid_init_report(report, inbuf, ihid->bufsize);
-
-       pm_runtime_put(&client->dev);
-
-       kfree(inbuf);
-}
-
 /*
  * Traverse the supplied list of reports and find the longest
  */
@@ -716,17 +719,16 @@ static int i2c_hid_start(struct hid_device *hid)
        i2c_hid_find_max_report(hid, HID_FEATURE_REPORT, &bufsize);
 
        if (bufsize > ihid->bufsize) {
+               disable_irq(client->irq);
                i2c_hid_free_buffers(ihid);
 
                ret = i2c_hid_alloc_buffers(ihid, bufsize);
+               enable_irq(client->irq);
 
                if (ret)
                        return ret;
        }
 
-       if (!(hid->quirks & HID_QUIRK_NO_INIT_REPORTS))
-               i2c_hid_init_reports(hid);
-
        return 0;
 }
 
@@ -806,18 +808,21 @@ static struct hid_ll_driver i2c_hid_ll_driver = {
 static int i2c_hid_init_irq(struct i2c_client *client)
 {
        struct i2c_hid *ihid = i2c_get_clientdata(client);
+       unsigned long irqflags = 0;
        int ret;
 
-       dev_dbg(&client->dev, "Requesting IRQ: %d\n", ihid->irq);
+       dev_dbg(&client->dev, "Requesting IRQ: %d\n", client->irq);
+
+       if (!irq_get_trigger_type(client->irq))
+               irqflags = IRQF_TRIGGER_LOW;
 
-       ret = request_threaded_irq(ihid->irq, NULL, i2c_hid_irq,
-                       IRQF_TRIGGER_LOW | IRQF_ONESHOT,
-                       client->name, ihid);
+       ret = request_threaded_irq(client->irq, NULL, i2c_hid_irq,
+                                  irqflags | IRQF_ONESHOT, client->name, ihid);
        if (ret < 0) {
                dev_warn(&client->dev,
                        "Could not register for %s interrupt, irq = %d,"
                        " ret = %d\n",
-                       client->name, ihid->irq, ret);
+                       client->name, client->irq, ret);
 
                return ret;
        }
@@ -864,14 +869,6 @@ static int i2c_hid_fetch_hid_descriptor(struct i2c_hid *ihid)
 }
 
 #ifdef CONFIG_ACPI
-
-/* Default GPIO mapping */
-static const struct acpi_gpio_params i2c_hid_irq_gpio = { 0, 0, true };
-static const struct acpi_gpio_mapping i2c_hid_acpi_gpios[] = {
-       { "gpios", &i2c_hid_irq_gpio, 1 },
-       { },
-};
-
 static int i2c_hid_acpi_pdata(struct i2c_client *client,
                struct i2c_hid_platform_data *pdata)
 {
@@ -882,7 +879,6 @@ static int i2c_hid_acpi_pdata(struct i2c_client *client,
        union acpi_object *obj;
        struct acpi_device *adev;
        acpi_handle handle;
-       int ret;
 
        handle = ACPI_HANDLE(&client->dev);
        if (!handle || acpi_bus_get_device(handle, &adev))
@@ -898,9 +894,7 @@ static int i2c_hid_acpi_pdata(struct i2c_client *client,
        pdata->hid_descriptor_address = obj->integer.value;
        ACPI_FREE(obj);
 
-       /* GPIOs are optional */
-       ret = acpi_dev_add_driver_gpios(adev, i2c_hid_acpi_gpios);
-       return ret < 0 && ret != -ENXIO ? ret : 0;
+       return 0;
 }
 
 static const struct acpi_device_id i2c_hid_acpi_match[] = {
@@ -937,6 +931,11 @@ static int i2c_hid_of_probe(struct i2c_client *client,
        }
        pdata->hid_descriptor_address = val;
 
+       ret = of_property_read_u32(dev->of_node, "post-power-on-delay-ms",
+                                  &val);
+       if (!ret)
+               pdata->post_power_delay_ms = val;
+
        return 0;
 }
 
@@ -964,6 +963,19 @@ static int i2c_hid_probe(struct i2c_client *client,
 
        dbg_hid("HID probe called for i2c 0x%02x\n", client->addr);
 
+       if (!client->irq) {
+               dev_err(&client->dev,
+                       "HID over i2c has not been provided an Int IRQ\n");
+               return -EINVAL;
+       }
+
+       if (client->irq < 0) {
+               if (client->irq != -EPROBE_DEFER)
+                       dev_err(&client->dev,
+                               "HID over i2c doesn't have a valid IRQ\n");
+               return client->irq;
+       }
+
        ihid = kzalloc(sizeof(struct i2c_hid), GFP_KERNEL);
        if (!ihid)
                return -ENOMEM;
@@ -983,22 +995,23 @@ static int i2c_hid_probe(struct i2c_client *client,
                ihid->pdata = *platform_data;
        }
 
-       if (client->irq > 0) {
-               ihid->irq = client->irq;
-       } else if (ACPI_COMPANION(&client->dev)) {
-               ihid->desc = gpiod_get(&client->dev, NULL, GPIOD_IN);
-               if (IS_ERR(ihid->desc)) {
-                       dev_err(&client->dev, "Failed to get GPIO interrupt\n");
-                       return PTR_ERR(ihid->desc);
-               }
+       ihid->pdata.supply = devm_regulator_get(&client->dev, "vdd");
+       if (IS_ERR(ihid->pdata.supply)) {
+               ret = PTR_ERR(ihid->pdata.supply);
+               if (ret != -EPROBE_DEFER)
+                       dev_err(&client->dev, "Failed to get regulator: %d\n",
+                               ret);
+               goto err;
+       }
 
-               ihid->irq = gpiod_to_irq(ihid->desc);
-               if (ihid->irq < 0) {
-                       gpiod_put(ihid->desc);
-                       dev_err(&client->dev, "Failed to convert GPIO to IRQ\n");
-                       return ihid->irq;
-               }
+       ret = regulator_enable(ihid->pdata.supply);
+       if (ret < 0) {
+               dev_err(&client->dev, "Failed to enable regulator: %d\n",
+                       ret);
+               goto err;
        }
+       if (ihid->pdata.post_power_delay_ms)
+               msleep(ihid->pdata.post_power_delay_ms);
 
        i2c_set_clientdata(client, ihid);
 
@@ -1015,11 +1028,12 @@ static int i2c_hid_probe(struct i2c_client *client,
         * real computation later. */
        ret = i2c_hid_alloc_buffers(ihid, HID_MIN_BUFFER_SIZE);
        if (ret < 0)
-               goto err;
+               goto err_regulator;
 
        pm_runtime_get_noresume(&client->dev);
        pm_runtime_set_active(&client->dev);
        pm_runtime_enable(&client->dev);
+       device_enable_async_suspend(&client->dev);
 
        ret = i2c_hid_fetch_hid_descriptor(ihid);
        if (ret < 0)
@@ -1049,6 +1063,8 @@ static int i2c_hid_probe(struct i2c_client *client,
                 client->name, hid->vendor, hid->product);
        strlcpy(hid->phys, dev_name(&client->dev), sizeof(hid->phys));
 
+       ihid->quirks = i2c_hid_lookup_quirk(hid->vendor, hid->product);
+
        ret = hid_add_device(hid);
        if (ret) {
                if (ret != -ENODEV)
@@ -1063,16 +1079,16 @@ err_mem_free:
        hid_destroy_device(hid);
 
 err_irq:
-       free_irq(ihid->irq, ihid);
+       free_irq(client->irq, ihid);
 
 err_pm:
        pm_runtime_put_noidle(&client->dev);
        pm_runtime_disable(&client->dev);
 
-err:
-       if (ihid->desc)
-               gpiod_put(ihid->desc);
+err_regulator:
+       regulator_disable(ihid->pdata.supply);
 
+err:
        i2c_hid_free_buffers(ihid);
        kfree(ihid);
        return ret;
@@ -1091,21 +1107,26 @@ static int i2c_hid_remove(struct i2c_client *client)
        hid = ihid->hid;
        hid_destroy_device(hid);
 
-       free_irq(ihid->irq, ihid);
+       free_irq(client->irq, ihid);
 
        if (ihid->bufsize)
                i2c_hid_free_buffers(ihid);
 
-       if (ihid->desc)
-               gpiod_put(ihid->desc);
+       regulator_disable(ihid->pdata.supply);
 
        kfree(ihid);
 
-       acpi_dev_remove_driver_gpios(ACPI_COMPANION(&client->dev));
-
        return 0;
 }
 
+static void i2c_hid_shutdown(struct i2c_client *client)
+{
+       struct i2c_hid *ihid = i2c_get_clientdata(client);
+
+       i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
+       free_irq(client->irq, ihid);
+}
+
 #ifdef CONFIG_PM_SLEEP
 static int i2c_hid_suspend(struct device *dev)
 {
@@ -1133,16 +1154,20 @@ static int i2c_hid_suspend(struct device *dev)
                /* Save some power */
                i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
 
-               disable_irq(ihid->irq);
+               disable_irq(client->irq);
        }
 
        if (device_may_wakeup(&client->dev)) {
-               wake_status = enable_irq_wake(ihid->irq);
+               wake_status = enable_irq_wake(client->irq);
                if (!wake_status)
                        ihid->irq_wake_enabled = true;
                else
                        hid_warn(hid, "Failed to enable irq wake: %d\n",
                                wake_status);
+       } else {
+               ret = regulator_disable(ihid->pdata.supply);
+               if (ret < 0)
+                       hid_warn(hid, "Failed to disable supply: %d\n", ret);
        }
 
        return 0;
@@ -1156,8 +1181,14 @@ static int i2c_hid_resume(struct device *dev)
        struct hid_device *hid = ihid->hid;
        int wake_status;
 
-       if (device_may_wakeup(&client->dev) && ihid->irq_wake_enabled) {
-               wake_status = disable_irq_wake(ihid->irq);
+       if (!device_may_wakeup(&client->dev)) {
+               ret = regulator_enable(ihid->pdata.supply);
+               if (ret < 0)
+                       hid_warn(hid, "Failed to enable supply: %d\n", ret);
+               if (ihid->pdata.post_power_delay_ms)
+                       msleep(ihid->pdata.post_power_delay_ms);
+       } else if (ihid->irq_wake_enabled) {
+               wake_status = disable_irq_wake(client->irq);
                if (!wake_status)
                        ihid->irq_wake_enabled = false;
                else
@@ -1170,7 +1201,7 @@ static int i2c_hid_resume(struct device *dev)
        pm_runtime_set_active(dev);
        pm_runtime_enable(dev);
 
-       enable_irq(ihid->irq);
+       enable_irq(client->irq);
        ret = i2c_hid_hwreset(client);
        if (ret)
                return ret;
@@ -1188,19 +1219,17 @@ static int i2c_hid_resume(struct device *dev)
 static int i2c_hid_runtime_suspend(struct device *dev)
 {
        struct i2c_client *client = to_i2c_client(dev);
-       struct i2c_hid *ihid = i2c_get_clientdata(client);
 
        i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
-       disable_irq(ihid->irq);
+       disable_irq(client->irq);
        return 0;
 }
 
 static int i2c_hid_runtime_resume(struct device *dev)
 {
        struct i2c_client *client = to_i2c_client(dev);
-       struct i2c_hid *ihid = i2c_get_clientdata(client);
 
-       enable_irq(ihid->irq);
+       enable_irq(client->irq);
        i2c_hid_set_power(client, I2C_HID_PWR_ON);
        return 0;
 }
@@ -1230,7 +1259,7 @@ static struct i2c_driver i2c_hid_driver = {
 
        .probe          = i2c_hid_probe,
        .remove         = i2c_hid_remove,
-
+       .shutdown       = i2c_hid_shutdown,
        .id_table       = i2c_hid_id_table,
 };