[linux-2.6-block.git] / drivers / hid / hid-thingm.c

/*
 * ThingM blink(1) USB RGB LED driver
 *
 * Copyright 2013-2014 Savoir-faire Linux Inc.
 *	Vivien Didelot <vivien.didelot@savoirfairelinux.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, version 2.
 */

#include <linux/hid.h>
#include <linux/hidraw.h>
#include <linux/leds.h>
#include <linux/module.h>
#include <linux/mutex.h>

#include "hid-ids.h"

#define REPORT_ID	1
#define REPORT_SIZE	9

/* Firmware major number of supported devices */
#define THINGM_MAJOR_MK1	'1'
#define THINGM_MAJOR_MK2	'2'

struct thingm_fwinfo {
	char major;
	unsigned numrgb;
	unsigned first;
};

static const struct thingm_fwinfo thingm_fwinfo[] = {
	{
		.major = THINGM_MAJOR_MK1,
		.numrgb = 1,
		.first = 0,
	}, {
		.major = THINGM_MAJOR_MK2,
		.numrgb = 2,
		.first = 1,
	}
};

/* A red, green or blue channel, part of an RGB chip */
struct thingm_led {
	struct thingm_rgb *rgb;
	struct led_classdev ldev;
	char name[32];
};

/* Basically a WS2812 5050 RGB LED chip */
struct thingm_rgb {
	struct thingm_device *tdev;
	struct thingm_led red;
	struct thingm_led green;
	struct thingm_led blue;
	u8 num;
};

struct thingm_device {
	struct hid_device *hdev;
	struct {
		char major;
		char minor;
	} version;
	const struct thingm_fwinfo *fwinfo;
	struct mutex lock;
	struct thingm_rgb *rgb;
};

static int thingm_send(struct thingm_device *tdev, u8 buf[REPORT_SIZE])
{
	int ret;

	hid_dbg(tdev->hdev, "-> %d %c %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx\n",
			buf[0], buf[1], buf[2], buf[3], buf[4],
			buf[5], buf[6], buf[7], buf[8]);

	ret = hid_hw_raw_request(tdev->hdev, buf[0], buf, REPORT_SIZE,
			HID_FEATURE_REPORT, HID_REQ_SET_REPORT);

	return ret < 0 ? ret : 0;
}

static int thingm_recv(struct thingm_device *tdev, u8 buf[REPORT_SIZE])
{
	int ret;

	ret = hid_hw_raw_request(tdev->hdev, buf[0], buf, REPORT_SIZE,
			HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
	if (ret < 0)
		return ret;

	hid_dbg(tdev->hdev, "<- %d %c %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx\n",
			buf[0], buf[1], buf[2], buf[3], buf[4],
			buf[5], buf[6], buf[7], buf[8]);

	return 0;
}

static int thingm_version(struct thingm_device *tdev)
{
	u8 buf[REPORT_SIZE] = { REPORT_ID, 'v', 0, 0, 0, 0, 0, 0, 0 };
	int err;

	err = thingm_send(tdev, buf);
	if (err)
		return err;

	err = thingm_recv(tdev, buf);
	if (err)
		return err;

	tdev->version.major = buf[3];
	tdev->version.minor = buf[4];

	return 0;
}

static int thingm_write_color(struct thingm_rgb *rgb)
{
	u8 buf[REPORT_SIZE] = { REPORT_ID, 'c', 0, 0, 0, 0, 0, rgb->num, 0 };

	buf[2] = rgb->red.ldev.brightness;
	buf[3] = rgb->green.ldev.brightness;
	buf[4] = rgb->blue.ldev.brightness;

	return thingm_send(rgb->tdev, buf);
}

static int thingm_led_set(struct led_classdev *ldev,
			  enum led_brightness brightness)
{
	struct thingm_led *led = container_of(ldev, struct thingm_led, ldev);
	int ret;

	mutex_lock(&led->rgb->tdev->lock);

	ret = thingm_write_color(led->rgb);
	if (ret)
		hid_err(led->rgb->tdev->hdev, "failed to write color\n");

	mutex_unlock(&led->rgb->tdev->lock);

	return ret;
}

static int thingm_init_rgb(struct thingm_rgb *rgb)
{
	const int minor = ((struct hidraw *) rgb->tdev->hdev->hidraw)->minor;
	int err;

	/* Register the red diode */
	snprintf(rgb->red.name, sizeof(rgb->red.name),
			"thingm%d:red:led%d", minor, rgb->num);
	rgb->red.ldev.name = rgb->red.name;
	rgb->red.ldev.max_brightness = 255;
	rgb->red.ldev.brightness_set_blocking = thingm_led_set;
	rgb->red.rgb = rgb;

	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->red.ldev);
	if (err)
		return err;

	/* Register the green diode */
	snprintf(rgb->green.name, sizeof(rgb->green.name),
			"thingm%d:green:led%d", minor, rgb->num);
	rgb->green.ldev.name = rgb->green.name;
	rgb->green.ldev.max_brightness = 255;
	rgb->green.ldev.brightness_set_blocking = thingm_led_set;
	rgb->green.rgb = rgb;

	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->green.ldev);
	if (err)
		goto unregister_red;

	/* Register the blue diode */
	snprintf(rgb->blue.name, sizeof(rgb->blue.name),
			"thingm%d:blue:led%d", minor, rgb->num);
	rgb->blue.ldev.name = rgb->blue.name;
	rgb->blue.ldev.max_brightness = 255;
	rgb->blue.ldev.brightness_set_blocking = thingm_led_set;
	rgb->blue.rgb = rgb;

	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->blue.ldev);
	if (err)
		goto unregister_green;

	return 0;

