proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-08-12 20:25:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

thunderbolt: Use replugging from the daemon (Closes: #730)

Browse Source
This commit is contained in:
Mario Limonciello 2018-09-25 13:08:50 -05:00 committed by Mario Limonciello
parent ccd5fd0088
commit 845896c954
3 changed files with 84 additions and 301 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

282
plugins/thunderbolt/fu-plugin-thunderbolt.c
View File

@ -14,7 +14,6 @@
#include <unistd.h> #include <unistd.h>
#include <errno.h> #include <errno.h>
#include "fu-plugin-thunderbolt.h"
#include "fu-plugin-vfuncs.h" #include "fu-plugin-vfuncs.h"
#include "fu-device-metadata.h" #include "fu-device-metadata.h"
#include "fu-thunderbolt-image.h" #include "fu-thunderbolt-image.h"
@ -26,7 +25,8 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUdevDevice, g_object_unref)
#pragma clang diagnostic pop #pragma clang diagnostic pop
#endif #endif
#define TBT_NVM_RETRY_TIMEOUT 200 /* ms */ #define TBT_NVM_RETRY_TIMEOUT 200 /* ms */
#define FU_PLUGIN_THUNDERBOLT_UPDATE_TIMEOUT 60000 /* ms */
typedef void (*UEventNotify) (FuPlugin *plugin, typedef void (*UEventNotify) (FuPlugin *plugin,
GUdevDevice *udevice, GUdevDevice *udevice,
@ -35,16 +35,6 @@ typedef void (*UEventNotify) (FuPlugin *plugin,
struct FuPluginData { struct FuPluginData {
GUdevClient *udev; GUdevClient *udev;
/* in the case we are updating */
UEventNotify update_notify;
gpointer update_data;
/* the timeout we wait for the device
* to be updated to re-appear, in ms.
* defaults to:
* FU_PLUGIN_THUNDERBOLT_UPDATE_TIMEOUT_MS */
guint timeout;
}; };
static gchar * static gchar *
@ -64,13 +54,13 @@ fu_plugin_thunderbolt_gen_id (GUdevDevice *device)
return fu_plugin_thunderbolt_gen_id_from_syspath (syspath); return fu_plugin_thunderbolt_gen_id_from_syspath (syspath);
} }
static guint64 static gboolean
udev_device_get_sysattr_guint64 (GUdevDevice *device, udev_device_get_sysattr_guint64 (GUdevDevice *device,
const gchar *name, const gchar *name,
guint64 *val_out,
GError **error) GError **error)
{ {
const gchar *sysfs; const gchar *sysfs;
guint64 val;
sysfs = g_udev_device_get_sysfs_attr (device, name); sysfs = g_udev_device_get_sysfs_attr (device, name);
if (sysfs == NULL) { if (sysfs == NULL) {
@ -78,19 +68,19 @@ udev_device_get_sysattr_guint64 (GUdevDevice *device,
FWUPD_ERROR, FWUPD_ERROR,
FWUPD_ERROR_INTERNAL, FWUPD_ERROR_INTERNAL,
"failed get id %s for %s", name, sysfs); "failed get id %s for %s", name, sysfs);
return 0x0; return FALSE;
} }
val = g_ascii_strtoull (sysfs, NULL, 16); *val_out = g_ascii_strtoull (sysfs, NULL, 16);
if (val == 0x0) { if (*val_out == 0x0) {
g_set_error (error, g_set_error (error,
FWUPD_ERROR, FWUPD_ERROR,
FWUPD_ERROR_INTERNAL, FWUPD_ERROR_INTERNAL,
"failed to parse %s", sysfs); "failed to parse %s", sysfs);
return 0x0; return FALSE;
} }
return val; return TRUE;
} }
static guint16 static guint16
@ -99,11 +89,10 @@ fu_plugin_thunderbolt_udev_get_id (GUdevDevice *device,
GError **error) GError **error)
{ {
guint64 id; guint64 id = 0;
id = udev_device_get_sysattr_guint64 (device, name, error); if (!udev_device_get_sysattr_guint64 (device, name, &id, error))
if (id == 0x0) return 0x0;
return id;
if (id > G_MAXUINT16) { if (id > G_MAXUINT16) {
g_set_error (error, g_set_error (error,
@ -376,6 +365,7 @@ fu_plugin_thunderbolt_remove (FuPlugin *plugin, GUdevDevice *device)
* power on supported devices even when in low power mode -- * power on supported devices even when in low power mode --
* this will happen in coldplug_prepare and prepare_for_update */ * this will happen in coldplug_prepare and prepare_for_update */
if (fu_plugin_thunderbolt_is_host (device) && if (fu_plugin_thunderbolt_is_host (device) &&
!fu_device_has_flag (dev, FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG) &&
fu_device_get_metadata_boolean (dev, FU_DEVICE_METADATA_TBT_CAN_FORCE_POWER)) { fu_device_get_metadata_boolean (dev, FU_DEVICE_METADATA_TBT_CAN_FORCE_POWER)) {
g_debug ("ignoring remove event as force powered"); g_debug ("ignoring remove event as force powered");
return; return;
@ -411,20 +401,12 @@ udev_uevent_cb (GUdevClient *udev,
gpointer user_data) gpointer user_data)
{ {
FuPlugin *plugin = (FuPlugin *) user_data; FuPlugin *plugin = (FuPlugin *) user_data;
FuPluginData *data = fu_plugin_get_data (plugin);
if (action == NULL) if (action == NULL)
return TRUE; return TRUE;
g_debug ("uevent for %s: %s", g_udev_device_get_sysfs_path (device), action); g_debug ("uevent for %s: %s", g_udev_device_get_sysfs_path (device), action);
if (data->update_notify != NULL) {
g_debug ("using update notify handler for uevent");
data->update_notify (plugin, device, action, data->update_data);
return TRUE;
}
if (g_str_equal (action, "add")) { if (g_str_equal (action, "add")) {
fu_plugin_thunderbolt_add (plugin, device); fu_plugin_thunderbolt_add (plugin, device);
} else if (g_str_equal (action, "remove")) { } else if (g_str_equal (action, "remove")) {
@ -565,192 +547,6 @@ fu_plugin_thunderbolt_write_firmware (FuDevice *device,
return g_output_stream_close (os, NULL, error); return g_output_stream_close (os, NULL, error);
} }
typedef struct UpdateData {
gboolean have_device;
GMainLoop *mainloop;
const gchar *target_uuid;
guint timeout_id;
GHashTable *changes;
} UpdateData;
static gboolean
on_wait_for_device_timeout (gpointer user_data)
{
UpdateData *data = (UpdateData *) user_data;
g_main_loop_quit (data->mainloop);
data->timeout_id = 0;
return FALSE;
}
static void
on_wait_for_device_added (FuPlugin *plugin,
GUdevDevice *device,
UpdateData *up_data)
{
FuDevice *dev;
const gchar *uuid;
const gchar *path;
g_autofree gchar *version = NULL;
g_autofree gchar *id = NULL;
uuid = g_udev_device_get_sysfs_attr (device, "unique_id");
if (uuid == NULL)
return;
dev = g_hash_table_lookup (up_data->changes, uuid);
if (dev == NULL) {
/* a previously unknown device, add it via
* the normal way */
fu_plugin_thunderbolt_add (plugin, device);
return;
}
/* ensure the device path is correct */
path = g_udev_device_get_sysfs_path (device);
fu_device_set_metadata (dev, "sysfs-path", path);
/* make sure the version is correct, might have changed
* after update. */
version = fu_plugin_thunderbolt_udev_get_version (device);
fu_device_set_version (dev, version);
id = fu_plugin_thunderbolt_gen_id (device);
fu_plugin_cache_add (plugin, id, dev);
g_hash_table_remove (up_data->changes, uuid);
/* check if this device is the target*/
if (g_str_equal (uuid, up_data->target_uuid)) {
up_data->have_device = TRUE;
g_debug ("target (%s) re-appeared", uuid);
g_main_loop_quit (up_data->mainloop);
}
}
static void
on_wait_for_device_removed (FuPlugin *plugin,
GUdevDevice *device,
UpdateData *up_data)
{
g_autofree gchar *id = NULL;
FuDevice *dev;
const gchar *uuid;
id = fu_plugin_thunderbolt_gen_id (device);
dev = fu_plugin_cache_lookup (plugin, id);
if (dev == NULL)
return;
fu_plugin_cache_remove (plugin, id);
uuid = fu_device_get_physical_id (dev);
g_hash_table_insert (up_data->changes,
(gpointer) uuid,
g_object_ref (dev));
/* check if this device is the target */
if (g_str_equal (uuid, up_data->target_uuid)) {
up_data->have_device = FALSE;
g_debug ("target (%s) disappeared", uuid);
}
}
static void
on_wait_for_device_notify (FuPlugin *plugin,
GUdevDevice *device,
const char *action,
gpointer user_data)
{
UpdateData *up_data = (UpdateData *) user_data;
/* nb: action cannot be NULL since we are only called from
* udev_event_cb, which ensures that */
if (g_str_equal (action, "add")) {
on_wait_for_device_added (plugin, device, up_data);
} else if (g_str_equal (action, "remove")) {
on_wait_for_device_removed (plugin, device, up_data);
} else if (g_str_equal (action, "change")) {
fu_plugin_thunderbolt_change (plugin, device);
}
}
static void
remove_leftover_devices (gpointer key,
gpointer value,
gpointer user_data)
{
FuPlugin *plugin = FU_PLUGIN (user_data);
FuDevice *dev = FU_DEVICE (value);
const gchar *syspath = fu_device_get_metadata (dev, "sysfs-path");
g_autofree gchar *id = NULL;
id = fu_plugin_thunderbolt_gen_id_from_syspath (syspath);
fu_plugin_cache_remove (plugin, id);
fu_plugin_device_remove (plugin, dev);
}
static gboolean
fu_plugin_thunderbolt_wait_for_device (FuPlugin *plugin,
FuDevice *dev,
GError **error)
{
FuPluginData *data = fu_plugin_get_data (plugin);
UpdateData up_data = { TRUE, };
g_autoptr(GMainLoop) mainloop = NULL;
g_autoptr(GHashTable) changes = NULL;
up_data.mainloop = mainloop = g_main_loop_new (NULL, FALSE);
up_data.target_uuid = fu_device_get_physical_id (dev);
/* this will limit the maximum amount of time we wait for
* the device (i.e. 'dev') to re-appear. */
up_data.timeout_id = g_timeout_add (data->timeout,
on_wait_for_device_timeout,
&up_data);
/* this will capture the device added, removed, changed
* signals while we are updating. */
data->update_data = &up_data;
data->update_notify = on_wait_for_device_notify;
changes = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, g_object_unref);
up_data.changes = changes;
/* now we wait ... */
g_main_loop_run (mainloop);
/* restore original udev change handler */
data->update_data = NULL;
data->update_notify = NULL;
if (up_data.timeout_id > 0)
g_source_remove (up_data.timeout_id);
if (!up_data.have_device) {
g_set_error_literal (error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_FOUND,
"timed out while waiting for device");
return FALSE;
}
g_hash_table_foreach (changes, remove_leftover_devices, plugin);
return TRUE;
}
/* internal interface */
void
fu_plugin_thunderbolt_set_timeout (FuPlugin *plugin, guint timeout_ms)
{
FuPluginData *data = fu_plugin_get_data (plugin);
data->timeout = timeout_ms;
}
/* virtual functions */ /* virtual functions */
void void
@ -762,8 +558,6 @@ fu_plugin_init (FuPlugin *plugin)
data->udev = g_udev_client_new (subsystems); data->udev = g_udev_client_new (subsystems);
g_signal_connect (data->udev, "uevent", g_signal_connect (data->udev, "uevent",
G_CALLBACK (udev_uevent_cb), plugin); G_CALLBACK (udev_uevent_cb), plugin);
data->timeout = FU_PLUGIN_THUNDERBOLT_UPDATE_TIMEOUT_MS;
} }
void void
@ -812,7 +606,6 @@ fu_plugin_update (FuPlugin *plugin,
{ {
FuPluginData *data = fu_plugin_get_data (plugin); FuPluginData *data = fu_plugin_get_data (plugin);
const gchar *devpath; const gchar *devpath;
guint64 status;
g_autoptr(GUdevDevice) udevice = NULL; g_autoptr(GUdevDevice) udevice = NULL;
g_autoptr(GError) error_local = NULL; g_autoptr(GError) error_local = NULL;
gboolean install_force = (flags & FWUPD_INSTALL_FLAG_FORCE) != 0; gboolean install_force = (flags & FWUPD_INSTALL_FLAG_FORCE) != 0;
@ -874,18 +667,53 @@ fu_plugin_update (FuPlugin *plugin,
} }
fu_device_set_status (dev, FWUPD_STATUS_DEVICE_RESTART); fu_device_set_status (dev, FWUPD_STATUS_DEVICE_RESTART);
fu_device_set_remove_delay (dev, FU_PLUGIN_THUNDERBOLT_UPDATE_TIMEOUT);
fu_device_add_flag (dev, FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG);
/* the device will disappear and we need to wait until it reappears, return TRUE;
* and then check if we find an error */ }
if (!fu_plugin_thunderbolt_wait_for_device (plugin, dev, error)) {
g_prefix_error (error, "could not detect device after update: "); gboolean
fu_plugin_update_attach (FuPlugin *plugin,
FuDevice *dev,
GError **error)
{
FuPluginData *data = fu_plugin_get_data (plugin);
const gchar *devpath;
const gchar *attribute;
guint64 status;
g_autoptr(GUdevDevice) udevice = NULL;
devpath = fu_device_get_metadata (dev, "sysfs-path");
udevice = g_udev_client_query_by_sysfs_path (data->udev, devpath);
if (udevice == NULL) {
g_set_error (error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_FOUND,
"could not find thunderbolt device at %s",
devpath);
return FALSE; return FALSE;
} }
/* now check if the update actually worked */ /* now check if the update actually worked */
status = udev_device_get_sysattr_guint64 (udevice, attribute = g_udev_device_get_sysfs_attr (udevice, "nvm_authenticate");
"nvm_authenticate", if (attribute == NULL) {
error); g_set_error (error,
FWUPD_ERROR,
FWUPD_ERROR_INTERNAL,
"failed to find nvm_authenticate attribute for %s",
fu_device_get_name (dev));
return FALSE;
}
status = g_ascii_strtoull (attribute, NULL, 16);
if ((status == 0x00 && errno == EINVAL) ||
(status == G_MAXUINT64 && errno == ERANGE)) {
g_set_error (error, G_IO_ERROR,
g_io_error_from_errno (errno),
"failed to read 'nvm_authenticate: %s",
g_strerror (errno));
return FALSE;
}
/* anything else then 0x0 means we got an error */ /* anything else then 0x0 means we got an error */
if (status != 0x0) { if (status != 0x0) {

17
plugins/thunderbolt/fu-plugin-thunderbolt.h
View File

@ -1,17 +0,0 @@
/*
* Copyright (C) 2017 Christian J. Kellner <christian@kellner.me>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#ifndef __FU_PLUGIN_THUNDERBOLT_H__
#define __FU_PLUGIN_THUNDERBOLT_H__
#include "fu-plugin.h"
#define FU_PLUGIN_THUNDERBOLT_UPDATE_TIMEOUT_MS 60 * 1000
void fu_plugin_thunderbolt_set_timeout (FuPlugin *plugin,
guint timeout_ms);
#endif /* __FU_PLUGIN_THUNDERBOLT_H__ */

86
plugins/thunderbolt/fu-self-test.c
View File

@ -24,7 +24,6 @@
#include <locale.h> #include <locale.h>
#include "fu-plugin-private.h" #include "fu-plugin-private.h"
#include "fu-plugin-thunderbolt.h"
#include "fu-thunderbolt-image.h" #include "fu-thunderbolt-image.h"
#include "fu-test.h" #include "fu-test.h"
@ -1136,12 +1135,20 @@ test_update_working (ThunderboltTest *tt, gconstpointer user_data)
g_assert_no_error (error); g_assert_no_error (error);
g_assert_true (ret); g_assert_true (ret);
/* we wait until the plugin has picked up all the
* subtree changes */
ret = mock_tree_settle (tree, plugin);
g_assert_true (ret);
ret = fu_plugin_runner_update_attach (plugin, tree->fu_device, &error);
g_assert_no_error (error);
g_assert_true (ret);
version_after = fu_device_get_version (tree->fu_device); version_after = fu_device_get_version (tree->fu_device);
g_debug ("version after update: %s", version_after); g_debug ("version after update: %s", version_after);
g_assert_cmpstr (version_after, ==, "42.23"); g_assert_cmpstr (version_after, ==, "42.23");
/* we wait until the plugin has picked up all the /* make sure all pending events have happened */
* subtree changes */
ret = mock_tree_settle (tree, plugin); ret = mock_tree_settle (tree, plugin);
g_assert_true (ret); g_assert_true (ret);
@ -1174,13 +1181,8 @@ test_update_fail (ThunderboltTest *tt, gconstpointer user_data)
up_ctx->result = UPDATE_FAIL_DEVICE_INTERNAL; up_ctx->result = UPDATE_FAIL_DEVICE_INTERNAL;
ret = fu_plugin_runner_update (plugin, tree->fu_device, NULL, fw_data, 0, &error); ret = fu_plugin_runner_update (plugin, tree->fu_device, NULL, fw_data, 0, &error);
g_assert_error (error, FWUPD_ERROR, FWUPD_ERROR_INTERNAL); g_assert_no_error (error);
g_assert_false (ret); g_assert_true (ret);
/* version should *not* have changed (but we get parsed version) */
version_after = fu_device_get_version (tree->fu_device);
g_debug ("version after update: %s", version_after);
g_assert_cmpstr (version_after, ==, tree->device->nvm_parsed_version);
/* we wait until the plugin has picked up all the /* we wait until the plugin has picked up all the
* subtree changes, and make sure we still receive * subtree changes, and make sure we still receive
@ -1188,6 +1190,19 @@ test_update_fail (ThunderboltTest *tt, gconstpointer user_data)
ret = mock_tree_settle (tree, plugin); ret = mock_tree_settle (tree, plugin);
g_assert_true (ret); g_assert_true (ret);
ret = fu_plugin_runner_update_attach (plugin, tree->fu_device, &error);
g_assert_error (error, FWUPD_ERROR, FWUPD_ERROR_INTERNAL);
g_assert_false (ret);
/* make sure all pending events have happened */
ret = mock_tree_settle (tree, plugin);
g_assert_true (ret);
/* version should *not* have changed (but we get parsed version) */
version_after = fu_device_get_version (tree->fu_device);
g_debug ("version after update: %s", version_after);
g_assert_cmpstr (version_after, ==, tree->device->nvm_parsed_version);
ret = mock_tree_all (tree, mock_tree_node_have_fu_device, NULL); ret = mock_tree_all (tree, mock_tree_node_have_fu_device, NULL);
g_assert_true (ret); g_assert_true (ret);
} }
@ -1213,52 +1228,16 @@ test_update_fail_nowshow (ThunderboltTest *tt, gconstpointer user_data)
up_ctx = mock_tree_prepare_for_update (tree, plugin, "42.23", fw_data, 1000); up_ctx = mock_tree_prepare_for_update (tree, plugin, "42.23", fw_data, 1000);
up_ctx->result = UPDATE_FAIL_DEVICE_NOSHOW; up_ctx->result = UPDATE_FAIL_DEVICE_NOSHOW;
/* lets make the plugin only wait a second for the device */
fu_plugin_thunderbolt_set_timeout (plugin, 1000);
ret = fu_plugin_runner_update (plugin, tree->fu_device, NULL, fw_data, 0, &error); ret = fu_plugin_runner_update (plugin, tree->fu_device, NULL, fw_data, 0, &error);
g_assert_error (error, FWUPD_ERROR, FWUPD_ERROR_NOT_FOUND); g_assert_no_error (error);
g_assert_false (ret);
}
static void
test_update_fail_tooslow (ThunderboltTest *tt, gconstpointer user_data)
{
FuPlugin *plugin = tt->plugin;
MockTree *tree = tt->tree;
GBytes *fw_data = tt->fw_data;
gboolean ret;
g_autoptr(GError) error = NULL;
g_autoptr(UpdateContext) up_ctx = NULL;
/* test sanity check */
g_assert_nonnull (tree);
g_assert_nonnull (fw_data);
/* simulate an update, as in test_update_working, that is also working,
* but that takes longer then our timeout, i.e. set_timeout < last
* param in prepare_for_update. We will report an error, but we want
* to make sure that the device tree afterwards is still correct
*/
up_ctx = mock_tree_prepare_for_update (tree, plugin, "42.23", fw_data, 2000);
up_ctx->result = UPDATE_SUCCESS;
/* lets make the plugin only wait half a second (1/4 of update time) */
fu_plugin_thunderbolt_set_timeout (plugin, 500);
ret = fu_plugin_runner_update (plugin, tree->fu_device, NULL, fw_data, 0, &error);
g_assert_error (error, FWUPD_ERROR, FWUPD_ERROR_NOT_FOUND);
g_assert_false (ret);
/* we wait until we see all devices again */
ret = mock_tree_settle (tree, plugin);
g_assert_true (ret); g_assert_true (ret);
mock_tree_sync (tree, plugin, 500);
ret = mock_tree_all (tree, mock_tree_node_have_fu_device, NULL); ret = mock_tree_all (tree, mock_tree_node_have_fu_device, NULL);
g_assert_true (ret); g_assert_false (ret);
} }
int int
main (int argc, char **argv) main (int argc, char **argv)
{ {
@ -1309,12 +1288,5 @@ main (int argc, char **argv)
test_update_fail_nowshow, test_update_fail_nowshow,
test_tear_down); test_tear_down);
g_test_add ("/thunderbolt/update{failing-tooslow}",
ThunderboltTest,
TEST_INIT_FULL,
test_set_up,
test_update_fail_tooslow,
test_tear_down);
return g_test_run (); return g_test_run ();
} }