[deliverable/linux.git] / drivers / hid / hid-gt683r.c

/*
 * MSI GT683R led driver
 *
 * Copyright (c) 2014 Janne Kanniainen <janne.kanniainen@gmail.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 <linux/device.h>
#include <linux/hid.h>
#include <linux/kernel.h>
#include <linux/leds.h>
#include <linux/module.h>

#include "hid-ids.h"

#define GT683R_BUFFER_SIZE			8

/*
 * GT683R_LED_OFF: all LEDs are off
 * GT683R_LED_AUDIO: LEDs brightness depends on sound level
 * GT683R_LED_BREATHING: LEDs brightness varies at human breathing rate
 * GT683R_LED_NORMAL: LEDs are fully on when enabled
 */
enum gt683r_led_mode {
	GT683R_LED_OFF = 0,
	GT683R_LED_AUDIO = 2,
	GT683R_LED_BREATHING = 3,
	GT683R_LED_NORMAL = 5
};

enum gt683r_panels {
	GT683R_LED_BACK = 0,
	GT683R_LED_SIDE = 1,
	GT683R_LED_FRONT = 2,
	GT683R_LED_COUNT,
};

static const char * const gt683r_panel_names[] = {
	"back",
	"side",
	"front",
};

struct gt683r_led {
	struct hid_device *hdev;
	struct led_classdev led_devs[GT683R_LED_COUNT];
	struct mutex lock;
	struct work_struct work;
	enum led_brightness brightnesses[GT683R_LED_COUNT];
	enum gt683r_led_mode mode;
};

static const struct hid_device_id gt683r_led_id[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_MSI, USB_DEVICE_ID_MSI_GT683R_LED_PANEL) },
	{ }
};

static void gt683r_brightness_set(struct led_classdev *led_cdev,
				enum led_brightness brightness)
{
	int i;
	struct device *dev = led_cdev->dev->parent;
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
	struct gt683r_led *led = hid_get_drvdata(hdev);

	for (i = 0; i < GT683R_LED_COUNT; i++) {
		if (led_cdev == &led->led_devs[i])
			break;
	}

	if (i < GT683R_LED_COUNT) {
		led->brightnesses[i] = brightness;
		schedule_work(&led->work);
	}
}

static ssize_t leds_mode_show(struct device *dev,
				struct device_attribute *attr,
				char *buf)
{
	u8 sysfs_mode;
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
	struct gt683r_led *led = hid_get_drvdata(hdev);

	if (led->mode == GT683R_LED_NORMAL)
		sysfs_mode = 0;
	else if (led->mode == GT683R_LED_AUDIO)
		sysfs_mode = 1;
	else
		sysfs_mode = 2;

	return scnprintf(buf, PAGE_SIZE, "%u\n", sysfs_mode);
}

static ssize_t leds_mode_store(struct device *dev,
				struct device_attribute *attr,
				const char *buf, size_t count)
{
	u8 sysfs_mode;
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
	struct gt683r_led *led = hid_get_drvdata(hdev);


	if (kstrtou8(buf, 10, &sysfs_mode) || sysfs_mode > 2)
		return -EINVAL;

	mutex_lock(&led->lock);

	if (sysfs_mode == 0)
		led->mode = GT683R_LED_NORMAL;
	else if (sysfs_mode == 1)
		led->mode = GT683R_LED_AUDIO;
	else
		led->mode = GT683R_LED_BREATHING;

	mutex_unlock(&led->lock);
	schedule_work(&led->work);

	return count;
}

