razer/librazer/hw_deathadder2013.c

/*
 *   Lowlevel hardware access for the
 *   Razer Deathadder2013 mouse
 *
 *   Important notice:
 *   This hardware driver is based on reverse engineering, only.
 *
 *   Copyright (C) 2007-2010 Michael Buesch <m@bues.ch>
 *   Copyright (C) 2010 Bernd Michael Helm <deathadder2013@rw23.de>
 *
 *   Deathadder2013 fixes by Tony Crisci <tony@dubstepdish.com>
 *
 *   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.
 */

#include "hw_deathadder2013.h"
#include "razer_private.h"

#include <errno.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>

enum {
	DEATHADDER2013_LED_SCROLL = 0,
	DEATHADDER2013_LED_LOGO,
	DEATHADDER2013_NR_LEDS,
};

enum {	/* Misc constants */
	DEATHADDER2013_NR_DPIMAPPINGS = 64,
	DEATHADDER2013_NR_AXES = 3,
};

struct deathadder2013_command {
	uint8_t status;
	uint8_t padding0[3];
	le16_t command;
	le16_t request;
	le16_t value0;
	le16_t value1;
	uint8_t padding1[76];
	uint8_t footer;
	uint8_t padding2;
} _packed;

struct deathadder2013_private {
	struct razer_mouse *m;

	/* Firmware version number. */
	uint16_t fw_version;
	/* The currently set LED states. */
	bool led_states[DEATHADDER2013_NR_LEDS];
	/* The currently set frequency. */
	enum razer_mouse_freq frequency;
	/* The currently set resolution. */
	struct razer_mouse_dpimapping *cur_dpimapping_X;
	struct razer_mouse_dpimapping *cur_dpimapping_Y;

	struct razer_mouse_profile profile;
	struct razer_mouse_dpimapping dpimapping[DEATHADDER2013_NR_DPIMAPPINGS];
	struct razer_axis axes[DEATHADDER2013_NR_AXES];

	bool commit_pending;
};

static void deathadder2013_command_init(struct deathadder2013_command *cmd)
{
	memset(cmd, 0, sizeof(*cmd));
}

static int deathadder2013_usb_write(struct deathadder2013_private *priv,
				    int request, int command,
				    void *buf, size_t size)
{
	int err;

	err = libusb_control_transfer(priv->m->usb_ctx->h,
				      LIBUSB_ENDPOINT_OUT |
				      LIBUSB_REQUEST_TYPE_CLASS |
				      LIBUSB_RECIPIENT_INTERFACE, request,
				      command, 0, (unsigned char *)buf, size,
				      RAZER_USB_TIMEOUT);
	if (err < 0 || (size_t)err != size) {
		razer_error("razer-deathadder2013: "
			    "USB write 0x%02X 0x%02X failed: %d\n",
			    request, command, err);
		return err;
	}
	return 0;
}

static int deathadder2013_usb_read(struct deathadder2013_private *priv,
				   int request, int command,
				   void *buf, size_t size)
{
	int err, try;

	for (try = 0; try < 3; try++) {
		err = libusb_control_transfer(priv->m->usb_ctx->h,
					      LIBUSB_ENDPOINT_IN |
					      LIBUSB_REQUEST_TYPE_CLASS |
					      LIBUSB_RECIPIENT_INTERFACE,
					      request, command, 0, buf, size,
					      RAZER_USB_TIMEOUT);
		if (err >= 0 && (size_t)err == size)
			break;
	}

	if (err < 0 || (size_t)err != size) {
		razer_error("razer-deathadder2013: USB read 0x%02X 0x%02X failed: %d\n",
			    request, command, err);
		return err;
	}
	return 0;
}

static int deathadder2013_send_command(struct deathadder2013_private *priv,
				       struct deathadder2013_command *cmd)
{
	int err, i;

	/* commands seem to fail less often when you do them a few times. */
	for (i = 0; i < 3; i++) {
		cmd->status = 0x00;

		err = deathadder2013_usb_write(priv,
					       LIBUSB_REQUEST_SET_CONFIGURATION,
					       0x300, cmd, sizeof(*cmd));
		if (err)
			return err;
		err = deathadder2013_usb_read(priv,
					      LIBUSB_REQUEST_CLEAR_FEATURE,
					      0x300, cmd, sizeof(*cmd));
		if (err)
			return err;
		if (cmd->status != 3 &&
		    cmd->status != 2 && cmd->status != 1 && cmd->status != 0) {
			razer_error("razer-deathadder2013: Command %04X/%04X failed with %02X\n",
				    le16_to_cpu(cmd->command),
				    le16_to_cpu(cmd->request), cmd->status);
		}

		razer_msleep(35);
	}

