fwupd/libebitdo/ebitdo-device.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 Lesser General Public License Version 2.1
 *
 * 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
 */

#include "config.h"

#include <string.h>

#include "ebitdo-common.h"
#include "ebitdo-device.h"

typedef struct
{
	EbitdoDeviceKind	 kind;
	GUsbDevice		*usb_device;
	guint32			 serial[9];
	gchar			*version;
} EbitdoDevicePrivate;

G_DEFINE_TYPE_WITH_PRIVATE (EbitdoDevice, ebitdo_device, G_TYPE_OBJECT)

#define GET_PRIVATE(o) (ebitdo_device_get_instance_private (o))

/**
 * ebitdo_device_kind_from_string:
 * @kind: the string.
 *
 * Converts the text representation to an enumerated value.
 *
 * Returns: (transfer full): a #EbitdoDeviceKind, or %EBITDO_DEVICE_KIND_UNKNOWN for unknown.
 *
 * Since: 0.1.0
 **/
EbitdoDeviceKind
ebitdo_device_kind_from_string (const gchar *kind)
{
	if (g_strcmp0 (kind, "BOOTLOADER") == 0)
		return EBITDO_DEVICE_KIND_BOOTLOADER;
	if (g_strcmp0 (kind, "FC30") == 0)
		return EBITDO_DEVICE_KIND_FC30;
	if (g_strcmp0 (kind, "NES30") == 0)
		return EBITDO_DEVICE_KIND_NES30;
	if (g_strcmp0 (kind, "SFC30") == 0)
		return EBITDO_DEVICE_KIND_SFC30;
	if (g_strcmp0 (kind, "SNES30") == 0)
		return EBITDO_DEVICE_KIND_SNES30;
	if (g_strcmp0 (kind, "FC30PRO") == 0)
		return EBITDO_DEVICE_KIND_FC30PRO;
	if (g_strcmp0 (kind, "NES30PRO") == 0)
		return EBITDO_DEVICE_KIND_NES30PRO;
	if (g_strcmp0 (kind, "FC30_ARCADE") == 0)
		return EBITDO_DEVICE_KIND_FC30_ARCADE;
	return EBITDO_DEVICE_KIND_UNKNOWN;
}

/**
 * ebitdo_device_kind_to_string:
 * @kind: the #EbitdoDeviceKind.
 *
 * Converts the enumerated value to an text representation.
 *
 * Returns: string version of @kind
 *
 * Since: 0.1.0
 **/
const gchar *
ebitdo_device_kind_to_string (EbitdoDeviceKind kind)
{
	if (kind == EBITDO_DEVICE_KIND_BOOTLOADER)
		return "BOOTLOADER";
	if (kind == EBITDO_DEVICE_KIND_FC30)
		return "FC30";
	if (kind == EBITDO_DEVICE_KIND_NES30)
		return "NES30";
	if (kind == EBITDO_DEVICE_KIND_SFC30)
		return "SFC30";
	if (kind == EBITDO_DEVICE_KIND_SNES30)
		return "SNES30";
	if (kind == EBITDO_DEVICE_KIND_FC30PRO)
		return "FC30PRO";
	if (kind == EBITDO_DEVICE_KIND_NES30PRO)
		return "NES30PRO";
	if (kind == EBITDO_DEVICE_KIND_FC30_ARCADE)
		return "FC30_ARCADE";
	return NULL;
}

static void
ebitdo_device_finalize (GObject *object)
{
	EbitdoDevice *device = EBITDO_DEVICE (object);
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);

	g_free (priv->version);
	if (priv->usb_device != NULL)
		g_object_unref (priv->usb_device);

	G_OBJECT_CLASS (ebitdo_device_parent_class)->finalize (object);
}

static void
ebitdo_device_init (EbitdoDevice *device)
{
}

static void
ebitdo_device_class_init (EbitdoDeviceClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);
	object_class->finalize = ebitdo_device_finalize;
}

/**
 * ebitdo_device_get_kind:
 * @device: a #EbitdoDevice instance.
 *
 * Gets the device kind.
 *
 * Returns: the #EbitdoDeviceKind
 *
 * Since: 0.1.0
 **/
EbitdoDeviceKind
ebitdo_device_get_kind (EbitdoDevice *device)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	return priv->kind;
}

