fwupd/plugins/unifying/fu-plugin-unifying.c
Richard Hughes c1c2fec6f5 Add optional icons to each device
This allows us to show the devices in a GUI with a nice icon. Some of the icon
mappings are not perfect and I'll be asking the GNOME designers for some
additions to the icon specification.

Custom vendor icons can also be specified, and /usr/share/fwupd/icons would be
a good place to put them. If vendor icons are used they should show a physical
device with the branding, rather than just the vendor logo.
2017-09-11 17:27:35 +01:00

331 lines
9.2 KiB
C

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2016 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU General Public License Version 2
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "config.h"
#include <appstream-glib.h>
#include <fwupd.h>
#include <gusb.h>
#include "fu-plugin.h"
#include "fu-plugin-vfuncs.h"
#include "lu-context.h"
#include "lu-device.h"
#include "lu-device-peripheral.h"
struct FuPluginData {
LuContext *ctx;
gboolean ignore_replug;
};
static gboolean
fu_plugin_unifying_device_added (FuPlugin *plugin,
LuDevice *device,
GError **error)
{
GPtrArray *guids;
GUsbDevice *usb_device;
g_autoptr(AsProfile) profile = as_profile_new ();
g_autoptr(AsProfileTask) ptask = NULL;
g_autoptr(FuDevice) dev = NULL;
/* profile */
ptask = as_profile_start (profile, "FuPluginLu:added{%s}",
lu_device_get_platform_id (device));
g_assert (ptask != NULL);
/* open the device */
if (!lu_device_open (device, error))
return FALSE;
/* create new FuDevice */
dev = fu_device_new ();
if (lu_device_has_flag (device, LU_DEVICE_FLAG_CAN_FLASH))
fu_device_add_flag (dev, FWUPD_DEVICE_FLAG_UPDATABLE);
fu_device_set_id (dev, lu_device_get_platform_id (device));
fu_device_set_name (dev, lu_device_get_product (device));
if (lu_device_get_kind (device) != LU_DEVICE_KIND_PERIPHERAL)
fu_device_set_summary (dev, "A miniaturised USB wireless receiver");
fu_device_set_vendor (dev, lu_device_get_vendor (device));
fu_device_set_vendor_id (dev, "USB:0x046D");
fu_device_set_version (dev, lu_device_get_version_fw (device));
fu_device_set_version_bootloader (dev, lu_device_get_version_bl (device));
guids = lu_device_get_guids (device);
for (guint i = 0; i < guids->len; i++) {
const gchar *guid = g_ptr_array_index (guids, i);
fu_device_add_guid (dev, guid);
}
/* add icon */
if (lu_device_get_kind (device) == LU_DEVICE_KIND_PERIPHERAL) {
const gchar *tmp = lu_device_peripheral_get_icon (LU_DEVICE_PERIPHERAL (device));
if (tmp != NULL)
fu_device_add_icon (dev, tmp);
} else {
/* FIXME: we need something better in the icon name spec for
* the USB Unifying receiver dongle */
fu_device_add_icon (dev, "preferences-desktop-keyboard");
}
/* don't allow the USB plugin to claim this */
usb_device = lu_device_get_usb_device (device);
if (usb_device != NULL) {
const gchar *platform_id = g_usb_device_get_platform_id (usb_device);
fu_device_set_equivalent_id (dev, platform_id);
}
/* insert to hash */
fu_plugin_device_add (plugin, dev);
fu_plugin_cache_add (plugin, fu_device_get_id (dev), dev);
return TRUE;
}
static void
lu_write_progress_cb (goffset current, goffset total, gpointer user_data)
{
FuPlugin *plugin = FU_PLUGIN (user_data);
gdouble percentage = -1.f;
if (total > 0)
percentage = (100.f * (gdouble) current) / (gdouble) total;
g_debug ("written %" G_GOFFSET_FORMAT "/%" G_GOFFSET_FORMAT " bytes [%.1f%%]",
current, total, percentage);
fu_plugin_set_percentage (plugin, (guint) percentage);
}
static LuDevice *
fu_plugin_unifying_get_device (FuPlugin *plugin,
FuDevice *dev,
GError **error)
{
FuPluginData *data = fu_plugin_get_data (plugin);
return lu_context_find_by_platform_id (data->ctx, fu_device_get_id (dev), error);
}
static gboolean
fu_plugin_unifying_detach_cb (gpointer user_data)
{
LuDevice *device = LU_DEVICE (user_data);
g_autoptr(GError) error = NULL;
/* ditch this device */
g_debug ("detaching");
if (!lu_device_detach (device, &error)) {
g_warning ("failed to detach: %s", error->message);
return FALSE;
}
return FALSE;
}
static gboolean
fu_plugin_unifying_attach_cb (gpointer user_data)
{
LuDevice *device = LU_DEVICE (user_data);
g_autoptr(GError) error = NULL;
/* ditch this device */
g_debug ("attaching");
if (!lu_device_attach (device, &error)) {
g_warning ("failed to detach: %s", error->message);
return FALSE;
}
return FALSE;
}
gboolean
fu_plugin_update (FuPlugin *plugin,
FuDevice *dev,
GBytes *blob_fw,
FwupdInstallFlags flags,
GError **error)
{
FuPluginData *data = fu_plugin_get_data (plugin);
g_autoptr(LuDevice) device = NULL;
/* get version */
device = fu_plugin_unifying_get_device (plugin, dev, error);
if (device == NULL)
return FALSE;
if (!lu_device_open (device, error))
return FALSE;
/* switch to bootloader */
data->ignore_replug = TRUE;
if (lu_device_has_flag (device, LU_DEVICE_FLAG_REQUIRES_DETACH)) {
/* wait for device to come back */
if (lu_device_has_flag (device, LU_DEVICE_FLAG_DETACH_WILL_REPLUG)) {
g_debug ("doing detach in idle");
g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
fu_plugin_unifying_detach_cb,
g_object_ref (device),
(GDestroyNotify) g_object_unref);
if (!lu_context_wait_for_replug (data->ctx,
device,
FU_DEVICE_TIMEOUT_REPLUG,
error))
return FALSE;
g_object_unref (device);
device = fu_plugin_unifying_get_device (plugin, dev, error);
if (device == NULL)
return FALSE;
if (!lu_device_open (device, error))
return FALSE;
} else {
g_debug ("doing detach in main thread");
if (!lu_device_detach (device, error))
return FALSE;
}
}
/* write the firmware */
fu_plugin_set_status (plugin, FWUPD_STATUS_DEVICE_WRITE);
if (!lu_device_write_firmware (device, blob_fw,
lu_write_progress_cb, plugin,
error))
return FALSE;
fu_plugin_set_status (plugin, FWUPD_STATUS_DEVICE_RESTART);
/* wait for it to appear back in runtime mode */
if (lu_device_has_flag (device, LU_DEVICE_FLAG_REQUIRES_ATTACH)) {
if (lu_device_has_flag (device, LU_DEVICE_FLAG_ATTACH_WILL_REPLUG)) {
g_debug ("doing attach in idle");
g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
fu_plugin_unifying_attach_cb,
g_object_ref (device),
(GDestroyNotify) g_object_unref);
if (!lu_context_wait_for_replug (data->ctx,
device,
FU_DEVICE_TIMEOUT_REPLUG,
error))
return FALSE;
g_object_unref (device);
device = fu_plugin_unifying_get_device (plugin, dev, error);
if (device == NULL)
return FALSE;
if (!lu_device_open (device, error))
return FALSE;
} else {
g_debug ("doing attach in main thread");
if (!lu_device_attach (device, error))
return FALSE;
}
}
/* set new version */
fu_device_set_version (dev, lu_device_get_version_fw (device));
/* success */
data->ignore_replug = FALSE;
return TRUE;
}
static void
fu_plugin_unifying_device_added_cb (LuContext *ctx,
LuDevice *device,
FuPlugin *plugin)
{
FuPluginData *data = fu_plugin_get_data (plugin);
g_autoptr(GError) error = NULL;
/* in process of flashing */
if (data->ignore_replug)
return;
/* add */
if (!fu_plugin_unifying_device_added (plugin, device, &error)) {
if (g_error_matches (error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_SUPPORTED)) {
g_debug ("Failed to add Logitech device: %s",
error->message);
} else {
g_warning ("Failed to add Logitech device: %s",
error->message);
}
}
}
static void
fu_plugin_unifying_device_removed_cb (LuContext *ctx,
LuDevice *device,
FuPlugin *plugin)
{
FuPluginData *data = fu_plugin_get_data (plugin);
FuDevice *dev;
const gchar *platform_id = NULL;
/* in process of flashing */
if (data->ignore_replug)
return;
/* already in database */
platform_id = lu_device_get_platform_id (device);
dev = fu_plugin_cache_lookup (plugin, platform_id);
if (dev == NULL)
return;
fu_plugin_device_remove (plugin, dev);
fu_plugin_cache_remove (plugin, platform_id);
}
gboolean
fu_plugin_startup (FuPlugin *plugin, GError **error)
{
FuPluginData *data = fu_plugin_get_data (plugin);
/* check the kernel has CONFIG_HIDRAW */
if (!g_file_test ("/sys/class/hidraw", G_FILE_TEST_IS_DIR)) {
g_set_error_literal (error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_SUPPORTED,
"no kernel support for CONFIG_HIDRAW");
return FALSE;
}
/* coldplug */
g_signal_connect (data->ctx, "added",
G_CALLBACK (fu_plugin_unifying_device_added_cb),
plugin);
g_signal_connect (data->ctx, "removed",
G_CALLBACK (fu_plugin_unifying_device_removed_cb),
plugin);
lu_context_coldplug (data->ctx);
lu_context_set_poll_interval (data->ctx, 5000);
return TRUE;
}
void
fu_plugin_init (FuPlugin *plugin)
{
FuPluginData *data = fu_plugin_alloc_data (plugin, sizeof (FuPluginData));
GUsbContext *usb_ctx = fu_plugin_get_usb_context (plugin);
data->ctx = lu_context_new_full (usb_ctx);
}
void
fu_plugin_destroy (FuPlugin *plugin)
{
FuPluginData *data = fu_plugin_get_data (plugin);
g_object_unref (data->ctx);
}