[linux-2.6-block.git] / drivers / media / rc / rc-loopback.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Loopback driver for rc-core,
 *
 * Copyright (c) 2010 David Härdeman <david@hardeman.nu>
 *
 * This driver receives TX data and passes it back as RX data,
 * which is useful for (scripted) debugging of rc-core without
 * having to use actual hardware.
 */

#include <linux/device.h>
#include <linux/module.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <media/rc-core.h>

#define DRIVER_NAME		"rc-loopback"
#define RXMASK_NARROWBAND	0x1
#define RXMASK_WIDEBAND		0x2

struct loopback_dev {
	struct rc_dev *dev;
	u32 txmask;
	u32 txcarrier;
	u32 txduty;
	bool idle;
	bool wideband;
	bool carrierreport;
	u32 rxcarriermin;
	u32 rxcarriermax;
};

static struct loopback_dev loopdev;

static int loop_set_tx_mask(struct rc_dev *dev, u32 mask)
{
	struct loopback_dev *lodev = dev->priv;

	if ((mask & (RXMASK_NARROWBAND | RXMASK_WIDEBAND)) != mask) {
		dev_dbg(&dev->dev, "invalid tx mask: %u\n", mask);
		return 2;
	}

	dev_dbg(&dev->dev, "setting tx mask: %u\n", mask);
	lodev->txmask = mask;
	return 0;
}

static int loop_set_tx_carrier(struct rc_dev *dev, u32 carrier)
{
	struct loopback_dev *lodev = dev->priv;

	dev_dbg(&dev->dev, "setting tx carrier: %u\n", carrier);
	lodev->txcarrier = carrier;
	return 0;
}

static int loop_set_tx_duty_cycle(struct rc_dev *dev, u32 duty_cycle)
{
	struct loopback_dev *lodev = dev->priv;

	if (duty_cycle < 1 || duty_cycle > 99) {
		dev_dbg(&dev->dev, "invalid duty cycle: %u\n", duty_cycle);
		return -EINVAL;
	}

	dev_dbg(&dev->dev, "setting duty cycle: %u\n", duty_cycle);
	lodev->txduty = duty_cycle;
	return 0;
}

static int loop_set_rx_carrier_range(struct rc_dev *dev, u32 min, u32 max)
{
	struct loopback_dev *lodev = dev->priv;

	if (min < 1 || min > max) {
		dev_dbg(&dev->dev, "invalid rx carrier range %u to %u\n", min, max);
		return -EINVAL;
	}

	dev_dbg(&dev->dev, "setting rx carrier range %u to %u\n", min, max);
	lodev->rxcarriermin = min;
	lodev->rxcarriermax = max;
	return 0;
}

static int loop_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
{
	struct loopback_dev *lodev = dev->priv;
	u32 rxmask;
	unsigned i;
	struct ir_raw_event rawir = {};

	if (lodev->txcarrier < lodev->rxcarriermin ||
	    lodev->txcarrier > lodev->rxcarriermax) {
		dev_dbg(&dev->dev, "ignoring tx, carrier out of range\n");
		goto out;
	}

	if (lodev->wideband)
		rxmask = RXMASK_WIDEBAND;
	else
		rxmask = RXMASK_NARROWBAND;

	if (!(rxmask & lodev->txmask)) {
		dev_dbg(&dev->dev, "ignoring tx, rx mask mismatch\n");
		goto out;
	}

	for (i = 0; i < count; i++) {
		rawir.pulse = i % 2 ? false : true;
		rawir.duration = txbuf[i];

		/* simulate overflow if ridiculously long pulse was sent */
		if (rawir.pulse && rawir.duration > MS_TO_US(50))
			ir_raw_event_overflow(dev);
		else
			ir_raw_event_store_with_filter(dev, &rawir);
	}

	if (lodev->carrierreport) {
		rawir.pulse = false;
		rawir.carrier_report = true;
		rawir.carrier = lodev->txcarrier;

		ir_raw_event_store(dev, &rawir);
	}

	/* Fake a silence long enough to cause us to go idle */
	rawir.pulse = false;
	rawir.duration = dev->timeout;
	ir_raw_event_store_with_filter(dev, &rawir);

	ir_raw_event_handle(dev);

out:
	return count;
}