/**
 * ebitdo_device_get_usb_device:
 * @device: a #EbitdoDevice instance.
 *
 * Gets the device usb_device if set.
 *
 * Returns: (transfer none): the #GUsbDevice, or %NULL
 *
 * Since: 0.1.0
 **/
GUsbDevice *
ebitdo_device_get_usb_device (EbitdoDevice *device)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	return priv->usb_device;
}

static gboolean
ebitdo_device_send (EbitdoDevice *device,
		    EbitdoPktType type,
		    EbitdoPktSubtype subtype,
		    EbitdoPktCmd cmd,
		    const guint8 *in,
		    gsize in_len,
		    GError **error)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	guint8 packet[EBITDO_USB_EP_SIZE];
	gsize actual_length;
	guint8 ep_out = EBITDO_USB_RUNTIME_EP_OUT;
	g_autoptr(GError) error_local = NULL;
	EbitdoPkt *hdr = (EbitdoPkt *) packet;

	/* different */
	if (priv->kind == EBITDO_DEVICE_KIND_BOOTLOADER)
		ep_out = EBITDO_USB_BOOTLOADER_EP_OUT;

	/* check size */
	if (in_len > 64 - 8) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "input buffer too large");
		return FALSE;
	}

	/* packet[0] is the total length of the packet */
	memset (packet, 0x00, sizeof(packet));
	hdr->type = type;
	hdr->subtype = subtype;

	/* do we have a payload */
	if (in_len > 0) {
		hdr->cmd_len = GUINT16_TO_LE (in_len + 3);
		hdr->cmd = cmd;
		hdr->payload_len = GUINT16_TO_LE (in_len);
		memcpy (packet + 0x07, in, in_len);
		hdr->pkt_len = (guint8) (in_len + 7);
	} else {
		hdr->cmd_len = GUINT16_TO_LE (in_len + 1);
		hdr->cmd = cmd;
		hdr->pkt_len = 5;
	}
	ebitdo_dump_raw ("->DEVICE", packet, (gsize) hdr->pkt_len + 1);
	ebitdo_dump_pkt (hdr);

	/* get data from device */
	if (!g_usb_device_interrupt_transfer (priv->usb_device,
					      ep_out,
					      packet,
					      EBITDO_USB_EP_SIZE,
					      &actual_length,
					      EBITDO_USB_TIMEOUT,
					      NULL, /* cancellable */
					      &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to send to device on ep 0x%02x: %s",
			     (guint) EBITDO_USB_BOOTLOADER_EP_OUT,
			     error_local->message);
		return FALSE;
	}
	return TRUE;
}

