Skip to contentSkip to conversation

input/serio/i8042: Attach fwnode to serio i8042 kbd device

PATCH Superseded Rajat Jain 3 participants 9 messages Mar 28, 2020 – Apr 27, 2020

Subsystems (3)

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Rajat Jain

author
#0 lore raw

PATCH v4 1/5 input/serio/i8042: Attach fwnode to serio i8042 kbd device

Attach the firmware node to the serio i8042 kbd device so that device properties can be passed from the firmware.

---
v4: Same as v3
v3: same as v2
v2: Remove the Change-Id from the commit log

 drivers/input/serio/i8042-x86ia64io.h | 1 +
 drivers/input/serio/i8042.c           | 3 +++
 2 files changed, 4 insertions(+)
drivers/input/serio/i8042-x86ia64io.h +1 -0
index dc974c288e880..ed9ec4310d976 100644
@@ -927,6 +927,7 @@ static int i8042_pnp_kbd_probe(struct pnp_dev *dev, const struct pnp_device_id *
 	}
 	i8042_pnp_id_to_string(dev->id, i8042_kbd_firmware_id,
 			       sizeof(i8042_kbd_firmware_id));
+	i8042_kbd_fwnode = dev_fwnode(&dev->dev);
 
 	/* Keyboard ports are always supposed to be wakeup-enabled */
 	device_set_wakeup_enable(&dev->dev, true);
drivers/input/serio/i8042.c +3 -0
index 20ff2bed3917a..0dddf273afd94 100644
@@ -21,6 +21,7 @@
 #include <linux/i8042.h>
 #include <linux/slab.h>
 #include <linux/suspend.h>
+#include <linux/property.h>
 
 #include <asm/io.h>
 
