[mirror_ubuntu-bionic-kernel.git] / drivers / staging / nvec / nvec_ps2.c

/*
 * nvec_ps2: mouse driver for a NVIDIA compliant embedded controller
 *
 * Copyright (C) 2011 The AC100 Kernel Team <ac100@lists.launchpad.net>
 *
 * Authors:  Pierre-Hugues Husson <phhusson@free.fr>
 *           Ilya Petrov <ilya.muromec@gmail.com>
 *           Marc Dietrich <marvin24@gmx.de>
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file "COPYING" in the main directory of this archive
 * for more details.
 *
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/serio.h>
#include <linux/delay.h>
#include <linux/platform_device.h>

#include "nvec.h"

#define PACKET_SIZE	6

#define ENABLE_MOUSE	0xf4
#define DISABLE_MOUSE	0xf5
#define PSMOUSE_RST	0xff

#ifdef NVEC_PS2_DEBUG
#define NVEC_PHD(str, buf, len) \
	print_hex_dump(KERN_DEBUG, str, DUMP_PREFIX_NONE, \
			16, 1, buf, len, false)
#else
#define NVEC_PHD(str, buf, len)
#endif

enum ps2_subcmds {
	SEND_COMMAND = 1,
	RECEIVE_N,
	AUTO_RECEIVE_N,
	CANCEL_AUTO_RECEIVE,
};

struct nvec_ps2 {
	struct serio *ser_dev;
	struct notifier_block notifier;
	struct nvec_chip *nvec;
};

static struct nvec_ps2 ps2_dev;

static int ps2_startstreaming(struct serio *ser_dev)
{
	unsigned char buf[] = { NVEC_PS2, AUTO_RECEIVE_N, PACKET_SIZE };

	return nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
}

static void ps2_stopstreaming(struct serio *ser_dev)
{
	unsigned char buf[] = { NVEC_PS2, CANCEL_AUTO_RECEIVE };

	nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
}

static int ps2_sendcommand(struct serio *ser_dev, unsigned char cmd)
{
	unsigned char buf[] = { NVEC_PS2, SEND_COMMAND, ENABLE_MOUSE, 1 };

	buf[2] = cmd & 0xff;

	dev_dbg(&ser_dev->dev, "Sending ps2 cmd %02x\n", cmd);
	return nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
}

static int nvec_ps2_notifier(struct notifier_block *nb,
			     unsigned long event_type, void *data)
{
	int i;
	unsigned char *msg = data;

	switch (event_type) {
	case NVEC_PS2_EVT:
		for (i = 0; i < msg[1]; i++)
			serio_interrupt(ps2_dev.ser_dev, msg[2 + i], 0);
		NVEC_PHD("ps/2 mouse event: ", &msg[2], msg[1]);
		return NOTIFY_STOP;

	case NVEC_PS2:
		if (msg[2] == 1) {
			for (i = 0; i < (msg[1] - 2); i++)
				serio_interrupt(ps2_dev.ser_dev, msg[i + 4], 0);
			NVEC_PHD("ps/2 mouse reply: ", &msg[4], msg[1] - 2);
		}

		else if (msg[1] != 2) /* !ack */
			NVEC_PHD("unhandled mouse event: ", msg, msg[1] + 2);
		return NOTIFY_STOP;
	}

	return NOTIFY_DONE;
}

static int nvec_mouse_probe(struct platform_device *pdev)
{
	struct nvec_chip *nvec = dev_get_drvdata(pdev->dev.parent);
	struct serio *ser_dev;

	ser_dev = kzalloc(sizeof(*ser_dev), GFP_KERNEL);
	if (!ser_dev)
		return -ENOMEM;

	ser_dev->id.type = SERIO_8042;
	ser_dev->write = ps2_sendcommand;
	ser_dev->start = ps2_startstreaming;
	ser_dev->stop = ps2_stopstreaming;

	strlcpy(ser_dev->name, "nvec mouse", sizeof(ser_dev->name));
	strlcpy(ser_dev->phys, "nvec", sizeof(ser_dev->phys));

	ps2_dev.ser_dev = ser_dev;
	ps2_dev.notifier.notifier_call = nvec_ps2_notifier;
	ps2_dev.nvec = nvec;
	nvec_register_notifier(nvec, &ps2_dev.notifier, 0);

	serio_register_port(ser_dev);

	return 0;
}

