[linux-block.git] / drivers / hid / hid-roccat-koneplus.c

/*
 * Roccat Kone[+] driver for Linux
 *
 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
 */

/*
 * 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.
 */

/*
 * Roccat Kone[+] is an updated/improved version of the Kone with more memory
 * and functionality and without the non-standard behaviours the Kone had.
 * KoneXTD has same capabilities but updated sensor.
 */

#include <linux/device.h>
#include <linux/input.h>
#include <linux/hid.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/hid-roccat.h>
#include "hid-ids.h"
#include "hid-roccat-common.h"
#include "hid-roccat-koneplus.h"

static uint profile_numbers[5] = {0, 1, 2, 3, 4};

static struct class *koneplus_class;

static void koneplus_profile_activated(struct koneplus_device *koneplus,
		uint new_profile)
{
	koneplus->actual_profile = new_profile;
}

static int koneplus_send_control(struct usb_device *usb_dev, uint value,
		enum koneplus_control_requests request)
{
	struct roccat_common2_control control;

	if ((request == KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS ||
			request == KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS) &&
			value > 4)
		return -EINVAL;

	control.command = ROCCAT_COMMON_COMMAND_CONTROL;
	control.value = value;
	control.request = request;

	return roccat_common2_send_with_status(usb_dev,
			ROCCAT_COMMON_COMMAND_CONTROL,
			&control, sizeof(struct roccat_common2_control));
}


/* retval is 0-4 on success, < 0 on error */
static int koneplus_get_actual_profile(struct usb_device *usb_dev)
{
	struct koneplus_actual_profile buf;
	int retval;

	retval = roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_ACTUAL_PROFILE,
			&buf, KONEPLUS_SIZE_ACTUAL_PROFILE);

	return retval ? retval : buf.actual_profile;
}

static int koneplus_set_actual_profile(struct usb_device *usb_dev,
		int new_profile)
{
	struct koneplus_actual_profile buf;

	buf.command = KONEPLUS_COMMAND_ACTUAL_PROFILE;
	buf.size = KONEPLUS_SIZE_ACTUAL_PROFILE;
	buf.actual_profile = new_profile;

	return roccat_common2_send_with_status(usb_dev,
			KONEPLUS_COMMAND_ACTUAL_PROFILE,
			&buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
}

static ssize_t koneplus_sysfs_read(struct file *fp, struct kobject *kobj,
		char *buf, loff_t off, size_t count,
		size_t real_size, uint command)
{
	struct device *dev =
			container_of(kobj, struct device, kobj)->parent->parent;
	struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	int retval;

	if (off >= real_size)
		return 0;

	if (off != 0 || count != real_size)
		return -EINVAL;

	mutex_lock(&koneplus->koneplus_lock);
	retval = roccat_common2_receive(usb_dev, command, buf, real_size);
	mutex_unlock(&koneplus->koneplus_lock);

	if (retval)
		return retval;

	return real_size;
}

static ssize_t koneplus_sysfs_write(struct file *fp, struct kobject *kobj,
		void const *buf, loff_t off, size_t count,
		size_t real_size, uint command)
{
	struct device *dev =
			container_of(kobj, struct device, kobj)->parent->parent;
	struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	int retval;

	if (off != 0 || count != real_size)
		return -EINVAL;

	mutex_lock(&koneplus->koneplus_lock);
	retval = roccat_common2_send_with_status(usb_dev, command,
			buf, real_size);
	mutex_unlock(&koneplus->koneplus_lock);

	if (retval)
		return retval;

	return real_size;
}

#define KONEPLUS_SYSFS_W(thingy, THINGY) \
static ssize_t koneplus_sysfs_write_ ## thingy(struct file *fp, \
		struct kobject *kobj, struct bin_attribute *attr, char *buf, \
		loff_t off, size_t count) \
{ \
	return koneplus_sysfs_write(fp, kobj, buf, off, count, \
			KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
}

#define KONEPLUS_SYSFS_R(thingy, THINGY) \
static ssize_t koneplus_sysfs_read_ ## thingy(struct file *fp, \
		struct kobject *kobj, struct bin_attribute *attr, char *buf, \
		loff_t off, size_t count) \
{ \
	return koneplus_sysfs_read(fp, kobj, buf, off, count, \
			KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
}

#define KONEPLUS_SYSFS_RW(thingy, THINGY) \
KONEPLUS_SYSFS_W(thingy, THINGY) \
KONEPLUS_SYSFS_R(thingy, THINGY)

#define KONEPLUS_BIN_ATTRIBUTE_RW(thingy, THINGY) \
KONEPLUS_SYSFS_RW(thingy, THINGY); \
static struct bin_attribute bin_attr_##thingy = { \
	.attr = { .name = #thingy, .mode = 0660 }, \
	.size = KONEPLUS_SIZE_ ## THINGY, \
	.read = koneplus_sysfs_read_ ## thingy, \
	.write = koneplus_sysfs_write_ ## thingy \
}

#define KONEPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
KONEPLUS_SYSFS_R(thingy, THINGY); \
static struct bin_attribute bin_attr_##thingy = { \
	.attr = { .name = #thingy, .mode = 0440 }, \
	.size = KONEPLUS_SIZE_ ## THINGY, \
	.read = koneplus_sysfs_read_ ## thingy, \
}

#define KONEPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
KONEPLUS_SYSFS_W(thingy, THINGY); \
static struct bin_attribute bin_attr_##thingy = { \
	.attr = { .name = #thingy, .mode = 0220 }, \
	.size = KONEPLUS_SIZE_ ## THINGY, \
	.write = koneplus_sysfs_write_ ## thingy \
}
KONEPLUS_BIN_ATTRIBUTE_W(control, CONTROL);
KONEPLUS_BIN_ATTRIBUTE_W(talk, TALK);
KONEPLUS_BIN_ATTRIBUTE_W(macro, MACRO);
KONEPLUS_BIN_ATTRIBUTE_R(tcu_image, TCU_IMAGE);
KONEPLUS_BIN_ATTRIBUTE_RW(info, INFO);
KONEPLUS_BIN_ATTRIBUTE_RW(sensor, SENSOR);
KONEPLUS_BIN_ATTRIBUTE_RW(tcu, TCU);
KONEPLUS_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS);
KONEPLUS_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS);

