fwupd/plugins/dell/fu-dell-smi.c

/*
 * Copyright (C) 2017 Mario Limonciello <mario.limonciello@dell.com>
 *
 * SPDX-License-Identifier: LGPL-2.1+
 */

#include "config.h"

#include "fu-dell-smi.h"

/* These are for dock query capabilities */
struct dock_count_in {
	guint32 argument;
	guint32 reserved1;
	guint32 reserved2;
	guint32 reserved3;
};

struct dock_count_out {
	guint32 ret;
	guint32 count;
	guint32 location;
	guint32 reserved;
};

static void
_dell_smi_obj_free(FuDellSmiObj *obj)
{
	dell_smi_obj_free(obj->smi);
	g_free(obj);
}

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-function"
G_DEFINE_AUTOPTR_CLEANUP_FUNC(FuDellSmiObj, _dell_smi_obj_free);
#pragma clang diagnostic pop

/* don't actually clear if we're testing */
gboolean
fu_dell_clear_smi(FuDellSmiObj *obj)
{
	if (obj->fake_smbios)
		return TRUE;

	for (gint i = 0; i < 4; i++) {
		obj->input[i] = 0;
		obj->output[i] = 0;
	}
	return TRUE;
}

gboolean
fu_dell_execute_smi(FuDellSmiObj *obj)
{
	gint ret;

	if (obj->fake_smbios)
		return TRUE;

	ret = dell_smi_obj_execute(obj->smi);
	if (ret != 0) {
		g_debug("SMI execution failed: %i", ret);
		return FALSE;
	}
	return TRUE;
}

guint32
fu_dell_get_res(FuDellSmiObj *smi_obj, guint8 arg)
{
	if (smi_obj->fake_smbios)
		return smi_obj->output[arg];

	return dell_smi_obj_get_res(smi_obj->smi, arg);
}

gboolean
fu_dell_execute_simple_smi(FuDellSmiObj *obj, guint16 class, guint16 select)
{
	/* test suite will mean don't actually call */
	if (obj->fake_smbios)
		return TRUE;

	if (dell_simple_ci_smi(class, select, obj->input, obj->output)) {
		g_debug("failed to run query %u/%u", class, select);
		return FALSE;
	}
	return TRUE;
}

gboolean
fu_dell_detect_dock(FuDellSmiObj *smi_obj, guint32 *location)
{
	struct dock_count_in *count_args;
	struct dock_count_out *count_out;

	/* look up dock count */
	count_args = (struct dock_count_in *)smi_obj->input;
	count_out = (struct dock_count_out *)smi_obj->output;
	if (!fu_dell_clear_smi(smi_obj)) {
		g_debug("failed to clear SMI buffers");
		return FALSE;
	}
	count_args->argument = DACI_DOCK_ARG_COUNT;

	if (!fu_dell_execute_simple_smi(smi_obj, DACI_DOCK_CLASS, DACI_DOCK_SELECT))
		return FALSE;
	if (count_out->ret != 0) {
		g_debug("Failed to query system for dock count: "
			"(%" G_GUINT32_FORMAT ")",
			count_out->ret);
		return FALSE;
	}
	if (count_out->count < 1) {
		g_debug("no dock plugged in");
		return FALSE;
	}
	if (location != NULL)
		*location = count_out->location;
	return TRUE;
}

gboolean
fu_dell_query_dock(FuDellSmiObj *smi_obj, DOCK_UNION *buf)
{
	gint result;
	guint32 location;
	guint buf_size;

	if (!fu_dell_detect_dock(smi_obj, &location))
		return FALSE;

	fu_dell_clear_smi(smi_obj);

	/* look up more information on dock */
	if (smi_obj->fake_smbios)
		buf->buf = smi_obj->fake_buffer;
	else {
		dell_smi_obj_set_class(smi_obj->smi, DACI_DOCK_CLASS);
		dell_smi_obj_set_select(smi_obj->smi, DACI_DOCK_SELECT);
		dell_smi_obj_set_arg(smi_obj->smi, cbARG1, DACI_DOCK_ARG_INFO);
		dell_smi_obj_set_arg(smi_obj->smi, cbARG2, location);
		buf_size = sizeof(DOCK_INFO_RECORD);
		buf->buf = dell_smi_obj_make_buffer_frombios_auto(smi_obj->smi, cbARG3, buf_size);
		if (!buf->buf) {
			g_debug("Failed to initialize buffer");
			return FALSE;
		}
	}
	if (!fu_dell_execute_smi(smi_obj))
		return FALSE;
	result = fu_dell_get_res(smi_obj, cbARG1);
	if (result != SMI_SUCCESS) {
		if (result == SMI_INVALID_BUFFER) {
			g_debug("Invalid buffer size, needed %" G_GUINT32_FORMAT,
				fu_dell_get_res(smi_obj, cbARG2));
		} else {
			g_debug("SMI execution returned error: %d", result);
		}
		return FALSE;
	}
	return TRUE;
}

const gchar *
fu_dell_get_dock_type(guint8 type)
{
	g_autoptr(FuDellSmiObj) smi_obj = NULL;
	DOCK_UNION buf;

	/* not yet initialized, look it up */
	if (type == DOCK_TYPE_NONE) {
		smi_obj = g_malloc0(sizeof(FuDellSmiObj));
		smi_obj->smi = dell_smi_factory(DELL_SMI_DEFAULTS);
		if (!fu_dell_query_dock(smi_obj, &buf))
			return NULL;
		type = buf.record->dock_info_header.dock_type;
	}

	switch (type) {
	case DOCK_TYPE_TB16:
		return "TB16";
	case DOCK_TYPE_WD15:
		return "WD15";
	default:
		g_debug("Dock type %d unknown", type);
	}

	return NULL;
}

gboolean
fu_dell_toggle_dock_mode(FuDellSmiObj *smi_obj,
			 guint32 new_mode,
			 guint32 dock_location,
			 GError **error)
{
	/* Put into mode to accept AR/MST */
	fu_dell_clear_smi(smi_obj);
	smi_obj->input[0] = DACI_DOCK_ARG_MODE;
	smi_obj->input[1] = dock_location;
	smi_obj->input[2] = new_mode;

	if (!fu_dell_execute_simple_smi(smi_obj, DACI_DOCK_CLASS, DACI_DOCK_SELECT))
		return FALSE;
	if (smi_obj->output[1] != 0) {
		g_set_error(error,
			    G_IO_ERROR,
			    G_IO_ERROR_INVALID_DATA,
			    "Failed to set dock flash mode: %u",
			    smi_obj->output[1]);
		return FALSE;
	}
	return TRUE;
}