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

/*
 * Simple USB RGB LED driver
 *
 * Copyright 2016 Heiner Kallweit <hkallweit1@gmail.com>
 * Based on drivers/hid/hid-thingm.c and
 * drivers/usb/misc/usbled.c
 *
 * 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"

enum hidled_report_type {
	RAW_REQUEST,
	OUTPUT_REPORT
};

enum hidled_type {
	RISO_KAGAKU,
	DREAM_CHEEKY,
};

static unsigned const char riso_kagaku_tbl[] = {
/* R+2G+4B -> riso kagaku color index */
	[0] = 0, /* black   */
	[1] = 2, /* red     */
	[2] = 1, /* green   */
	[3] = 5, /* yellow  */
	[4] = 3, /* blue    */
	[5] = 6, /* magenta */
	[6] = 4, /* cyan    */
	[7] = 7  /* white   */
};

#define RISO_KAGAKU_IX(r, g, b) riso_kagaku_tbl[((r)?1:0)+((g)?2:0)+((b)?4:0)]

struct hidled_device;
struct hidled_rgb;

struct hidled_config {
	enum hidled_type	type;
	const char		*name;
	const char		*short_name;
	enum led_brightness	max_brightness;
	int			num_leds;
	size_t			report_size;
	enum hidled_report_type	report_type;
	u8			report_id;
	int (*init)(struct hidled_device *ldev);
	int (*write)(struct led_classdev *cdev, enum led_brightness br);
};

struct hidled_led {
	struct led_classdev	cdev;
	struct hidled_rgb	*rgb;
	char			name[32];
};

struct hidled_rgb {
	struct hidled_device	*ldev;
	struct hidled_led	red;
	struct hidled_led	green;
	struct hidled_led	blue;
	u8			num;
};

struct hidled_device {
	const struct hidled_config *config;
	struct hid_device       *hdev;
	struct hidled_rgb	*rgb;
	struct mutex		lock;
};

#define MAX_REPORT_SIZE		16

#define to_hidled_led(arg) container_of(arg, struct hidled_led, cdev)

static bool riso_kagaku_switch_green_blue;
module_param(riso_kagaku_switch_green_blue, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(riso_kagaku_switch_green_blue,
	"switch green and blue RGB component for Riso Kagaku devices");

static int hidled_send(struct hidled_device *ldev, __u8 *buf)
{
	int ret;

	buf[0] = ldev->config->report_id;

	mutex_lock(&ldev->lock);

	if (ldev->config->report_type == RAW_REQUEST)
		ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
					 ldev->config->report_size,
					 HID_FEATURE_REPORT,
					 HID_REQ_SET_REPORT);
	else if (ldev->config->report_type == OUTPUT_REPORT)
		ret = hid_hw_output_report(ldev->hdev, buf,
					   ldev->config->report_size);
	else
		ret = -EINVAL;

	mutex_unlock(&ldev->lock);

	if (ret < 0)
		return ret;

	return ret == ldev->config->report_size ? 0 : -EMSGSIZE;
}

/* reading data is supported for report type RAW_REQUEST only */
static int hidled_recv(struct hidled_device *ldev, __u8 *buf)
{
	int ret;

	if (ldev->config->report_type != RAW_REQUEST)
		return -EINVAL;

	buf[0] = ldev->config->report_id;

	mutex_lock(&ldev->lock);

	ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
				 ldev->config->report_size,
				 HID_FEATURE_REPORT,
				 HID_REQ_SET_REPORT);
	if (ret < 0)
		goto err;

	ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
				 ldev->config->report_size,
				 HID_FEATURE_REPORT,
				 HID_REQ_GET_REPORT);
err:
	mutex_unlock(&ldev->lock);

	return ret < 0 ? ret : 0;
}

static u8 riso_kagaku_index(struct hidled_rgb *rgb)
{
	enum led_brightness r, g, b;

	r = rgb->red.cdev.brightness;
	g = rgb->green.cdev.brightness;
	b = rgb->blue.cdev.brightness;

	if (riso_kagaku_switch_green_blue)
		return RISO_KAGAKU_IX(r, b, g);
	else
		return RISO_KAGAKU_IX(r, g, b);
}