@@ -124,6 +125,7 @@ MODULE_PARM_DESC(unmask_kbd_data, "Unconditional enable (may reveal sensitive da
 static bool i8042_bypass_aux_irq_test;
 static char i8042_kbd_firmware_id[128];
 static char i8042_aux_firmware_id[128];
+static struct fwnode_handle *i8042_kbd_fwnode;
 
 #include "i8042.h"
 
@@ -1335,6 +1337,7 @@ static int __init i8042_create_kbd_port(void)
 	strlcpy(serio->phys, I8042_KBD_PHYS_DESC, sizeof(serio->phys));
 	strlcpy(serio->firmware_id, i8042_kbd_firmware_id,
 		sizeof(serio->firmware_id));
+	set_primary_fwnode(&serio->dev, i8042_kbd_fwnode);
 
 	port->serio = serio;
 	port->irq = I8042_KBD_IRQ;
Signature · 1 line
2.26.0.rc2.310.g2932bb562d-goog
author
#1 lore raw

PATCH v4 2/5 Input: atkbd: Expose function row physical map to userspace

Certain keyboards have their top-row keys intended
for actions such as "Browser back", "Browser Refresh", "Fullscreen" etc as their primary mode, thus they will send physical codes for those actions. Further, they don't have a dedicated "Fn" key so don't have the capability to generate function key codes (e.g. F1, F2 etc..). However in this case, if userspace still wants to "synthesize" those function keys using the top row action keys, it needs to know the physical position of the top row keys. (Essentially a mapping between usage codes and a physical location in the top row).

This patch enhances the atkbd driver to receive such a mapping from the firmware / device tree, and expose it to userspace in the form of a function-row-physmap attribute. The attribute would be a space separated ordered list of physical codes, for the keys in the function row, in left-to-right order.

The attribute will only be present if the kernel knows about such mapping, otherwise the attribute shall not be visible.

---
v4: Same as v3
v3: Change to dev_dbg and remove unecessary error check
v2: Remove the Change-Id from the commit log

 drivers/input/keyboard/atkbd.c | 56 ++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
drivers/input/keyboard/atkbd.c +56 -0
index 7e3eae54c1926..3b20aba1861cd 100644
@@ -24,6 +24,7 @@
 #include <linux/libps2.h>
 #include <linux/mutex.h>
 #include <linux/dmi.h>
+#include <linux/property.h>
 
 #define DRIVER_DESC	"AT and PS/2 keyboard driver"
 
@@ -63,6 +64,8 @@ static bool atkbd_terminal;
 module_param_named(terminal, atkbd_terminal, bool, 0);
 MODULE_PARM_DESC(terminal, "Enable break codes on an IBM Terminal keyboard connected via AT/PS2");
 
+#define MAX_FUNCTION_ROW_KEYS	24
+
 /*
  * Scancode to keycode tables. These are just the default setting, and
  * are loadable via a userland utility.
@@ -230,6 +233,9 @@ struct atkbd {
 
 	/* Serializes reconnect(), attr->set() and event work */
 	struct mutex mutex;
+
+	u16 function_row_physmap[MAX_FUNCTION_ROW_KEYS];
+	int num_function_row_keys;
 };
 
 /*
@@ -283,6 +289,7 @@ static struct device_attribute atkbd_attr_##_name =				\
 	__ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
 
 ATKBD_DEFINE_RO_ATTR(err_count);
+ATKBD_DEFINE_RO_ATTR(function_row_physmap);
 
 static struct attribute *atkbd_attributes[] = {
 	&atkbd_attr_extra.attr,
@@ -292,11 +299,42 @@ static struct attribute *atkbd_attributes[] = {
 	&atkbd_attr_softrepeat.attr,
 	&atkbd_attr_softraw.attr,
 	&atkbd_attr_err_count.attr,
+	&atkbd_attr_function_row_physmap.attr,
 	NULL
 };
 
+static ssize_t atkbd_show_function_row_physmap(struct atkbd *atkbd, char *buf)
+{
+	ssize_t size = 0;
+	int i;
+
+	if (!atkbd->num_function_row_keys)
+		return 0;
+
+	for (i = 0; i < atkbd->num_function_row_keys; i++)
+		size += sprintf(buf + size, "%02X ",
+				atkbd->function_row_physmap[i]);
+	size += sprintf(buf + size, "\n");
+	return size;
+}
+
+static umode_t atkbd_attr_is_visible(struct kobject *kobj,
+				struct attribute *attr, int i)
+{
+	struct device *dev = container_of(kobj, struct device, kobj);
+	struct serio *serio = to_serio_port(dev);
+	struct atkbd *atkbd = serio_get_drvdata(serio);
+
+	if (attr == &atkbd_attr_function_row_physmap.attr &&
+	    !atkbd->num_function_row_keys)
+		return 0;
+
+	return attr->mode;
+}
+
 static struct attribute_group atkbd_attribute_group = {
 	.attrs	= atkbd_attributes,
+	.is_visible = atkbd_attr_is_visible,
 };
 
 static const unsigned int xl_table[] = {
@@ -1121,6 +1159,22 @@ static void atkbd_set_device_attrs(struct atkbd *atkbd)
 	}
 }
 
+static void atkbd_parse_fwnode_data(struct serio *serio)
+{
+	struct atkbd *atkbd = serio_get_drvdata(serio);
+	struct device *dev = &serio->dev;
+	int n;
+
+	/* Parse "function-row-physmap" property */
+	n = device_property_count_u16(dev, "function-row-physmap");
+	if (n > 0 && n <= MAX_FUNCTION_ROW_KEYS &&
+	    !device_property_read_u16_array(dev, "function-row-physmap",
+					    atkbd->function_row_physmap, n)) {
+		atkbd->num_function_row_keys = n;
+		dev_dbg(dev, "FW reported %d function-row key locations\n", n);
+	}
+}
+
 /*
  * atkbd_connect() is called when the serio module finds an interface
  * that isn't handled yet by an appropriate device driver. We check if
@@ -1184,6 +1238,8 @@ static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
 		atkbd->id = 0xab00;
 	}
 
+	atkbd_parse_fwnode_data(serio);
+
 	atkbd_set_keycode_table(atkbd);
 	atkbd_set_device_attrs(atkbd);
 
Signature · 1 line
2.26.0.rc2.310.g2932bb562d-goog
maintainer
#2 lore raw

Re: [PATCH v4 2/5] Input: atkbd: Expose function row physical map to userspace

Hi Rajat,

Quoted 77 lines · Rajat Jain

Certain keyboards have their top-row keys intended
for actions such as "Browser back", "Browser Refresh", "Fullscreen" etc as their primary mode, thus they will send physical codes for those actions. Further, they don't have a dedicated "Fn" key so don't have the capability to generate function key codes (e.g. F1, F2 etc..). However in this case, if userspace still wants to "synthesize" those function keys using the top row action keys, it needs to know the physical position of the top row keys. (Essentially a mapping between usage codes and a physical location in the top row).

This patch enhances the atkbd driver to receive such a mapping from the firmware / device tree, and expose it to userspace in the form of a function-row-physmap attribute. The attribute would be a space separated ordered list of physical codes, for the keys in the function row, in left-to-right order.

The attribute will only be present if the kernel knows about such mapping, otherwise the attribute shall not be visible.

---
v4: Same as v3
v3: Change to dev_dbg and remove unecessary error check
v2: Remove the Change-Id from the commit log

 drivers/input/keyboard/atkbd.c | 56 ++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
drivers/input/keyboard/atkbd.c +10 -0
index 7e3eae54c1926..3b20aba1861cd 100644
@@ -24,6 +24,7 @@
 #include <linux/libps2.h>
 #include <linux/mutex.h>
 #include <linux/dmi.h>
+#include <linux/property.h>
 
 #define DRIVER_DESC	"AT and PS/2 keyboard driver"
 
@@ -63,6 +64,8 @@ static bool atkbd_terminal;
 module_param_named(terminal, atkbd_terminal, bool, 0);
 MODULE_PARM_DESC(terminal, "Enable break codes on an IBM Terminal keyboard connected via AT/PS2");
 
+#define MAX_FUNCTION_ROW_KEYS	24
+
 /*
  * Scancode to keycode tables. These are just the default setting, and
  * are loadable via a userland utility.
@@ -230,6 +233,9 @@ struct atkbd {
 
 	/* Serializes reconnect(), attr->set() and event work */
 	struct mutex mutex;
