Skip to contentSkip to conversation

winmate-fm07-keys: Winmate FM07/FM07P buttons

PATCH Superseded Daniel Beer 3 participants 7 messages Mar 21, 2022 – Mar 22, 2022 x86 platform drivers

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 winmate-fm07-keys: Winmate FM07/FM07P buttons

Winmate FM07 and FM07P in-vehicle computers have a row of five buttons below the display. This module adds an input device that delivers key events when these buttons are pressed.

---
 drivers/platform/x86/Kconfig             |   8 +
 drivers/platform/x86/Makefile            |   3 +
 drivers/platform/x86/winmate-fm07-keys.c | 184 +++++++++++++++++++++++
 3 files changed, 195 insertions(+)
 create mode 100644 drivers/platform/x86/winmate-fm07-keys.c
drivers/platform/x86/Kconfig +8 -0
index 24deeeb29af2..62a5754d6ac9 100644
@@ -1138,6 +1138,14 @@ config SIEMENS_SIMATIC_IPC
 	  To compile this driver as a module, choose M here: the module
 	  will be called simatic-ipc.
 
+config WINMATE_FM07_KEYS
+	tristate "Winmate FM07/FM07P front-panel keys driver"
+	depends on INPUT
+	help
+	  Winmate FM07 and FM07P in-vehicle computers have a row of five
+	  buttons below the display. This module adds an input device
+	  that delivers key events when these buttons are pressed.
+
 endif # X86_PLATFORM_DEVICES
 
 config PMC_ATOM
drivers/platform/x86/Makefile +3 -0
index c12a9b044fd8..04e7c995b838 100644
@@ -129,3 +129,6 @@ obj-$(CONFIG_PMC_ATOM)			+= pmc_atom.o
 
 # Siemens Simatic Industrial PCs
 obj-$(CONFIG_SIEMENS_SIMATIC_IPC)	+= simatic-ipc.o
+
+# Winmate
+obj-$(CONFIG_WINMATE_FM07_KEYS)		+= winmate-fm07-keys.o
drivers/platform/x86/winmate-fm07-keys.c new file +184 -0

184 lines not on this page · raw message

Signature · 1 line
2.30.2
#1 lore raw

Hi Daniel,

Quoted 5 lines · Daniel Beer

Winmate FM07 and FM07P in-vehicle computers have a row of five buttons below the display. This module adds an input device that delivers key events when these buttons are pressed.

Do you have control of the firmware on this device?

If yes then IMHO it would be better to implement this in ACPI using the intel-hid fw API for this, see:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/platform/x86/intel/hid.c

Basically you create an ACPI device with one of the HIDs from the driver. Then on button presses you do an ACPI notify on that device with a value of 0xc0 then the driver will call the device's _DSM (device specific ACPI) method with a GUID of eeec56b3-4442-408f-a792-4edd4d758054 and an argument value of INTEL_HID_DSM_HDEM_FN and then you return the event-code for the button.

You can remap the event-codes to different KEY_FOO values using /lib/udev/hwdb.d/60-keyboard.hwdb

Regards,

Hans

Quoted 227 lines
---
 drivers/platform/x86/Kconfig             |   8 +
 drivers/platform/x86/Makefile            |   3 +
 drivers/platform/x86/winmate-fm07-keys.c | 184 +++++++++++++++++++++++
 3 files changed, 195 insertions(+)
 create mode 100644 drivers/platform/x86/winmate-fm07-keys.c
drivers/platform/x86/Kconfig +8 -0
index 24deeeb29af2..62a5754d6ac9 100644
@@ -1138,6 +1138,14 @@ config SIEMENS_SIMATIC_IPC
 	  To compile this driver as a module, choose M here: the module
 	  will be called simatic-ipc.
 
+config WINMATE_FM07_KEYS
+	tristate "Winmate FM07/FM07P front-panel keys driver"
+	depends on INPUT
+	help
+	  Winmate FM07 and FM07P in-vehicle computers have a row of five
+	  buttons below the display. This module adds an input device
+	  that delivers key events when these buttons are pressed.
+
 endif # X86_PLATFORM_DEVICES
 
 config PMC_ATOM
drivers/platform/x86/Makefile +3 -0
index c12a9b044fd8..04e7c995b838 100644
@@ -129,3 +129,6 @@ obj-$(CONFIG_PMC_ATOM)			+= pmc_atom.o
 
 # Siemens Simatic Industrial PCs
 obj-$(CONFIG_SIEMENS_SIMATIC_IPC)	+= simatic-ipc.o