static void loop_set_idle(struct rc_dev *dev, bool enable)
{
	struct loopback_dev *lodev = dev->priv;

	if (lodev->idle != enable) {
		dev_dbg(&dev->dev, "%sing idle mode\n", enable ? "enter" : "exit");
		lodev->idle = enable;
	}
}

static int loop_set_wideband_receiver(struct rc_dev *dev, int enable)
{
	struct loopback_dev *lodev = dev->priv;

	if (lodev->wideband != enable) {
		dev_dbg(&dev->dev, "using %sband receiver\n", enable ? "wide" : "narrow");
		lodev->wideband = !!enable;
	}

	return 0;
}

static int loop_set_carrier_report(struct rc_dev *dev, int enable)
{
	struct loopback_dev *lodev = dev->priv;

	if (lodev->carrierreport != enable) {
		dev_dbg(&dev->dev, "%sabling carrier reports\n", enable ? "en" : "dis");
		lodev->carrierreport = !!enable;
	}

	return 0;
}

static int loop_set_wakeup_filter(struct rc_dev *dev,
				  struct rc_scancode_filter *sc)
{
	static const unsigned int max = 512;
	struct ir_raw_event *raw;
	int ret;
	int i;

	/* fine to disable filter */
	if (!sc->mask)
		return 0;

	/* encode the specified filter and loop it back */
	raw = kmalloc_array(max, sizeof(*raw), GFP_KERNEL);
	if (!raw)
		return -ENOMEM;

	ret = ir_raw_encode_scancode(dev->wakeup_protocol, sc->data, raw, max);
	/* still loop back the partial raw IR even if it's incomplete */
	if (ret == -ENOBUFS)
		ret = max;
	if (ret >= 0) {
		/* do the loopback */
		for (i = 0; i < ret; ++i)
			ir_raw_event_store(dev, &raw[i]);
		ir_raw_event_handle(dev);

		ret = 0;
	}

	kfree(raw);

	return ret;
}

static int __init loop_init(void)
{
	struct rc_dev *rc;
	int ret;

	rc = rc_allocate_device(RC_DRIVER_IR_RAW);
	if (!rc)
		return -ENOMEM;

	rc->device_name		= "rc-core loopback device";
	rc->input_phys		= "rc-core/virtual";
	rc->input_id.bustype	= BUS_VIRTUAL;
	rc->input_id.version	= 1;
	rc->driver_name		= DRIVER_NAME;
	rc->map_name		= RC_MAP_EMPTY;
	rc->priv		= &loopdev;
	rc->allowed_protocols	= RC_PROTO_BIT_ALL_IR_DECODER;
	rc->allowed_wakeup_protocols = RC_PROTO_BIT_ALL_IR_ENCODER;
	rc->encode_wakeup	= true;
	rc->timeout		= IR_DEFAULT_TIMEOUT;
	rc->min_timeout		= 1;
	rc->max_timeout		= IR_MAX_TIMEOUT;
	rc->rx_resolution	= 1;
	rc->tx_resolution	= 1;
	rc->s_tx_mask		= loop_set_tx_mask;
	rc->s_tx_carrier	= loop_set_tx_carrier;
	rc->s_tx_duty_cycle	= loop_set_tx_duty_cycle;
	rc->s_rx_carrier_range	= loop_set_rx_carrier_range;
	rc->tx_ir		= loop_tx_ir;
	rc->s_idle		= loop_set_idle;
	rc->s_wideband_receiver	= loop_set_wideband_receiver;
	rc->s_carrier_report	= loop_set_carrier_report;
	rc->s_wakeup_filter	= loop_set_wakeup_filter;

	loopdev.txmask		= RXMASK_NARROWBAND;
	loopdev.txcarrier	= 36000;
	loopdev.txduty		= 50;
	loopdev.rxcarriermin	= 1;
	loopdev.rxcarriermax	= ~0;
	loopdev.idle		= true;
	loopdev.wideband	= false;
	loopdev.carrierreport	= false;

	ret = rc_register_device(rc);
	if (ret < 0) {
		dev_err(&rc->dev, "rc_dev registration failed\n");
		rc_free_device(rc);
		return ret;
	}

	loopdev.dev = rc;
	return 0;
}