static ssize_t koneplus_sysfs_read_profilex_settings(struct file *fp,
		struct kobject *kobj, struct bin_attribute *attr, char *buf,
		loff_t off, size_t count)
{
	struct device *dev =
			container_of(kobj, struct device, kobj)->parent->parent;
	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	ssize_t retval;

	retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
			KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
	if (retval)
		return retval;

	return koneplus_sysfs_read(fp, kobj, buf, off, count,
			KONEPLUS_SIZE_PROFILE_SETTINGS,
			KONEPLUS_COMMAND_PROFILE_SETTINGS);
}

static ssize_t koneplus_sysfs_read_profilex_buttons(struct file *fp,
		struct kobject *kobj, struct bin_attribute *attr, char *buf,
		loff_t off, size_t count)
{
	struct device *dev =
			container_of(kobj, struct device, kobj)->parent->parent;
	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	ssize_t retval;

	retval = koneplus_send_control(usb_dev, *(uint *)(attr->private),
			KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
	if (retval)
		return retval;

	return koneplus_sysfs_read(fp, kobj, buf, off, count,
			KONEPLUS_SIZE_PROFILE_BUTTONS,
			KONEPLUS_COMMAND_PROFILE_BUTTONS);
}

#define PROFILE_ATTR(number)						\
static struct bin_attribute bin_attr_profile##number##_settings = {	\
	.attr = { .name = "profile" #number "_settings", .mode = 0440 },	\
	.size = KONEPLUS_SIZE_PROFILE_SETTINGS,				\
	.read = koneplus_sysfs_read_profilex_settings,			\
	.private = &profile_numbers[number-1],				\
};									\
static struct bin_attribute bin_attr_profile##number##_buttons = {	\
	.attr = { .name = "profile" #number "_buttons", .mode = 0440 },	\
	.size = KONEPLUS_SIZE_PROFILE_BUTTONS,				\
	.read = koneplus_sysfs_read_profilex_buttons,			\
	.private = &profile_numbers[number-1],				\
};
PROFILE_ATTR(1);
PROFILE_ATTR(2);
PROFILE_ATTR(3);
PROFILE_ATTR(4);
PROFILE_ATTR(5);

static ssize_t koneplus_sysfs_show_actual_profile(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct koneplus_device *koneplus =
			hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
	return snprintf(buf, PAGE_SIZE, "%d\n", koneplus->actual_profile);
}

static ssize_t koneplus_sysfs_set_actual_profile(struct device *dev,
		struct device_attribute *attr, char const *buf, size_t size)
{
	struct koneplus_device *koneplus;
	struct usb_device *usb_dev;
	unsigned long profile;
	int retval;
	struct koneplus_roccat_report roccat_report;

	dev = dev->parent->parent;
	koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	usb_dev = interface_to_usbdev(to_usb_interface(dev));

	retval = kstrtoul(buf, 10, &profile);
	if (retval)
		return retval;

	if (profile > 4)
		return -EINVAL;

	mutex_lock(&koneplus->koneplus_lock);

	retval = koneplus_set_actual_profile(usb_dev, profile);
	if (retval) {
		mutex_unlock(&koneplus->koneplus_lock);
		return retval;
	}

	koneplus_profile_activated(koneplus, profile);

	roccat_report.type = KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE;
	roccat_report.data1 = profile + 1;
	roccat_report.data2 = 0;
	roccat_report.profile = profile + 1;
	roccat_report_event(koneplus->chrdev_minor,
			(uint8_t const *)&roccat_report);

	mutex_unlock(&koneplus->koneplus_lock);

	return size;
}
static DEVICE_ATTR(actual_profile, 0660,
		   koneplus_sysfs_show_actual_profile,
		   koneplus_sysfs_set_actual_profile);
static DEVICE_ATTR(startup_profile, 0660,
		   koneplus_sysfs_show_actual_profile,
		   koneplus_sysfs_set_actual_profile);

static ssize_t koneplus_sysfs_show_firmware_version(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct koneplus_device *koneplus;
	struct usb_device *usb_dev;
	struct koneplus_info info;

	dev = dev->parent->parent;
	koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	usb_dev = interface_to_usbdev(to_usb_interface(dev));

	mutex_lock(&koneplus->koneplus_lock);
	roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_INFO,
			&info, KONEPLUS_SIZE_INFO);
	mutex_unlock(&koneplus->koneplus_lock);

	return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
}
static DEVICE_ATTR(firmware_version, 0440,
		   koneplus_sysfs_show_firmware_version, NULL);