+
+# Winmate
+obj-$(CONFIG_WINMATE_FM07_KEYS)		+= winmate-fm07-keys.o
drivers/platform/x86/winmate-fm07-keys.c new file +184 -0
new file mode 100644
index 000000000000..3e75adb15444
@@ -0,0 +1,184 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// Driver for the Winmate FM07 front-panel keys
+//
+// Author: Daniel Beer <[email protected]>
+
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/input.h>
+#include <linux/ioport.h>
+#include <linux/platform_device.h>
+#include <linux/dmi.h>
+#include <linux/io.h>
+
+#define DRV_NAME	"winmate-fm07keys"
+
+#define PORT_CMD	0x6c
+#define PORT_DATA	0x68
+
+#define EC_ADDR_KEYS	0x3b
+#define EC_CMD_READ	0x80
+
+#define BASE_KEY	KEY_F13
+#define NUM_KEYS	5
+
+/* Typically we're done in fewer than 10 iterations */
+#define LOOP_TIMEOUT	1000
+
+static void fm07keys_poll(struct input_dev *input)
+{
+	uint8_t k;
+	int i;
+
+	/* Flush output buffer */
+	i = 0;
+	while (inb(PORT_CMD) & 0x01) {
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+		inb(PORT_DATA);
+	}
+
+	/* Send request and wait for write completion */
+	outb(EC_CMD_READ, PORT_CMD);
+	i = 0;
+	while (inb(PORT_CMD) & 0x02)
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+
+	outb(EC_ADDR_KEYS, PORT_DATA);
+	i = 0;
+	while (inb(PORT_CMD) & 0x02)
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+
+	/* Wait for data ready */
+	i = 0;
+	while (!(inb(PORT_CMD) & 0x01))
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+	k = inb(PORT_DATA);
+
+	/* Notify of new key states */
+	for (i = 0; i < NUM_KEYS; i++) {
+		input_report_key(input, BASE_KEY + i, (~k) & 1);
+		k >>= 1;
+	}
+
+	input_sync(input);
+	return;
+timeout:
+	dev_err(&input->dev, "timeout polling IO memory\n");
+}
+
+static int fm07keys_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct input_dev *input;
+	int ret;
+	int i;
+
+	input = devm_input_allocate_device(dev);
+	if (!input) {
+		dev_err(dev, "no memory for input device\n");
+		return -ENOMEM;
+	}
+
+	if (!devm_request_region(dev, PORT_CMD, 1, "Winmate FM07 EC"))
+		return -EBUSY;
+	if (!devm_request_region(dev, PORT_DATA, 1, "Winmate FM07 EC"))
+		return -EBUSY;
+
+	input->name = "Winmate FM07 front-panel keys";
+	input->phys = DRV_NAME "/input0";
+
+	input->id.bustype = BUS_HOST;
+	input->id.vendor = 0x0001;
+	input->id.product = 0x0001;
+	input->id.version = 0x0100;
+
+	__set_bit(EV_KEY, input->evbit);
+
+	for (i = 0; i < NUM_KEYS; i++)
+		__set_bit(BASE_KEY + i, input->keybit);
+
+	ret = input_setup_polling(input, fm07keys_poll);
+	if (ret) {
+		dev_err(dev, "unable to set up polling, err=%d\n", ret);
+		return ret;
+	}
+
+	input_set_poll_interval(input, 20);
+
+	ret = input_register_device(input);
+	if (ret) {
+		dev_err(dev, "unable to register polled device, err=%d\n",
+			ret);
+		return ret;
+	}
+
+	input_sync(input);
+	return 0;
+}
+
+static struct platform_driver fm07keys_driver = {
+	.probe		= fm07keys_probe,
+	.driver		= {
+		.name	= DRV_NAME
+	},
+};
+
+/************************************************************************
+ * Device instance for the FM07
+ */
+
+static struct platform_device *dev;
+
+static const struct dmi_system_id fm07keys_dmi_table[] __initconst = {
+	{
+		/* FM07 and FM07P */
+		.matches = {
+			DMI_MATCH(DMI_SYS_VENDOR, "Winmate Inc."),
+			DMI_MATCH(DMI_PRODUCT_NAME, "IP30"),
+		},
+	},
+};
+
+static int __init fm07keys_init(void)
+{
+	int ret;
+
+	if (!dmi_check_system(fm07keys_dmi_table))
+		return -ENODEV;
+
+	ret = platform_driver_register(&fm07keys_driver);
+	if (ret) {
+		pr_err("fm07keys: failed to register driver, err=%d\n", ret);
+		return ret;
+	}
+
+	dev = platform_device_register_simple(DRV_NAME, -1, NULL, 0);
+	if (!dev) {
+		pr_err("fm07keys: failed to allocate device\n");
+		ret = -ENOMEM;
+		goto fail_alloc;
+	}
+
+	return 0;
+fail_alloc:
+	platform_driver_unregister(&fm07keys_driver);
+	return ret;
+}
+
+static void __exit fm07keys_exit(void)
+{
+	platform_driver_unregister(&fm07keys_driver);
+	platform_device_unregister(dev);
+}
+
+module_init(fm07keys_init);
+module_exit(fm07keys_exit);
+
+MODULE_AUTHOR("Daniel Beer <[email protected]>");
+MODULE_DESCRIPTION("Winmate FM07 front-panel keys driver");
+MODULE_LICENSE("GPL v2");
#2 lore raw
Quoted 4 lines · Hans de Goede

