Added initial 5110 driver

Author: Alexander Meiler

data/autosuspend.hwdb

@@ -279,3 +279,7 @@ usb:v2808p9338*
 usb:v298Dp2033*
 usb:v3538p0930*
  ID_AUTOSUSPEND=1
+ 
+# Supported by libfprint driver goodix
+usb:v27c6p5110*
+ID_AUTOSUSPEND=1

libfprint/drivers/goodix5110.c

@@ -0,0 +1,370 @@
+/*
+ * Goodix 5110 driver for libfprint
+ *
+ * Copyright (C) 2021 Alexander Meiler <[email protected]>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#define FP_COMPONENT "goodix5110"
+
+#include "drivers_api.h"
+#include "goodix5110.h"
+
+struct _FpiDeviceGoodix
+{
+  FpImageDevice parent;
+
+  /* device config */
+  //   unsigned short dev_type;
+  char *fw_ver;
+  //   void           (*process_frame) (unsigned short *raw_frame,
+  //                                    GSList       ** frames);
+  /* end device config */
+
+  /* commands */
+  const struct goodix_cmd *cmd;
+  int cmd_timeout;
+  /* end commands */
+
+  /* state */
+  gboolean        active;
+  gboolean        deactivating;
+  unsigned char  *last_read;
+  // unsigned char   calib_atts_left;
+  // unsigned char   calib_status;
+  unsigned short *background;
+  // unsigned char   frame_width;
+  // unsigned char   frame_height;
+  // unsigned char   raw_frame_height;
+  // int             num_frames;
+  // GSList         *frames;
+  /* end state */
+};
+G_DEFINE_TYPE (FpiDeviceGoodix, fpi_device_goodix, FP_TYPE_IMAGE_DEVICE);
+
+static void
+goodix_cmd_done (FpiSsm *ssm)
+{
+  G_DEBUG_HERE ();
+  fpi_ssm_next_state (ssm);
+}
+
+static void
+goodix_cmd_read (FpiSsm *ssm, FpDevice *dev, int response_len)
+{
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+  FpiUsbTransfer *transfer;
+  GCancellable *cancellable = NULL;
+  //int response_len = self->cmd->response_len;
+
+  G_DEBUG_HERE ();
+
+  if (self->cmd->response_len == GOODIX_CMD_SKIP_READ)
+    {
+      fp_dbg ("skipping read, not expecting anything");
+      goodix_cmd_done (ssm);
+      return;
+    }
+
+  g_clear_pointer (&self->last_read, g_free);
+
+  transfer = fpi_usb_transfer_new (dev);
+  transfer->ssm = ssm;
+  transfer->short_is_error = TRUE;
+
+  fpi_usb_transfer_fill_bulk (transfer,
+                              GOODIX_EP_CMD_IN,
+                              response_len);
+
+  fpi_usb_transfer_submit (transfer, self->cmd_timeout, cancellable, goodix_cmd_cb, NULL);
+}
+
+static void
+goodix_cmd_cb (FpiUsbTransfer *transfer, FpDevice *dev,
+             gpointer user_data, GError *error)
+{
+  FpiSsm *ssm = transfer->ssm;
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+
+  if (error)
+    {
+      /* XXX: In the cancellation case we used to not
+       *      mark the SSM as failed?! */
+      fpi_ssm_mark_failed (transfer->ssm, error);
+      return;
+    }
+
+  /* XXX: We used to reset the device in error cases! */
+  if (transfer->endpoint & FPI_USB_ENDPOINT_IN)
+    {
+      /* just finished receiving */
+      self->last_read = g_memdup (transfer->buffer, transfer->actual_length);
+      //fp_dbg("%lu", transfer->actual_length);
+      if(self->cmd->cmd == read_fw.cmd)
+      {
+        if(transfer->actual_length == self->cmd->response_len)
+        {
+          // We got ACK, now wait for the firmware string packet
+          G_DEBUG_HERE ();
+          goodix_cmd_read (ssm, dev, self->cmd->response_len_2);
+        }
+        else
+        {
+          // Reading the firmware version
+          self->fw_ver = g_memdup (&self->last_read[7], self->cmd->response_len_2);
+          G_DEBUG_HERE ();
+          goodix_cmd_done (ssm);
+        }
+      }
+      else
+      {
+        goodix_cmd_done (ssm);
+      }
+    }
+  else
+    {
+      /* just finished sending */
+      G_DEBUG_HERE ();
+      goodix_cmd_read (ssm, dev, self->cmd->response_len);
+    }
+}
+
+static void
+goodix_run_cmd (FpiSsm *ssm,
+              FpDevice *dev,
+              const struct goodix_cmd *cmd,
+              int cmd_timeout)
+{
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+  FpiUsbTransfer *transfer;
+  GCancellable *cancellable = NULL;
+
+  self->cmd = cmd;
+
+  transfer = fpi_usb_transfer_new (dev);
+  transfer->ssm = ssm;
+  transfer->short_is_error = TRUE;
+
+  fpi_usb_transfer_fill_bulk_full (transfer,
+                                   GOODIX_EP_CMD_OUT,
+                                   (guint8 *) cmd->cmd,
+                                   GOODIX_CMD_LEN,
+                                   NULL);
+
+  fpi_usb_transfer_submit (transfer,
+                           cmd_timeout,
+                           cancellable,
+                           goodix_cmd_cb,
+                           NULL);
+}
+
+/* ------------------------------------------------------------------------------- */
+
+/* ---- ACTIVE SECTION START ---- */
+
+enum activate_states {
+  ACTIVATE_NOP1,
+  ACTIVATE_ENABLE_CHIP,
+  ACTIVATE_NOP2,
+  ACTIVATE_GET_FW_VER,
+  ACTIVATE_VERIFY_FW_VER,
+  ACTIVATE_NUM_STATES
+};
+
+static void
+activate_run_state (FpiSsm *ssm, FpDevice *dev)
+{
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+
+  switch (fpi_ssm_get_cur_state (ssm))
+    {
+      // NOP seems to do nothing, but the Windows driver does it in places too
+      case ACTIVATE_NOP1:
+      case ACTIVATE_NOP2:
+        goodix_run_cmd(ssm, dev, &nop, GOODIX_CMD_TIMEOUT);
+        break;
+
+      case ACTIVATE_ENABLE_CHIP:
+        goodix_run_cmd(ssm, dev, &enable_chip, GOODIX_CMD_TIMEOUT);
+        break;
+
+      case ACTIVATE_GET_FW_VER:
+        goodix_run_cmd(ssm, dev, &read_fw, GOODIX_CMD_TIMEOUT);
+        break;
+
+      case ACTIVATE_VERIFY_FW_VER:
+        if(strcmp(self->fw_ver, GOODIX_FIRMWARE_VERSION_SUPPORTED) == 0)
+        {
+          // The firmware version supports the 0xF2 command to directly read from the MCU SRAM
+          fpi_ssm_mark_completed (ssm);
+        }
+        else
+        {
+          // The firmware version is unsupported
+          fpi_ssm_mark_failed (ssm, fpi_device_error_new_msg (FP_DEVICE_ERROR_GENERAL, "Unsupported firmware!"));
+        }
+    }
+}
+
+static void
+activate_complete (FpiSsm *ssm, FpDevice *dev, GError *error)
+{
+  FpImageDevice *idev = FP_IMAGE_DEVICE (dev);
+
+  G_DEBUG_HERE ();
+
+  fpi_image_device_activate_complete (idev, error);
+
+}
+
+static void
+goodix_activate (FpImageDevice *dev)
+{
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+  goodix_dev_reset_state (self);
+
+  FpiSsm *ssm =
+    fpi_ssm_new (FP_DEVICE (dev), activate_run_state,
+                 ACTIVATE_NUM_STATES);
+
+  fpi_ssm_start (ssm, activate_complete);
+}
+
+/* ---- ACTIVE SECTION END ---- */
+
+/* ------------------------------------------------------------------------------- */
+
+/* ---- DEV SECTION START ---- */
+
+static void
+dev_init (FpImageDevice *dev)
+{
+  GError *error = NULL;
+  // FpiDeviceGoodix *self;
+
+  G_DEBUG_HERE ();
+
+  if (!g_usb_device_claim_interface (fpi_device_get_usb_device (FP_DEVICE (dev)), 0, 0, &error))
+    {
+      fpi_image_device_open_complete (dev, error);
+      return;
+    }
+
+  // self = FPI_DEVICE_GOODIX (dev);
+
+  fpi_image_device_open_complete (dev, NULL);
+}
+
+static void
+goodix_dev_reset_state (FpiDeviceGoodix *goodixdev)
+{
+  G_DEBUG_HERE ();
+
+  goodixdev->cmd = NULL;
+  goodixdev->cmd_timeout = GOODIX_CMD_TIMEOUT;
+
+  g_free (goodixdev->last_read);
+  goodixdev->last_read = NULL;
+}
+
+static void
+dev_deinit (FpImageDevice *dev)
+{
+  GError *error = NULL;
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+
+  goodix_dev_reset_state (self);
+  g_free (self->background);
+  g_usb_device_release_interface (fpi_device_get_usb_device (FP_DEVICE (dev)),
+                                  0, 0, &error);
+  fpi_image_device_close_complete (dev, error);
+}
+
+static void
+dev_activate (FpImageDevice *dev)
+{
+  G_DEBUG_HERE ();
+  goodix_activate (dev);
+}
+
+static void
+dev_change_state (FpImageDevice *dev, FpiImageDeviceState state)
+{
+  //FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+}
+
+static void
+dev_deactivate (FpImageDevice *dev)
+{
+  FpiDeviceGoodix *self = FPI_DEVICE_GOODIX (dev);
+
+  G_DEBUG_HERE ();
+
+   if (!self->active)
+    /* The device is inactive already, complete the operation immediately. */
+     fpi_image_device_deactivate_complete (dev, NULL);
+   else
+    /* The device is not yet inactive, flag that we are deactivating (and
+     * need to signal back deactivation).
+     * Note that any running capture will be cancelled already if needed. */
+     self->deactivating = TRUE;
+}
+
+/* ---- DEV SECTION END ---- */
+
+/* ------------------------------------------------------------------------------- */
+
+/* ---- FPI SECTION START ---- */
+
+static void
+fpi_device_goodix_init (FpiDeviceGoodix *self)
+{
+    // nothing to be done here, move along
+}
+
+static void
+fpi_device_goodix_class_init (FpiDeviceGoodixClass *class)
+{
+  FpDeviceClass *dev_class = FP_DEVICE_CLASS (class);
+  FpImageDeviceClass *img_class = FP_IMAGE_DEVICE_CLASS (class);
+
+  dev_class->id = "goodix";
+  dev_class->full_name = "Goodix 5110 Fingerprint Sensor";
+  dev_class->type = FP_DEVICE_TYPE_USB;
+  dev_class->id_table = goodix_id_table;
+  dev_class->scan_type = FP_SCAN_TYPE_SWIPE;
+
+  img_class->img_open = dev_init;
+  img_class->img_close = dev_deinit;
+  img_class->activate = dev_activate;
+  img_class->deactivate = dev_deactivate;
+  img_class->change_state = dev_change_state;
+
+  // ToDo
+  img_class->bz3_threshold = 24;
+}
+
+/* ---- FPI SECTION END ---- */