static int riso_kagaku_write(struct led_classdev *cdev, enum led_brightness br)
{
	struct hidled_led *led = to_hidled_led(cdev);
	struct hidled_rgb *rgb = led->rgb;
	__u8 buf[MAX_REPORT_SIZE] = {};

	buf[1] = riso_kagaku_index(rgb);

	return hidled_send(rgb->ldev, buf);
}

static int dream_cheeky_write(struct led_classdev *cdev, enum led_brightness br)
{
	struct hidled_led *led = to_hidled_led(cdev);
	struct hidled_rgb *rgb = led->rgb;
	__u8 buf[MAX_REPORT_SIZE] = {};

	buf[1] = rgb->red.cdev.brightness;
	buf[2] = rgb->green.cdev.brightness;
	buf[3] = rgb->blue.cdev.brightness;
	buf[7] = 0x1a;
	buf[8] = 0x05;

	return hidled_send(rgb->ldev, buf);
}

static int dream_cheeky_init(struct hidled_device *ldev)
{
	__u8 buf[MAX_REPORT_SIZE] = {};

	/* Dream Cheeky magic */
	buf[1] = 0x1f;
	buf[2] = 0x02;
	buf[4] = 0x5f;
	buf[7] = 0x1a;
	buf[8] = 0x03;

	return hidled_send(ldev, buf);
}

static const struct hidled_config hidled_configs[] = {
	{
		.type = RISO_KAGAKU,
		.name = "Riso Kagaku Webmail Notifier",
		.short_name = "riso_kagaku",
		.max_brightness = 1,
		.num_leds = 1,
		.report_size = 6,
		.report_type = OUTPUT_REPORT,
		.report_id = 0,
		.write = riso_kagaku_write,
	},
	{
		.type = DREAM_CHEEKY,
		.name = "Dream Cheeky Webmail Notifier",
		.short_name = "dream_cheeky",
		.max_brightness = 31,
		.num_leds = 1,
		.report_size = 9,
		.report_type = RAW_REQUEST,
		.report_id = 0,
		.init = dream_cheeky_init,
		.write = dream_cheeky_write,
	},
};

static int hidled_init_led(struct hidled_led *led, const char *color_name,
			   struct hidled_rgb *rgb, unsigned int minor)
{
	const struct hidled_config *config = rgb->ldev->config;

	if (config->num_leds > 1)
		snprintf(led->name, sizeof(led->name), "%s%u:%s:led%u",
			 config->short_name, minor, color_name, rgb->num);
	else
		snprintf(led->name, sizeof(led->name), "%s%u:%s",
			 config->short_name, minor, color_name);
	led->cdev.name = led->name;
	led->cdev.max_brightness = config->max_brightness;
	led->cdev.brightness_set_blocking = config->write;
	led->cdev.flags = LED_HW_PLUGGABLE;
	led->rgb = rgb;

	return devm_led_classdev_register(&rgb->ldev->hdev->dev, &led->cdev);
}

static int hidled_init_rgb(struct hidled_rgb *rgb, unsigned int minor)
{
	int ret;

	/* Register the red diode */
	ret = hidled_init_led(&rgb->red, "red", rgb, minor);
	if (ret)
		return ret;

	/* Register the green diode */
	ret = hidled_init_led(&rgb->green, "green", rgb, minor);
	if (ret)
		return ret;

	/* Register the blue diode */
	return hidled_init_led(&rgb->blue, "blue", rgb, minor);
}