static gboolean
ebitdo_device_receive (EbitdoDevice *device,
		       guint8 *out,
		       gsize out_len,
		       GError **error)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	guint8 packet[EBITDO_USB_EP_SIZE];
	gsize actual_length;
	guint8 ep_in = EBITDO_USB_RUNTIME_EP_IN;
	g_autoptr(GError) error_local = NULL;
	EbitdoPkt *hdr = (EbitdoPkt *) packet;

	/* different */
	if (priv->kind == EBITDO_DEVICE_KIND_BOOTLOADER)
		ep_in = EBITDO_USB_BOOTLOADER_EP_IN;

	/* get data from device */
	memset (packet, 0x0, sizeof(packet));
	if (!g_usb_device_interrupt_transfer (priv->usb_device,
					      ep_in,
					      packet,
					      EBITDO_USB_EP_SIZE,
					      &actual_length,
					      EBITDO_USB_TIMEOUT,
					      NULL, /* cancellable */
					      &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to retrieve from device on ep 0x%02x: %s",
			     (guint) EBITDO_USB_BOOTLOADER_EP_IN,
			     error_local->message);
		return FALSE;
	}

	ebitdo_dump_raw ("<-DEVICE", packet, (gsize) hdr->pkt_len - 1);
	ebitdo_dump_pkt (hdr);

	/* get-version (booloader) */
	if (hdr->type == EBITDO_PKT_TYPE_USER_CMD &&
	    hdr->subtype == EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA &&
	    hdr->cmd == EBITDO_PKT_CMD_FW_GET_VERSION) {
		if (out != NULL) {
			if (hdr->payload_len != out_len) {
				g_set_error (error,
					     G_IO_ERROR,
					     G_IO_ERROR_INVALID_DATA,
					     "outbuf size wrong, expected %" G_GSIZE_FORMAT " got %u",
					     out_len,
					     hdr->payload_len);
				return FALSE;
			}
			memcpy (out,
				packet + sizeof(EbitdoPkt),
				hdr->payload_len);
		}
		return TRUE;
	}

	/* get-version (firmware) -- not a packet, just raw data! */
	if (hdr->pkt_len == EBITDO_PKT_SUBTYPE_GET_VERSION_RESPONSE) {
		if (out != NULL) {
			if (out_len != 4) {
				g_set_error (error,
					     G_IO_ERROR,
					     G_IO_ERROR_INVALID_DATA,
					     "outbuf size wrong, expected 4 got %" G_GSIZE_FORMAT,
					     out_len);
				return FALSE;
			}
			memcpy (out, packet + 1, 4);
		}
		return TRUE;
	}

	/* verification-id response */
	if (hdr->type == EBITDO_PKT_TYPE_USER_CMD &&
	    hdr->subtype == EBITDO_PKT_SUBTYPE_VERIFICATION_ID) {
		if (out != NULL) {
			if (hdr->cmd_len != out_len) {
				g_set_error (error,
					     G_IO_ERROR,
					     G_IO_ERROR_INVALID_DATA,
					     "outbuf size wrong, expected %" G_GSIZE_FORMAT " got %i",
					     out_len,
					     hdr->cmd_len);
				return FALSE;
			}
			memcpy (out,
				packet + sizeof(EbitdoPkt) - 3,
				hdr->cmd_len);
		}
		return TRUE;
	}

	/* update-firmware-data */
	if (hdr->type == EBITDO_PKT_TYPE_USER_CMD &&
	    hdr->subtype == EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA &&
	    hdr->payload_len == 0x00) {
		if (hdr->cmd != EBITDO_PKT_SUBTYPE_ACK) {
			g_set_error_literal (error,
					     G_IO_ERROR,
					     G_IO_ERROR_INVALID_DATA,
					     "write failed");
			return FALSE;
		}
		return TRUE;
	}

	/* unhandled */
	g_set_error_literal (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "unexpected device response");
	return FALSE;
}

gboolean
ebitdo_device_open (EbitdoDevice *device, GError **error)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	gdouble tmp;
	guint32 version_tmp = 0;
	guint32 serial_tmp[9];
	guint i;

	if (!g_usb_device_open (priv->usb_device, error))
		return FALSE;
	if (!g_usb_device_claim_interface (priv->usb_device, 0, /* 0 = idx? */
					   G_USB_DEVICE_CLAIM_INTERFACE_BIND_KERNEL_DRIVER,
					   error)) {
		return FALSE;
	}

	/* in firmware mode */
	if (priv->kind != EBITDO_DEVICE_KIND_BOOTLOADER) {
		if (!ebitdo_device_send (device,
					 EBITDO_PKT_TYPE_USER_CMD,
					 EBITDO_PKT_SUBTYPE_GET_VERSION,
					 0,
					 NULL, 0, /* in */
					 error)) {
			return FALSE;
		}
		if (!ebitdo_device_receive (device,
					    (guint8 *) &version_tmp,
					    sizeof(version_tmp),
					    error)) {
			return FALSE;
		}
		tmp = (gdouble) GUINT32_FROM_LE (version_tmp);
		priv->version = g_strdup_printf ("%.2f", tmp / 100.f);
		return TRUE;
	}

	/* get version */
	if (!ebitdo_device_send (device,
				 EBITDO_PKT_TYPE_USER_CMD,
				 EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA,
				 EBITDO_PKT_CMD_FW_GET_VERSION,
				 NULL, 0, /* in */
				 error)) {
		return FALSE;
	}
	if (!ebitdo_device_receive (device,
				    (guint8 *) &version_tmp,
				    sizeof(version_tmp),
				    error)) {
		return FALSE;
	}
	tmp = (gdouble) GUINT32_FROM_LE (version_tmp);
	priv->version = g_strdup_printf ("%.2f", tmp / 100.f);

	/* get verification ID */
	if (!ebitdo_device_send (device,
				 EBITDO_PKT_TYPE_USER_CMD,
				 EBITDO_PKT_SUBTYPE_GET_VERIFICATION_ID,
				 0x00, /* cmd */
				 NULL, 0,
				 error)) {
		return FALSE;
	}
	memset (serial_tmp, 0x00, sizeof (serial_tmp));
	if (!ebitdo_device_receive (device,
				    (guint8 *) &serial_tmp, sizeof(serial_tmp),
				    error)) {
		return FALSE;
	}
	for (i = 0; i < 9; i++)
		priv->serial[i] = GUINT32_FROM_LE (serial_tmp[i]);

	return TRUE;
}