	return 0;
}

static int deathadder2013_read_fw_ver(struct deathadder2013_private *priv)
{
	struct deathadder2013_command cmd;
	uint16_t ver;
	int err;
	unsigned int i;

	/* Poke the device several times until it responds with a
	 * valid version number */
	for (i = 0; i < 10; i++) {
		deathadder2013_command_init(&cmd);
		cmd.status = 0x00;
		cmd.command = cpu_to_le16(0x0400);
		cmd.request = cpu_to_le16(0x8700);
		cmd.footer = 0x83;
		err = deathadder2013_send_command(priv, &cmd);
		ver = be16_to_cpu((be16_t) cmd.value0);

		if (!err && (ver & 0xFF00) != 0)
			return ver;

		razer_msleep(150);
	}
	razer_error("razer-deathadder2013: Failed to read firmware version\n");

	/* sometimes it just won't read the firmware version. */
	return 0;
}

static int deathadder2013_do_commit(struct deathadder2013_private *priv)
{
	struct deathadder2013_command cmd;
	unsigned int xres, yres, freq;
	int err;

	/* Set the resolution. */
	deathadder2013_command_init(&cmd);
	cmd.command = cpu_to_le16(0x0300);
	cmd.request = cpu_to_le16(0x0104);
	xres = (((unsigned int)priv->cur_dpimapping_X->res[RAZER_DIM_0] / 100) - 1) * 4;
	yres = (((unsigned int)priv->cur_dpimapping_Y->res[RAZER_DIM_0] / 100) - 1) * 4;
	cmd.value0 = cpu_to_le16(xres | (yres << 8));
	cmd.footer = 0x06;

	err = deathadder2013_send_command(priv, &cmd);
	if (err)
		return err;

	/* Set the scroll wheel and buttons LEDs. */
	deathadder2013_command_init(&cmd);
	cmd.command = cpu_to_le16(0x0300);
	cmd.request = cpu_to_le16(0x0003);
	cmd.value0 = cpu_to_le16(0x0101);
	if (priv->led_states[DEATHADDER2013_LED_SCROLL]) {
		cmd.value1 = cpu_to_le16(0x0001);
		cmd.footer = 0x01;
	} else {
		cmd.value1 = cpu_to_le16(0x0000);
		cmd.footer = 0x00;
	}

	err = deathadder2013_send_command(priv, &cmd);

	if (err)
		return err;

	/* Set the logo LED. */
	deathadder2013_command_init(&cmd);
	cmd.command = cpu_to_le16(0x0300);
	cmd.request = cpu_to_le16(0x0003);
	cmd.value0 = cpu_to_le16(0x0401);

	if (priv->led_states[DEATHADDER2013_LED_LOGO]) {
		cmd.value1 = cpu_to_le16(1);
		cmd.footer = 0x04;
	} else {
		cmd.value1 = cpu_to_le16(0);
		cmd.footer = 0x05;
	}

	err = deathadder2013_send_command(priv, &cmd);

	if (err)
		return err;

	/* Set scan frequency. */
	switch (priv->frequency) {
	case RAZER_MOUSE_FREQ_125HZ:
		freq = 8;
		cmd.footer = 0x0C;
		break;
	case RAZER_MOUSE_FREQ_500HZ:
		freq = 2;
		cmd.footer = 0x06;
		break;
	case RAZER_MOUSE_FREQ_1000HZ:
	case RAZER_MOUSE_FREQ_UNKNOWN:
		freq = 1;
		cmd.footer = 0x05;
		break;
	default:
		return -EINVAL;
	}

	deathadder2013_command_init(&cmd);
	cmd.command = cpu_to_le16(0x0100);
	cmd.request = cpu_to_le16(0x0500);
	cmd.value0 = cpu_to_le16(freq);

	err = deathadder2013_send_command(priv, &cmd);
	if (err)
		return err;

	return 0;
}

static int deathadder2013_get_fw_version(struct razer_mouse *m)
{
	struct deathadder2013_private *priv = m->drv_data;

	return priv->fw_version;
}

