byd-mouse.patch

The Puri_sm Librem13 mousedriver is available as part of a large kernel source drop at https://github.com/purism/linux.

Unfortunately the git tree there has exactly one commit, containing _everything_, which is rather unfortunate.

This gist has the driver for the BYD BTP-10463 touchpad split out into a separate patch.

 Kconfig        |   10 +
 Makefile       |    2 
 byd.c          |  362 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 byd.h          |   31 ++++
 psmouse-base.c |   23 +++
 psmouse.h      |    1 
 6 files changed, 428 insertions(+), 1 deletion(-)

diff -uNr linux-4.2.3/drivers/input/mouse/byd.c linux.git/drivers/input/mouse/byd.c
--- linux-4.2.3/drivers/input/mouse/byd.c	1970-01-01 01:00:00.000000000 +0100
+++ linux.git/drivers/input/mouse/byd.c	2015-10-28 21:41:53.345318904 +0100
@@ -0,0 +1,362 @@
+/*
+ * byd.c --- Driver for BYD BTP-10463
+ *
+ * Copyright (C) 2015, Tai Chi Minh Ralph Eastwood
+ * Copyright (C) 2015, Martin Wimpress
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ * Protocol of BYD Touch Pad reverse-engineered.
+ * Datasheet: http://bydit.com/userfiles/file/BTP10463-XXX.pdf
+ *
+ */
+
+/* #define DEBUG 1 */
+
+#include <linux/input.h>
+#include <linux/serio.h>
+#include <linux/slab.h>
+#include <linux/libps2.h>
+
+#include "psmouse.h"
+#include "byd.h"
+
+#define BYD_MODEL_ID_LEN        2
+#define BYD_CMD_PAIR(c)		((1 << 12) | (c))
+#define BYD_CMD_PAIR_R(r,c)	((1 << 12) | (r << 8) | (c))
+
+#define DEBUG 1
+
+struct byd_model_info {
+	char name[16];
+	char id[BYD_MODEL_ID_LEN];
+};
+
+static struct byd_model_info byd_model_data[] = {
+	{ "BTP10463", { 0x03, 0x64 } }
+};
+
+static const unsigned char byd_init_param[] = {
+
+	0xd3, 0x01,  // set right-handedness
+	0xd0, 0x00,  // reset button
+	0xd0, 0x07,  // send click in both corners as separate gestures
+	0xd4, 0x02,  // disable tapping.
+	0xd5, 0x03,  // tap and drag off
+	0xd7, 0x04,  // edge scrolling off
+	0xd8, 0x04,  // edge motion disabled
+	0xda, 0x04,  // slide speed fast
+	0xdb, 0x01,  // Edge motion off
+	0xe4, 0x05,  // Edge motion speed middle.
+	0xd6, 0x07,  // Touch Gesture Sensitivity high
+	0xde, 0x01,  // Palm detection low: seems to affect gesture detection
+	0xe3, 0x01,  // Enable gesture detection
+	0xcf, 0x00,  // Tap/Drag delay - off
+	0xd2, 0x03,  // Enable two-finger scrolling gesture in both directions
+	0xe5, 0x00,  // Two finger continue scrolling at edge - off
+	// 0xd9, 0x02,  // unknown - unnecessary?
+	// 0xd9, 0x07,  // unknown - unnecessary?
+	0xdc, 0x03,  // left edge width medium
+	0xdd, 0x03,  // top edge height medium
+	0xdf, 0x03,  // right edge height medium
+	0xe1, 0x03,  // bottom edge height medium
+	0xd1, 0x00,  // no 'absolute' position interleaving
+	// 0xe7, 0xe8,   // set scaling normal then double. (have to send be in pairs atm.)
+	0xce, 0x00,
+	0xcc, 0x00,
+	0xe0, 0x00
+};
+
+#define BYD_CMD_GESTURE		 0
+#define BYD_CMD_SCROLL_INC	 1
+#define BYD_CMD_SCROLL_DEC	-1
+
+struct byd_ext_cmd {
+	char type;
+	unsigned char code;
+	int cmd;
+};
+
+static const struct byd_ext_cmd byd_ext_cmd_data[] = {
+	{ BYD_CMD_SCROLL_DEC, 0x28, REL_Z       }, /* pinch out                 */
+	{ BYD_CMD_GESTURE,    0x29, BTN_FORWARD }, /* rotate clockwise          */
+	{ BYD_CMD_SCROLL_INC, 0x2a, REL_HWHEEL  }, /* scroll right (two finger) */
+	{ BYD_CMD_SCROLL_DEC, 0x2b, REL_WHEEL   }, /* scroll down (two finger)  */
+	{ BYD_CMD_GESTURE,    0x2c, BTN_SIDE    }, /* 3-finger-swipe right      */
+	{ BYD_CMD_GESTURE,    0x2d, BTN_TASK    }, /* 3-finger-swipe down       */
+	{ BYD_CMD_GESTURE,    0x33, BTN_MOUSE+10}, /* four finger down          */
+	{ BYD_CMD_SCROLL_INC, 0x35, REL_HWHEEL  }, /* scroll right (region)     */
+	{ BYD_CMD_SCROLL_DEC, 0x36, REL_WHEEL,  }, /* scroll down (region)      */
+	{ BYD_CMD_GESTURE,    0xd3, BTN_MOUSE+8 }, /* 3-finger-swipe up         */
+	{ BYD_CMD_GESTURE,    0xd4, BTN_EXTRA   }, /* 3-finger-swipe left       */
+	{ BYD_CMD_SCROLL_INC, 0xd5, REL_WHEEL   }, /* scroll up (two finger)    */
+	{ BYD_CMD_SCROLL_DEC, 0xd6, REL_HWHEEL  }, /* scroll left (two finger)  */
+	{ BYD_CMD_GESTURE,    0xd7, BTN_BACK    }, /* rotate anti-clockwise     */
+	{ BYD_CMD_SCROLL_INC, 0xd8, REL_RZ      }, /* pinch in                  */
+	{ BYD_CMD_SCROLL_INC, 0xca, REL_WHEEL   }, /* scroll up (region)        */
+	{ BYD_CMD_SCROLL_DEC, 0xcb, REL_HWHEEL  }, /* scroll left (region)      */
+	{ BYD_CMD_GESTURE,    0xcd, BTN_MOUSE+9 }, /* four finger up            */
+	{ BYD_CMD_GESTURE,    0xd2, BTN_RIGHT   }, /* right corner click        */
+	{ BYD_CMD_GESTURE,    0x2e, BTN_LEFT    }, /* left corner click         */
+};
+
+struct byd_data {
+	unsigned char ext_lookup[256];
+};
+
+static psmouse_ret_t byd_process_byte(struct psmouse *psmouse)
+{
+	struct byd_data *priv = psmouse->private;
+	struct input_dev *dev = psmouse->dev;
+	unsigned char *packet = psmouse->packet;
+	int i;
+
+	if (psmouse->pktcnt < psmouse->pktsize)
+		return PSMOUSE_GOOD_DATA;
+
+#ifdef DEBUG
+	psmouse_dbg(psmouse, "process: packet = %x %x %x %x\n",
+			packet[0], packet[1], packet[2], packet[3]);
+#endif
+
+	input_report_key(dev, BTN_LEFT,    packet[0]       & 1);
+	input_report_key(dev, BTN_MIDDLE, (packet[0] >> 2) & 1);
+	input_report_key(dev, BTN_RIGHT,  (packet[0] >> 1) & 1);
+
+	if (packet[3]) {
+		i = priv->ext_lookup[packet[3]];
+		if (i != 0xff && byd_ext_cmd_data[i].code == packet[3]) {
+#ifdef DEBUG
+			psmouse_dbg(psmouse, "process: %x %x\n",
+					byd_ext_cmd_data[i].code,
+					byd_ext_cmd_data[i].cmd);
+#endif
+			if (byd_ext_cmd_data[i].type == BYD_CMD_GESTURE) {
+				input_report_key(dev, byd_ext_cmd_data[i].cmd, 1);
+				input_report_key(dev, byd_ext_cmd_data[i].cmd, 0);
+			} else {
+				input_report_rel(dev, byd_ext_cmd_data[i].cmd,
+						byd_ext_cmd_data[i].type);
+			}
+		} else {
+			psmouse_warn(psmouse, "unknown code detected %x\n", packet[3]);
+		}
+	} else {
+		input_report_rel(dev, REL_X, packet[1] ? (int) packet[1] - (int) ((packet[0] << 4) & 0x100) : 0);
+		input_report_rel(dev, REL_Y, packet[2] ? (int) ((packet[0] << 3) & 0x100) - (int) packet[2] : 0);
+	}
+
+	input_sync(dev);
+
+	return PSMOUSE_FULL_PACKET;
+}
+
+int byd_init(struct psmouse *psmouse)
+{
+	struct byd_data *priv;
+	struct ps2dev *ps2dev = &psmouse->ps2dev;
+	unsigned char param[4];
+	int cmd, error = 0;
+	int i = 0;
+
+	/* it needs to be initialised like an intellimouse to get 4-byte packets */
+	psmouse_reset(psmouse);
+	param[0] = 200;
+	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
+	param[0] = 100;
+	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
+	param[0] =  80;
+	ps2_command(ps2dev, param, PSMOUSE_CMD_SETRATE);
+	ps2_command(ps2dev, param, PSMOUSE_CMD_GETID);
+
+	if (param[0] != 3)
+		return -1;
+
+#ifdef DEBUG
+	psmouse_dbg(psmouse, "detect: init sequence\n");
+#endif
+
+	/* activate the mouse to initialise it */
+	psmouse_activate(psmouse);
+
+	/* enter command mode */
+	param[0] = 0x00;
+	if (ps2_command(ps2dev, param, BYD_CMD_PAIR(0xe2))) {
+		error = -EIO;
+		goto init_fail;
+	}
+#ifdef DEBUG
+	psmouse_dbg(psmouse, "detect: entered command mode\n");
+#endif
+
+	/* send second identification command */
+	param[0] = 0x02;
+	if (ps2_command(ps2dev, param, BYD_CMD_PAIR(0xe0))) {
+		error = -EIO;
+		goto init_fail;
+	}
+
+	param[0] = 0x01;
+	if (ps2_command(ps2dev, param, BYD_CMD_PAIR_R(4, 0xe0))) {
+		error = -EIO;
+		goto init_fail;
+	}
+
+#ifdef DEBUG
+	psmouse_dbg(psmouse, "detect: magic %x %x %x %x\n",
+			param[0], param[1], param[2], param[3]);
+#endif
+
+	/* magic identifier the vendor driver reads */
+	if (param[0] != 0x08 || param[1] != 0x01 ||
+	    param[2] != 0x01 || param[3] != 0x31) {
+		psmouse_err(psmouse, "unknown magic, expected: 08 01 01 31\n");
+		error = -EINVAL;
+		goto init_fail;
+	}
+
+	/*
+	 * send the byd vendor commands
+	 * these appear to be pairs of (command, param)
+	 */
+	for (; i < sizeof(byd_init_param); i += 2) {
+		param[0] = byd_init_param[i + 1];
+		cmd = BYD_CMD_PAIR(byd_init_param[i]);
+		if (ps2_command(ps2dev, param, cmd)) {
+			error = -EIO;
+			goto init_fail;
+		}
+	}
+
+	// set scaling to double - makes low-speed a bit more sane
+	psmouse->set_scale(psmouse, PSMOUSE_SCALE21);
+
+
+	/* build lookup table for extended commands */
+	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
+	if (!priv) {
+		kfree(priv);
+		error = -ENOMEM;
+		goto init_fail;
+	}
+	memset(priv, 0xff, sizeof(*priv));
+	for (i = 0; i < ARRAY_SIZE(byd_ext_cmd_data); i++) {
+		priv->ext_lookup[byd_ext_cmd_data[i].code] = i & 0xff;
+	}
+	psmouse->private = priv;
+
+	/* exit command mode */
+	param[0] = 0x01;
+	if (ps2_command(ps2dev, param, BYD_CMD_PAIR(0xe2))) {
+		error = -ENOMEM;
+		goto init_fail;
+	}
+#ifdef DEBUG
+	psmouse_dbg(psmouse, "detect: exit command mode\n");
+#endif
+
+	return 0;
+
+init_fail:
+	psmouse_deactivate(psmouse);
+	return error;
+}
+
+static void byd_disconnect(struct psmouse *psmouse)
+{
+	if (psmouse->private)
+		kfree(psmouse->private);
+	psmouse->private = NULL;
+}
+
+static int byd_reconnect(struct psmouse *psmouse)
+{
+	if (byd_detect(psmouse, 0))
+		return -1;
+
+	if (byd_init(psmouse))
+		return -1;
+
+	return 0;
+}
+
+int byd_detect(struct psmouse *psmouse, bool set_properties)
+{
+	struct ps2dev *ps2dev = &psmouse->ps2dev;
+	unsigned char param[4];
+	int i;
+
+	/* reset the mouse */
+	psmouse_reset(psmouse);
+
+	/* magic knock - identify the mouse (as per. the datasheet) */
+	param[0] = 0x03;
+	if (ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
+	    ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
+	    ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
+	    ps2_command(ps2dev, param, PSMOUSE_CMD_SETRES) ||
+	    ps2_command(ps2dev, param, PSMOUSE_CMD_GETINFO))
+		return -EIO;
+
+	psmouse_dbg(psmouse, "detect: model id: %x %x %x\n",
+			param[0], param[1], param[2]);
+
+	/*
+	 * match the device - the first byte, param[0], appears to be set
+	 * to some unknown value based on the state of the mouse and cannot
+	 * be used for identification after suspend.
+	 */
+	for (i = 0; i < ARRAY_SIZE(byd_model_data); i++) {
+		if (!memcmp(param + 1, &byd_model_data[i].id,
+				 BYD_MODEL_ID_LEN))
+			break;
+	}
+
+	/* no match found */
+	if (i == ARRAY_SIZE(byd_model_data)) {
+		psmouse_dbg(psmouse, "detect: no match found\n");
+		return -EINVAL;
+	} else {
+		psmouse_dbg(psmouse, "detect: matched %s\n",
+				byd_model_data[i].name);
+	}
+
+	if (set_properties) {
+		__set_bit(BTN_SIDE, psmouse->dev->keybit);
+
+		__set_bit(BTN_FORWARD, psmouse->dev->keybit);
+		__set_bit(BTN_BACK, psmouse->dev->keybit);
+		__set_bit(BTN_TASK, psmouse->dev->keybit);
+		__set_bit(BTN_MOUSE+8, psmouse->dev->keybit);
+		__set_bit(BTN_MOUSE+9, psmouse->dev->keybit);
+		__set_bit(BTN_MOUSE+10, psmouse->dev->keybit);
+		__set_bit(BTN_MIDDLE, psmouse->dev->keybit);
+		__set_bit(REL_WHEEL, psmouse->dev->relbit);
+		__set_bit(REL_HWHEEL, psmouse->dev->relbit);
+		__set_bit(REL_MISC, psmouse->dev->relbit);
+		__set_bit(REL_Z, psmouse->dev->relbit);
+		__set_bit(REL_RZ, psmouse->dev->relbit);
+
+		psmouse->vendor = "BYD";
+		psmouse->name = byd_model_data[i].name;
+		psmouse->protocol_handler = byd_process_byte;
+		psmouse->pktsize = 4;
+		psmouse->private = NULL;
+		psmouse->disconnect = byd_disconnect;
+		psmouse->reconnect = byd_reconnect;
+	}
+
+	return 0;
+}
diff -uNr linux-4.2.3/drivers/input/mouse/byd.h linux.git/drivers/input/mouse/byd.h
--- linux-4.2.3/drivers/input/mouse/byd.h	1970-01-01 01:00:00.000000000 +0100
+++ linux.git/drivers/input/mouse/byd.h	2015-10-28 21:41:53.345318904 +0100
@@ -0,0 +1,31 @@
+/*
+ * byd.h --- Driver for BYD Touchpad
+ *
+ * Copyright (C) 2015, Tai Chi Minh Ralph Eastwood
+ * Copyright (C) 2015, Martin Wimpress
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 as published by
+ * the Free Software Foundation.
+ */
+
+#ifndef __BYD_H
+#define __BYD_H
+
+#ifdef CONFIG_MOUSE_PS2_BYD
+int byd_detect(struct psmouse *psmouse, bool set_properties);
+int byd_init(struct psmouse *psmouse);
+#else
+static inline int byd_detect(struct psmouse *psmouse,
+				      bool set_properties)
+{
+	return -ENOSYS;
+}
+static inline int byd_init(struct psmouse *psmouse)
+{
+	return -ENOSYS;
+}
+
+#endif /* CONFIG_MOUSE_PS2_BYD */
+
+#endif /* !__BYD_H */
diff -uNr linux-4.2.3/drivers/input/mouse/Kconfig linux.git/drivers/input/mouse/Kconfig
--- linux-4.2.3/drivers/input/mouse/Kconfig	2015-10-03 13:52:18.000000000 +0200
+++ linux.git/drivers/input/mouse/Kconfig	2015-10-28 21:41:53.342318874 +0100
@@ -161,6 +161,16 @@
 
 	  If unsure, say N.
 