static void __exit loop_exit(void)
{
	rc_unregister_device(loopdev.dev);
}

module_init(loop_init);
module_exit(loop_exit);

MODULE_DESCRIPTION("Loopback device for rc-core debugging");
MODULE_AUTHOR("David Härdeman <david@hardeman.nu>");
MODULE_LICENSE("GPL");
Commit	Line	Data
c942fddf	1	// SPDX-License-Identifier: GPL-2.0-or-later
801c73c0 DH	2	/*
	3	* Loopback driver for rc-core,
	4	*
	5	* Copyright (c) 2010 David Härdeman <david@hardeman.nu>
	6	*
	7	* This driver receives TX data and passes it back as RX data,
	8	* which is useful for (scripted) debugging of rc-core without
	9	* having to use actual hardware.
801c73c0 DH	10	*/
	11
	12	#include <linux/device.h>
	13	#include <linux/module.h>
	14	#include <linux/sched.h>
914535c0	15	#include <linux/slab.h>
801c73c0 DH	16	#include <media/rc-core.h>
801c73c0 DH	17
8b777edf SY	18	#define DRIVER_NAME "rc-loopback"
	19	#define RXMASK_NARROWBAND 0x1
	20	#define RXMASK_WIDEBAND 0x2
801c73c0	21
801c73c0 DH	22	struct loopback_dev {
	23	struct rc_dev *dev;
	24	u32 txmask;
	25	u32 txcarrier;
	26	u32 txduty;
	27	bool idle;
8b777edf	28	bool wideband;
801c73c0 DH	29	bool carrierreport;
	30	u32 rxcarriermin;
	31	u32 rxcarriermax;
	32	};
	33
	34	static struct loopback_dev loopdev;
	35
	36	static int loop_set_tx_mask(struct rc_dev *dev, u32 mask)
	37	{
	38	struct loopback_dev *lodev = dev->priv;
	39
8b777edf	40	if ((mask & (RXMASK_NARROWBAND \| RXMASK_WIDEBAND)) != mask) {
d9d01039	41	dev_dbg(&dev->dev, "invalid tx mask: %u\n", mask);
6b7f554b	42	return 2;
801c73c0 DH	43	}
801c73c0 DH	44
d9d01039	45	dev_dbg(&dev->dev, "setting tx mask: %u\n", mask);
801c73c0 DH	46	lodev->txmask = mask;
	47	return 0;
	48	}
	49
	50	static int loop_set_tx_carrier(struct rc_dev *dev, u32 carrier)
	51	{
	52	struct loopback_dev *lodev = dev->priv;
	53
d9d01039	54	dev_dbg(&dev->dev, "setting tx carrier: %u\n", carrier);
801c73c0 DH	55	lodev->txcarrier = carrier;
	56	return 0;
	57	}
	58
	59	static int loop_set_tx_duty_cycle(struct rc_dev *dev, u32 duty_cycle)
	60	{
	61	struct loopback_dev *lodev = dev->priv;
	62
	63	if (duty_cycle < 1 \|\| duty_cycle > 99) {
d9d01039	64	dev_dbg(&dev->dev, "invalid duty cycle: %u\n", duty_cycle);
801c73c0 DH	65	return -EINVAL;
	66	}
	67
d9d01039	68	dev_dbg(&dev->dev, "setting duty cycle: %u\n", duty_cycle);
801c73c0 DH	69	lodev->txduty = duty_cycle;
	70	return 0;
	71	}
	72
	73	static int loop_set_rx_carrier_range(struct rc_dev *dev, u32 min, u32 max)
	74	{
	75	struct loopback_dev *lodev = dev->priv;
	76
	77	if (min < 1 \|\| min > max) {
d9d01039	78	dev_dbg(&dev->dev, "invalid rx carrier range %u to %u\n", min, max);
801c73c0 DH	79	return -EINVAL;
	80	}
	81
d9d01039	82	dev_dbg(&dev->dev, "setting rx carrier range %u to %u\n", min, max);
801c73c0 DH	83	lodev->rxcarriermin = min;
	84	lodev->rxcarriermax = max;
	85	return 0;
	86	}
	87