static int gt683r_led_snd_msg(struct gt683r_led *led, u8 *msg)
{
	int ret;

	ret = hid_hw_raw_request(led->hdev, msg[0], msg, GT683R_BUFFER_SIZE,
				HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
	if (ret != GT683R_BUFFER_SIZE) {
		hid_err(led->hdev,
			"failed to send set report request: %i\n", ret);
		if (ret < 0)
			return ret;
		return -EIO;
	}

	return 0;
}

static int gt683r_leds_set(struct gt683r_led *led, u8 leds)
{
	int ret;
	u8 *buffer;

	buffer = kzalloc(GT683R_BUFFER_SIZE, GFP_KERNEL);
	if (!buffer)
		return -ENOMEM;

	buffer[0] = 0x01;
	buffer[1] = 0x02;
	buffer[2] = 0x30;
	buffer[3] = leds;
	ret = gt683r_led_snd_msg(led, buffer);

	kfree(buffer);
	return ret;
}

static int gt683r_mode_set(struct gt683r_led *led, u8 mode)
{
	int ret;
	u8 *buffer;

	buffer = kzalloc(GT683R_BUFFER_SIZE, GFP_KERNEL);
	if (!buffer)
		return -ENOMEM;

	buffer[0] = 0x01;
	buffer[1] = 0x02;
	buffer[2] = 0x20;
	buffer[3] = mode;
	buffer[4] = 0x01;
	ret = gt683r_led_snd_msg(led, buffer);

	kfree(buffer);
	return ret;
}

static void gt683r_led_work(struct work_struct *work)
{
	int i;
	u8 leds = 0;
	u8 mode;
	struct gt683r_led *led = container_of(work, struct gt683r_led, work);

	mutex_lock(&led->lock);

	for (i = 0; i < GT683R_LED_COUNT; i++) {
		if (led->brightnesses[i])
			leds |= BIT(i);
	}

	if (gt683r_leds_set(led, leds))
		goto fail;

	if (leds)
		mode = led->mode;
	else
		mode = GT683R_LED_OFF;

	gt683r_mode_set(led, mode);
fail:
	mutex_unlock(&led->lock);
}

static DEVICE_ATTR_RW(leds_mode);

static int gt683r_led_probe(struct hid_device *hdev,
			const struct hid_device_id *id)
{
	int i;
	int ret;
	int name_sz;
	char *name;
	struct gt683r_led *led;

	led = devm_kzalloc(&hdev->dev, sizeof(*led), GFP_KERNEL);
	if (!led)
		return -ENOMEM;

	mutex_init(&led->lock);
	INIT_WORK(&led->work, gt683r_led_work);

	led->mode = GT683R_LED_NORMAL;
	led->hdev = hdev;
	hid_set_drvdata(hdev, led);

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "hid parsing failed\n");
		return ret;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		return ret;
	}

	for (i = 0; i < GT683R_LED_COUNT; i++) {
		name_sz = strlen(dev_name(&hdev->dev)) +
				strlen(gt683r_panel_names[i]) + 3;

		name = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
		if (!name) {
			ret = -ENOMEM;
			goto fail;
		}

		snprintf(name, name_sz, "%s::%s",
				dev_name(&hdev->dev), gt683r_panel_names[i]);
		led->led_devs[i].name = name;
		led->led_devs[i].max_brightness = 1;
		led->led_devs[i].brightness_set = gt683r_brightness_set;
		ret = led_classdev_register(&hdev->dev, &led->led_devs[i]);
		if (ret) {
			hid_err(hdev, "could not register led device\n");
			goto fail;
		}
	}

	ret = device_create_file(&led->hdev->dev, &dev_attr_leds_mode);
	if (ret) {
		hid_err(hdev, "could not make mode attribute file\n");
		goto fail;
	}

	return 0;

fail:
	for (i = i - 1; i >= 0; i--)
		led_classdev_unregister(&led->led_devs[i]);
	hid_hw_stop(hdev);
	return ret;
}

static void gt683r_led_remove(struct hid_device *hdev)
{
	int i;
	struct gt683r_led *led = hid_get_drvdata(hdev);

	device_remove_file(&hdev->dev, &dev_attr_leds_mode);
	for (i = 0; i < GT683R_LED_COUNT; i++)
		led_classdev_unregister(&led->led_devs[i]);
	flush_work(&led->work);
	hid_hw_stop(hdev);
}

static struct hid_driver gt683r_led_driver = {
	.probe = gt683r_led_probe,
	.remove = gt683r_led_remove,
	.name = "gt683r_led",
	.id_table = gt683r_led_id,
};

module_hid_driver(gt683r_led_driver);