+config MOUSE_PS2_BYD
+	bool "BYD PS/2 protocol extension"
+	depends on MOUSE_PS2
+	help
+	  Say Y here if you have a BYD PS/2 touchpad
+	  connected to your system.
+
+	  If unsure, say N.
+
+
 config MOUSE_SERIAL
 	tristate "Serial mouse"
 	select SERIO
diff -uNr linux-4.2.3/drivers/input/mouse/Makefile linux.git/drivers/input/mouse/Makefile
--- linux-4.2.3/drivers/input/mouse/Makefile	2015-10-03 13:52:18.000000000 +0200
+++ linux.git/drivers/input/mouse/Makefile	2015-10-28 21:41:53.342318874 +0100
@@ -37,7 +37,7 @@
 psmouse-$(CONFIG_MOUSE_PS2_TOUCHKIT)	+= touchkit_ps2.o
 psmouse-$(CONFIG_MOUSE_PS2_CYPRESS)	+= cypress_ps2.o
 psmouse-$(CONFIG_MOUSE_PS2_VMMOUSE)	+= vmmouse.o
-
+psmouse-$(CONFIG_MOUSE_PS2_BYD)		+= byd.o
 elan_i2c-objs := elan_i2c_core.o
 elan_i2c-$(CONFIG_MOUSE_ELAN_I2C_I2C)	+= elan_i2c_i2c.o
 elan_i2c-$(CONFIG_MOUSE_ELAN_I2C_SMBUS)	+= elan_i2c_smbus.o