5588dc2b	88	static int loop_tx_ir(struct rc_dev dev, unsigned txbuf, unsigned count)
801c73c0 DH	89	{
	90	struct loopback_dev *lodev = dev->priv;
	91	u32 rxmask;
801c73c0	92	unsigned i;
183e19f5	93	struct ir_raw_event rawir = {};
801c73c0	94
801c73c0 DH	95	if (lodev->txcarrier < lodev->rxcarriermin \|\|
801c73c0 DH	96	lodev->txcarrier > lodev->rxcarriermax) {
d9d01039	97	dev_dbg(&dev->dev, "ignoring tx, carrier out of range\n");
801c73c0 DH	98	goto out;
	99	}
	100
8b777edf SY	101	if (lodev->wideband)
8b777edf SY	102	rxmask = RXMASK_WIDEBAND;
801c73c0	103	else
8b777edf	104	rxmask = RXMASK_NARROWBAND;
801c73c0 DH	105
801c73c0 DH	106	if (!(rxmask & lodev->txmask)) {
d9d01039	107	dev_dbg(&dev->dev, "ignoring tx, rx mask mismatch\n");
801c73c0 DH	108	goto out;
	109	}
	110
	111	for (i = 0; i < count; i++) {
	112	rawir.pulse = i % 2 ? false : true;
528222d8	113	rawir.duration = txbuf[i];
7300d0c2	114
68a99f6a SY	115	/* simulate overflow if ridiculously long pulse was sent */
	116	if (rawir.pulse && rawir.duration > MS_TO_US(50))
	117	ir_raw_event_overflow(dev);
	118	else
	119	ir_raw_event_store_with_filter(dev, &rawir);
7300d0c2 SY	120	}
	121
	122	if (lodev->carrierreport) {
	123	rawir.pulse = false;
	124	rawir.carrier_report = true;
	125	rawir.carrier = lodev->txcarrier;
	126
	127	ir_raw_event_store(dev, &rawir);
801c73c0	128	}
08ffff9f DH	129
	130	/* Fake a silence long enough to cause us to go idle */
	131	rawir.pulse = false;
	132	rawir.duration = dev->timeout;
	133	ir_raw_event_store_with_filter(dev, &rawir);
	134
801c73c0 DH	135	ir_raw_event_handle(dev);
	136
	137	out:
5588dc2b	138	return count;
801c73c0 DH	139	}
	140
	141	static void loop_set_idle(struct rc_dev *dev, bool enable)
	142	{
	143	struct loopback_dev *lodev = dev->priv;
	144
	145	if (lodev->idle != enable) {
d9d01039	146	dev_dbg(&dev->dev, "%sing idle mode\n", enable ? "enter" : "exit");
801c73c0 DH	147	lodev->idle = enable;
	148	}
	149	}
	150
8b777edf	151	static int loop_set_wideband_receiver(struct rc_dev *dev, int enable)
801c73c0 DH	152	{
	153	struct loopback_dev *lodev = dev->priv;
	154
8b777edf SY	155	if (lodev->wideband != enable) {
	156	dev_dbg(&dev->dev, "using %sband receiver\n", enable ? "wide" : "narrow");
	157	lodev->wideband = !!enable;
801c73c0 DH	158	}
	159
	160	return 0;
	161	}
	162
	163	static int loop_set_carrier_report(struct rc_dev *dev, int enable)
	164	{
	165	struct loopback_dev *lodev = dev->priv;
	166
	167	if (lodev->carrierreport != enable) {
d9d01039	168	dev_dbg(&dev->dev, "%sabling carrier reports\n", enable ? "en" : "dis");
801c73c0 DH	169	lodev->carrierreport = !!enable;
	170	}
	171
	172	return 0;
	173	}
	174