static int hidled_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	struct hidled_device *ldev;
	unsigned int minor;
	int ret, i;

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

	ret = hid_parse(hdev);
	if (ret)
		return ret;

	ldev->hdev = hdev;
	mutex_init(&ldev->lock);

	for (i = 0; !ldev->config && i < ARRAY_SIZE(hidled_configs); i++)
		if (hidled_configs[i].type == id->driver_data)
			ldev->config = &hidled_configs[i];

	if (!ldev->config)
		return -EINVAL;

	if (ldev->config->init) {
		ret = ldev->config->init(ldev);
		if (ret)
			return ret;
	}

	ldev->rgb = devm_kcalloc(&hdev->dev, ldev->config->num_leds,
				 sizeof(struct hidled_rgb), GFP_KERNEL);
	if (!ldev->rgb)
		return -ENOMEM;

	ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
	if (ret)
		return ret;

	minor = ((struct hidraw *) hdev->hidraw)->minor;

	for (i = 0; i < ldev->config->num_leds; i++) {
		ldev->rgb[i].ldev = ldev;
		ldev->rgb[i].num = i;
		ret = hidled_init_rgb(&ldev->rgb[i], minor);
		if (ret) {
			hid_hw_stop(hdev);
			return ret;
		}
	}

	hid_info(hdev, "%s initialized\n", ldev->config->name);

	return 0;
}

static const struct hid_device_id hidled_table[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_RISO_KAGAKU,
	  USB_DEVICE_ID_RI_KA_WEBMAIL), .driver_data = RISO_KAGAKU },
	{ HID_USB_DEVICE(USB_VENDOR_ID_DREAM_CHEEKY,
	  USB_DEVICE_ID_DREAM_CHEEKY_WN), .driver_data = DREAM_CHEEKY },
	{ HID_USB_DEVICE(USB_VENDOR_ID_DREAM_CHEEKY,
	  USB_DEVICE_ID_DREAM_CHEEKY_FA), .driver_data = DREAM_CHEEKY },
	{ }
};
MODULE_DEVICE_TABLE(hid, hidled_table);

static struct hid_driver hidled_driver = {
	.name = "hid-led",
	.probe = hidled_probe,
	.id_table = hidled_table,
};

module_hid_driver(hidled_driver);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Heiner Kallweit <hkallweit1@gmail.com>");
MODULE_DESCRIPTION("Simple USB RGB LED driver");
Commit	Line	Data
6c7ad07e HK	1	/*
	2	* Simple USB RGB LED driver
	3	*
	4	* Copyright 2016 Heiner Kallweit <hkallweit1@gmail.com>
	5	* Based on drivers/hid/hid-thingm.c and
	6	* drivers/usb/misc/usbled.c
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as
	10	* published by the Free Software Foundation, version 2.
	11	*/
	12
	13	#include <linux/hid.h>
	14	#include <linux/hidraw.h>
	15	#include <linux/leds.h>
	16	#include <linux/module.h>
	17	#include <linux/mutex.h>
	18
	19	#include "hid-ids.h"
	20
	21	enum hidled_report_type {
	22	RAW_REQUEST,
	23	OUTPUT_REPORT
	24	};
	25
	26	enum hidled_type {
	27	RISO_KAGAKU,
	28	DREAM_CHEEKY,
	29	};
	30
	31	static unsigned const char riso_kagaku_tbl[] = {
	32	/* R+2G+4B -> riso kagaku color index */
	33	[0] = 0, /* black */
	34	[1] = 2, /* red */
	35	[2] = 1, /* green */
	36	[3] = 5, /* yellow */
	37	[4] = 3, /* blue */
	38	[5] = 6, /* magenta */
	39	[6] = 4, /* cyan */
	40	[7] = 7 /* white */
	41	};
	42
	43	#define RISO_KAGAKU_IX(r, g, b) riso_kagaku_tbl[((r)?1:0)+((g)?2:0)+((b)?4:0)]
	44
	45	struct hidled_device;