+
+	u16 function_row_physmap[MAX_FUNCTION_ROW_KEYS];
+	int num_function_row_keys;
 };
 
 /*
@@ -283,6 +289,7 @@ static struct device_attribute atkbd_attr_##_name =				\
 	__ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
 
 ATKBD_DEFINE_RO_ATTR(err_count);
+ATKBD_DEFINE_RO_ATTR(function_row_physmap);
 
 static struct attribute *atkbd_attributes[] = {
 	&atkbd_attr_extra.attr,
@@ -292,11 +299,42 @@ static struct attribute *atkbd_attributes[] = {
 	&atkbd_attr_softrepeat.attr,
 	&atkbd_attr_softraw.attr,
 	&atkbd_attr_err_count.attr,
+	&atkbd_attr_function_row_physmap.attr,
 	NULL
 };
 
+static ssize_t atkbd_show_function_row_physmap(struct atkbd *atkbd, char *buf)
+{

drivers/input/keyboard/atkbd.c static struct attribute *atkbd_attributes[] = { · line 317

Quoted 10 lines
drivers/input/keyboard/atkbd.c +10 -0
+	ssize_t size = 0;
+	int i;
+
+	if (!atkbd->num_function_row_keys)
+		return 0;
+
+	for (i = 0; i < atkbd->num_function_row_keys; i++)
+		size += sprintf(buf + size, "%02X ",
+				atkbd->function_row_physmap[i]);
+	size += sprintf(buf + size, "\n");

Can we change this to scnprintf() with PAGE_SIZE as the initial limit?

Quoted 25 lines
drivers/input/keyboard/atkbd.c +18 -0
+	return size;
+}
+
+static umode_t atkbd_attr_is_visible(struct kobject *kobj,
+				struct attribute *attr, int i)
+{
+	struct device *dev = container_of(kobj, struct device, kobj);
+	struct serio *serio = to_serio_port(dev);
+	struct atkbd *atkbd = serio_get_drvdata(serio);
+
+	if (attr == &atkbd_attr_function_row_physmap.attr &&
+	    !atkbd->num_function_row_keys)
+		return 0;
+
+	return attr->mode;
+}
+
 static struct attribute_group atkbd_attribute_group = {
 	.attrs	= atkbd_attributes,
+	.is_visible = atkbd_attr_is_visible,
 };
 
 static const unsigned int xl_table[] = {
@@ -1121,6 +1159,22 @@ static void atkbd_set_device_attrs(struct atkbd *atkbd)
 	}

drivers/input/keyboard/atkbd.c static void atkbd_set_device_attrs(struct atkbd *atkbd) · line 1169

Quoted 10 lines
drivers/input/keyboard/atkbd.c +8 -0
 }
 
+static void atkbd_parse_fwnode_data(struct serio *serio)
+{
+	struct atkbd *atkbd = serio_get_drvdata(serio);
+	struct device *dev = &serio->dev;
+	int n;
+
+	/* Parse "function-row-physmap" property */
+	n = device_property_count_u16(dev, "function-row-physmap");