static struct attribute *koneplus_attrs[] = {
	&dev_attr_actual_profile.attr,
	&dev_attr_startup_profile.attr,
	&dev_attr_firmware_version.attr,
	NULL,
};

static struct bin_attribute *koneplus_bin_attributes[] = {
	&bin_attr_control,
	&bin_attr_talk,
	&bin_attr_macro,
	&bin_attr_tcu_image,
	&bin_attr_info,
	&bin_attr_sensor,
	&bin_attr_tcu,
	&bin_attr_profile_settings,
	&bin_attr_profile_buttons,
	&bin_attr_profile1_settings,
	&bin_attr_profile2_settings,
	&bin_attr_profile3_settings,
	&bin_attr_profile4_settings,
	&bin_attr_profile5_settings,
	&bin_attr_profile1_buttons,
	&bin_attr_profile2_buttons,
	&bin_attr_profile3_buttons,
	&bin_attr_profile4_buttons,
	&bin_attr_profile5_buttons,
	NULL,
};

static const struct attribute_group koneplus_group = {
	.attrs = koneplus_attrs,
	.bin_attrs = koneplus_bin_attributes,
};

static const struct attribute_group *koneplus_groups[] = {
	&koneplus_group,
	NULL,
};

static int koneplus_init_koneplus_device_struct(struct usb_device *usb_dev,
		struct koneplus_device *koneplus)
{
	int retval;

	mutex_init(&koneplus->koneplus_lock);

	retval = koneplus_get_actual_profile(usb_dev);
	if (retval < 0)
		return retval;
	koneplus_profile_activated(koneplus, retval);

	return 0;
}

static int koneplus_init_specials(struct hid_device *hdev)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	struct usb_device *usb_dev = interface_to_usbdev(intf);
	struct koneplus_device *koneplus;
	int retval;

	if (intf->cur_altsetting->desc.bInterfaceProtocol
			== USB_INTERFACE_PROTOCOL_MOUSE) {

		koneplus = kzalloc(sizeof(*koneplus), GFP_KERNEL);
		if (!koneplus) {
			hid_err(hdev, "can't alloc device descriptor\n");
			return -ENOMEM;
		}
		hid_set_drvdata(hdev, koneplus);

		retval = koneplus_init_koneplus_device_struct(usb_dev, koneplus);
		if (retval) {
			hid_err(hdev, "couldn't init struct koneplus_device\n");
			goto exit_free;
		}

		retval = roccat_connect(koneplus_class, hdev,
				sizeof(struct koneplus_roccat_report));
		if (retval < 0) {
			hid_err(hdev, "couldn't init char dev\n");
		} else {
			koneplus->chrdev_minor = retval;
			koneplus->roccat_claimed = 1;
		}
	} else {
		hid_set_drvdata(hdev, NULL);
	}

	return 0;
exit_free:
	kfree(koneplus);
	return retval;
}

static void koneplus_remove_specials(struct hid_device *hdev)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	struct koneplus_device *koneplus;

	if (intf->cur_altsetting->desc.bInterfaceProtocol
			== USB_INTERFACE_PROTOCOL_MOUSE) {
		koneplus = hid_get_drvdata(hdev);
		if (koneplus->roccat_claimed)
			roccat_disconnect(koneplus->chrdev_minor);
		kfree(koneplus);
	}
}

static int koneplus_probe(struct hid_device *hdev,
		const struct hid_device_id *id)
{
	int retval;

	retval = hid_parse(hdev);
	if (retval) {
		hid_err(hdev, "parse failed\n");
		goto exit;
	}

	retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	if (retval) {
		hid_err(hdev, "hw start failed\n");
		goto exit;
	}

	retval = koneplus_init_specials(hdev);
	if (retval) {
		hid_err(hdev, "couldn't install mouse\n");
		goto exit_stop;
	}

	return 0;

exit_stop:
	hid_hw_stop(hdev);
exit:
	return retval;
}

static void koneplus_remove(struct hid_device *hdev)
{
	koneplus_remove_specials(hdev);
	hid_hw_stop(hdev);
}

static void koneplus_keep_values_up_to_date(struct koneplus_device *koneplus,
		u8 const *data)
{
	struct koneplus_mouse_report_button const *button_report;

	switch (data[0]) {
	case KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON:
		button_report = (struct koneplus_mouse_report_button const *)data;
		switch (button_report->type) {
		case KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE:
			koneplus_profile_activated(koneplus, button_report->data1 - 1);
			break;
		}
		break;
	}
}

static void koneplus_report_to_chrdev(struct koneplus_device const *koneplus,
		u8 const *data)
{
	struct koneplus_roccat_report roccat_report;
	struct koneplus_mouse_report_button const *button_report;

	if (data[0] != KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON)
		return;

	button_report = (struct koneplus_mouse_report_button const *)data;

	if ((button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH ||
			button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER) &&
			button_report->data2 != KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS)
		return;

	roccat_report.type = button_report->type;
	roccat_report.data1 = button_report->data1;
	roccat_report.data2 = button_report->data2;
	roccat_report.profile = koneplus->actual_profile + 1;
	roccat_report_event(koneplus->chrdev_minor,
			(uint8_t const *)&roccat_report);
}