unregister_green:
	led_classdev_unregister(&rgb->green.ldev);

unregister_red:
	led_classdev_unregister(&rgb->red.ldev);

	return err;
}

static void thingm_remove_rgb(struct thingm_rgb *rgb)
{
	led_classdev_unregister(&rgb->red.ldev);
	led_classdev_unregister(&rgb->green.ldev);
	led_classdev_unregister(&rgb->blue.ldev);
}

static int thingm_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	struct thingm_device *tdev;
	int i, err;

	tdev = devm_kzalloc(&hdev->dev, sizeof(struct thingm_device),
			GFP_KERNEL);
	if (!tdev)
		return -ENOMEM;

	tdev->hdev = hdev;
	hid_set_drvdata(hdev, tdev);

	err = hid_parse(hdev);
	if (err)
		goto error;

	err = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
	if (err)
		goto error;

	mutex_init(&tdev->lock);

	err = thingm_version(tdev);
	if (err)
		goto stop;

	hid_dbg(hdev, "firmware version: %c.%c\n",
			tdev->version.major, tdev->version.minor);

	for (i = 0; i < ARRAY_SIZE(thingm_fwinfo) && !tdev->fwinfo; ++i)
		if (thingm_fwinfo[i].major == tdev->version.major)
			tdev->fwinfo = &thingm_fwinfo[i];

	if (!tdev->fwinfo) {
		hid_err(hdev, "unsupported firmware %c\n", tdev->version.major);
		err = -ENODEV;
		goto stop;
	}

	tdev->rgb = devm_kzalloc(&hdev->dev,
			sizeof(struct thingm_rgb) * tdev->fwinfo->numrgb,
			GFP_KERNEL);
	if (!tdev->rgb) {
		err = -ENOMEM;
		goto stop;
	}

	for (i = 0; i < tdev->fwinfo->numrgb; ++i) {
		struct thingm_rgb *rgb = tdev->rgb + i;

		rgb->tdev = tdev;
		rgb->num = tdev->fwinfo->first + i;
		err = thingm_init_rgb(rgb);
		if (err) {
			while (--i >= 0)
				thingm_remove_rgb(tdev->rgb + i);
			goto stop;
		}
	}

	return 0;
stop:
	hid_hw_stop(hdev);
error:
	return err;
}

static void thingm_remove(struct hid_device *hdev)
{
	struct thingm_device *tdev = hid_get_drvdata(hdev);
	int i;

	hid_hw_stop(hdev);

	for (i = 0; i < tdev->fwinfo->numrgb; ++i)
		thingm_remove_rgb(tdev->rgb + i);
}

static const struct hid_device_id thingm_table[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_THINGM, USB_DEVICE_ID_BLINK1) },
	{ }
};
MODULE_DEVICE_TABLE(hid, thingm_table);

static struct hid_driver thingm_driver = {
	.name = "thingm",
	.probe = thingm_probe,
	.remove = thingm_remove,
	.id_table = thingm_table,
};

module_hid_driver(thingm_driver);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Vivien Didelot <vivien.didelot@savoirfairelinux.com>");
MODULE_DESCRIPTION("ThingM blink(1) USB RGB LED driver");
Commit	Line	Data
30ba2fbd VD	1	/*
	2	* ThingM blink(1) USB RGB LED driver
	3	*
f70ed8a6	4	* Copyright 2013-2014 Savoir-faire Linux Inc.
30ba2fbd VD	5	* Vivien Didelot <vivien.didelot@savoirfairelinux.com>
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License as
	9	* published by the Free Software Foundation, version 2.
	10	*/
	11
	12	#include <linux/hid.h>