static int deathadder2013_commit(struct razer_mouse *m, int force)
{
	struct deathadder2013_private *priv = m->drv_data;
	int err = 0;

	if (!m->claim_count)
		return -EBUSY;

	if (priv->commit_pending || force) {
		err = deathadder2013_do_commit(priv);
		if (!err)
			priv->commit_pending = 0;
	}

	return err;
}

static int deathadder2013_led_toggle(struct razer_led *led,
				     enum razer_led_state new_state)
{
	struct razer_mouse *m = led->u.mouse;
	struct deathadder2013_private *priv = m->drv_data;

	if (led->id >= DEATHADDER2013_NR_LEDS)
		return -EINVAL;

	if ((new_state != RAZER_LED_OFF) && (new_state != RAZER_LED_ON))
		return -EINVAL;

	if (!priv->m->claim_count)
		return -EBUSY;

	priv->led_states[led->id] = new_state;
	priv->commit_pending = 1;

	return 0;
}

static int deathadder2013_get_leds(struct razer_mouse *m,
				   struct razer_led **leds_list)
{
	struct deathadder2013_private *priv = m->drv_data;
	struct razer_led *scroll, *logo;

	scroll = zalloc(sizeof(struct razer_led));
	if (!scroll)
		return -ENOMEM;

	logo = zalloc(sizeof(struct razer_led));

	if (!logo) {
		free(scroll);
		return -ENOMEM;
	}

	scroll->name = "Scrollwheel";
	scroll->id = DEATHADDER2013_LED_SCROLL;
	scroll->state = priv->led_states[DEATHADDER2013_LED_SCROLL];
	scroll->toggle_state = deathadder2013_led_toggle;
	scroll->u.mouse = m;

	logo->name = "GlowingLogo";
	logo->id = DEATHADDER2013_LED_LOGO;
	logo->state = priv->led_states[DEATHADDER2013_LED_LOGO];
	logo->toggle_state = deathadder2013_led_toggle;
	logo->u.mouse = m;

	/* Link the list */
	*leds_list = scroll;
	scroll->next = logo;
	logo->next = NULL;

	return DEATHADDER2013_NR_LEDS;
}

static int deathadder2013_supported_freqs(struct razer_mouse *m,
					  enum razer_mouse_freq **freq_list)
{
	enum razer_mouse_freq *list;
	const int count = 3;

	list = zalloc(sizeof(*list) * count);

	if (!list)
		return -ENOMEM;

	list[0] = RAZER_MOUSE_FREQ_125HZ;
	list[1] = RAZER_MOUSE_FREQ_500HZ;
	list[2] = RAZER_MOUSE_FREQ_1000HZ;

	*freq_list = list;

	return count;
}

static enum razer_mouse_freq deathadder2013_get_freq(struct razer_mouse_profile
						     *p)
{
	struct deathadder2013_private *priv = p->mouse->drv_data;

	return priv->frequency;
}

static int deathadder2013_set_freq(struct razer_mouse_profile *p,
				   enum razer_mouse_freq freq)
{
	struct deathadder2013_private *priv = p->mouse->drv_data;

	if (!priv->m->claim_count)
		return -EBUSY;

	priv->frequency = freq;
	priv->commit_pending = 1;

	return 0;
}

static int deathadder2013_supported_axes(struct razer_mouse *m,
					 struct razer_axis **axes_list)
{
	struct deathadder2013_private *priv = m->drv_data;

	*axes_list = priv->axes;

	return ARRAY_SIZE(priv->axes);
}

static int deathadder2013_supported_resolutions(struct razer_mouse *m,
						enum razer_mouse_res **res_list)
{
	enum razer_mouse_res *list;
	unsigned int i;
	const unsigned int count = DEATHADDER2013_NR_DPIMAPPINGS;

	list = zalloc(sizeof(*list) * count);

	if (!list)
		return -ENOMEM;

	for (i = 0; i < count; i++)
		list[i] = (i + 1) * 100;

	*res_list = list;

	return count;
}

static struct razer_mouse_profile *deathadder2013_get_profiles(struct
							       razer_mouse *m)
{
	struct deathadder2013_private *priv = m->drv_data;

	return &priv->profile;
}

static int deathadder2013_supported_dpimappings(struct razer_mouse *m,
						struct razer_mouse_dpimapping
						**res_ptr)
{
	struct deathadder2013_private *priv = m->drv_data;

	*res_ptr = &priv->dpimapping[0];

	return ARRAY_SIZE(priv->dpimapping);
}

static struct razer_mouse_dpimapping *deathadder2013_get_dpimapping(struct razer_mouse_profile *p,
								    struct razer_axis *axis)
{
	struct deathadder2013_private *priv = p->mouse->drv_data;