Do you have control of the firmware on this device?

If yes then IMHO it would be better to implement this in ACPI using the intel-hid fw API for this, see:

Hi Hans,

Unfortunately not. I don't work for Winmate and they haven't provided any documentation on this.

Cheers,
Daniel

Signature · 3 lines
Daniel Beer
Software Development Manager
Tirotech Ltd
#3 lore raw

Hi,

Quoted 10 lines · Daniel Beer
Quoted 4 lines · Hans de Goede

Do you have control of the firmware on this device?

If yes then IMHO it would be better to implement this in ACPI using the intel-hid fw API for this, see:

Hi Hans,

Unfortunately not. I don't work for Winmate and they haven't provided any documentation on this.

Ok, in that case please send a v2 addressing Barnabás' remarks.

I'll do a full review of v2 and then depending on what I find merge it, or ask you to do a v3.

Regards,

Hans

#4 lore raw
In reply to Daniel Beer

Hi

2022. március 21., hétfő 4:16 keltezéssel, Daniel Beer írta:

Quoted 59 lines

Winmate FM07 and FM07P in-vehicle computers have a row of five buttons below the display. This module adds an input device that delivers key events when these buttons are pressed.

---
 drivers/platform/x86/Kconfig             |   8 +
 drivers/platform/x86/Makefile            |   3 +
 drivers/platform/x86/winmate-fm07-keys.c | 184 +++++++++++++++++++++++
 3 files changed, 195 insertions(+)
 create mode 100644 drivers/platform/x86/winmate-fm07-keys.c
drivers/platform/x86/Kconfig +8 -0
index 24deeeb29af2..62a5754d6ac9 100644
@@ -1138,6 +1138,14 @@ config SIEMENS_SIMATIC_IPC
 	  To compile this driver as a module, choose M here: the module
 	  will be called simatic-ipc.
 
+config WINMATE_FM07_KEYS
+	tristate "Winmate FM07/FM07P front-panel keys driver"
+	depends on INPUT
+	help
+	  Winmate FM07 and FM07P in-vehicle computers have a row of five
+	  buttons below the display. This module adds an input device
+	  that delivers key events when these buttons are pressed.
+
 endif # X86_PLATFORM_DEVICES
 
 config PMC_ATOM
drivers/platform/x86/Makefile +3 -0
index c12a9b044fd8..04e7c995b838 100644
@@ -129,3 +129,6 @@ obj-$(CONFIG_PMC_ATOM)			+= pmc_atom.o
 
 # Siemens Simatic Industrial PCs
 obj-$(CONFIG_SIEMENS_SIMATIC_IPC)	+= simatic-ipc.o
+
+# Winmate
+obj-$(CONFIG_WINMATE_FM07_KEYS)		+= winmate-fm07-keys.o
drivers/platform/x86/winmate-fm07-keys.c new file +11 -0
new file mode 100644
index 000000000000..3e75adb15444
@@ -0,0 +1,184 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// Driver for the Winmate FM07 front-panel keys
+//
+// Author: Daniel Beer <[email protected]>
+
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/input.h>
+#include <linux/ioport.h>
+#include <linux/platform_device.h>

drivers/platform/x86/winmate-fm07-keys.c line 21