I think for ACPI case it does not matter, but if we ever have device tree using it, it will lead to less errors if we use u32 as the element size. Do you mind switching to it?

Quoted 12 lines
drivers/input/keyboard/atkbd.c +8 -0
+	if (n > 0 && n <= MAX_FUNCTION_ROW_KEYS &&
+	    !device_property_read_u16_array(dev, "function-row-physmap",
+					    atkbd->function_row_physmap, n)) {
+		atkbd->num_function_row_keys = n;
+		dev_dbg(dev, "FW reported %d function-row key locations\n", n);
+	}
+}
+
 /*
  * atkbd_connect() is called when the serio module finds an interface
  * that isn't handled yet by an appropriate device driver. We check if

drivers/input/keyboard/atkbd.c static int atkbd_connect(struct serio *serio, struct serio_driver *drv) · line 1245

Quoted 8 lines
drivers/input/keyboard/atkbd.c +2 -0
@@ -1184,6 +1238,8 @@ static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
 		atkbd->id = 0xab00;
 	}
 
+	atkbd_parse_fwnode_data(serio);
+
 	atkbd_set_keycode_table(atkbd);
 	atkbd_set_device_attrs(atkbd);
 

Thanks.

Signature · 1 line
Dmitry
author
#3 lore raw

Re: [PATCH v4 2/5] Input: atkbd: Expose function row physical map to userspace

Hi Dmitry,

Quoted 79 lines · Dmitry Torokhov

Hi Rajat,

Quoted 75 lines · Rajat Jain

Certain keyboards have their top-row keys intended
for actions such as "Browser back", "Browser Refresh", "Fullscreen" etc as their primary mode, thus they will send physical codes for those actions. Further, they don't have a dedicated "Fn" key so don't have the capability to generate function key codes (e.g. F1, F2 etc..). However in this case, if userspace still wants to "synthesize" those function keys using the top row action keys, it needs to know the physical position of the top row keys. (Essentially a mapping between usage codes and a physical location in the top row).

This patch enhances the atkbd driver to receive such a mapping from the firmware / device tree, and expose it to userspace in the form of a function-row-physmap attribute. The attribute would be a space separated ordered list of physical codes, for the keys in the function row, in left-to-right order.

The attribute will only be present if the kernel knows about such mapping, otherwise the attribute shall not be visible.

---
v4: Same as v3
v3: Change to dev_dbg and remove unecessary error check
v2: Remove the Change-Id from the commit log

 drivers/input/keyboard/atkbd.c | 56 ++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
drivers/input/keyboard/atkbd.c +8 -0
index 7e3eae54c1926..3b20aba1861cd 100644
@@ -24,6 +24,7 @@
 #include <linux/libps2.h>
 #include <linux/mutex.h>
 #include <linux/dmi.h>
+#include <linux/property.h>
 
 #define DRIVER_DESC  "AT and PS/2 keyboard driver"
 
@@ -63,6 +64,8 @@ static bool atkbd_terminal;
 module_param_named(terminal, atkbd_terminal, bool, 0);
 MODULE_PARM_DESC(terminal, "Enable break codes on an IBM Terminal keyboard connected via AT/PS2");
 
+#define MAX_FUNCTION_ROW_KEYS        24
+
 /*
  * Scancode to keycode tables. These are just the default setting, and
  * are loadable via a userland utility.
@@ -230,6 +233,9 @@ struct atkbd {
 
      /* Serializes reconnect(), attr->set() and event work */
      struct mutex mutex;