MODULE_AUTHOR("Janne Kanniainen");
MODULE_DESCRIPTION("MSI GT683R led driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
f471d948 JK	1	/*
	2	* MSI GT683R led driver
	3	*
	4	* Copyright (c) 2014 Janne Kanniainen <janne.kanniainen@gmail.com>
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License as
	8	* published by the Free Software Foundation; either version 2 of
	9	* the License, or (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	*/
	17
	18	#include <linux/device.h>
	19	#include <linux/hid.h>
	20	#include <linux/kernel.h>
	21	#include <linux/leds.h>
	22	#include <linux/module.h>
	23
	24	#include "hid-ids.h"
	25
	26	#define GT683R_BUFFER_SIZE 8
	27
	28	/*
	29	* GT683R_LED_OFF: all LEDs are off
	30	* GT683R_LED_AUDIO: LEDs brightness depends on sound level
	31	* GT683R_LED_BREATHING: LEDs brightness varies at human breathing rate
	32	* GT683R_LED_NORMAL: LEDs are fully on when enabled
	33	*/
	34	enum gt683r_led_mode {
	35	GT683R_LED_OFF = 0,
	36	GT683R_LED_AUDIO = 2,
	37	GT683R_LED_BREATHING = 3,
	38	GT683R_LED_NORMAL = 5
	39	};
	40
	41	enum gt683r_panels {
	42	GT683R_LED_BACK = 0,
	43	GT683R_LED_SIDE = 1,
	44	GT683R_LED_FRONT = 2,
	45	GT683R_LED_COUNT,
	46	};
	47
	48	static const char * const gt683r_panel_names[] = {
	49	"back",
	50	"side",
	51	"front",
	52	};
	53
	54	struct gt683r_led {
	55	struct hid_device *hdev;
	56	struct led_classdev led_devs[GT683R_LED_COUNT];
	57	struct mutex lock;
	58	struct work_struct work;
	59	enum led_brightness brightnesses[GT683R_LED_COUNT];
	60	enum gt683r_led_mode mode;
	61	};
	62
	63	static const struct hid_device_id gt683r_led_id[] = {
	64	{ HID_USB_DEVICE(USB_VENDOR_ID_MSI, USB_DEVICE_ID_MSI_GT683R_LED_PANEL) },
65	{ }
66	};
67
68	static void gt683r_brightness_set(struct led_classdev *led_cdev,
69	enum led_brightness brightness)
70	{
71	int i;
72	struct device *dev = led_cdev->dev->parent;
73	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
74	struct gt683r_led *led = hid_get_drvdata(hdev);
75
76	for (i = 0; i < GT683R_LED_COUNT; i++) {
77	if (led_cdev == &led->led_devs[i])
78	break;
79	}
80
81	if (i < GT683R_LED_COUNT) {
82	led->brightnesses[i] = brightness;
83	schedule_work(&led->work);
84	}
85	}
86
87	static ssize_t leds_mode_show(struct device *dev,
88	struct device_attribute *attr,
89	char *buf)
90	{
91	u8 sysfs_mode;
92	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
93	struct gt683r_led *led = hid_get_drvdata(hdev);
94
95	if (led->mode == GT683R_LED_NORMAL)
96	sysfs_mode = 0;
97	else if (led->mode == GT683R_LED_AUDIO)
98	sysfs_mode = 1;
99	else
100	sysfs_mode = 2;
101
102	return scnprintf(buf, PAGE_SIZE, "%u\n", sysfs_mode);
103	}
104
105	static ssize_t leds_mode_store(struct device *dev,
106	struct device_attribute *attr,
107	const char *buf, size_t count)
108	{
109	u8 sysfs_mode;
110	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
111	struct gt683r_led *led = hid_get_drvdata(hdev);
112
113
114	if (kstrtou8(buf, 10, &sysfs_mode) \|\| sysfs_mode > 2)
115	return -EINVAL;
116
117	mutex_lock(&led->lock);
118
119	if (sysfs_mode == 0)
120	led->mode = GT683R_LED_NORMAL;
121	else if (sysfs_mode == 1)
122	led->mode = GT683R_LED_AUDIO;
123	else
124	led->mode = GT683R_LED_BREATHING;
125
126	mutex_unlock(&led->lock);
127	schedule_work(&led->work);
128
129	return count;
130	}
131
132	static int gt683r_led_snd_msg(struct gt683r_led led, u8 msg)
133	{
134	int ret;
135
136	ret = hid_hw_raw_request(led->hdev, msg[0], msg, GT683R_BUFFER_SIZE,
137	HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
138	if (ret != GT683R_BUFFER_SIZE) {
139	hid_err(led->hdev,
140	"failed to send set report request: %i\n", ret);
141	if (ret < 0)
142	return ret;
143	return -EIO;
144	}
145
146	return 0;
147	}
148
149	static int gt683r_leds_set(struct gt683r_led *led, u8 leds)
150	{
151	int ret;
152	u8 *buffer;
153
154	buffer = kzalloc(GT683R_BUFFER_SIZE, GFP_KERNEL);
155	if (!buffer)
156	return -ENOMEM;
157
158	buffer[0] = 0x01;
159	buffer[1] = 0x02;
160	buffer[2] = 0x30;
161	buffer[3] = leds;
162	ret = gt683r_led_snd_msg(led, buffer);
163
164	kfree(buffer);
165	return ret;
166	}
167
168	static int gt683r_mode_set(struct gt683r_led *led, u8 mode)
169	{
170	int ret;
171	u8 *buffer;
172
173	buffer = kzalloc(GT683R_BUFFER_SIZE, GFP_KERNEL);
174	if (!buffer)
175	return -ENOMEM;
176
177	buffer[0] = 0x01;
178	buffer[1] = 0x02;
179	buffer[2] = 0x20;
180	buffer[3] = mode;
181	buffer[4] = 0x01;
182	ret = gt683r_led_snd_msg(led, buffer);
183
184	kfree(buffer);
185	return ret;
186	}
187
188	static void gt683r_led_work(struct work_struct *work)
189	{
190	int i;
191	u8 leds = 0;
192	u8 mode;
193	struct gt683r_led *led = container_of(work, struct gt683r_led, work);
194
195	mutex_lock(&led->lock);
196
197	for (i = 0; i < GT683R_LED_COUNT; i++) {
198	if (led->brightnesses[i])
199	leds \|= BIT(i);
200	}
201
202	if (gt683r_leds_set(led, leds))
203	goto fail;
204
205	if (leds)
206	mode = led->mode;
207	else
208	mode = GT683R_LED_OFF;
209
210	gt683r_mode_set(led, mode);
211	fail:
212	mutex_unlock(&led->lock);
213	}
214
215	static DEVICE_ATTR_RW(leds_mode);
216
217	static int gt683r_led_probe(struct hid_device *hdev,
218	const struct hid_device_id *id)
219	{
220	int i;
221	int ret;
222	int name_sz;
223	char *name;
224	struct gt683r_led *led;
225
226	led = devm_kzalloc(&hdev->dev, sizeof(*led), GFP_KERNEL);
227	if (!led)
228	return -ENOMEM;
229
c3883ae9 JK	230	mutex_init(&led->lock);
	231	INIT_WORK(&led->work, gt683r_led_work);
	232
f471d948 JK	233	led->mode = GT683R_LED_NORMAL;
	234	led->hdev = hdev;
	235	hid_set_drvdata(hdev, led);
	236
	237	ret = hid_parse(hdev);
	238	if (ret) {
	239	hid_err(hdev, "hid parsing failed\n");
	240	return ret;
	241	}
	242
	243	ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
	244	if (ret) {
	245	hid_err(hdev, "hw start failed\n");
	246	return ret;
	247	}
	248
	249	for (i = 0; i < GT683R_LED_COUNT; i++) {
	250	name_sz = strlen(dev_name(&hdev->dev)) +
	251	strlen(gt683r_panel_names[i]) + 3;
	252
	253	name = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
	254	if (!name) {
	255	ret = -ENOMEM;
	256	goto fail;
	257	}
	258
	259	snprintf(name, name_sz, "%s::%s",
	260	dev_name(&hdev->dev), gt683r_panel_names[i]);
	261	led->led_devs[i].name = name;
	262	led->led_devs[i].max_brightness = 1;
	263	led->led_devs[i].brightness_set = gt683r_brightness_set;
	264	ret = led_classdev_register(&hdev->dev, &led->led_devs[i]);
	265	if (ret) {
	266	hid_err(hdev, "could not register led device\n");
	267	goto fail;
	268	}
	269	}
	270
	271	ret = device_create_file(&led->hdev->dev, &dev_attr_leds_mode);
	272	if (ret) {
	273	hid_err(hdev, "could not make mode attribute file\n");
	274	goto fail;
	275	}
	276
f471d948 JK	277	return 0;
	278
	279	fail:
	280	for (i = i - 1; i >= 0; i--)
	281	led_classdev_unregister(&led->led_devs[i]);
	282	hid_hw_stop(hdev);
	283	return ret;
	284	}
	285
	286	static void gt683r_led_remove(struct hid_device *hdev)
	287	{
	288	int i;
	289	struct gt683r_led *led = hid_get_drvdata(hdev);
	290
	291	device_remove_file(&hdev->dev, &dev_attr_leds_mode);
	292	for (i = 0; i < GT683R_LED_COUNT; i++)
	293	led_classdev_unregister(&led->led_devs[i]);
	294	flush_work(&led->work);
	295	hid_hw_stop(hdev);
	296	}
	297
	298	static struct hid_driver gt683r_led_driver = {
	299	.probe = gt683r_led_probe,
	300	.remove = gt683r_led_remove,
	301	.name = "gt683r_led",
	302	.id_table = gt683r_led_id,
	303	};
	304
	305	module_hid_driver(gt683r_led_driver);
	306
	307	MODULE_AUTHOR("Janne Kanniainen");
	308	MODULE_DESCRIPTION("MSI GT683R led driver");
	309	MODULE_LICENSE("GPL");