Quoted 10 lines
drivers/platform/x86/winmate-fm07-keys.c new file +10 -0
+#include <linux/dmi.h>
+#include <linux/io.h>
+
+#define DRV_NAME	"winmate-fm07keys"
+
+#define PORT_CMD	0x6c
+#define PORT_DATA	0x68
+
+#define EC_ADDR_KEYS	0x3b
+#define EC_CMD_READ	0x80

It seems you are reading from the embedded controller, have you checked if the ACPI EC driver works? Then you could probably just use the ec_{read,write}() functions.

Quoted 40 lines
drivers/platform/x86/winmate-fm07-keys.c new file +40 -0
+
+#define BASE_KEY	KEY_F13
+#define NUM_KEYS	5
+
+/* Typically we're done in fewer than 10 iterations */
+#define LOOP_TIMEOUT	1000
+
+static void fm07keys_poll(struct input_dev *input)
+{
+	uint8_t k;
+	int i;
+
+	/* Flush output buffer */
+	i = 0;
+	while (inb(PORT_CMD) & 0x01) {
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+		inb(PORT_DATA);
+	}
+
+	/* Send request and wait for write completion */
+	outb(EC_CMD_READ, PORT_CMD);
+	i = 0;
+	while (inb(PORT_CMD) & 0x02)
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+
+	outb(EC_ADDR_KEYS, PORT_DATA);
+	i = 0;
+	while (inb(PORT_CMD) & 0x02)
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+
+	/* Wait for data ready */
+	i = 0;
+	while (!(inb(PORT_CMD) & 0x01))
+		if (++i >= LOOP_TIMEOUT)
+			goto timeout;
+	k = inb(PORT_DATA);
+

drivers/platform/x86/winmate-fm07-keys.c line 71

Quoted 10 lines
drivers/platform/x86/winmate-fm07-keys.c new file +10 -0
+	/* Notify of new key states */
+	for (i = 0; i < NUM_KEYS; i++) {
+		input_report_key(input, BASE_KEY + i, (~k) & 1);
+		k >>= 1;
+	}
+
+	input_sync(input);
+	return;
+timeout:
+	dev_err(&input->dev, "timeout polling IO memory\n");

I think it may be better to use dev_warn_{ratelimited,once}() here.

Quoted 30 lines
drivers/platform/x86/winmate-fm07-keys.c new file +30 -0
+}
+
+static int fm07keys_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct input_dev *input;
+	int ret;
+	int i;
+
+	input = devm_input_allocate_device(dev);
+	if (!input) {
+		dev_err(dev, "no memory for input device\n");
+		return -ENOMEM;
+	}
+
+	if (!devm_request_region(dev, PORT_CMD, 1, "Winmate FM07 EC"))
+		return -EBUSY;
+	if (!devm_request_region(dev, PORT_DATA, 1, "Winmate FM07 EC"))
+		return -EBUSY;
+
+	input->name = "Winmate FM07 front-panel keys";
+	input->phys = DRV_NAME "/input0";
+
+	input->id.bustype = BUS_HOST;
+	input->id.vendor = 0x0001;
+	input->id.product = 0x0001;
+	input->id.version = 0x0100;
+
+	__set_bit(EV_KEY, input->evbit);
+

drivers/platform/x86/winmate-fm07-keys.c line 111

Quoted 10 lines
drivers/platform/x86/winmate-fm07-keys.c new file +10 -0
+	for (i = 0; i < NUM_KEYS; i++)
+		__set_bit(BASE_KEY + i, input->keybit);
+
+	ret = input_setup_polling(input, fm07keys_poll);
+	if (ret) {
+		dev_err(dev, "unable to set up polling, err=%d\n", ret);
+		return ret;
+	}
+
+	input_set_poll_interval(input, 20);

Can you please elaborate how you have arrived at this number?

Quoted 24 lines
drivers/platform/x86/winmate-fm07-keys.c new file +24 -0
+
+	ret = input_register_device(input);
+	if (ret) {
+		dev_err(dev, "unable to register polled device, err=%d\n",
+			ret);
+		return ret;
+	}
+
+	input_sync(input);
+	return 0;
+}
+
+static struct platform_driver fm07keys_driver = {
+	.probe		= fm07keys_probe,
+	.driver		= {
+		.name	= DRV_NAME
+	},
+};
+
+/************************************************************************
+ * Device instance for the FM07
+ */
+
+static struct platform_device *dev;

drivers/platform/x86/winmate-fm07-keys.c line 145