static int nvec_mouse_remove(struct platform_device *pdev)
{
	struct nvec_chip *nvec = dev_get_drvdata(pdev->dev.parent);

	ps2_sendcommand(ps2_dev.ser_dev, DISABLE_MOUSE);
	ps2_stopstreaming(ps2_dev.ser_dev);
	nvec_unregister_notifier(nvec, &ps2_dev.notifier);
	serio_unregister_port(ps2_dev.ser_dev);

	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int nvec_mouse_suspend(struct device *dev)
{
	/* disable mouse */
	ps2_sendcommand(ps2_dev.ser_dev, DISABLE_MOUSE);

	/* send cancel autoreceive */
	ps2_stopstreaming(ps2_dev.ser_dev);

	return 0;
}

static int nvec_mouse_resume(struct device *dev)
{
	/* start streaming */
	ps2_startstreaming(ps2_dev.ser_dev);

	/* enable mouse */
	ps2_sendcommand(ps2_dev.ser_dev, ENABLE_MOUSE);

	return 0;
}
#endif

static SIMPLE_DEV_PM_OPS(nvec_mouse_pm_ops, nvec_mouse_suspend,
			 nvec_mouse_resume);

static struct platform_driver nvec_mouse_driver = {
	.probe  = nvec_mouse_probe,
	.remove = nvec_mouse_remove,
	.driver = {
		.name = "nvec-mouse",
		.pm = &nvec_mouse_pm_ops,
	},
};

module_platform_driver(nvec_mouse_driver);

MODULE_DESCRIPTION("NVEC mouse driver");
MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>");
MODULE_ALIAS("platform:nvec-mouse");
MODULE_LICENSE("GPL");
Commit	Line	Data
162c7d8c MD	1	/*
	2	* nvec_ps2: mouse driver for a NVIDIA compliant embedded controller
	3	*
	4	* Copyright (C) 2011 The AC100 Kernel Team <ac100@lists.launchpad.net>
	5	*
	6	* Authors: Pierre-Hugues Husson <phhusson@free.fr>
	7	* Ilya Petrov <ilya.muromec@gmail.com>
	8	* Marc Dietrich <marvin24@gmx.de>
	9	*
	10	* This file is subject to the terms and conditions of the GNU General Public
	11	* License. See the file "COPYING" in the main directory of this archive
	12	* for more details.
	13	*
	14	*/
	15
7974035c	16	#include <linux/module.h>
32890b98 MD	17	#include <linux/slab.h>
	18	#include <linux/serio.h>
	19	#include <linux/delay.h>
f686e9af	20	#include <linux/platform_device.h>
162c7d8c	21
32890b98 MD	22	#include "nvec.h"
32890b98 MD	23
93eff83f	24	#define PACKET_SIZE 6
32890b98	25
93eff83f MD	26	#define ENABLE_MOUSE 0xf4
	27	#define DISABLE_MOUSE 0xf5
	28	#define PSMOUSE_RST 0xff
85a90528	29
0eedab70 MD	30	#ifdef NVEC_PS2_DEBUG
	31	#define NVEC_PHD(str, buf, len) \
	32	print_hex_dump(KERN_DEBUG, str, DUMP_PREFIX_NONE, \
	33	16, 1, buf, len, false)
	34	#else
	35	#define NVEC_PHD(str, buf, len)
	36	#endif
	37
93eff83f MD	38	enum ps2_subcmds {
	39	SEND_COMMAND = 1,
	40	RECEIVE_N,
	41	AUTO_RECEIVE_N,
	42	CANCEL_AUTO_RECEIVE,
	43	};
162c7d8c MD	44
162c7d8c MD	45	struct nvec_ps2 {
32890b98 MD	46	struct serio *ser_dev;
	47	struct notifier_block notifier;
	48	struct nvec_chip *nvec;
	49	};
	50
	51	static struct nvec_ps2 ps2_dev;
	52
	53	static int ps2_startstreaming(struct serio *ser_dev)
	54	{
93eff83f	55	unsigned char buf[] = { NVEC_PS2, AUTO_RECEIVE_N, PACKET_SIZE };
fa799617	56
ff006d12	57	return nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
32890b98 MD	58	}
	59
	60	static void ps2_stopstreaming(struct serio *ser_dev)
	61	{
93eff83f	62	unsigned char buf[] = { NVEC_PS2, CANCEL_AUTO_RECEIVE };
fa799617	63
32890b98 MD	64	nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
	65	}
	66
32890b98 MD	67	static int ps2_sendcommand(struct serio *ser_dev, unsigned char cmd)
32890b98 MD	68	{
93eff83f	69	unsigned char buf[] = { NVEC_PS2, SEND_COMMAND, ENABLE_MOUSE, 1 };
32890b98 MD	70
	71	buf[2] = cmd & 0xff;
	72
	73	dev_dbg(&ser_dev->dev, "Sending ps2 cmd %02x\n", cmd);
ff006d12	74	return nvec_write_async(ps2_dev.nvec, buf, sizeof(buf));
32890b98 MD	75	}
	76
	77	static int nvec_ps2_notifier(struct notifier_block *nb,
162c7d8c	78	unsigned long event_type, void *data)
32890b98 MD	79	{
32890b98 MD	80	int i;
0df8f51e	81	unsigned char *msg = data;
32890b98 MD	82
32890b98 MD	83	switch (event_type) {
162c7d8c	84	case NVEC_PS2_EVT:
1e46e627 JAK	85	for (i = 0; i < msg[1]; i++)
1e46e627 JAK	86	serio_interrupt(ps2_dev.ser_dev, msg[2 + i], 0);
0eedab70	87	NVEC_PHD("ps/2 mouse event: ", &msg[2], msg[1]);
162c7d8c MD	88	return NOTIFY_STOP;
	89
	90	case NVEC_PS2:
0eedab70	91	if (msg[2] == 1) {
162c7d8c MD	92	for (i = 0; i < (msg[1] - 2); i++)
162c7d8c MD	93	serio_interrupt(ps2_dev.ser_dev, msg[i + 4], 0);
0eedab70	94	NVEC_PHD("ps/2 mouse reply: ", &msg[4], msg[1] - 2);
162c7d8c MD	95	}
162c7d8c MD	96
0eedab70 MD	97	else if (msg[1] != 2) /* !ack */
0eedab70 MD	98	NVEC_PHD("unhandled mouse event: ", msg, msg[1] + 2);
162c7d8c	99	return NOTIFY_STOP;
32890b98 MD	100	}
	101
	102	return NOTIFY_DONE;
	103	}
	104
46620803	105	static int nvec_mouse_probe(struct platform_device *pdev)
32890b98	106	{
f686e9af	107	struct nvec_chip *nvec = dev_get_drvdata(pdev->dev.parent);
f5e3352e MD	108	struct serio *ser_dev;
f5e3352e MD	109
cf13a747	110	ser_dev = kzalloc(sizeof(*ser_dev), GFP_KERNEL);
4c42d979	111	if (!ser_dev)
f5e3352e	112	return -ENOMEM;
32890b98	113
17c1c9ba	114	ser_dev->id.type = SERIO_8042;
162c7d8c	115	ser_dev->write = ps2_sendcommand;
34ba143b MD	116	ser_dev->start = ps2_startstreaming;
34ba143b MD	117	ser_dev->stop = ps2_stopstreaming;
32890b98	118
162c7d8c MD	119	strlcpy(ser_dev->name, "nvec mouse", sizeof(ser_dev->name));
162c7d8c MD	120	strlcpy(ser_dev->phys, "nvec", sizeof(ser_dev->phys));
32890b98 MD	121
	122	ps2_dev.ser_dev = ser_dev;
	123	ps2_dev.notifier.notifier_call = nvec_ps2_notifier;
	124	ps2_dev.nvec = nvec;
	125	nvec_register_notifier(nvec, &ps2_dev.notifier, 0);
	126
	127	serio_register_port(ser_dev);
	128
32890b98 MD	129	return 0;
32890b98 MD	130	}
f686e9af	131
1a6a8a84	132	static int nvec_mouse_remove(struct platform_device *pdev)
3cdde3a3	133	{
c2b62f60 MD	134	struct nvec_chip *nvec = dev_get_drvdata(pdev->dev.parent);
	135
	136	ps2_sendcommand(ps2_dev.ser_dev, DISABLE_MOUSE);
	137	ps2_stopstreaming(ps2_dev.ser_dev);
	138	nvec_unregister_notifier(nvec, &ps2_dev.notifier);
3cdde3a3 MD	139	serio_unregister_port(ps2_dev.ser_dev);
	140
	141	return 0;
	142	}
	143
ebefae28 MD	144	#ifdef CONFIG_PM_SLEEP
ebefae28 MD	145	static int nvec_mouse_suspend(struct device *dev)
d1b5342c	146	{
a573298b	147	/* disable mouse */
85a90528	148	ps2_sendcommand(ps2_dev.ser_dev, DISABLE_MOUSE);
a573298b	149
d1b5342c	150	/* send cancel autoreceive */
85a90528	151	ps2_stopstreaming(ps2_dev.ser_dev);
d1b5342c MD	152
	153	return 0;
	154	}
	155
ebefae28	156	static int nvec_mouse_resume(struct device *dev)
d1b5342c	157	{
85a90528	158	/* start streaming */
d1b5342c MD	159	ps2_startstreaming(ps2_dev.ser_dev);
d1b5342c MD	160
a573298b	161	/* enable mouse */
85a90528	162	ps2_sendcommand(ps2_dev.ser_dev, ENABLE_MOUSE);
a573298b	163
d1b5342c MD	164	return 0;
d1b5342c MD	165	}
ebefae28 MD	166	#endif
ebefae28 MD	167
716baa7b PF	168	static SIMPLE_DEV_PM_OPS(nvec_mouse_pm_ops, nvec_mouse_suspend,
716baa7b PF	169	nvec_mouse_resume);
d1b5342c	170
f686e9af	171	static struct platform_driver nvec_mouse_driver = {
162c7d8c	172	.probe = nvec_mouse_probe,
44b90a3f	173	.remove = nvec_mouse_remove,
162c7d8c MD	174	.driver = {
162c7d8c MD	175	.name = "nvec-mouse",
ebefae28	176	.pm = &nvec_mouse_pm_ops,
f686e9af MD	177	},
	178	};
	179
9891b1ce	180	module_platform_driver(nvec_mouse_driver);
162c7d8c MD	181
	182	MODULE_DESCRIPTION("NVEC mouse driver");
	183	MODULE_AUTHOR("Marc Dietrich <marvin24@gmx.de>");
99758dec	184	MODULE_ALIAS("platform:nvec-mouse");
162c7d8c	185	MODULE_LICENSE("GPL");