+
+     u16 function_row_physmap[MAX_FUNCTION_ROW_KEYS];
+     int num_function_row_keys;
 };
 
 /*
@@ -283,6 +289,7 @@ static struct device_attribute atkbd_attr_##_name =                               \
      __ATTR(_name, S_IRUGO, atkbd_do_show_##_name, NULL);
 
 ATKBD_DEFINE_RO_ATTR(err_count);
+ATKBD_DEFINE_RO_ATTR(function_row_physmap);
 
 static struct attribute *atkbd_attributes[] = {
      &atkbd_attr_extra.attr,
@@ -292,11 +299,42 @@ static struct attribute *atkbd_attributes[] = {
      &atkbd_attr_softrepeat.attr,
      &atkbd_attr_softraw.attr,
      &atkbd_attr_err_count.attr,
+     &atkbd_attr_function_row_physmap.attr,
      NULL
 };
 
Quoted 14 lines

drivers/input/keyboard/atkbd.c static struct attribute *atkbd_attributes[] = { · line 317

Quoted 12 lines
drivers/input/keyboard/atkbd.c +12 -0
+static ssize_t atkbd_show_function_row_physmap(struct atkbd *atkbd, char *buf)
+{
+     ssize_t size = 0;
+     int i;
+
+     if (!atkbd->num_function_row_keys)
+             return 0;
+
+     for (i = 0; i < atkbd->num_function_row_keys; i++)
+             size += sprintf(buf + size, "%02X ",
+                             atkbd->function_row_physmap[i]);
+     size += sprintf(buf + size, "\n");

Can we change this to scnprintf() with PAGE_SIZE as the initial limit?

Done.

Quoted 28 lines
Quoted 28 lines
drivers/input/keyboard/atkbd.c +18 -0
+     return size;
+}
+
+static umode_t atkbd_attr_is_visible(struct kobject *kobj,
+                             struct attribute *attr, int i)
+{
+     struct device *dev = container_of(kobj, struct device, kobj);
+     struct serio *serio = to_serio_port(dev);
+     struct atkbd *atkbd = serio_get_drvdata(serio);
+
+     if (attr == &atkbd_attr_function_row_physmap.attr &&
+         !atkbd->num_function_row_keys)
+             return 0;
+
+     return attr->mode;
+}
+
 static struct attribute_group atkbd_attribute_group = {
      .attrs  = atkbd_attributes,
+     .is_visible = atkbd_attr_is_visible,
 };
 
 static const unsigned int xl_table[] = {
@@ -1121,6 +1159,22 @@ static void atkbd_set_device_attrs(struct atkbd *atkbd)
      }
 }
 
Quoted 12 lines

drivers/input/keyboard/atkbd.c static void atkbd_set_device_attrs(struct atkbd *atkbd) · line 1169

Quoted 8 lines
drivers/input/keyboard/atkbd.c +8 -0
+static void atkbd_parse_fwnode_data(struct serio *serio)
+{
+     struct atkbd *atkbd = serio_get_drvdata(serio);
+     struct device *dev = &serio->dev;
+     int n;
+
+     /* Parse "function-row-physmap" property */
+     n = device_property_count_u16(dev, "function-row-physmap");

I think for ACPI case it does not matter, but if we ever have device tree using it, it will lead to less errors if we use u32 as the element size. Do you mind switching to it?

Done and posted the new patchset here:
https://patchwork.kernel.org/patch/11513295/

Thanks,
Rajat