914535c0 JH	175	static int loop_set_wakeup_filter(struct rc_dev *dev,
	176	struct rc_scancode_filter *sc)
	177	{
	178	static const unsigned int max = 512;
	179	struct ir_raw_event *raw;
	180	int ret;
	181	int i;
	182
	183	/* fine to disable filter */
	184	if (!sc->mask)
	185	return 0;
	186
	187	/* encode the specified filter and loop it back */
	188	raw = kmalloc_array(max, sizeof(*raw), GFP_KERNEL);
	189	if (!raw)
	190	return -ENOMEM;
	191
	192	ret = ir_raw_encode_scancode(dev->wakeup_protocol, sc->data, raw, max);
	193	/* still loop back the partial raw IR even if it's incomplete */
	194	if (ret == -ENOBUFS)
	195	ret = max;
	196	if (ret >= 0) {
	197	/* do the loopback */
	198	for (i = 0; i < ret; ++i)
	199	ir_raw_event_store(dev, &raw[i]);
	200	ir_raw_event_handle(dev);
	201
	202	ret = 0;
	203	}
	204
	205	kfree(raw);
	206
	207	return ret;
	208	}
	209
801c73c0 DH	210	static int __init loop_init(void)
	211	{
	212	struct rc_dev *rc;
	213	int ret;
	214
0f7499fd	215	rc = rc_allocate_device(RC_DRIVER_IR_RAW);
d9d01039	216	if (!rc)
801c73c0	217	return -ENOMEM;
801c73c0	218
518f4b26	219	rc->device_name = "rc-core loopback device";
801c73c0 DH	220	rc->input_phys = "rc-core/virtual";
	221	rc->input_id.bustype = BUS_VIRTUAL;
	222	rc->input_id.version = 1;
	223	rc->driver_name = DRIVER_NAME;
	224	rc->map_name = RC_MAP_EMPTY;
	225	rc->priv = &loopdev;
6d741bfe SY	226	rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
6d741bfe SY	227	rc->allowed_wakeup_protocols = RC_PROTO_BIT_ALL_IR_ENCODER;
914535c0	228	rc->encode_wakeup = true;
50634548	229	rc->timeout = IR_DEFAULT_TIMEOUT;
801c73c0	230	rc->min_timeout = 1;
50634548	231	rc->max_timeout = IR_MAX_TIMEOUT;
528222d8 SY	232	rc->rx_resolution = 1;
528222d8 SY	233	rc->tx_resolution = 1;
801c73c0 DH	234	rc->s_tx_mask = loop_set_tx_mask;
	235	rc->s_tx_carrier = loop_set_tx_carrier;
	236	rc->s_tx_duty_cycle = loop_set_tx_duty_cycle;
	237	rc->s_rx_carrier_range = loop_set_rx_carrier_range;
	238	rc->tx_ir = loop_tx_ir;
	239	rc->s_idle = loop_set_idle;
8b777edf	240	rc->s_wideband_receiver = loop_set_wideband_receiver;
801c73c0	241	rc->s_carrier_report = loop_set_carrier_report;
914535c0	242	rc->s_wakeup_filter = loop_set_wakeup_filter;
801c73c0	243
8b777edf	244	loopdev.txmask = RXMASK_NARROWBAND;
801c73c0 DH	245	loopdev.txcarrier = 36000;
	246	loopdev.txduty = 50;
	247	loopdev.rxcarriermin = 1;
	248	loopdev.rxcarriermax = ~0;
	249	loopdev.idle = true;
8b777edf	250	loopdev.wideband = false;
801c73c0 DH	251	loopdev.carrierreport = false;
	252
	253	ret = rc_register_device(rc);
	254	if (ret < 0) {
d9d01039	255	dev_err(&rc->dev, "rc_dev registration failed\n");
801c73c0 DH	256	rc_free_device(rc);
	257	return ret;
	258	}
	259
	260	loopdev.dev = rc;
	261	return 0;
	262	}
	263
	264	static void __exit loop_exit(void)
	265	{
	266	rc_unregister_device(loopdev.dev);
	267	}
	268
	269	module_init(loop_init);
	270	module_exit(loop_exit);
	271
801c73c0 DH	272	MODULE_DESCRIPTION("Loopback device for rc-core debugging");
	273	MODULE_AUTHOR("David Härdeman <david@hardeman.nu>");
	274	MODULE_LICENSE("GPL");