static int koneplus_raw_event(struct hid_device *hdev,
		struct hid_report *report, u8 *data, int size)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	struct koneplus_device *koneplus = hid_get_drvdata(hdev);

	if (intf->cur_altsetting->desc.bInterfaceProtocol
			!= USB_INTERFACE_PROTOCOL_MOUSE)
		return 0;

	if (koneplus == NULL)
		return 0;

	koneplus_keep_values_up_to_date(koneplus, data);

	if (koneplus->roccat_claimed)
		koneplus_report_to_chrdev(koneplus, data);

	return 0;
}

static const struct hid_device_id koneplus_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPLUS) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEXTD) },
	{ }
};

MODULE_DEVICE_TABLE(hid, koneplus_devices);

static struct hid_driver koneplus_driver = {
		.name = "koneplus",
		.id_table = koneplus_devices,
		.probe = koneplus_probe,
		.remove = koneplus_remove,
		.raw_event = koneplus_raw_event
};

static int __init koneplus_init(void)
{
	int retval;

	/* class name has to be same as driver name */
	koneplus_class = class_create(THIS_MODULE, "koneplus");
	if (IS_ERR(koneplus_class))
		return PTR_ERR(koneplus_class);
	koneplus_class->dev_groups = koneplus_groups;

	retval = hid_register_driver(&koneplus_driver);
	if (retval)
		class_destroy(koneplus_class);
	return retval;
}

static void __exit koneplus_exit(void)
{
	hid_unregister_driver(&koneplus_driver);
	class_destroy(koneplus_class);
}

module_init(koneplus_init);
module_exit(koneplus_exit);