Quoted 26 lines
Quoted 13 lines
drivers/input/keyboard/atkbd.c +8 -0
+     if (n > 0 && n <= MAX_FUNCTION_ROW_KEYS &&
+         !device_property_read_u16_array(dev, "function-row-physmap",
+                                         atkbd->function_row_physmap, n)) {
+             atkbd->num_function_row_keys = n;
+             dev_dbg(dev, "FW reported %d function-row key locations\n", n);
+     }
+}
+
 /*
  * atkbd_connect() is called when the serio module finds an interface
  * that isn't handled yet by an appropriate device driver. We check if

drivers/input/keyboard/atkbd.c static int atkbd_connect(struct serio *serio, struct serio_driver *drv) · line 1245

Quoted 8 lines
drivers/input/keyboard/atkbd.c +2 -0
@@ -1184,6 +1238,8 @@ static int atkbd_connect(struct serio *serio, struct serio_driver *drv)
              atkbd->id = 0xab00;
      }
 
+     atkbd_parse_fwnode_data(serio);
+
      atkbd_set_keycode_table(atkbd);
      atkbd_set_device_attrs(atkbd);
 

Thanks.

--
Dmitry

author
#4 lore raw

PATCH v4 3/5 dt-bindings: input/atkbd.txt: Add binding for "function-row-physmap"

In reply to Rajat Jain

Create the documentation for the new introduced property, that describes the function-row keys physical positions.

---
v4: Same as v3
v3: same as v2
v2: Remove the Change-Id from the commit log

 .../devicetree/bindings/input/atkbd.txt       | 34 +++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/atkbd.txt
Documentation/devicetree/bindings/input/atkbd.txt new file +34 -0
new file mode 100644
index 0000000000000..816653eb8e98d
@@ -0,0 +1,34 @@
+Device tree bindings for AT / PS2 keyboard device
+
+Optional properties:
+
+	function-row-physmap:
+			An ordered array of the physical codes for the function
+			row keys. Arranged in order from left to right.
+
+Example:
+
+	This is a sample ACPI _DSD node describing the property:
+
+        Name (_DSD, Package () {
+                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+                Package () {
+                        Package () { "function-row-physmap",
+                                Package () {
+                                        0xEA, /* T1 BACK */
+                                        0xE7, /* T2 REFRESH */
+                                        0x91, /* T3 FULLSCREEN */
+                                        0x92, /* T4 SCALE */
+                                        0x93, /* T5 SNIP */
+                                        0x94, /* T6 BRIGHTNESS_DOWN */
+                                        0x95, /* T7 BRIGHTNESS_UP */
+                                        0x96, /* T8 PRIVACY_SCRN_TOGGLE */
+                                        0x97, /* T9 KBD_BKLIGHT_DOWN */
+                                        0x98, /* T10 KBD_BKLIGHT_UP */
+                                        0xA0, /* T11 VOL_MUTE */
+                                        0xAE, /* T12 VOL_DOWN */
+                                        0xB0, /* T13 VOL_UP */
+                                }
+                        }
+                }
+        })
Signature · 1 line
2.26.0.rc2.310.g2932bb562d-goog
maintainer
#5 lore raw

Re: [PATCH v4 3/5] dt-bindings: input/atkbd.txt: Add binding for "function-row-physmap"

Quoted 19 lines · Rajat Jain

Create the documentation for the new introduced property, that describes the function-row keys physical positions.

---
v4: Same as v3
v3: same as v2
v2: Remove the Change-Id from the commit log

 .../devicetree/bindings/input/atkbd.txt       | 34 +++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/atkbd.txt
Documentation/devicetree/bindings/input/atkbd.txt new file +0 -0
new file mode 100644
index 0000000000000..816653eb8e98d

Documentation/devicetree/bindings/input/atkbd.txt line 7

Quoted 7 lines
Documentation/devicetree/bindings/input/atkbd.txt new file +7 -0
@@ -0,0 +1,34 @@
+Device tree bindings for AT / PS2 keyboard device
+
+Optional properties:
+
+	function-row-physmap:
+			An ordered array of the physical codes for the function
+			row keys. Arranged in order from left to right.

A single optional property doesn't constitute a DT binding.

Documentation/devicetree/bindings/input/atkbd.txt line 11