5bc83936	46	struct hidled_rgb;
6c7ad07e HK	47
	48	struct hidled_config {
	49	enum hidled_type type;
	50	const char *name;
	51	const char *short_name;
	52	enum led_brightness max_brightness;
5bc83936	53	int num_leds;
6c7ad07e HK	54	size_t report_size;
	55	enum hidled_report_type report_type;
	56	u8 report_id;
	57	int (init)(struct hidled_device ldev);
	58	int (write)(struct led_classdev cdev, enum led_brightness br);
	59	};
	60
	61	struct hidled_led {
	62	struct led_classdev cdev;
5bc83936	63	struct hidled_rgb *rgb;
6c7ad07e HK	64	char name[32];
	65	};
	66
5bc83936 HK	67	struct hidled_rgb {
5bc83936 HK	68	struct hidled_device *ldev;
6c7ad07e HK	69	struct hidled_led red;
	70	struct hidled_led green;
	71	struct hidled_led blue;
5bc83936 HK	72	u8 num;
	73	};
	74
	75	struct hidled_device {
	76	const struct hidled_config *config;
6c7ad07e	77	struct hid_device *hdev;
5bc83936	78	struct hidled_rgb *rgb;
6c7ad07e HK	79	struct mutex lock;
	80	};
	81
	82	#define MAX_REPORT_SIZE 16
	83
	84	#define to_hidled_led(arg) container_of(arg, struct hidled_led, cdev)
	85
	86	static bool riso_kagaku_switch_green_blue;
	87	module_param(riso_kagaku_switch_green_blue, bool, S_IRUGO \| S_IWUSR);
	88	MODULE_PARM_DESC(riso_kagaku_switch_green_blue,
	89	"switch green and blue RGB component for Riso Kagaku devices");
	90
	91	static int hidled_send(struct hidled_device ldev, __u8 buf)
	92	{
	93	int ret;
	94
	95	buf[0] = ldev->config->report_id;
	96
	97	mutex_lock(&ldev->lock);
	98
	99	if (ldev->config->report_type == RAW_REQUEST)
	100	ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
	101	ldev->config->report_size,
	102	HID_FEATURE_REPORT,
	103	HID_REQ_SET_REPORT);
	104	else if (ldev->config->report_type == OUTPUT_REPORT)
	105	ret = hid_hw_output_report(ldev->hdev, buf,
	106	ldev->config->report_size);
	107	else
	108	ret = -EINVAL;
	109
	110	mutex_unlock(&ldev->lock);
	111
	112	if (ret < 0)
	113	return ret;
	114
	115	return ret == ldev->config->report_size ? 0 : -EMSGSIZE;
	116	}
	117
43745730 HK	118	/* reading data is supported for report type RAW_REQUEST only */
	119	static int hidled_recv(struct hidled_device ldev, __u8 buf)
	120	{
	121	int ret;
	122
	123	if (ldev->config->report_type != RAW_REQUEST)
	124	return -EINVAL;
	125
	126	buf[0] = ldev->config->report_id;
	127
	128	mutex_lock(&ldev->lock);
	129
	130	ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
	131	ldev->config->report_size,
	132	HID_FEATURE_REPORT,
	133	HID_REQ_SET_REPORT);
	134	if (ret < 0)
	135	goto err;
	136
	137	ret = hid_hw_raw_request(ldev->hdev, buf[0], buf,
	138	ldev->config->report_size,
	139	HID_FEATURE_REPORT,
	140	HID_REQ_GET_REPORT);
	141	err:
	142	mutex_unlock(&ldev->lock);
	143
	144	return ret < 0 ? ret : 0;
	145	}
	146