MODULE_AUTHOR("Stefan Achatz");
MODULE_DESCRIPTION("USB Roccat Kone[+]/XTD driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
47dbdbff SA	1	/*
	2	* Roccat Kone[+] driver for Linux
	3	*
	4	* Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
	5	*/
	6
	7	/*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the Free
	10	* Software Foundation; either version 2 of the License, or (at your option)
	11	* any later version.
	12	*/
	13
	14	/*
	15	* Roccat Kone[+] is an updated/improved version of the Kone with more memory
	16	* and functionality and without the non-standard behaviours the Kone had.
8e74a2d3	17	* KoneXTD has same capabilities but updated sensor.
47dbdbff SA	18	*/
	19
	20	#include <linux/device.h>
	21	#include <linux/input.h>
	22	#include <linux/hid.h>
47dbdbff SA	23	#include <linux/module.h>
47dbdbff SA	24	#include <linux/slab.h>
5dc0c983	25	#include <linux/hid-roccat.h>
47dbdbff	26	#include "hid-ids.h"
5772f636	27	#include "hid-roccat-common.h"
47dbdbff SA	28	#include "hid-roccat-koneplus.h"
	29
	30	static uint profile_numbers[5] = {0, 1, 2, 3, 4};
	31
	32	static struct class *koneplus_class;
	33
	34	static void koneplus_profile_activated(struct koneplus_device *koneplus,
	35	uint new_profile)
	36	{
	37	koneplus->actual_profile = new_profile;
	38	}
	39
	40	static int koneplus_send_control(struct usb_device *usb_dev, uint value,
	41	enum koneplus_control_requests request)
	42	{
7392d73b	43	struct roccat_common2_control control;
47dbdbff SA	44
	45	if ((request == KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS \|\|
	46	request == KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS) &&
	47	value > 4)
	48	return -EINVAL;
	49
4728f2dc	50	control.command = ROCCAT_COMMON_COMMAND_CONTROL;
5772f636 SA	51	control.value = value;
5772f636 SA	52	control.request = request;
47dbdbff	53
7392d73b	54	return roccat_common2_send_with_status(usb_dev,
4728f2dc	55	ROCCAT_COMMON_COMMAND_CONTROL,
7392d73b	56	&control, sizeof(struct roccat_common2_control));
47dbdbff SA	57	}
47dbdbff SA	58
47dbdbff SA	59
47dbdbff SA	60	/* retval is 0-4 on success, < 0 on error */
b50f315c	61	static int koneplus_get_actual_profile(struct usb_device *usb_dev)
47dbdbff	62	{
b50f315c	63	struct koneplus_actual_profile buf;
47dbdbff SA	64	int retval;
47dbdbff SA	65
7392d73b	66	retval = roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_ACTUAL_PROFILE,
f114fec5	67	&buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
47dbdbff	68
b50f315c	69	return retval ? retval : buf.actual_profile;
47dbdbff SA	70	}
47dbdbff SA	71
b50f315c SA	72	static int koneplus_set_actual_profile(struct usb_device *usb_dev,
b50f315c SA	73	int new_profile)
47dbdbff	74	{
b50f315c	75	struct koneplus_actual_profile buf;
47dbdbff	76
b50f315c	77	buf.command = KONEPLUS_COMMAND_ACTUAL_PROFILE;
f114fec5	78	buf.size = KONEPLUS_SIZE_ACTUAL_PROFILE;
b50f315c	79	buf.actual_profile = new_profile;
47dbdbff	80
7392d73b	81	return roccat_common2_send_with_status(usb_dev,
4728f2dc	82	KONEPLUS_COMMAND_ACTUAL_PROFILE,
f114fec5	83	&buf, KONEPLUS_SIZE_ACTUAL_PROFILE);
47dbdbff SA	84	}
	85
	86	static ssize_t koneplus_sysfs_read(struct file fp, struct kobject kobj,
	87	char *buf, loff_t off, size_t count,
	88	size_t real_size, uint command)
	89	{
	90	struct device *dev =
	91	container_of(kobj, struct device, kobj)->parent->parent;
	92	struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	93	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	94	int retval;
	95
fd82be6c SA	96	if (off >= real_size)
	97	return 0;
	98
47dbdbff SA	99	if (off != 0 \|\| count != real_size)
	100	return -EINVAL;
	101
	102	mutex_lock(&koneplus->koneplus_lock);
7392d73b	103	retval = roccat_common2_receive(usb_dev, command, buf, real_size);
47dbdbff SA	104	mutex_unlock(&koneplus->koneplus_lock);
	105
	106	if (retval)
	107	return retval;
	108
	109	return real_size;
	110	}
	111
	112	static ssize_t koneplus_sysfs_write(struct file fp, struct kobject kobj,
	113	void const *buf, loff_t off, size_t count,
	114	size_t real_size, uint command)
	115	{
	116	struct device *dev =
	117	container_of(kobj, struct device, kobj)->parent->parent;
	118	struct koneplus_device *koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	119	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
	120	int retval;
	121
	122	if (off != 0 \|\| count != real_size)
	123	return -EINVAL;
	124
	125	mutex_lock(&koneplus->koneplus_lock);
7392d73b	126	retval = roccat_common2_send_with_status(usb_dev, command,
4728f2dc	127	buf, real_size);
47dbdbff SA	128	mutex_unlock(&koneplus->koneplus_lock);
	129
	130	if (retval)
	131	return retval;
	132
	133	return real_size;
	134	}
	135
f114fec5 SA	136	#define KONEPLUS_SYSFS_W(thingy, THINGY) \
	137	static ssize_t koneplus_sysfs_write_ ## thingy(struct file *fp, \
	138	struct kobject kobj, struct bin_attribute attr, char *buf, \
	139	loff_t off, size_t count) \
	140	{ \
	141	return koneplus_sysfs_write(fp, kobj, buf, off, count, \
	142	KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
fabe51eb SA	143	}
fabe51eb SA	144
f114fec5 SA	145	#define KONEPLUS_SYSFS_R(thingy, THINGY) \
	146	static ssize_t koneplus_sysfs_read_ ## thingy(struct file *fp, \
	147	struct kobject kobj, struct bin_attribute attr, char *buf, \
	148	loff_t off, size_t count) \
	149	{ \
	150	return koneplus_sysfs_read(fp, kobj, buf, off, count, \
	151	KONEPLUS_SIZE_ ## THINGY, KONEPLUS_COMMAND_ ## THINGY); \
fabe51eb SA	152	}
fabe51eb SA	153
f114fec5 SA	154	#define KONEPLUS_SYSFS_RW(thingy, THINGY) \
	155	KONEPLUS_SYSFS_W(thingy, THINGY) \
	156	KONEPLUS_SYSFS_R(thingy, THINGY)
6d1dec85	157
f114fec5	158	#define KONEPLUS_BIN_ATTRIBUTE_RW(thingy, THINGY) \
eb3156e0 GKH	159	KONEPLUS_SYSFS_RW(thingy, THINGY); \
eb3156e0 GKH	160	static struct bin_attribute bin_attr_##thingy = { \
f114fec5 SA	161	.attr = { .name = #thingy, .mode = 0660 }, \
	162	.size = KONEPLUS_SIZE_ ## THINGY, \
	163	.read = koneplus_sysfs_read_ ## thingy, \
	164	.write = koneplus_sysfs_write_ ## thingy \
47dbdbff SA	165	}
47dbdbff SA	166
f114fec5	167	#define KONEPLUS_BIN_ATTRIBUTE_R(thingy, THINGY) \
eb3156e0 GKH	168	KONEPLUS_SYSFS_R(thingy, THINGY); \
eb3156e0 GKH	169	static struct bin_attribute bin_attr_##thingy = { \
f114fec5 SA	170	.attr = { .name = #thingy, .mode = 0440 }, \
	171	.size = KONEPLUS_SIZE_ ## THINGY, \
	172	.read = koneplus_sysfs_read_ ## thingy, \
47dbdbff SA	173	}
47dbdbff SA	174
f114fec5	175	#define KONEPLUS_BIN_ATTRIBUTE_W(thingy, THINGY) \
eb3156e0 GKH	176	KONEPLUS_SYSFS_W(thingy, THINGY); \
eb3156e0 GKH	177	static struct bin_attribute bin_attr_##thingy = { \
f114fec5 SA	178	.attr = { .name = #thingy, .mode = 0220 }, \
	179	.size = KONEPLUS_SIZE_ ## THINGY, \
	180	.write = koneplus_sysfs_write_ ## thingy \
47dbdbff	181	}
eb3156e0 GKH	182	KONEPLUS_BIN_ATTRIBUTE_W(control, CONTROL);
	183	KONEPLUS_BIN_ATTRIBUTE_W(talk, TALK);
	184	KONEPLUS_BIN_ATTRIBUTE_W(macro, MACRO);
	185	KONEPLUS_BIN_ATTRIBUTE_R(tcu_image, TCU_IMAGE);
	186	KONEPLUS_BIN_ATTRIBUTE_RW(info, INFO);
	187	KONEPLUS_BIN_ATTRIBUTE_RW(sensor, SENSOR);
	188	KONEPLUS_BIN_ATTRIBUTE_RW(tcu, TCU);
	189	KONEPLUS_BIN_ATTRIBUTE_RW(profile_settings, PROFILE_SETTINGS);
	190	KONEPLUS_BIN_ATTRIBUTE_RW(profile_buttons, PROFILE_BUTTONS);
47dbdbff SA	191
	192	static ssize_t koneplus_sysfs_read_profilex_settings(struct file *fp,
	193	struct kobject kobj, struct bin_attribute attr, char *buf,
	194	loff_t off, size_t count)
	195	{
	196	struct device *dev =
	197	container_of(kobj, struct device, kobj)->parent->parent;
47dbdbff	198	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
f114fec5	199	ssize_t retval;
47dbdbff	200
f114fec5 SA	201	retval = koneplus_send_control(usb_dev, (uint )(attr->private),
f114fec5 SA	202	KONEPLUS_CONTROL_REQUEST_PROFILE_SETTINGS);
47dbdbff SA	203	if (retval)
	204	return retval;
	205
f114fec5 SA	206	return koneplus_sysfs_read(fp, kobj, buf, off, count,
	207	KONEPLUS_SIZE_PROFILE_SETTINGS,
	208	KONEPLUS_COMMAND_PROFILE_SETTINGS);
47dbdbff SA	209	}
	210
	211	static ssize_t koneplus_sysfs_read_profilex_buttons(struct file *fp,
	212	struct kobject kobj, struct bin_attribute attr, char *buf,
	213	loff_t off, size_t count)
	214	{
	215	struct device *dev =
	216	container_of(kobj, struct device, kobj)->parent->parent;
47dbdbff	217	struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
f114fec5	218	ssize_t retval;
47dbdbff	219
f114fec5 SA	220	retval = koneplus_send_control(usb_dev, (uint )(attr->private),
f114fec5 SA	221	KONEPLUS_CONTROL_REQUEST_PROFILE_BUTTONS);
47dbdbff SA	222	if (retval)
	223	return retval;
	224
f114fec5 SA	225	return koneplus_sysfs_read(fp, kobj, buf, off, count,
	226	KONEPLUS_SIZE_PROFILE_BUTTONS,
	227	KONEPLUS_COMMAND_PROFILE_BUTTONS);
47dbdbff SA	228	}
47dbdbff SA	229
eb3156e0 GKH	230	#define PROFILE_ATTR(number) \
eb3156e0 GKH	231	static struct bin_attribute bin_attr_profile##number##_settings = { \
550dbf47	232	.attr = { .name = "profile" #number "_settings", .mode = 0440 }, \
eb3156e0 GKH	233	.size = KONEPLUS_SIZE_PROFILE_SETTINGS, \
	234	.read = koneplus_sysfs_read_profilex_settings, \
	235	.private = &profile_numbers[number-1], \
	236	}; \
	237	static struct bin_attribute bin_attr_profile##number##_buttons = { \
550dbf47	238	.attr = { .name = "profile" #number "_buttons", .mode = 0440 }, \
eb3156e0 GKH	239	.size = KONEPLUS_SIZE_PROFILE_BUTTONS, \
	240	.read = koneplus_sysfs_read_profilex_buttons, \
	241	.private = &profile_numbers[number-1], \
	242	};
	243	PROFILE_ATTR(1);
	244	PROFILE_ATTR(2);
	245	PROFILE_ATTR(3);
	246	PROFILE_ATTR(4);
	247	PROFILE_ATTR(5);
	248
b50f315c	249	static ssize_t koneplus_sysfs_show_actual_profile(struct device *dev,
47dbdbff SA	250	struct device_attribute attr, char buf)
	251	{
	252	struct koneplus_device *koneplus =
	253	hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
b50f315c	254	return snprintf(buf, PAGE_SIZE, "%d\n", koneplus->actual_profile);
47dbdbff SA	255	}
47dbdbff SA	256
b50f315c	257	static ssize_t koneplus_sysfs_set_actual_profile(struct device *dev,
47dbdbff SA	258	struct device_attribute attr, char const buf, size_t size)
	259	{
	260	struct koneplus_device *koneplus;
	261	struct usb_device *usb_dev;
	262	unsigned long profile;
	263	int retval;
b50f315c	264	struct koneplus_roccat_report roccat_report;
47dbdbff SA	265
	266	dev = dev->parent->parent;
	267	koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	268	usb_dev = interface_to_usbdev(to_usb_interface(dev));
	269
dfc450b5	270	retval = kstrtoul(buf, 10, &profile);
47dbdbff SA	271	if (retval)
	272	return retval;
	273
901e64db SA	274	if (profile > 4)
	275	return -EINVAL;
	276
47dbdbff	277	mutex_lock(&koneplus->koneplus_lock);
b50f315c SA	278
	279	retval = koneplus_set_actual_profile(usb_dev, profile);
	280	if (retval) {
	281	mutex_unlock(&koneplus->koneplus_lock);
47dbdbff	282	return retval;
b50f315c	283	}
47dbdbff	284
901e64db	285	koneplus_profile_activated(koneplus, profile);
47dbdbff	286
b50f315c SA	287	roccat_report.type = KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE;
	288	roccat_report.data1 = profile + 1;
	289	roccat_report.data2 = 0;
	290	roccat_report.profile = profile + 1;
	291	roccat_report_event(koneplus->chrdev_minor,
	292	(uint8_t const *)&roccat_report);
	293
	294	mutex_unlock(&koneplus->koneplus_lock);
	295
	296	return size;
47dbdbff	297	}
46a58c44 GKH	298	static DEVICE_ATTR(actual_profile, 0660,
	299	koneplus_sysfs_show_actual_profile,
	300	koneplus_sysfs_set_actual_profile);
	301	static DEVICE_ATTR(startup_profile, 0660,
	302	koneplus_sysfs_show_actual_profile,
	303	koneplus_sysfs_set_actual_profile);
47dbdbff SA	304
	305	static ssize_t koneplus_sysfs_show_firmware_version(struct device *dev,
	306	struct device_attribute attr, char buf)
	307	{
f114fec5 SA	308	struct koneplus_device *koneplus;
	309	struct usb_device *usb_dev;
	310	struct koneplus_info info;
	311
	312	dev = dev->parent->parent;
	313	koneplus = hid_get_drvdata(dev_get_drvdata(dev));
	314	usb_dev = interface_to_usbdev(to_usb_interface(dev));
	315
	316	mutex_lock(&koneplus->koneplus_lock);
	317	roccat_common2_receive(usb_dev, KONEPLUS_COMMAND_INFO,
	318	&info, KONEPLUS_SIZE_INFO);
	319	mutex_unlock(&koneplus->koneplus_lock);
	320
	321	return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
47dbdbff	322	}
46a58c44 GKH	323	static DEVICE_ATTR(firmware_version, 0440,
	324	koneplus_sysfs_show_firmware_version, NULL);
	325
	326	static struct attribute *koneplus_attrs[] = {
	327	&dev_attr_actual_profile.attr,
	328	&dev_attr_startup_profile.attr,
	329	&dev_attr_firmware_version.attr,
	330	NULL,
47dbdbff	331	};
eb3156e0 GKH	332
	333	static struct bin_attribute *koneplus_bin_attributes[] = {
	334	&bin_attr_control,
	335	&bin_attr_talk,
	336	&bin_attr_macro,
	337	&bin_attr_tcu_image,
	338	&bin_attr_info,
	339	&bin_attr_sensor,
	340	&bin_attr_tcu,
	341	&bin_attr_profile_settings,
	342	&bin_attr_profile_buttons,
	343	&bin_attr_profile1_settings,
	344	&bin_attr_profile2_settings,
	345	&bin_attr_profile3_settings,
	346	&bin_attr_profile4_settings,
	347	&bin_attr_profile5_settings,
	348	&bin_attr_profile1_buttons,
	349	&bin_attr_profile2_buttons,
	350	&bin_attr_profile3_buttons,
	351	&bin_attr_profile4_buttons,
	352	&bin_attr_profile5_buttons,
	353	NULL,
	354	};
	355
	356	static const struct attribute_group koneplus_group = {
	357	.attrs = koneplus_attrs,
	358	.bin_attrs = koneplus_bin_attributes,
	359	};
	360
	361	static const struct attribute_group *koneplus_groups[] = {
	362	&koneplus_group,
	363	NULL,
47dbdbff SA	364	};
	365
	366	static int koneplus_init_koneplus_device_struct(struct usb_device *usb_dev,
	367	struct koneplus_device *koneplus)
	368	{
f114fec5	369	int retval;
47dbdbff SA	370
	371	mutex_init(&koneplus->koneplus_lock);
	372
b50f315c SA	373	retval = koneplus_get_actual_profile(usb_dev);
	374	if (retval < 0)
	375	return retval;
	376	koneplus_profile_activated(koneplus, retval);
47dbdbff SA	377
	378	return 0;
	379	}
	380
	381	static int koneplus_init_specials(struct hid_device *hdev)
	382	{
	383	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	384	struct usb_device *usb_dev = interface_to_usbdev(intf);
	385	struct koneplus_device *koneplus;
	386	int retval;
	387
	388	if (intf->cur_altsetting->desc.bInterfaceProtocol
	389	== USB_INTERFACE_PROTOCOL_MOUSE) {
	390
	391	koneplus = kzalloc(sizeof(*koneplus), GFP_KERNEL);
	392	if (!koneplus) {
a28764ef	393	hid_err(hdev, "can't alloc device descriptor\n");
47dbdbff SA	394	return -ENOMEM;
	395	}
	396	hid_set_drvdata(hdev, koneplus);
	397
	398	retval = koneplus_init_koneplus_device_struct(usb_dev, koneplus);
	399	if (retval) {
a28764ef	400	hid_err(hdev, "couldn't init struct koneplus_device\n");
47dbdbff SA	401	goto exit_free;
	402	}
	403
8211e460 SA	404	retval = roccat_connect(koneplus_class, hdev,
8211e460 SA	405	sizeof(struct koneplus_roccat_report));
47dbdbff	406	if (retval < 0) {
a28764ef	407	hid_err(hdev, "couldn't init char dev\n");
47dbdbff SA	408	} else {
	409	koneplus->chrdev_minor = retval;
	410	koneplus->roccat_claimed = 1;
	411	}
	412	} else {
	413	hid_set_drvdata(hdev, NULL);
	414	}
	415
	416	return 0;
	417	exit_free:
	418	kfree(koneplus);
	419	return retval;
	420	}
	421
	422	static void koneplus_remove_specials(struct hid_device *hdev)
	423	{
	424	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	425	struct koneplus_device *koneplus;
	426
	427	if (intf->cur_altsetting->desc.bInterfaceProtocol
	428	== USB_INTERFACE_PROTOCOL_MOUSE) {
	429	koneplus = hid_get_drvdata(hdev);
	430	if (koneplus->roccat_claimed)
	431	roccat_disconnect(koneplus->chrdev_minor);
	432	kfree(koneplus);
	433	}
	434	}
	435
	436	static int koneplus_probe(struct hid_device *hdev,
	437	const struct hid_device_id *id)
	438	{
	439	int retval;
	440
	441	retval = hid_parse(hdev);
	442	if (retval) {
a28764ef	443	hid_err(hdev, "parse failed\n");
47dbdbff SA	444	goto exit;
	445	}
	446
	447	retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	448	if (retval) {
a28764ef	449	hid_err(hdev, "hw start failed\n");
47dbdbff SA	450	goto exit;
	451	}
	452
	453	retval = koneplus_init_specials(hdev);
	454	if (retval) {
a28764ef	455	hid_err(hdev, "couldn't install mouse\n");
47dbdbff SA	456	goto exit_stop;
	457	}
	458
	459	return 0;
	460
	461	exit_stop:
	462	hid_hw_stop(hdev);
	463	exit:
	464	return retval;
	465	}
	466
	467	static void koneplus_remove(struct hid_device *hdev)
	468	{
	469	koneplus_remove_specials(hdev);
	470	hid_hw_stop(hdev);
	471	}
	472
	473	static void koneplus_keep_values_up_to_date(struct koneplus_device *koneplus,
	474	u8 const *data)
	475	{
	476	struct koneplus_mouse_report_button const *button_report;
	477
	478	switch (data[0]) {
	479	case KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON:
	480	button_report = (struct koneplus_mouse_report_button const *)data;
	481	switch (button_report->type) {
	482	case KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_PROFILE:
	483	koneplus_profile_activated(koneplus, button_report->data1 - 1);
	484	break;
	485	}
	486	break;
	487	}
	488	}
	489
	490	static void koneplus_report_to_chrdev(struct koneplus_device const *koneplus,
	491	u8 const *data)
	492	{
	493	struct koneplus_roccat_report roccat_report;
	494	struct koneplus_mouse_report_button const *button_report;
	495
	496	if (data[0] != KONEPLUS_MOUSE_REPORT_NUMBER_BUTTON)
	497	return;
	498
	499	button_report = (struct koneplus_mouse_report_button const *)data;
	500
	501	if ((button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_QUICKLAUNCH \|\|
	502	button_report->type == KONEPLUS_MOUSE_REPORT_BUTTON_TYPE_TIMER) &&
	503	button_report->data2 != KONEPLUS_MOUSE_REPORT_BUTTON_ACTION_PRESS)
	504	return;
	505
	506	roccat_report.type = button_report->type;
	507	roccat_report.data1 = button_report->data1;
	508	roccat_report.data2 = button_report->data2;
	509	roccat_report.profile = koneplus->actual_profile + 1;
	510	roccat_report_event(koneplus->chrdev_minor,
8211e460	511	(uint8_t const *)&roccat_report);
47dbdbff SA	512	}
	513
	514	static int koneplus_raw_event(struct hid_device *hdev,
	515	struct hid_report report, u8 data, int size)
	516	{
	517	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	518	struct koneplus_device *koneplus = hid_get_drvdata(hdev);
	519
	520	if (intf->cur_altsetting->desc.bInterfaceProtocol
	521	!= USB_INTERFACE_PROTOCOL_MOUSE)
	522	return 0;
	523
901e64db SA	524	if (koneplus == NULL)
	525	return 0;
	526
47dbdbff SA	527	koneplus_keep_values_up_to_date(koneplus, data);
	528
	529	if (koneplus->roccat_claimed)
	530	koneplus_report_to_chrdev(koneplus, data);
	531
	532	return 0;
	533	}
	534
	535	static const struct hid_device_id koneplus_devices[] = {
	536	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPLUS) },