f70ed8a6	13	#include <linux/hidraw.h>
30ba2fbd VD	14	#include <linux/leds.h>
30ba2fbd VD	15	#include <linux/module.h>
f70ed8a6	16	#include <linux/mutex.h>
30ba2fbd VD	17
	18	#include "hid-ids.h"
	19
f70ed8a6 VD	20	#define REPORT_ID 1
f70ed8a6 VD	21	#define REPORT_SIZE 9
30ba2fbd	22
f70ed8a6 VD	23	/* Firmware major number of supported devices */
f70ed8a6 VD	24	#define THINGM_MAJOR_MK1 '1'
3121b1c4	25	#define THINGM_MAJOR_MK2 '2'
30ba2fbd	26
f70ed8a6 VD	27	struct thingm_fwinfo {
	28	char major;
	29	unsigned numrgb;
	30	unsigned first;
	31	};
	32
e4aecaf2	33	static const struct thingm_fwinfo thingm_fwinfo[] = {
f70ed8a6 VD	34	{
	35	.major = THINGM_MAJOR_MK1,
	36	.numrgb = 1,
	37	.first = 0,
3121b1c4 VD	38	}, {
	39	.major = THINGM_MAJOR_MK2,
	40	.numrgb = 2,
	41	.first = 1,
f70ed8a6 VD	42	}
	43	};
	44
	45	/* A red, green or blue channel, part of an RGB chip */
	46	struct thingm_led {
	47	struct thingm_rgb *rgb;
	48	struct led_classdev ldev;
	49	char name[32];
	50	};
	51
	52	/* Basically a WS2812 5050 RGB LED chip */
	53	struct thingm_rgb {
	54	struct thingm_device *tdev;
	55	struct thingm_led red;
	56	struct thingm_led green;
	57	struct thingm_led blue;
f70ed8a6 VD	58	u8 num;
	59	};
	60
	61	struct thingm_device {
30ba2fbd	62	struct hid_device *hdev;
f70ed8a6 VD	63	struct {
	64	char major;
	65	char minor;
	66	} version;
	67	const struct thingm_fwinfo *fwinfo;
	68	struct mutex lock;
	69	struct thingm_rgb *rgb;
30ba2fbd VD	70	};
30ba2fbd VD	71
f70ed8a6	72	static int thingm_send(struct thingm_device *tdev, u8 buf[REPORT_SIZE])
30ba2fbd VD	73	{
	74	int ret;
	75
f70ed8a6	76	hid_dbg(tdev->hdev, "-> %d %c %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx\n",
30ba2fbd VD	77	buf[0], buf[1], buf[2], buf[3], buf[4],
	78	buf[5], buf[6], buf[7], buf[8]);
	79
f70ed8a6 VD	80	ret = hid_hw_raw_request(tdev->hdev, buf[0], buf, REPORT_SIZE,
f70ed8a6 VD	81	HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
30ba2fbd VD	82
	83	return ret < 0 ? ret : 0;
	84	}
	85
f70ed8a6	86	static int thingm_recv(struct thingm_device *tdev, u8 buf[REPORT_SIZE])
30ba2fbd	87	{
f70ed8a6	88	int ret;
30ba2fbd	89
f70ed8a6 VD	90	ret = hid_hw_raw_request(tdev->hdev, buf[0], buf, REPORT_SIZE,
	91	HID_FEATURE_REPORT, HID_REQ_GET_REPORT);
	92	if (ret < 0)
	93	return ret;
30ba2fbd	94
f70ed8a6 VD	95	hid_dbg(tdev->hdev, "<- %d %c %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx %02hhx\n",
	96	buf[0], buf[1], buf[2], buf[3], buf[4],
	97	buf[5], buf[6], buf[7], buf[8]);
30ba2fbd	98
f70ed8a6	99	return 0;
30ba2fbd VD	100	}
30ba2fbd VD	101
f70ed8a6	102	static int thingm_version(struct thingm_device *tdev)
30ba2fbd	103	{
f70ed8a6 VD	104	u8 buf[REPORT_SIZE] = { REPORT_ID, 'v', 0, 0, 0, 0, 0, 0, 0 };
	105	int err;
	106
	107	err = thingm_send(tdev, buf);
	108	if (err)
	109	return err;
	110
	111	err = thingm_recv(tdev, buf);
	112	if (err)
	113	return err;
30ba2fbd	114
f70ed8a6 VD	115	tdev->version.major = buf[3];
	116	tdev->version.minor = buf[4];
	117
	118	return 0;
30ba2fbd VD	119	}
30ba2fbd VD	120
f70ed8a6	121	static int thingm_write_color(struct thingm_rgb *rgb)
30ba2fbd	122	{
3121b1c4	123	u8 buf[REPORT_SIZE] = { REPORT_ID, 'c', 0, 0, 0, 0, 0, rgb->num, 0 };
f70ed8a6 VD	124
	125	buf[2] = rgb->red.ldev.brightness;
	126	buf[3] = rgb->green.ldev.brightness;
	127	buf[4] = rgb->blue.ldev.brightness;
30ba2fbd	128
f70ed8a6	129	return thingm_send(rgb->tdev, buf);
30ba2fbd VD	130	}
30ba2fbd VD	131
3de68ce9 HK	132	static int thingm_led_set(struct led_classdev *ldev,
3de68ce9 HK	133	enum led_brightness brightness)
30ba2fbd	134	{
3de68ce9 HK	135	struct thingm_led *led = container_of(ldev, struct thingm_led, ldev);
3de68ce9 HK	136	int ret;
30ba2fbd	137
3de68ce9	138	mutex_lock(&led->rgb->tdev->lock);
f70ed8a6	139
3de68ce9 HK	140	ret = thingm_write_color(led->rgb);
	141	if (ret)
	142	hid_err(led->rgb->tdev->hdev, "failed to write color\n");
f70ed8a6	143
3de68ce9	144	mutex_unlock(&led->rgb->tdev->lock);
30ba2fbd	145
3de68ce9	146	return ret;
f70ed8a6	147	}
30ba2fbd	148
f70ed8a6 VD	149	static int thingm_init_rgb(struct thingm_rgb *rgb)
	150	{
	151	const int minor = ((struct hidraw *) rgb->tdev->hdev->hidraw)->minor;
	152	int err;
	153
	154	/* Register the red diode */
	155	snprintf(rgb->red.name, sizeof(rgb->red.name),
	156	"thingm%d:red:led%d", minor, rgb->num);
	157	rgb->red.ldev.name = rgb->red.name;
	158	rgb->red.ldev.max_brightness = 255;
3de68ce9	159	rgb->red.ldev.brightness_set_blocking = thingm_led_set;
f70ed8a6 VD	160	rgb->red.rgb = rgb;
	161
	162	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->red.ldev);
	163	if (err)
	164	return err;
	165
	166	/* Register the green diode */
	167	snprintf(rgb->green.name, sizeof(rgb->green.name),
	168	"thingm%d:green:led%d", minor, rgb->num);
	169	rgb->green.ldev.name = rgb->green.name;
	170	rgb->green.ldev.max_brightness = 255;
3de68ce9	171	rgb->green.ldev.brightness_set_blocking = thingm_led_set;
f70ed8a6 VD	172	rgb->green.rgb = rgb;
	173
	174	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->green.ldev);
	175	if (err)
	176	goto unregister_red;
	177
	178	/* Register the blue diode */
	179	snprintf(rgb->blue.name, sizeof(rgb->blue.name),
	180	"thingm%d:blue:led%d", minor, rgb->num);
	181	rgb->blue.ldev.name = rgb->blue.name;
	182	rgb->blue.ldev.max_brightness = 255;