gboolean
ebitdo_device_close (EbitdoDevice *device, GError **error)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	if (!g_usb_device_close (priv->usb_device, error))
		return FALSE;
	return TRUE;
}

const gchar *
ebitdo_device_get_version (EbitdoDevice *device)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	return priv->version;
}

const guint32 *
ebitdo_device_get_serial (EbitdoDevice *device)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	return priv->serial;
}

gboolean
ebitdo_device_write_firmware (EbitdoDevice *device, GBytes *fw, GError **error)
{
	EbitdoDevicePrivate *priv = GET_PRIVATE (device);
	EbitdoFirmwareHeader *hdr;
	const guint8 *payload_data;
	const guint chunk_sz = 32;
	guint32 offset;
	guint32 payload_len;
	guint32 serial_new[3];
	guint i;
	g_autoptr(GError) error_local = NULL;
	const guint32 app_key_index[16] = {
		0x186976e5, 0xcac67acd, 0x38f27fee, 0x0a4948f1,
		0xb75b7753, 0x1f8ffa5c, 0xbff8cf43, 0xc4936167,
		0x92bd03f0, 0x5573c6ed, 0x57d8845b, 0x827197ac,
		0xb91901c9, 0x3917edfe, 0xbcd6344f, 0xcf9e23b5
	};

	/* corrupt */
	if (g_bytes_get_size (fw) < sizeof (EbitdoFirmwareHeader)) {
		g_set_error_literal (error,
				     G_IO_ERROR,
				     G_IO_ERROR_INVALID_DATA,
				     "firmware too small for header");
		return FALSE;
	}

	/* print details about the firmware */
	hdr = (EbitdoFirmwareHeader *) g_bytes_get_data (fw, NULL);
	ebitdo_dump_firmware_header (hdr);

	/* check the file size */
	payload_len = (guint32) (g_bytes_get_size (fw) - sizeof (EbitdoFirmwareHeader));
	if (payload_len != GUINT32_FROM_LE (hdr->destination_len)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "file size incorrect, expected 0x%04x got 0x%04x",
			     (guint) GUINT32_FROM_LE (hdr->destination_len),
			     (guint) payload_len);
		return FALSE;
	}

	/* check if this is firmware */
	for (i = 0; i < 4; i++) {
		if (hdr->reserved[i] != 0x0) {
			g_set_error (error,
				     G_IO_ERROR,
				     G_IO_ERROR_INVALID_DATA,
				     "data invalid, reserved[%u] = 0x%04x",
				     i, hdr->reserved[i]);
			return FALSE;
		}
	}