	if (!axis)
		axis = &priv->axes[0];

	if (axis->id == 0)
		return priv->cur_dpimapping_X;

	if (axis->id == 1)
		return priv->cur_dpimapping_Y;

	return NULL;
}

static int deathadder2013_set_dpimapping(struct razer_mouse_profile *p,
					 struct razer_axis *axis,
					 struct razer_mouse_dpimapping *d)
{
	struct deathadder2013_private *priv = p->mouse->drv_data;

	if (!priv->m->claim_count)
		return -EBUSY;

	if (axis && axis->id >= ARRAY_SIZE(priv->axes))
		return -EINVAL;

	if (axis) {
		if (axis->id == 0)
			priv->cur_dpimapping_X = d;
		else if (axis->id == 1)
			priv->cur_dpimapping_Y = d;
		else
			return -EINVAL;
	} else {
		priv->cur_dpimapping_X = d;
		priv->cur_dpimapping_Y = d;
	}
	priv->commit_pending = 1;

	return 0;
}

int razer_deathadder2013_init(struct razer_mouse *m,
			      struct libusb_device *usbdev)
{
	struct deathadder2013_private *priv;
	unsigned int i;
	int fwver, err;

	BUILD_BUG_ON(sizeof(struct deathadder2013_command) != 90);

	priv = zalloc(sizeof(struct deathadder2013_private));

	if (!priv)
		return -ENOMEM;

	priv->m = m;
	m->drv_data = priv;

	err = razer_usb_add_used_interface(m->usb_ctx, 0, 0);

	if (err)
		goto err_free;

	err = m->claim(m);
	if (err) {
		razer_error("hw_deathadder2013: Failed to claim device\n");
		goto err_free;
	}

	/* Fetch firmware version */
	fwver = deathadder2013_read_fw_ver(priv);
	if (fwver < 0) {
		err = fwver;
		goto err_release;
	}
	priv->fw_version = fwver;
	priv->frequency = RAZER_MOUSE_FREQ_1000HZ;

	for (i = 0; i < DEATHADDER2013_NR_LEDS; i++)
		priv->led_states[i] = RAZER_LED_ON;

	priv->profile.nr = 0;
	priv->profile.get_freq = deathadder2013_get_freq;
	priv->profile.set_freq = deathadder2013_set_freq;
	priv->profile.get_dpimapping = deathadder2013_get_dpimapping;
	priv->profile.set_dpimapping = deathadder2013_set_dpimapping;
	priv->profile.mouse = m;

	for (i = 0; i < DEATHADDER2013_NR_DPIMAPPINGS; i++) {
		priv->dpimapping[i].nr = i;
		priv->dpimapping[i].res[RAZER_DIM_0] = (i + 1) * 100;
		if (priv->dpimapping[i].res[RAZER_DIM_0] == 1000) {
			priv->cur_dpimapping_X = &priv->dpimapping[i];
			priv->cur_dpimapping_Y = &priv->dpimapping[i];
		}
		priv->dpimapping[i].dimension_mask = (1 << RAZER_DIM_0);
		priv->dpimapping[i].change = NULL;
		priv->dpimapping[i].mouse = m;
	}
	razer_init_axes(&priv->axes[0],
			"X", RAZER_AXIS_INDEPENDENT_DPIMAPPING,
			"Y", RAZER_AXIS_INDEPENDENT_DPIMAPPING, "Scroll", 0);

	m->type = RAZER_MOUSETYPE_DEATHADDER;
	razer_generic_usb_gen_idstr(usbdev, m->usb_ctx->h,
				    "DeathAdder 2013 Edition", 1, NULL,
				    m->idstr);

	m->get_fw_version = deathadder2013_get_fw_version;
	m->commit = deathadder2013_commit;
	m->global_get_leds = deathadder2013_get_leds;
	m->get_profiles = deathadder2013_get_profiles;
	m->supported_axes = deathadder2013_supported_axes;
	m->supported_resolutions = deathadder2013_supported_resolutions;
	m->supported_freqs = deathadder2013_supported_freqs;
	m->supported_dpimappings = deathadder2013_supported_dpimappings;

	m->release(m);

	return 0;

err_release:
	m->release(m);
err_free:
	free(priv);
	return err;
}

void razer_deathadder2013_release(struct razer_mouse *m)
{
	struct deathadder2013_private *priv = m->drv_data;

	free(priv);
}