Quoted 4 lines
Documentation/devicetree/bindings/input/atkbd.txt new file +4 -0
+
+Example:
+
+	This is a sample ACPI _DSD node describing the property:

Neither does this ACPI stuff.

Rob

author
#6 lore raw

Re: [PATCH v4 3/5] dt-bindings: input/atkbd.txt: Add binding for "function-row-physmap"

Hi,

Quoted 31 lines · Rob Herring
Quoted 19 lines · Rajat Jain

Create the documentation for the new introduced property, that describes the function-row keys physical positions.

---
v4: Same as v3
v3: same as v2
v2: Remove the Change-Id from the commit log

 .../devicetree/bindings/input/atkbd.txt       | 34 +++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/atkbd.txt
Documentation/devicetree/bindings/input/atkbd.txt new file +0 -0
new file mode 100644
index 0000000000000..816653eb8e98d

Documentation/devicetree/bindings/input/atkbd.txt line 7

Quoted 7 lines
Documentation/devicetree/bindings/input/atkbd.txt new file +7 -0
@@ -0,0 +1,34 @@
+Device tree bindings for AT / PS2 keyboard device
+
+Optional properties:
+
+     function-row-physmap:
+                     An ordered array of the physical codes for the function
+                     row keys. Arranged in order from left to right.

A single optional property doesn't constitute a DT binding.

Quoted 6 lines

Documentation/devicetree/bindings/input/atkbd.txt line 11

Quoted 4 lines
Documentation/devicetree/bindings/input/atkbd.txt new file +4 -0
+
+Example:
+
+     This is a sample ACPI _DSD node describing the property:

Neither does this ACPI stuff.

I assume this means a nack to the documentation patches.

Dmitry, can you apply the other patches in the series?

Thanks,

Rajat

Quoted 2 lines

Rob

author
#7 lore raw

PATCH v4 4/5 Input: atkbd: Receive and use physcode->keycode mapping from FW

In reply to Rajat Jain

Allow the firmware to specify the mapping between the physical code and the linux keycode. This takes the form of a "linux,keymap" property which is an array of u32 values, each value specifying mapping for a key.

---
v4: Property name "keymap" -> "linux,keymap"
v3: Don't save the FW mapping in atkbd device.
v2: Remove the Change-Id from the commit log

 drivers/input/keyboard/atkbd.c | 41 +++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)