g_error ("ABORT, THERE BE DRAGONS");

	/* set up the firmware header */
	if (!ebitdo_device_send (device,
				 EBITDO_PKT_TYPE_USER_CMD,
				 EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA,
				 EBITDO_PKT_CMD_FW_UPDATE_HEADER,
				 (const guint8 *) hdr, sizeof(EbitdoFirmwareHeader),
				 &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to set up firmware header: %s",
			     error_local->message);
		return FALSE;
	}

	/* flash the firmware in 32 byte blocks */
	payload_data = g_bytes_get_data (fw, NULL);
	payload_data += sizeof(EbitdoFirmwareHeader);
	for (offset = 0; offset < payload_len + chunk_sz - 1; offset += chunk_sz) {
		if (!ebitdo_device_send (device,
					 EBITDO_PKT_TYPE_USER_CMD,
					 EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA,
					 EBITDO_PKT_CMD_FW_UPDATE_DATA,
					 payload_data + offset, chunk_sz,
					 &error_local)) {
			g_set_error (error,
				     G_IO_ERROR,
				     G_IO_ERROR_INVALID_DATA,
				     "Failed to write firmware @0x%04x: %s",
				     offset, error_local->message);
			return FALSE;
		}
		if (!ebitdo_device_receive (device, NULL, 0, &error_local)) {
			g_set_error (error,
				     G_IO_ERROR,
				     G_IO_ERROR_INVALID_DATA,
				     "Failed to get ACK for write firmware @0x%04x: %s",
				     offset, error_local->message);
			return FALSE;
		}
	}

	/* set the "encode id" which is likely a checksum, bluetooth pairing
	 * or maybe just security-through-obscurity */
	serial_new[0] = priv->serial[0] ^ app_key_index[priv->serial[0] & 0x0f];
	serial_new[1] = priv->serial[1] ^ app_key_index[priv->serial[1] & 0x0f];
	serial_new[2] = priv->serial[2] ^ app_key_index[priv->serial[2] & 0x0f];
	if (!ebitdo_device_send (device,
				 EBITDO_PKT_TYPE_USER_CMD,
				 EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA,
				 EBITDO_PKT_CMD_FW_SET_ENCODE_ID,
				 (guint8 *) serial_new,
				 sizeof(serial_new),
				 &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to set encoding ID: %s",
			     error_local->message);
		return FALSE;
	}

	/* mark flash as successful */
	if (!ebitdo_device_send (device,
				 EBITDO_PKT_TYPE_USER_CMD,
				 EBITDO_PKT_SUBTYPE_UPDATE_FIRMWARE_DATA,
				 EBITDO_PKT_CMD_FW_UPDATE_OK,
				 NULL, 0,
				 &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to mark firmware as successful: %s",
			     error_local->message);
		return FALSE;
	}
	if (!ebitdo_device_receive (device, NULL, 0, &error_local)) {
		g_set_error (error,
			     G_IO_ERROR,
			     G_IO_ERROR_INVALID_DATA,
			     "failed to get ACK for mark firmware as successful: %s",
			     error_local->message);
		return FALSE;
	}

	/* success! */
	return TRUE;
}

typedef struct {
	guint16			 vid;
	guint16			 pid;
	EbitdoDeviceKind	 kind;
} EbitdoVidPid;

/**
 * ebitdo_device_new:
 *
 * Creates a new #EbitdoDevice.
 *
 * Returns: (transfer full): a #EbitdoDevice
 *
 * Since: 0.1.0
 **/
EbitdoDevice *
ebitdo_device_new (GUsbDevice *usb_device)
{
	EbitdoDevice *device;
	EbitdoDevicePrivate *priv;
	guint j;
	const EbitdoVidPid vidpids[] = {
		{ 0x0483, 0x5750, EBITDO_DEVICE_KIND_BOOTLOADER },
		{ 0x1235, 0xab11, EBITDO_DEVICE_KIND_FC30 },
		{ 0x1235, 0xab12, EBITDO_DEVICE_KIND_NES30 },
		{ 0x1235, 0xab21, EBITDO_DEVICE_KIND_SFC30 },
		{ 0x1235, 0xab20, EBITDO_DEVICE_KIND_SNES30 },
		{ 0x1002, 0x9000, EBITDO_DEVICE_KIND_FC30PRO },
		{ 0x2002, 0x9000, EBITDO_DEVICE_KIND_NES30PRO },
		{ 0x8000, 0x1002, EBITDO_DEVICE_KIND_FC30_ARCADE },
		{ 0x0000, 0x0000, EBITDO_DEVICE_KIND_UNKNOWN, NULL }
	};

	device = g_object_new (EBITDO_TYPE_DEVICE, NULL);
	priv = GET_PRIVATE (device);
	priv->usb_device = g_object_ref (usb_device);

	/* set kind */
	for (j = 0; vidpids[j].vid != 0x0000; j++) {
		if (g_usb_device_get_vid (usb_device) == vidpids[j].vid &&
		    g_usb_device_get_pid (usb_device) == vidpids[j].pid) {
			priv->kind = vidpids[j].kind;
			break;
		}
	}
	return EBITDO_DEVICE (device);
}