diff -uNr linux-4.2.3/drivers/input/mouse/psmouse-base.c linux.git/drivers/input/mouse/psmouse-base.c
--- linux-4.2.3/drivers/input/mouse/psmouse-base.c	2015-10-03 13:52:18.000000000 +0200
+++ linux.git/drivers/input/mouse/psmouse-base.c	2015-10-28 21:41:53.351318964 +0100
@@ -32,6 +32,7 @@
 #include "lifebook.h"
 #include "trackpoint.h"
 #include "touchkit_ps2.h"
+#include "byd.h"
 #include "elantech.h"
 #include "sentelic.h"
 #include "cypress_ps2.h"
@@ -904,6 +905,19 @@
 		max_proto = PSMOUSE_IMEX;
 	}
 
+/*
+ * Try BYD Touch Pad.
+ */
+	if (max_proto > PSMOUSE_IMEX &&
+	    psmouse_do_detect(byd_detect, psmouse, set_properties) == 0) {
+		if (!set_properties || byd_init(psmouse) == 0)
+			return PSMOUSE_BYD;
+/*
+ * Init failed, try basic relative protocols
+ */
+		max_proto = PSMOUSE_IMEX;
+	}
+
 	if (max_proto > PSMOUSE_IMEX) {
 		if (psmouse_do_detect(genius_detect,
 				      psmouse, set_properties) == 0)
@@ -1130,6 +1144,15 @@
 		.init		= vmmouse_init,
 	},
 #endif
+#ifdef CONFIG_MOUSE_BYD
+	{
+		.type		= PSMOUSE_BYD,
+		.name		= "BYDPS/2",
+		.alias		= "byd",
+		.detect		= byd_detect,
+	},
+#endif
+
 	{
 		.type		= PSMOUSE_AUTO,
 		.name		= "auto",
diff -uNr linux-4.2.3/drivers/input/mouse/psmouse.h linux.git/drivers/input/mouse/psmouse.h
--- linux-4.2.3/drivers/input/mouse/psmouse.h	2015-10-03 13:52:18.000000000 +0200
+++ linux.git/drivers/input/mouse/psmouse.h	2015-10-28 21:41:53.351318964 +0100
@@ -104,6 +104,7 @@
 	PSMOUSE_CYPRESS,
 	PSMOUSE_FOCALTECH,
 	PSMOUSE_VMMOUSE,
+	PSMOUSE_BYD,
 	PSMOUSE_AUTO		/* This one should always be last */
 };