8e74a2d3	537	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEXTD) },
47dbdbff SA	538	{ }
	539	};
	540
	541	MODULE_DEVICE_TABLE(hid, koneplus_devices);
	542
	543	static struct hid_driver koneplus_driver = {
	544	.name = "koneplus",
	545	.id_table = koneplus_devices,
	546	.probe = koneplus_probe,
	547	.remove = koneplus_remove,
	548	.raw_event = koneplus_raw_event
	549	};
	550
	551	static int __init koneplus_init(void)
	552	{
	553	int retval;
	554
	555	/* class name has to be same as driver name */
	556	koneplus_class = class_create(THIS_MODULE, "koneplus");
	557	if (IS_ERR(koneplus_class))
	558	return PTR_ERR(koneplus_class);
46a58c44	559	koneplus_class->dev_groups = koneplus_groups;
47dbdbff SA	560
	561	retval = hid_register_driver(&koneplus_driver);
	562	if (retval)
	563	class_destroy(koneplus_class);
	564	return retval;
	565	}
	566
	567	static void __exit koneplus_exit(void)
	568	{
47dbdbff	569	hid_unregister_driver(&koneplus_driver);
74b643da	570	class_destroy(koneplus_class);
47dbdbff SA	571	}
	572
	573	module_init(koneplus_init);
	574	module_exit(koneplus_exit);
	575
	576	MODULE_AUTHOR("Stefan Achatz");
8e74a2d3	577	MODULE_DESCRIPTION("USB Roccat Kone[+]/XTD driver");
47dbdbff	578	MODULE_LICENSE("GPL v2");