5bc83936	147	static u8 riso_kagaku_index(struct hidled_rgb *rgb)
6c7ad07e HK	148	{
	149	enum led_brightness r, g, b;
	150
5bc83936 HK	151	r = rgb->red.cdev.brightness;
	152	g = rgb->green.cdev.brightness;
	153	b = rgb->blue.cdev.brightness;
6c7ad07e HK	154
	155	if (riso_kagaku_switch_green_blue)
	156	return RISO_KAGAKU_IX(r, b, g);
	157	else
	158	return RISO_KAGAKU_IX(r, g, b);
	159	}
	160
	161	static int riso_kagaku_write(struct led_classdev *cdev, enum led_brightness br)
	162	{
	163	struct hidled_led *led = to_hidled_led(cdev);
5bc83936	164	struct hidled_rgb *rgb = led->rgb;
6c7ad07e HK	165	__u8 buf[MAX_REPORT_SIZE] = {};
6c7ad07e HK	166
5bc83936	167	buf[1] = riso_kagaku_index(rgb);
6c7ad07e	168
5bc83936	169	return hidled_send(rgb->ldev, buf);
6c7ad07e HK	170	}
	171
	172	static int dream_cheeky_write(struct led_classdev *cdev, enum led_brightness br)
	173	{
	174	struct hidled_led *led = to_hidled_led(cdev);
5bc83936	175	struct hidled_rgb *rgb = led->rgb;
6c7ad07e HK	176	__u8 buf[MAX_REPORT_SIZE] = {};
6c7ad07e HK	177
5bc83936 HK	178	buf[1] = rgb->red.cdev.brightness;
	179	buf[2] = rgb->green.cdev.brightness;
	180	buf[3] = rgb->blue.cdev.brightness;
6c7ad07e HK	181	buf[7] = 0x1a;
	182	buf[8] = 0x05;
	183
5bc83936	184	return hidled_send(rgb->ldev, buf);
6c7ad07e HK	185	}
	186
	187	static int dream_cheeky_init(struct hidled_device *ldev)
	188	{
	189	__u8 buf[MAX_REPORT_SIZE] = {};
	190
	191	/* Dream Cheeky magic */
	192	buf[1] = 0x1f;
	193	buf[2] = 0x02;
	194	buf[4] = 0x5f;
	195	buf[7] = 0x1a;
	196	buf[8] = 0x03;
	197
	198	return hidled_send(ldev, buf);
	199	}
	200
	201	static const struct hidled_config hidled_configs[] = {
	202	{
	203	.type = RISO_KAGAKU,
	204	.name = "Riso Kagaku Webmail Notifier",
	205	.short_name = "riso_kagaku",
	206	.max_brightness = 1,
5bc83936	207	.num_leds = 1,
6c7ad07e HK	208	.report_size = 6,
	209	.report_type = OUTPUT_REPORT,
	210	.report_id = 0,
	211	.write = riso_kagaku_write,
	212	},
	213	{
	214	.type = DREAM_CHEEKY,
	215	.name = "Dream Cheeky Webmail Notifier",
	216	.short_name = "dream_cheeky",
	217	.max_brightness = 31,
5bc83936	218	.num_leds = 1,
6c7ad07e HK	219	.report_size = 9,
	220	.report_type = RAW_REQUEST,
	221	.report_id = 0,
	222	.init = dream_cheeky_init,
	223	.write = dream_cheeky_write,
	224	},
	225	};
	226
	227	static int hidled_init_led(struct hidled_led led, const char color_name,
5bc83936	228	struct hidled_rgb *rgb, unsigned int minor)
6c7ad07e	229	{
5bc83936 HK	230	const struct hidled_config *config = rgb->ldev->config;
	231
	232	if (config->num_leds > 1)
	233	snprintf(led->name, sizeof(led->name), "%s%u:%s:led%u",
	234	config->short_name, minor, color_name, rgb->num);
	235	else
	236	snprintf(led->name, sizeof(led->name), "%s%u:%s",
	237	config->short_name, minor, color_name);
6c7ad07e	238	led->cdev.name = led->name;
5bc83936 HK	239	led->cdev.max_brightness = config->max_brightness;
5bc83936 HK	240	led->cdev.brightness_set_blocking = config->write;
6c7ad07e	241	led->cdev.flags = LED_HW_PLUGGABLE;
5bc83936	242	led->rgb = rgb;
6c7ad07e	243
5bc83936	244	return devm_led_classdev_register(&rgb->ldev->hdev->dev, &led->cdev);
6c7ad07e HK	245	}
6c7ad07e HK	246
5bc83936	247	static int hidled_init_rgb(struct hidled_rgb *rgb, unsigned int minor)
6c7ad07e HK	248	{
	249	int ret;
	250
	251	/* Register the red diode */
5bc83936	252	ret = hidled_init_led(&rgb->red, "red", rgb, minor);
6c7ad07e HK	253	if (ret)
	254	return ret;
	255
	256	/* Register the green diode */
5bc83936	257	ret = hidled_init_led(&rgb->green, "green", rgb, minor);
6c7ad07e HK	258	if (ret)
	259	return ret;
	260
	261	/* Register the blue diode */
5bc83936	262	return hidled_init_led(&rgb->blue, "blue", rgb, minor);
6c7ad07e HK	263	}
	264
	265	static int hidled_probe(struct hid_device hdev, const struct hid_device_id id)
	266	{
	267	struct hidled_device *ldev;
	268	unsigned int minor;
	269	int ret, i;
	270
	271	ldev = devm_kzalloc(&hdev->dev, sizeof(*ldev), GFP_KERNEL);
	272	if (!ldev)
	273	return -ENOMEM;
	274
	275	ret = hid_parse(hdev);
	276	if (ret)
	277	return ret;
	278
	279	ldev->hdev = hdev;
	280	mutex_init(&ldev->lock);
	281
	282	for (i = 0; !ldev->config && i < ARRAY_SIZE(hidled_configs); i++)
	283	if (hidled_configs[i].type == id->driver_data)
	284	ldev->config = &hidled_configs[i];
	285
	286	if (!ldev->config)
	287	return -EINVAL;
	288
	289	if (ldev->config->init) {
	290	ret = ldev->config->init(ldev);
	291	if (ret)
	292	return ret;
	293	}
	294
5bc83936 HK	295	ldev->rgb = devm_kcalloc(&hdev->dev, ldev->config->num_leds,
	296	sizeof(struct hidled_rgb), GFP_KERNEL);
	297	if (!ldev->rgb)
	298	return -ENOMEM;
	299
6c7ad07e HK	300	ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
	301	if (ret)
	302	return ret;
	303
	304	minor = ((struct hidraw *) hdev->hidraw)->minor;
	305
5bc83936 HK	306	for (i = 0; i < ldev->config->num_leds; i++) {
	307	ldev->rgb[i].ldev = ldev;
	308	ldev->rgb[i].num = i;
	309	ret = hidled_init_rgb(&ldev->rgb[i], minor);
	310	if (ret) {
	311	hid_hw_stop(hdev);
	312	return ret;
	313	}
6c7ad07e HK	314	}
	315
	316	hid_info(hdev, "%s initialized\n", ldev->config->name);
	317
	318	return 0;
	319	}
	320
	321	static const struct hid_device_id hidled_table[] = {
	322	{ HID_USB_DEVICE(USB_VENDOR_ID_RISO_KAGAKU,
	323	USB_DEVICE_ID_RI_KA_WEBMAIL), .driver_data = RISO_KAGAKU },
	324	{ HID_USB_DEVICE(USB_VENDOR_ID_DREAM_CHEEKY,
	325	USB_DEVICE_ID_DREAM_CHEEKY_WN), .driver_data = DREAM_CHEEKY },
	326	{ HID_USB_DEVICE(USB_VENDOR_ID_DREAM_CHEEKY,
	327	USB_DEVICE_ID_DREAM_CHEEKY_FA), .driver_data = DREAM_CHEEKY },
	328	{ }
	329	};
	330	MODULE_DEVICE_TABLE(hid, hidled_table);
	331
	332	static struct hid_driver hidled_driver = {
	333	.name = "hid-led",
	334	.probe = hidled_probe,
	335	.id_table = hidled_table,
	336	};
	337
	338	module_hid_driver(hidled_driver);
	339
	340	MODULE_LICENSE("GPL");
	341	MODULE_AUTHOR("Heiner Kallweit <hkallweit1@gmail.com>");
	342	MODULE_DESCRIPTION("Simple USB RGB LED driver");