drivers/input/keyboard/atkbd.c +40 -1
index 3b20aba1861cd..3379fb5e7169b 100644
@@ -66,6 +66,9 @@ MODULE_PARM_DESC(terminal, "Enable break codes on an IBM Terminal keyboard conne
 
 #define MAX_FUNCTION_ROW_KEYS	24
 
+#define PHYSCODE(keymap)	((keymap >> 16) & 0xFFFF)
+#define KEYCODE(keymap)		(keymap & 0xFFFF)
+
 /*
  * Scancode to keycode tables. These are just the default setting, and
  * are loadable via a userland utility.
@@ -1032,6 +1035,38 @@ static unsigned int atkbd_oqo_01plus_scancode_fixup(struct atkbd *atkbd,
 	return code;
 }
 
+static int atkbd_get_keymap_from_fwnode(struct atkbd *atkbd)
+{
+	struct device *dev = &atkbd->ps2dev.serio->dev;
+	int i, n;
+	u32 *ptr;
+	u16 physcode, keycode;
+
+	/* Parse "linux,keymap" property */
+	n = device_property_count_u32(dev, "linux,keymap");
+	if (n <= 0 || n > ATKBD_KEYMAP_SIZE)
+		return -ENXIO;
+
+	ptr = kcalloc(n, sizeof(u32), GFP_KERNEL);
+	if (!ptr)
+		return -ENOMEM;
+
+	if (device_property_read_u32_array(dev, "linux,keymap", ptr, n)) {
+		dev_err(dev, "problem parsing FW keymap property\n");
+		kfree(ptr);
+		return -EINVAL;
+	}
+
+	memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
+	for (i = 0; i < n; i++) {
+		physcode = PHYSCODE(ptr[i]);
+		keycode = KEYCODE(ptr[i]);
+		atkbd->keycode[physcode] = keycode;
+	}
+	kfree(ptr);
+	return 0;
+}
+
 /*
  * atkbd_set_keycode_table() initializes keyboard's keycode table
  * according to the selected scancode set
@@ -1039,13 +1074,16 @@ static unsigned int atkbd_oqo_01plus_scancode_fixup(struct atkbd *atkbd,
 
 static void atkbd_set_keycode_table(struct atkbd *atkbd)
 {
+	struct device *dev = &atkbd->ps2dev.serio->dev;
 	unsigned int scancode;
 	int i, j;
 
 	memset(atkbd->keycode, 0, sizeof(atkbd->keycode));
 	bitmap_zero(atkbd->force_release_mask, ATKBD_KEYMAP_SIZE);
 
-	if (atkbd->translated) {
+	if (!atkbd_get_keymap_from_fwnode(atkbd)) {
+		dev_dbg(dev, "Using FW keymap\n");
+	} else if (atkbd->translated) {
 		for (i = 0; i < 128; i++) {
 			scancode = atkbd_unxlate_table[i];
 			atkbd->keycode[i] = atkbd_set2_keycode[scancode];
@@ -1173,6 +1211,7 @@ static void atkbd_parse_fwnode_data(struct serio *serio)
 		atkbd->num_function_row_keys = n;
 		dev_dbg(dev, "FW reported %d function-row key locations\n", n);
 	}
+
 }
 
 /*
Signature · 1 line
2.26.0.rc2.310.g2932bb562d-goog
author
#8 lore raw

PATCH v4 5/5 dt-bindings: input/atkbd.txt: Add binding info for "keymap" property

In reply to Rajat Jain

Add the info for keymap property that allows firmware to specify the mapping from physical code to linux keycode, that the kernel should use.

---
v4: Property name "keymap" -> "linux,keymap"
v3: same as v2
v2: Remove the Change-Id from the commit log

 .../devicetree/bindings/input/atkbd.txt       | 27 ++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/input/atkbd.txt +26 -1
index 816653eb8e98d..8b6d7e2c55bb6 100644
@@ -6,9 +6,15 @@ Optional properties:
 			An ordered array of the physical codes for the function
 			row keys. Arranged in order from left to right.
 
+	linux,keymap:
+			An array of the u32 entries to specify mapping from the
+			keyboard physcial codes to linux keycodes. The top 16
+			bits of each entry are the physical code, and bottom
+			16 bits are the	linux keycode.
+
 Example:
 
-	This is a sample ACPI _DSD node describing the property:
+	This is a sample ACPI _DSD node describing the properties:
 
         Name (_DSD, Package () {
                 ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
@@ -29,6 +35,25 @@ Example:
                                         0xAE, /* T12 VOL_DOWN */
                                         0xB0, /* T13 VOL_UP */
                                 }
+                        },
+                        Package () { "linux,keymap",
+                                Package () {
+                                        0xEA009E, /* EA -> KEY_BACK */
+                                        0xE700AD, /* E7 -> KEY_REFRESH */
+                                        0x910174, /* 91 -> KEY_FULL_SCREEN */
+                                        0x920078, /* 92 -> KEY_SCALE */
+                                        0x930280, /* 93 -> 0x280 */
+                                        0x9400E0, /* 94 -> KEY_BRIGHTNESS_DOWN*/
+                                        0x9500E1, /* 95 -> KEY_BRIGHTNESS_UP */
+                                        0x960279, /* 96 -> KEY_PRIVACY_SCRN_TOGGLE*/
+                                        0x9700E5, /* 97 -> KEY_KBDILLUMDOWN */
+                                        0x9800E6, /* 98 -> KEY_KBDILLUMUP */
+                                        0xA00071, /* A0 -> KEY_MUTE */
+                                        0xAE0072, /* AE -> KEY_VOLUMEDOWN */
+                                        0xB00073, /* B0 -> KEY_VOLUMEUP */
+					...
+					<snip other entries>
+                                }
                         }
                 }
         })
Signature · 1 line
2.26.0.rc2.310.g2932bb562d-goog