3de68ce9	183	rgb->blue.ldev.brightness_set_blocking = thingm_led_set;
f70ed8a6 VD	184	rgb->blue.rgb = rgb;
	185
	186	err = led_classdev_register(&rgb->tdev->hdev->dev, &rgb->blue.ldev);
	187	if (err)
	188	goto unregister_green;
	189
f70ed8a6	190	return 0;
30ba2fbd	191
f70ed8a6 VD	192	unregister_green:
f70ed8a6 VD	193	led_classdev_unregister(&rgb->green.ldev);
30ba2fbd	194
f70ed8a6 VD	195	unregister_red:
f70ed8a6 VD	196	led_classdev_unregister(&rgb->red.ldev);
30ba2fbd	197
f70ed8a6 VD	198	return err;
	199	}
	200
	201	static void thingm_remove_rgb(struct thingm_rgb *rgb)
	202	{
f70ed8a6 VD	203	led_classdev_unregister(&rgb->red.ldev);
	204	led_classdev_unregister(&rgb->green.ldev);
	205	led_classdev_unregister(&rgb->blue.ldev);
	206	}
30ba2fbd VD	207
	208	static int thingm_probe(struct hid_device hdev, const struct hid_device_id id)
	209	{
f70ed8a6 VD	210	struct thingm_device *tdev;
f70ed8a6 VD	211	int i, err;
30ba2fbd	212
f70ed8a6 VD	213	tdev = devm_kzalloc(&hdev->dev, sizeof(struct thingm_device),
	214	GFP_KERNEL);
	215	if (!tdev)
30ba2fbd VD	216	return -ENOMEM;
30ba2fbd VD	217
f70ed8a6 VD	218	tdev->hdev = hdev;
f70ed8a6 VD	219	hid_set_drvdata(hdev, tdev);
30ba2fbd	220
f70ed8a6 VD	221	err = hid_parse(hdev);
f70ed8a6 VD	222	if (err)
30ba2fbd VD	223	goto error;
30ba2fbd VD	224
f70ed8a6 VD	225	err = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
f70ed8a6 VD	226	if (err)
30ba2fbd VD	227	goto error;
30ba2fbd VD	228
f70ed8a6 VD	229	mutex_init(&tdev->lock);
	230
	231	err = thingm_version(tdev);
	232	if (err)
30ba2fbd VD	233	goto stop;
30ba2fbd VD	234
f70ed8a6 VD	235	hid_dbg(hdev, "firmware version: %c.%c\n",
f70ed8a6 VD	236	tdev->version.major, tdev->version.minor);
30ba2fbd	237
f70ed8a6 VD	238	for (i = 0; i < ARRAY_SIZE(thingm_fwinfo) && !tdev->fwinfo; ++i)
	239	if (thingm_fwinfo[i].major == tdev->version.major)
	240	tdev->fwinfo = &thingm_fwinfo[i];
	241
	242	if (!tdev->fwinfo) {
	243	hid_err(hdev, "unsupported firmware %c\n", tdev->version.major);
e4cf19ff	244	err = -ENODEV;
f70ed8a6 VD	245	goto stop;
	246	}
	247
	248	tdev->rgb = devm_kzalloc(&hdev->dev,
	249	sizeof(struct thingm_rgb) * tdev->fwinfo->numrgb,
	250	GFP_KERNEL);
	251	if (!tdev->rgb) {
	252	err = -ENOMEM;
	253	goto stop;
	254	}
	255
	256	for (i = 0; i < tdev->fwinfo->numrgb; ++i) {
	257	struct thingm_rgb *rgb = tdev->rgb + i;
	258
	259	rgb->tdev = tdev;
	260	rgb->num = tdev->fwinfo->first + i;
	261	err = thingm_init_rgb(rgb);
	262	if (err) {
	263	while (--i >= 0)
	264	thingm_remove_rgb(tdev->rgb + i);
	265	goto stop;
	266	}
	267	}
30ba2fbd	268
f70ed8a6	269	return 0;
30ba2fbd VD	270	stop:
	271	hid_hw_stop(hdev);
	272	error:
f70ed8a6	273	return err;
30ba2fbd VD	274	}
	275
	276	static void thingm_remove(struct hid_device *hdev)
	277	{
f70ed8a6 VD	278	struct thingm_device *tdev = hid_get_drvdata(hdev);
	279	int i;
	280
67a97845 JK	281	hid_hw_stop(hdev);
67a97845 JK	282
f70ed8a6 VD	283	for (i = 0; i < tdev->fwinfo->numrgb; ++i)
f70ed8a6 VD	284	thingm_remove_rgb(tdev->rgb + i);
30ba2fbd VD	285	}
	286
	287	static const struct hid_device_id thingm_table[] = {
	288	{ HID_USB_DEVICE(USB_VENDOR_ID_THINGM, USB_DEVICE_ID_BLINK1) },
	289	{ }
	290	};
	291	MODULE_DEVICE_TABLE(hid, thingm_table);
	292
	293	static struct hid_driver thingm_driver = {
	294	.name = "thingm",
	295	.probe = thingm_probe,
	296	.remove = thingm_remove,
	297	.id_table = thingm_table,
	298	};
	299
	300	module_hid_driver(thingm_driver);
	301
	302	MODULE_LICENSE("GPL");
	303	MODULE_AUTHOR("Vivien Didelot <vivien.didelot@savoirfairelinux.com>");
	304	MODULE_DESCRIPTION("ThingM blink(1) USB RGB LED driver");