Quoted 10 lines
drivers/platform/x86/winmate-fm07-keys.c new file +10 -0
+
+static const struct dmi_system_id fm07keys_dmi_table[] __initconst = {
+	{
+		/* FM07 and FM07P */
+		.matches = {
+			DMI_MATCH(DMI_SYS_VENDOR, "Winmate Inc."),
+			DMI_MATCH(DMI_PRODUCT_NAME, "IP30"),
+		},
+	},
+};

You should probably add:

  MODULE_DEVICE_TABLE(dmi, fm07keys_dmi_table);
Quoted 6 lines
drivers/platform/x86/winmate-fm07-keys.c new file +6 -0
+
+static int __init fm07keys_init(void)
+{
+	int ret;
+
+	if (!dmi_check_system(fm07keys_dmi_table))

drivers/platform/x86/winmate-fm07-keys.c line 161

Quoted 10 lines
drivers/platform/x86/winmate-fm07-keys.c new file +10 -0
+		return -ENODEV;
+
+	ret = platform_driver_register(&fm07keys_driver);
+	if (ret) {
+		pr_err("fm07keys: failed to register driver, err=%d\n", ret);
+		return ret;
+	}
+
+	dev = platform_device_register_simple(DRV_NAME, -1, NULL, 0);
+	if (!dev) {

platform_device_register_simple() returns an ERR_PTR(), so this should be:

  if (IS_ERR(dev)) {
    ret = PTR_ERR(dev);
    ...
  }
Quoted 24 lines
drivers/platform/x86/winmate-fm07-keys.c new file +23 -1
+		pr_err("fm07keys: failed to allocate device\n");
+		ret = -ENOMEM;
+		goto fail_alloc;
+	}
+
+	return 0;
+fail_alloc:
+	platform_driver_unregister(&fm07keys_driver);
+	return ret;
+}
+
+static void __exit fm07keys_exit(void)
+{
+	platform_driver_unregister(&fm07keys_driver);
+	platform_device_unregister(dev);
+}
+
+module_init(fm07keys_init);
+module_exit(fm07keys_exit);
+
+MODULE_AUTHOR("Daniel Beer <[email protected]>");
+MODULE_DESCRIPTION("Winmate FM07 front-panel keys driver");
+MODULE_LICENSE("GPL v2");
--
Quoted 1 line

2.30.2

Regards,
Barnabás Pőcze

#5 lore raw
Quoted 8 lines · Barnabás Pőcze

drivers/platform/x86/winmate-fm07-keys.c line 21

Quoted 5 lines
drivers/platform/x86/winmate-fm07-keys.c new file +5 -0
+#define PORT_CMD	0x6c
+#define PORT_DATA	0x68
+
+#define EC_ADDR_KEYS	0x3b
+#define EC_CMD_READ	0x80

It seems you are reading from the embedded controller, have you checked if the ACPI EC driver works? Then you could probably just use the ec_{read,write}() functions.

Hi Barnabás,

There is already an ACPI EC driver working on this system, but it's using ports 0x66 and 0x62. I guess this one is something unrelated, although it does appear to use the same protocol.

I might be missing something, but it doesn't look like I can use the ec_ functions in this case as they will direct everything towards the EC at 0x66/0x62. Is there anything else you'd suggest?

If it helps to know, the hardware vendor shipped an Ubuntu distribution with a kernel module that just exposed the ability to read/write ports 0x6c/0x68 via chardev ioctls, and then a proprietary userspace program polled for button states.

I'll address your other comments in v2.

Cheers,
Daniel

Signature · 3 lines
Daniel Beer
Software Development Manager
Tirotech Ltd
#6 lore raw
In reply to Daniel Beer

2022. március 21., hétfő 4:16 keltezéssel, Daniel Beer írta

drivers/platform/x86/winmate-fm07-keys.c line 145

Quoted 10 lines

[...]

drivers/platform/x86/winmate-fm07-keys.c new file +9 -0
+static const struct dmi_system_id fm07keys_dmi_table[] __initconst = {
+	{
+		/* FM07 and FM07P */
+		.matches = {
+			DMI_MATCH(DMI_SYS_VENDOR, "Winmate Inc."),
+			DMI_MATCH(DMI_PRODUCT_NAME, "IP30"),
+		},
+	},
+};

I forgot to mention it, but the sentinel entry is missing from the end.

Quoted 1 line

[...]

Regards,
Barnabás Pőcze