Skip to contentSkip to conversation

Add device tree support for Samsung's keypad controller driver

PATCH Superseded Thomas Abraham 2 participants 9 messages Sep 13, 2011 – Sep 15, 2011

Subsystems (4)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v2 cover Add device tree support for Samsung's keypad controller driver

Changes since v1:
- Addressed comments from Dmitry Torokhov.
- Type of controller is cached in driver's private data and the function that determines the type of the controller for each keypad scan is removed.
- pdata allocated during probe is explicitly freed after probe completes without any error. In case of exit from probe due a error, no explicit deallocation of pdata memory is performed and it is left to devres to handle that.
- The generic code to translate KEY(x,y,code) is retained in the driver itself. I am unsure of a right common place for it.
- Driver continues with the probe even if one or more gpio configuration fails.
- Patch 1 that adds a new config option is still retained in this patchset.

This patchset adds device tree support for samsung's keypad controller driver. First patch adds a new config option to be used by device tree enabled platforms for selecting the samsung's keypad controller driver. The second patch adds device tree support for the keypad driver.

Thomas Abraham (2):
input: samsung-keypad: Add HAVE_SAMSUNG_KEYPAD config option
input: samsung-keypad: Add device tree support

 .../devicetree/bindings/input/samsung-keypad.txt   |   88 ++++++++++
 drivers/input/keyboard/Kconfig                     |    9 +-
 drivers/input/keyboard/samsung-keypad.c            |  177 ++++++++++++++++++--
 3 files changed, 261 insertions(+), 13 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt
#1 lore raw

PATCH v2 1/2 input: samsung-keypad: Add HAVE_SAMSUNG_KEYPAD config option

For platforms using device tree, the static keypad device instances are not required and SAMSUNG_DEV_KEYPAD is not selected. Since, samsung keypad driver has dependency on SAMSUNG_DEV_KEYPAD config option, the driver is left out of the compilation for dt enabled platforms.

An additional config option 'HAVE_SAMSUNG_KEYPAD' is added which the device tree based platforms can select. This config option is added as an alternative dependency for keypad driver.

---
 drivers/input/keyboard/Kconfig |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
drivers/input/keyboard/Kconfig +8 -1
index b4dee9d..7c322a3 100644
@@ -423,9 +423,16 @@ config KEYBOARD_PMIC8XXX
 	  To compile this driver as a module, choose M here: the module will
 	  be called pmic8xxx-keypad.
 
+config HAVE_SAMSUNG_KEYPAD
+	bool
+	help
+	  This will include Samsung Keypad controller driver support. If you
+	  want to include Samsung Keypad support for any machine, kindly
+	  select this in the respective mach-xxxx/Kconfig file.
+
 config KEYBOARD_SAMSUNG
 	tristate "Samsung keypad support"
-	depends on SAMSUNG_DEV_KEYPAD
+	depends on SAMSUNG_DEV_KEYPAD || HAVE_SAMSUNG_KEYPAD
 	help
 	  Say Y here if you want to use the Samsung keypad.
 
Signature · 1 line
1.6.6.rc2
#2 lore raw

PATCH v2 2/2 input: samsung-keypad: Add device tree support

Add device tree based discovery support for Samsung's keypad controller.

Cc Joonyoung Shim <[email protected]>
Cc Donghwa Lee <[email protected]>
---
 .../devicetree/bindings/input/samsung-keypad.txt   |   88 ++++++++++
 drivers/input/keyboard/samsung-keypad.c            |  177 ++++++++++++++++++--
 2 files changed, 253 insertions(+), 12 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +88 -0
new file mode 100644
index 0000000..e1c7237
@@ -0,0 +1,88 @@
+* Samsung's Keypad Controller device tree bindings
+
+Samsung's Keypad controller is used to interface a SoC with a matrix-type
+keypad device. The keypad controller supports multiple row and column lines.
+A key can be placed at each intersection of a unique row and a unique column.
+The keypad controller can sense a key-press and key-release and report the
+event using a interrupt to the cpu.
+
+Required SoC Specific Properties:
+- compatible: should be one of the following
+  - "samsung,s3c6410-keypad": For controllers compatible with s3c6410 keypad
+    controller.
+  - "samsung,s5pv210-keypad": For controllers compatible with s5pv210 keypad
+    controller.
+
+- reg: physical base address of the controller and length of memory mapped
+  region.
+
+- interrupts: The interrupt number to the cpu.
+
+Required Board Specific Properties:
+- samsung,keypad-num-rows: Number of row lines connected to the keypad
+  controller.
+
+- samsung,keypad-num-columns: Number of column lines connected to the
+  keypad controller.
+
+- row-gpios: List of gpios used as row lines. The gpio specifier for
+  this property depends on the gpio controller to which these row lines
+  are connected.
+
+- col-gpios: List of gpios used as column lines. The gpio specifier for
+  this property depends on the gpio controller to which these column
+  lines are connected.
+
+- Keys represented as child nodes: Each key connected to the keypad
+  controller is represented as a child node to the keypad controller
+  device node and should include the following properties.
+  - keypad,row: the row number to which the key is connected.
+  - keypad,column: the column number to which the key is connected.
+  - keypad,key-code: the key-code to be reported when the key is pressed
+    and released.
+
+Optional Properties specific to linux:
+- linux,keypad-no-autorepeat: do no enable autorepeat feature.
+- linux,keypad-wakeup: use any event on keypad as wakeup event.
+
+
+Example:
+	keypad at 100A0000 {
+		compatible = "samsung,s5pv210-keypad";
+		reg = <0x100A0000 0x100>;
+		interrupts = <173>;
+		samsung,keypad-num-rows = <2>;
+		samsung,keypad-num-columns = <8>;
+		linux,input-no-autorepeat;
+		linux,input-wakeup;
+
+		row-gpios = <&gpx2 0 3 3 0
+			     &gpx2 1 3 3 0>;
+
+		col-gpios = <&gpx1 0 3 0 0
+			     &gpx1 1 3 0 0
+			     &gpx1 2 3 0 0
+			     &gpx1 3 3 0 0
+			     &gpx1 4 3 0 0
+			     &gpx1 5 3 0 0
+			     &gpx1 6 3 0 0
+			     &gpx1 7 3 0 0>;
+
+		key_1 {
+			keypad,row = <0>;
+			keypad,column = <3>;
+			keypad,key-code = <2>;
+		};
+
+		key_2 {
+			keypad,row = <0>;
+			keypad,column = <4>;
+			keypad,key-code = <3>;
+		};
+
+		key_3 {
+			keypad,row = <0>;
+			keypad,column = <5>;
+			keypad,key-code = <4>;
+		};
+	};
drivers/input/keyboard/samsung-keypad.c +165 -12

251 lines not on this page · raw message

Signature · 1 line
1.6.6.rc2
#3 lore raw

PATCH 2/2 input: samsung-keypad: Add device tree support

Quoted 41 lines · Thomas Abraham

Add device tree based discovery support for Samsung's keypad controller.

Cc Joonyoung Shim <[email protected]>
Cc Donghwa Lee <[email protected]>
---
 .../devicetree/bindings/input/samsung-keypad.txt   |   88 ++++++++++
 drivers/input/keyboard/samsung-keypad.c            |  177 ++++++++++++++++++--
 2 files changed, 253 insertions(+), 12 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +24 -0
new file mode 100644
index 0000000..e1c7237
@@ -0,0 +1,88 @@
+* Samsung's Keypad Controller device tree bindings
+
+Samsung's Keypad controller is used to interface a SoC with a matrix-type
+keypad device. The keypad controller supports multiple row and column lines.
+A key can be placed at each intersection of a unique row and a unique column.
+The keypad controller can sense a key-press and key-release and report the
+event using a interrupt to the cpu.
+
+Required SoC Specific Properties:
+- compatible: should be one of the following
+  - "samsung,s3c6410-keypad": For controllers compatible with s3c6410 keypad
+    controller.
+  - "samsung,s5pv210-keypad": For controllers compatible with s5pv210 keypad
+    controller.
+
+- reg: physical base address of the controller and length of memory mapped
+  region.
+
+- interrupts: The interrupt number to the cpu.
+
+Required Board Specific Properties:
+- samsung,keypad-num-rows: Number of row lines connected to the keypad
+  controller.
+

Documentation/devicetree/bindings/input/samsung-keypad.txt line 34

Quoted 10 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +10 -0
+- samsung,keypad-num-columns: Number of column lines connected to the
+  keypad controller.
+
+- row-gpios: List of gpios used as row lines. The gpio specifier for
+  this property depends on the gpio controller to which these row lines
+  are connected.
+
+- col-gpios: List of gpios used as column lines. The gpio specifier for
+  this property depends on the gpio controller to which these column
+  lines are connected.

I know we've got overlapping terminology here. When you say GPIOs here, does it refer to the pin multiplexing feature of the samsung parts, and thus how the keypad controller IO is routed to the pins? Or does the driver manipulate GPIO lines manually?

If it is pin multiplexing, then using the GPIO binding seems rather odd. It may be entirely appropriate, but it will need to play well with the pinmux stuff that linusw is working on.

Documentation/devicetree/bindings/input/samsung-keypad.txt line 42

Quoted 8 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +8 -0
+
+- Keys represented as child nodes: Each key connected to the keypad
+  controller is represented as a child node to the keypad controller
+  device node and should include the following properties.
+  - keypad,row: the row number to which the key is connected.
+  - keypad,column: the column number to which the key is connected.
+  - keypad,key-code: the key-code to be reported when the key is pressed
+    and released.

What defines the meanings of the key codes?

Documentation/devicetree/bindings/input/samsung-keypad.txt line 46

Quoted 4 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +4 -0
+
+Optional Properties specific to linux:
+- linux,keypad-no-autorepeat: do no enable autorepeat feature.
+- linux,keypad-wakeup: use any event on keypad as wakeup event.

Is this really a linux-specific feature?

Quoted 94 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +42 -0
+
+
+Example:
+	keypad at 100A0000 {
+		compatible = "samsung,s5pv210-keypad";
+		reg = <0x100A0000 0x100>;
+		interrupts = <173>;
+		samsung,keypad-num-rows = <2>;
+		samsung,keypad-num-columns = <8>;
+		linux,input-no-autorepeat;
+		linux,input-wakeup;
+
+		row-gpios = <&gpx2 0 3 3 0
+			     &gpx2 1 3 3 0>;
+
+		col-gpios = <&gpx1 0 3 0 0
+			     &gpx1 1 3 0 0
+			     &gpx1 2 3 0 0
+			     &gpx1 3 3 0 0
+			     &gpx1 4 3 0 0
+			     &gpx1 5 3 0 0
+			     &gpx1 6 3 0 0
+			     &gpx1 7 3 0 0>;
+
+		key_1 {
+			keypad,row = <0>;
+			keypad,column = <3>;
+			keypad,key-code = <2>;
+		};
+
+		key_2 {
+			keypad,row = <0>;
+			keypad,column = <4>;
+			keypad,key-code = <3>;
+		};
+
+		key_3 {
+			keypad,row = <0>;
+			keypad,column = <5>;
+			keypad,key-code = <4>;
+		};
+	};
drivers/input/keyboard/samsung-keypad.c +8 -11
index f689f49..cf01a56 100644
@@ -21,6 +21,8 @@
 #include <linux/module.h>
 #include <linux/platform_device.h>
 #include <linux/slab.h>
+#include <linux/of.h>
+#include <linux/of_gpio.h>
 #include <linux/sched.h>
 #include <plat/keypad.h>
 
@@ -68,31 +70,26 @@ struct samsung_keypad {
 	wait_queue_head_t wait;
 	bool stopped;
 	int irq;
+	enum samsung_keypad_type type;
 	unsigned int row_shift;
 	unsigned int rows;
 	unsigned int cols;
 	unsigned int row_state[SAMSUNG_MAX_COLS];
+#ifdef CONFIG_OF
+	int row_gpios[SAMSUNG_MAX_ROWS];
+	int col_gpios[SAMSUNG_MAX_COLS];
+#endif
 	unsigned short keycodes[];
 };
 
-static int samsung_keypad_is_s5pv210(struct device *dev)
-{
-	struct platform_device *pdev = to_platform_device(dev);
-	enum samsung_keypad_type type =
-		platform_get_device_id(pdev)->driver_data;
-
-	return type == KEYPAD_TYPE_S5PV210;
-}
-
 static void samsung_keypad_scan(struct samsung_keypad *keypad,
 				unsigned int *row_state)
 {
-	struct device *dev = keypad->input_dev->dev.parent;
 	unsigned int col;
 	unsigned int val;
 
 	for (col = 0; col < keypad->cols; col++) {
-		if (samsung_keypad_is_s5pv210(dev)) {
+		if (keypad->type == KEYPAD_TYPE_S5PV210) {
 			val = S5PV210_KEYIFCOLEN_MASK;
 			val &= ~(1 << col) << 8;
 		} else {

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 237

Quoted 6 lines
drivers/input/keyboard/samsung-keypad.c +3 -0
@@ -235,6 +232,129 @@ static void samsung_keypad_close(struct input_dev *input_dev)
 	samsung_keypad_stop(keypad);
 }
 
+#ifdef CONFIG_OF
+static
+struct samsung_keypad_platdata *samsung_keypad_parse_dt(struct device *dev)

Nit: keep everything up to the function name on the same line. It is more grep-friendly to make line breaks in the parameters list.

Quoted 5 lines
drivers/input/keyboard/samsung-keypad.c +5 -0
+{
+	struct samsung_keypad_platdata *pdata;
+	struct matrix_keymap_data *keymap_data;
+	uint32_t *keymap;
+	struct device_node *np = dev->of_node, *key_np;

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 252

Quoted 10 lines
drivers/input/keyboard/samsung-keypad.c +10 -0
+	unsigned int key_count = 0;
+
+	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
+	if (!pdata) {
+		dev_err(dev, "could not allocate memory for platform data\n");
+		return NULL;
+	}
+
+	of_property_read_u32(np, "samsung,keypad-num-rows", &pdata->rows);
+	of_property_read_u32(np, "samsung,keypad-num-columns", &pdata->cols);

pdata->rows and ->cols needs to be changed to a u32 for this to be safe.

Quoted 15 lines
drivers/input/keyboard/samsung-keypad.c +15 -0
+	if (!pdata->rows || !pdata->cols) {
+		dev_err(dev, "number of keypad rows/columns not specified\n");
+		return NULL;
+	}
+
+	keymap_data = devm_kzalloc(dev, sizeof(*keymap_data), GFP_KERNEL);
+	if (!keymap_data) {
+		dev_err(dev, "could not allocate memory for keymap data\n");
+		return NULL;
+	}
+	pdata->keymap_data = keymap_data;
+
+	for_each_child_of_node(np, key_np)
+		key_count++;
+

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 277

Quoted 10 lines
drivers/input/keyboard/samsung-keypad.c +10 -0
+	keymap_data->keymap_size = key_count;
+	keymap = devm_kzalloc(dev, sizeof(uint32_t) * key_count, GFP_KERNEL);
+	if (!keymap) {
+		dev_err(dev, "could not allocate memory for keymap\n");
+		return NULL;
+	}
+	keymap_data->keymap = keymap;
+
+	for_each_child_of_node(np, key_np) {
+		unsigned int row, col, key_code;

These need to be u32

Quoted 96 lines
drivers/input/keyboard/samsung-keypad.c +84 -1
+		of_property_read_u32(key_np, "keypad,row", &row);
+		of_property_read_u32(key_np, "keypad,column", &col);
+		of_property_read_u32(key_np, "keypad,key-code", &key_code);
+		*keymap++ = KEY(row, col, key_code);
+	}
+
+	if (of_get_property(np, "linux,input-no-autorepeat", NULL))
+		pdata->no_autorepeat = true;
+	if (of_get_property(np, "linux,input-wakeup", NULL))
+		pdata->wakeup = true;
+
+	return pdata;
+}
+
+static void samsung_keypad_parse_dt_gpio(struct device *dev,
+				struct samsung_keypad *keypad)
+{
+	struct device_node *np = dev->of_node;
+	int gpio, ret, row, col;
+
+	for (row = 0; row < keypad->rows; row++) {
+		gpio = of_get_named_gpio(np, "row-gpios", row);
+		keypad->row_gpios[row] = gpio;
+		if (!gpio_is_valid(gpio)) {
+			dev_err(dev, "keypad row[%d]: invalid gpio %d\n",
+					row, gpio);
+			continue;
+		}
+
+		ret = gpio_request(gpio, "keypad-row");
+		if (ret)
+			dev_err(dev, "keypad row[%d] gpio request failed\n",
+					row);
+	}
+
+	for (col = 0; col < keypad->cols; col++) {
+		gpio = of_get_named_gpio(np, "col-gpios", col);
+		keypad->col_gpios[col] = gpio;
+		if (!gpio_is_valid(gpio)) {
+			dev_err(dev, "keypad column[%d]: invalid gpio %d\n",
+					col, gpio);
+			continue;
+		}
+
+		ret = gpio_request(col, "keypad-col");
+		if (ret)
+			dev_err(dev, "keypad column[%d] gpio request failed\n",
+					col);
+	}
+}
+
+static void samsung_keypad_dt_gpio_free(struct samsung_keypad *keypad)
+{
+	int cnt;
+
+	for (cnt = 0; cnt < keypad->rows; cnt++)
+		if (gpio_is_valid(keypad->row_gpios[cnt]))
+			gpio_free(keypad->row_gpios[cnt]);
+
+	for (cnt = 0; cnt < keypad->cols; cnt++)
+		if (gpio_is_valid(keypad->col_gpios[cnt]))
+			gpio_free(keypad->col_gpios[cnt]);
+}
+#else
+static
+struct samsung_keypad_platdata *samsung_keypad_parse_dt(struct device *dev)
+{
+	return NULL;
+}
+
+static void samsung_keypad_parse_dt_gpio(struct device *dev,
+				struct samsung_keypad *keypad)
+{
+}
+
+static void samsung_keypad_dt_gpio_free(struct samsung_keypad *keypad)
+{
+}
+#endif
+
 static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 {
 	const struct samsung_keypad_platdata *pdata;
@@ -246,7 +366,10 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 	unsigned int keymap_size;
 	int error;
 
-	pdata = pdev->dev.platform_data;
+	if (pdev->dev.of_node)
+		pdata = samsung_keypad_parse_dt(&pdev->dev);
+	else
+		pdata = pdev->dev.platform_data;
 	if (!pdata) {
 		dev_err(&pdev->dev, "no platform data defined\n");
 		return -EINVAL;

drivers/input/keyboard/samsung-keypad.c static int __devinit samsung_keypad_probe(struct platform_device *pdev) · line 434

Quoted 9 lines
drivers/input/keyboard/samsung-keypad.c +6 -0
@@ -303,6 +426,16 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 	keypad->cols = pdata->cols;
 	init_waitqueue_head(&keypad->wait);
 
+	if (pdev->dev.of_node) {
+		samsung_keypad_parse_dt_gpio(&pdev->dev, keypad);
+#ifdef CONFIG_OF
+		keypad->type = of_device_is_compatible(pdev->dev.of_node,
+					"samsung,s5pv210-keypad");
+#endif

It is odd having the #ifdef around only part of the if() block.

Quoted 8 lines
drivers/input/keyboard/samsung-keypad.c +4 -0
+	} else {
+		keypad->type = platform_get_device_id(pdev)->driver_data;
+	}
+
 	input_dev->name = pdev->name;
 	input_dev->id.bustype = BUS_HOST;
 	input_dev->dev.parent = &pdev->dev;

drivers/input/keyboard/samsung-keypad.c static int __devinit samsung_keypad_probe(struct platform_device *pdev) · line 484

Quoted 9 lines
drivers/input/keyboard/samsung-keypad.c +6 -0
@@ -343,12 +476,19 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 
 	device_init_wakeup(&pdev->dev, pdata->wakeup);
 	platform_set_drvdata(pdev, keypad);
+
+	if (pdev->dev.of_node) {
+		devm_kfree(&pdev->dev, (void *)pdata->keymap_data->keymap);
+		devm_kfree(&pdev->dev, (void *)pdata->keymap_data);
+		devm_kfree(&pdev->dev, (void *)pdata);
+	}

Don't need to do this. The driver core will take care of freeing the devm for you when removed.

A few things that should be fixed up, but otherwise looks pretty good.

Quoted 47 lines
drivers/input/keyboard/samsung-keypad.c +14 -0
 	return 0;
 
 err_free_irq:
 	free_irq(keypad->irq, keypad);
 err_put_clk:
 	clk_put(keypad->clk);
+	samsung_keypad_dt_gpio_free(keypad);
 err_unmap_base:
 	iounmap(keypad->base);
 err_free_mem:
@@ -374,6 +514,7 @@ static int __devexit samsung_keypad_remove(struct platform_device *pdev)
 	free_irq(keypad->irq, keypad);
 
 	clk_put(keypad->clk);
+	samsung_keypad_dt_gpio_free(keypad);
 
 	iounmap(keypad->base);
 	kfree(keypad);
@@ -447,6 +588,17 @@ static const struct dev_pm_ops samsung_keypad_pm_ops = {
 };
 #endif
 
+#ifdef CONFIG_OF
+static const struct of_device_id samsung_keypad_dt_match[] = {
+	{ .compatible = "samsung,s3c6410-keypad" },
+	{ .compatible = "samsung,s5pv210-keypad" },
+	{},
+};
+MODULE_DEVICE_TABLE(of, samsung_keypad_dt_match);
+#else
+#define samsung_keypad_dt_match NULL
+#endif
+
 static struct platform_device_id samsung_keypad_driver_ids[] = {
 	{
 		.name		= "samsung-keypad",
@@ -465,6 +617,7 @@ static struct platform_driver samsung_keypad_driver = {
 	.driver		= {
 		.name	= "samsung-keypad",
 		.owner	= THIS_MODULE,
+		.of_match_table = samsung_keypad_dt_match,
 #ifdef CONFIG_PM
 		.pm	= &samsung_keypad_pm_ops,
 #endif
Signature · 1 line
1.6.6.rc2
#4 lore raw

PATCH v2 2/2 input: samsung-keypad: Add device tree support

Hi Grant,

Quoted 49 lines · Grant Likely
Quoted 48 lines · Thomas Abraham

Add device tree based discovery support for Samsung's keypad controller.

Cc Joonyoung Shim <[email protected]>
Cc Donghwa Lee <[email protected]>

---
?.../devicetree/bindings/input/samsung-keypad.txt ? | ? 88 ++++++++++ ?drivers/input/keyboard/samsung-keypad.c ? ? ? ? ? ?| ?177 ++++++++++++++++++-- ?2 files changed, 253 insertions(+), 12 deletions(-)
?create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt

Documentation/devicetree/bindings/input/samsung-keypad.txt new file +31 -0
new file mode 100644
index 0000000..e1c7237
@@ -0,0 +1,88 @@
+* Samsung's Keypad Controller device tree bindings
+
+Samsung's Keypad controller is used to interface a SoC with a matrix-type
+keypad device. The keypad controller supports multiple row and column lines.
+A key can be placed at each intersection of a unique row and a unique column.
+The keypad controller can sense a key-press and key-release and report the
+event using a interrupt to the cpu.
+
+Required SoC Specific Properties:
+- compatible: should be one of the following
+ ?- "samsung,s3c6410-keypad": For controllers compatible with s3c6410 keypad
+ ? ?controller.
+ ?- "samsung,s5pv210-keypad": For controllers compatible with s5pv210 keypad
+ ? ?controller.
+
+- reg: physical base address of the controller and length of memory mapped
+ ?region.
+
+- interrupts: The interrupt number to the cpu.
+
+Required Board Specific Properties:
+- samsung,keypad-num-rows: Number of row lines connected to the keypad
+ ?controller.
+
+- samsung,keypad-num-columns: Number of column lines connected to the
+ ?keypad controller.
+
+- row-gpios: List of gpios used as row lines. The gpio specifier for
+ ?this property depends on the gpio controller to which these row lines
+ ?are connected.
+
Quoted 8 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 34

Quoted 3 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +3 -0
+- col-gpios: List of gpios used as column lines. The gpio specifier for
+ ?this property depends on the gpio controller to which these column
+ ?lines are connected.

I know we've got overlapping terminology here. ?When you say GPIOs here, does it refer to the pin multiplexing feature of the samsung parts, and thus how the keypad controller IO is routed to the pins? Or does the driver manipulate GPIO lines manually?

It is intended to mean gpio and not the pinmux. But the way the gpio specifier is specified in the dts file, it includes information about both gpio number and the pin-control details. For instance, if 'gpa0' is a gpio controller (which includes pin-control functionality as well in the hardware), then the gpio specifier for the keypad would be as below.

row-gpios = <&gpa0 0 3 3 0>,

                 <&gpa0 1 3 3 0>;

The syntax for the gpio specifier is
<[phandle of gpio controller] [pin number within the gpio controller] [mux function] [pull up/down] [drive strength]>

The keypad driver does not know or use the mux function, pull up/down and drive strength details. The driver would call of_get_gpio to get the linux gpio number and then do a gpio_request on that gpio number. The gpio dt support manges the pin-mux and other settings transparently for the keypad driver. So even though the gpio specifier format changes, the dt support code for the driver does not change.

The driver does not manipulate the gpios directly. It just requests for the gpio number and makes a note of the number to free it when the driver unbinds.

Quoted 4 lines

If it is pin multiplexing, then using the GPIO binding seems rather odd. It may be entirely appropriate, but it will need to play well with the pinmux stuff that linusw is working on.

When pinmux/pin-ctrl functionality which linusw is developing is used for this driver, it would be a extension to this patch. The driver would request for the gpio and then use the pin-ctrl subsystem api to setup the pin-control. In that case, the gpio-specifier would change but that change would be break anything which this patch does.

Quoted 11 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 42

Quoted 9 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +8 -0
+
+- Keys represented as child nodes: Each key connected to the keypad
+ ?controller is represented as a child node to the keypad controller
+ ?device node and should include the following properties.
+ ?- keypad,row: the row number to which the key is connected.
+ ?- keypad,column: the column number to which the key is connected.
+ ?- keypad,key-code: the key-code to be reported when the key is pressed
+ ? ?and released.

What defines the meanings of the key codes?

The key-code could be any value which the system would want the keypad driver to report when that key is pressed.

Quoted 7 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 46

Quoted 5 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +4 -0
+
+Optional Properties specific to linux:
+- linux,keypad-no-autorepeat: do no enable autorepeat feature.
+- linux,keypad-wakeup: use any event on keypad as wakeup event.

Is this really a linux-specific feature?

Yes, it is a property defined by the linux subsystems. A non-linux system might not have such features.

Quoted 98 lines
Quoted 98 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +42 -0
+
+
+Example:
+ ? ? keypad at 100A0000 {
+ ? ? ? ? ? ? compatible = "samsung,s5pv210-keypad";
+ ? ? ? ? ? ? reg = <0x100A0000 0x100>;
+ ? ? ? ? ? ? interrupts = <173>;
+ ? ? ? ? ? ? samsung,keypad-num-rows = <2>;
+ ? ? ? ? ? ? samsung,keypad-num-columns = <8>;
+ ? ? ? ? ? ? linux,input-no-autorepeat;
+ ? ? ? ? ? ? linux,input-wakeup;
+
+ ? ? ? ? ? ? row-gpios = <&gpx2 0 3 3 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx2 1 3 3 0>;
+
+ ? ? ? ? ? ? col-gpios = <&gpx1 0 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 1 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 2 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 3 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 4 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 5 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 6 3 0 0
+ ? ? ? ? ? ? ? ? ? ? ? ? ?&gpx1 7 3 0 0>;
+
+ ? ? ? ? ? ? key_1 {
+ ? ? ? ? ? ? ? ? ? ? keypad,row = <0>;
+ ? ? ? ? ? ? ? ? ? ? keypad,column = <3>;
+ ? ? ? ? ? ? ? ? ? ? keypad,key-code = <2>;
+ ? ? ? ? ? ? };
+
+ ? ? ? ? ? ? key_2 {
+ ? ? ? ? ? ? ? ? ? ? keypad,row = <0>;
+ ? ? ? ? ? ? ? ? ? ? keypad,column = <4>;
+ ? ? ? ? ? ? ? ? ? ? keypad,key-code = <3>;
+ ? ? ? ? ? ? };
+
+ ? ? ? ? ? ? key_3 {
+ ? ? ? ? ? ? ? ? ? ? keypad,row = <0>;
+ ? ? ? ? ? ? ? ? ? ? keypad,column = <5>;
+ ? ? ? ? ? ? ? ? ? ? keypad,key-code = <4>;
+ ? ? ? ? ? ? };
+ ? ? };
drivers/input/keyboard/samsung-keypad.c +0 -0
index f689f49..cf01a56 100644
@@ -21,6 +21,8 @@

?#include <linux/module.h>
?#include <linux/platform_device.h>
?#include <linux/slab.h>

drivers/input/keyboard/samsung-keypad.c +2 -0
+#include <linux/of.h>
+#include <linux/of_gpio.h>

?#include <linux/sched.h>
?#include <plat/keypad.h>

drivers/input/keyboard/samsung-keypad.c +6 -11
@@ -68,31 +70,26 @@ struct samsung_keypad {
 ? ? ? wait_queue_head_t wait;
 ? ? ? bool stopped;
 ? ? ? int irq;
+ ? ? enum samsung_keypad_type type;
 ? ? ? unsigned int row_shift;
 ? ? ? unsigned int rows;
 ? ? ? unsigned int cols;
 ? ? ? unsigned int row_state[SAMSUNG_MAX_COLS];
+#ifdef CONFIG_OF
+ ? ? int row_gpios[SAMSUNG_MAX_ROWS];
+ ? ? int col_gpios[SAMSUNG_MAX_COLS];
+#endif
 ? ? ? unsigned short keycodes[];
 ?};
 
-static int samsung_keypad_is_s5pv210(struct device *dev)
-{
- ? ? struct platform_device *pdev = to_platform_device(dev);
- ? ? enum samsung_keypad_type type =
- ? ? ? ? ? ? platform_get_device_id(pdev)->driver_data;
-
- ? ? return type == KEYPAD_TYPE_S5PV210;
-}
-
 ?static void samsung_keypad_scan(struct samsung_keypad *keypad,
 ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? unsigned int *row_state)
 ?{
- ? ? struct device *dev = keypad->input_dev->dev.parent;
 ? ? ? unsigned int col;
 ? ? ? unsigned int val;
 
 ? ? ? for (col = 0; col < keypad->cols; col++) {
- ? ? ? ? ? ? if (samsung_keypad_is_s5pv210(dev)) {
+ ? ? ? ? ? ? if (keypad->type == KEYPAD_TYPE_S5PV210) {
 ? ? ? ? ? ? ? ? ? ? ? val = S5PV210_KEYIFCOLEN_MASK;
 ? ? ? ? ? ? ? ? ? ? ? val &= ~(1 << col) << 8;
 ? ? ? ? ? ? ? } else {
@@ -235,6 +232,129 @@ static void samsung_keypad_close(struct input_dev *input_dev)
 ? ? ? samsung_keypad_stop(keypad);
 ?}
 
Quoted 6 lines

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 237

Quoted 3 lines
drivers/input/keyboard/samsung-keypad.c +3 -0
+#ifdef CONFIG_OF
+static
+struct samsung_keypad_platdata *samsung_keypad_parse_dt(struct device *dev)

Nit: keep everything up to the function name on the same line. ?It is more grep-friendly to make line breaks in the parameters list.

Ok. I will change this.

Quoted 11 lines
Quoted 11 lines
drivers/input/keyboard/samsung-keypad.c +10 -0
+{
+ ? ? struct samsung_keypad_platdata *pdata;
+ ? ? struct matrix_keymap_data *keymap_data;
+ ? ? uint32_t *keymap;
+ ? ? struct device_node *np = dev->of_node, *key_np;
+ ? ? unsigned int key_count = 0;
+
+ ? ? pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
+ ? ? if (!pdata) {
+ ? ? ? ? ? ? dev_err(dev, "could not allocate memory for platform data\n");
Quoted 8 lines

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 252

Quoted 5 lines
drivers/input/keyboard/samsung-keypad.c +5 -0
+ ? ? ? ? ? ? return NULL;
+ ? ? }
+
+ ? ? of_property_read_u32(np, "samsung,keypad-num-rows", &pdata->rows);
+ ? ? of_property_read_u32(np, "samsung,keypad-num-columns", &pdata->cols);

pdata->rows and ->cols needs to be changed to a u32 for this to be safe.

Ok.

Quoted 20 lines
Quoted 20 lines
drivers/input/keyboard/samsung-keypad.c +19 -0
+ ? ? if (!pdata->rows || !pdata->cols) {
+ ? ? ? ? ? ? dev_err(dev, "number of keypad rows/columns not specified\n");
+ ? ? ? ? ? ? return NULL;
+ ? ? }
+
+ ? ? keymap_data = devm_kzalloc(dev, sizeof(*keymap_data), GFP_KERNEL);
+ ? ? if (!keymap_data) {
+ ? ? ? ? ? ? dev_err(dev, "could not allocate memory for keymap data\n");
+ ? ? ? ? ? ? return NULL;
+ ? ? }
+ ? ? pdata->keymap_data = keymap_data;
+
+ ? ? for_each_child_of_node(np, key_np)
+ ? ? ? ? ? ? key_count++;
+
+ ? ? keymap_data->keymap_size = key_count;
+ ? ? keymap = devm_kzalloc(dev, sizeof(uint32_t) * key_count, GFP_KERNEL);
+ ? ? if (!keymap) {
+ ? ? ? ? ? ? dev_err(dev, "could not allocate memory for keymap\n");
Quoted 8 lines

drivers/input/keyboard/samsung-keypad.c static void samsung_keypad_close(struct input_dev *input_dev) · line 277

Quoted 6 lines
drivers/input/keyboard/samsung-keypad.c +6 -0
+ ? ? ? ? ? ? return NULL;
+ ? ? }
+ ? ? keymap_data->keymap = keymap;
+
+ ? ? for_each_child_of_node(np, key_np) {
+ ? ? ? ? ? ? unsigned int row, col, key_code;

These need to be u32

Ok.

Quoted 100 lines
Quoted 100 lines
drivers/input/keyboard/samsung-keypad.c +84 -1
+ ? ? ? ? ? ? of_property_read_u32(key_np, "keypad,row", &row);
+ ? ? ? ? ? ? of_property_read_u32(key_np, "keypad,column", &col);
+ ? ? ? ? ? ? of_property_read_u32(key_np, "keypad,key-code", &key_code);
+ ? ? ? ? ? ? *keymap++ = KEY(row, col, key_code);
+ ? ? }
+
+ ? ? if (of_get_property(np, "linux,input-no-autorepeat", NULL))
+ ? ? ? ? ? ? pdata->no_autorepeat = true;
+ ? ? if (of_get_property(np, "linux,input-wakeup", NULL))
+ ? ? ? ? ? ? pdata->wakeup = true;
+
+ ? ? return pdata;
+}
+
+static void samsung_keypad_parse_dt_gpio(struct device *dev,
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? struct samsung_keypad *keypad)
+{
+ ? ? struct device_node *np = dev->of_node;
+ ? ? int gpio, ret, row, col;
+
+ ? ? for (row = 0; row < keypad->rows; row++) {
+ ? ? ? ? ? ? gpio = of_get_named_gpio(np, "row-gpios", row);
+ ? ? ? ? ? ? keypad->row_gpios[row] = gpio;
+ ? ? ? ? ? ? if (!gpio_is_valid(gpio)) {
+ ? ? ? ? ? ? ? ? ? ? dev_err(dev, "keypad row[%d]: invalid gpio %d\n",
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? row, gpio);
+ ? ? ? ? ? ? ? ? ? ? continue;
+ ? ? ? ? ? ? }
+
+ ? ? ? ? ? ? ret = gpio_request(gpio, "keypad-row");
+ ? ? ? ? ? ? if (ret)
+ ? ? ? ? ? ? ? ? ? ? dev_err(dev, "keypad row[%d] gpio request failed\n",
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? row);
+ ? ? }
+
+ ? ? for (col = 0; col < keypad->cols; col++) {
+ ? ? ? ? ? ? gpio = of_get_named_gpio(np, "col-gpios", col);
+ ? ? ? ? ? ? keypad->col_gpios[col] = gpio;
+ ? ? ? ? ? ? if (!gpio_is_valid(gpio)) {
+ ? ? ? ? ? ? ? ? ? ? dev_err(dev, "keypad column[%d]: invalid gpio %d\n",
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? col, gpio);
+ ? ? ? ? ? ? ? ? ? ? continue;
+ ? ? ? ? ? ? }
+
+ ? ? ? ? ? ? ret = gpio_request(col, "keypad-col");
+ ? ? ? ? ? ? if (ret)
+ ? ? ? ? ? ? ? ? ? ? dev_err(dev, "keypad column[%d] gpio request failed\n",
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? col);
+ ? ? }
+}
+
+static void samsung_keypad_dt_gpio_free(struct samsung_keypad *keypad)
+{
+ ? ? int cnt;
+
+ ? ? for (cnt = 0; cnt < keypad->rows; cnt++)
+ ? ? ? ? ? ? if (gpio_is_valid(keypad->row_gpios[cnt]))
+ ? ? ? ? ? ? ? ? ? ? gpio_free(keypad->row_gpios[cnt]);
+
+ ? ? for (cnt = 0; cnt < keypad->cols; cnt++)
+ ? ? ? ? ? ? if (gpio_is_valid(keypad->col_gpios[cnt]))
+ ? ? ? ? ? ? ? ? ? ? gpio_free(keypad->col_gpios[cnt]);
+}
+#else
+static
+struct samsung_keypad_platdata *samsung_keypad_parse_dt(struct device *dev)
+{
+ ? ? return NULL;
+}
+
+static void samsung_keypad_parse_dt_gpio(struct device *dev,
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? struct samsung_keypad *keypad)
+{
+}
+
+static void samsung_keypad_dt_gpio_free(struct samsung_keypad *keypad)
+{
+}
+#endif
+
 ?static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 ?{
 ? ? ? const struct samsung_keypad_platdata *pdata;
@@ -246,7 +366,10 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 ? ? ? unsigned int keymap_size;
 ? ? ? int error;
 
- ? ? pdata = pdev->dev.platform_data;
+ ? ? if (pdev->dev.of_node)
+ ? ? ? ? ? ? pdata = samsung_keypad_parse_dt(&pdev->dev);
+ ? ? else
+ ? ? ? ? ? ? pdata = pdev->dev.platform_data;
 ? ? ? if (!pdata) {
 ? ? ? ? ? ? ? dev_err(&pdev->dev, "no platform data defined\n");
 ? ? ? ? ? ? ? return -EINVAL;
@@ -303,6 +426,16 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 ? ? ? keypad->cols = pdata->cols;
 ? ? ? init_waitqueue_head(&keypad->wait);
 
Quoted 8 lines

drivers/input/keyboard/samsung-keypad.c static int __devinit samsung_keypad_probe(struct platform_device *pdev) · line 434

Quoted 6 lines
drivers/input/keyboard/samsung-keypad.c +6 -0
+ ? ? if (pdev->dev.of_node) {
+ ? ? ? ? ? ? samsung_keypad_parse_dt_gpio(&pdev->dev, keypad);
+#ifdef CONFIG_OF
+ ? ? ? ? ? ? keypad->type = of_device_is_compatible(pdev->dev.of_node,
+ ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? "samsung,s5pv210-keypad");
+#endif

It is odd having the #ifdef around only part of the if() block.

I did not want to do it this way. But any other way would have increased the number of lines added. If is against the coding rules or style, I will change it.

Quoted 10 lines
Quoted 10 lines
drivers/input/keyboard/samsung-keypad.c +4 -0
+ ? ? } else {
+ ? ? ? ? ? ? keypad->type = platform_get_device_id(pdev)->driver_data;
+ ? ? }
+
 ? ? ? input_dev->name = pdev->name;
 ? ? ? input_dev->id.bustype = BUS_HOST;
 ? ? ? input_dev->dev.parent = &pdev->dev;
@@ -343,12 +476,19 @@ static int __devinit samsung_keypad_probe(struct platform_device *pdev)
 
Quoted 11 lines

drivers/input/keyboard/samsung-keypad.c static int __devinit samsung_keypad_probe(struct platform_device *pdev) · line 484

Quoted 8 lines
drivers/input/keyboard/samsung-keypad.c +6 -0
 ? ? ? device_init_wakeup(&pdev->dev, pdata->wakeup);
 ? ? ? platform_set_drvdata(pdev, keypad);
+
+ ? ? if (pdev->dev.of_node) {
+ ? ? ? ? ? ? devm_kfree(&pdev->dev, (void *)pdata->keymap_data->keymap);
+ ? ? ? ? ? ? devm_kfree(&pdev->dev, (void *)pdata->keymap_data);
+ ? ? ? ? ? ? devm_kfree(&pdev->dev, (void *)pdata);
+ ? ? }

Don't need to do this. ?The driver core will take care of freeing the devm for you when removed.

Dmitry Torokhov suggested that since the allocated pdata is not used after the probe, it can be deallocated to save some memory. So this was added.

Quoted 3 lines

A few things that should be fixed up, but otherwise looks pretty good.

Thanks for your review and suggestions.

Regards,
Thomas.

[...]

#5 lore raw

PATCH 2/2 input: samsung-keypad: Add device tree support

Quoted 107 lines · Thomas Abraham

Hi Grant,

Quoted 49 lines · Grant Likely
Quoted 48 lines · Thomas Abraham

Add device tree based discovery support for Samsung's keypad controller.

Cc Joonyoung Shim <[email protected]>
Cc Donghwa Lee <[email protected]>

---
?.../devicetree/bindings/input/samsung-keypad.txt ? | ? 88 ++++++++++ ?drivers/input/keyboard/samsung-keypad.c ? ? ? ? ? ?| ?177 ++++++++++++++++++-- ?2 files changed, 253 insertions(+), 12 deletions(-)
?create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt

Documentation/devicetree/bindings/input/samsung-keypad.txt new file +31 -0
new file mode 100644
index 0000000..e1c7237
@@ -0,0 +1,88 @@
+* Samsung's Keypad Controller device tree bindings
+
+Samsung's Keypad controller is used to interface a SoC with a matrix-type
+keypad device. The keypad controller supports multiple row and column lines.
+A key can be placed at each intersection of a unique row and a unique column.
+The keypad controller can sense a key-press and key-release and report the
+event using a interrupt to the cpu.
+
+Required SoC Specific Properties:
+- compatible: should be one of the following
+ ?- "samsung,s3c6410-keypad": For controllers compatible with s3c6410 keypad
+ ? ?controller.
+ ?- "samsung,s5pv210-keypad": For controllers compatible with s5pv210 keypad
+ ? ?controller.
+
+- reg: physical base address of the controller and length of memory mapped
+ ?region.
+
+- interrupts: The interrupt number to the cpu.
+
+Required Board Specific Properties:
+- samsung,keypad-num-rows: Number of row lines connected to the keypad
+ ?controller.
+
+- samsung,keypad-num-columns: Number of column lines connected to the
+ ?keypad controller.
+
+- row-gpios: List of gpios used as row lines. The gpio specifier for
+ ?this property depends on the gpio controller to which these row lines
+ ?are connected.
+
Quoted 8 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 34

Quoted 3 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +3 -0
+- col-gpios: List of gpios used as column lines. The gpio specifier for
+ ?this property depends on the gpio controller to which these column
+ ?lines are connected.

I know we've got overlapping terminology here. ?When you say GPIOs here, does it refer to the pin multiplexing feature of the samsung parts, and thus how the keypad controller IO is routed to the pins? Or does the driver manipulate GPIO lines manually?

It is intended to mean gpio and not the pinmux. But the way the gpio specifier is specified in the dts file, it includes information about both gpio number and the pin-control details. For instance, if 'gpa0' is a gpio controller (which includes pin-control functionality as well in the hardware), then the gpio specifier for the keypad would be as below.

row-gpios = <&gpa0 0 3 3 0>,

                 <&gpa0 1 3 3 0>;

The syntax for the gpio specifier is
<[phandle of gpio controller] [pin number within the gpio controller] [mux function] [pull up/down] [drive strength]>

The keypad driver does not know or use the mux function, pull up/down and drive strength details. The driver would call of_get_gpio to get the linux gpio number and then do a gpio_request on that gpio number. The gpio dt support manges the pin-mux and other settings transparently for the keypad driver. So even though the gpio specifier format changes, the dt support code for the driver does not change.

The driver does not manipulate the gpios directly. It just requests for the gpio number and makes a note of the number to free it when the driver unbinds.

Quoted 4 lines

If it is pin multiplexing, then using the GPIO binding seems rather odd. It may be entirely appropriate, but it will need to play well with the pinmux stuff that linusw is working on.

When pinmux/pin-ctrl functionality which linusw is developing is used for this driver, it would be a extension to this patch. The driver would request for the gpio and then use the pin-ctrl subsystem api to setup the pin-control. In that case, the gpio-specifier would change but that change would be break anything which this patch does.

Quoted 10 lines
Quoted 9 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +8 -0
+
+- Keys represented as child nodes: Each key connected to the keypad
+ ?controller is represented as a child node to the keypad controller
+ ?device node and should include the following properties.
+ ?- keypad,row: the row number to which the key is connected.
+ ?- keypad,column: the column number to which the key is connected.
+ ?- keypad,key-code: the key-code to be reported when the key is pressed
+ ? ?and released.
Quoted 4 lines
Quoted 1 line

What defines the meanings of the key codes?

The key-code could be any value which the system would want the keypad driver to report when that key is pressed.

Are they linux keycodes? If so, then this property name can probably be linux,code. There is already precedence for that usage in Documentation/devicetree/bindings/gpio/gpio-keys.txt. (I would personally prefer "linux,key-code", but sometimes it is better to go with existing precidence) You could also use linux,input-type as specified in that binding.

Quoted 11 lines
Quoted 8 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 46

Quoted 6 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +4 -0
+
+Optional Properties specific to linux:
+- linux,keypad-no-autorepeat: do no enable autorepeat feature.
+- linux,keypad-wakeup: use any event on keypad as wakeup event.

Is this really a linux-specific feature?

Yes, it is a property defined by the linux subsystems. A non-linux system might not have such features.

I was specifically referring to the wakeup property, but okay, I can see the argument that it is linux-specific because it is usage-policy related.

g.

#6 lore raw

PATCH v2 2/2 input: samsung-keypad: Add device tree support

Hi Grant,

Quoted 16 lines · Grant Likely
Quoted 15 lines · Thomas Abraham

Hi Grant,

Quoted 12 lines · Grant Likely
Quoted 11 lines · Thomas Abraham

Add device tree based discovery support for Samsung's keypad controller.

Cc Joonyoung Shim <[email protected]>
Cc Donghwa Lee <[email protected]>

---
?.../devicetree/bindings/input/samsung-keypad.txt ? | ? 88 ++++++++++ ?drivers/input/keyboard/samsung-keypad.c ? ? ? ? ? ?| ?177 ++++++++++++++++++-- ?2 files changed, 253 insertions(+), 12 deletions(-)
?create mode 100644 Documentation/devicetree/bindings/input/samsung-keypad.txt

[...]

Quoted 13 lines
Quoted 8 lines
Quoted 8 lines
Quoted 7 lines

+- Keys represented as child nodes: Each key connected to the keypad
+ ?controller is represented as a child node to the keypad controller
+ ?device node and should include the following properties.
+ ?- keypad,row: the row number to which the key is connected.
+ ?- keypad,column: the column number to which the key is connected.
+ ?- keypad,key-code: the key-code to be reported when the key is pressed
+ ? ?and released.

Quoted 4 lines
Quoted 1 line

What defines the meanings of the key codes?

The key-code could be any value which the system would want the keypad driver to report when that key is pressed.

Quoted 6 lines

Are they linux keycodes? ?If so, then this property name can probably be linux,code. ?There is already precedence for that usage in Documentation/devicetree/bindings/gpio/gpio-keys.txt. ?(I would personally prefer "linux,key-code", but sometimes it is better to go with existing precidence) You could also use linux,input-type as specified in that binding.

Ok. For linux, "keypad,key-code" would mean linux keycodes. The property name 'keypad,key-code' was chosen since it can be reused on non-linux platforms as well. I did have a look at Documentation/devicetree/bindings/gpio/gpio-keys.txt while doing this, but preferred using 'keypad,key-code' since it would be generic. Given a choice, I would like to retain this.

Quoted 10 lines
Quoted 10 lines
Quoted 9 lines

Documentation/devicetree/bindings/input/samsung-keypad.txt line 46

Quoted 7 lines
Documentation/devicetree/bindings/input/samsung-keypad.txt new file +4 -0
+
+Optional Properties specific to linux:
+- linux,keypad-no-autorepeat: do no enable autorepeat feature.
+- linux,keypad-wakeup: use any event on keypad as wakeup event.

Is this really a linux-specific feature?

Quoted 8 lines
Quoted 2 lines

Yes, it is a property defined by the linux subsystems. A non-linux system might not have such features.

I was specifically referring to the wakeup property, but okay, I can see the argument that it is linux-specific because it is usage-policy related.

g.

Thanks for your review.

Regards,
Thomas.

#7 lore raw

PATCH 2/2 input: samsung-keypad: Add device tree support

Quoted 24 lines · Thomas Abraham
Quoted 16 lines · Grant Likely
Quoted 10 lines · Thomas Abraham
Quoted 9 lines · Grant Likely
Quoted 7 lines · Thomas Abraham

+- Keys represented as child nodes: Each key connected to the keypad
+ ?controller is represented as a child node to the keypad controller
+ ?device node and should include the following properties.
+ ?- keypad,row: the row number to which the key is connected.
+ ?- keypad,column: the column number to which the key is connected.
+ ?- keypad,key-code: the key-code to be reported when the key is pressed
+ ? ?and released.

Quoted 4 lines
Quoted 1 line

What defines the meanings of the key codes?

The key-code could be any value which the system would want the keypad driver to report when that key is pressed.

Quoted 6 lines

Are they linux keycodes? ?If so, then this property name can probably be linux,code. ?There is already precedence for that usage in Documentation/devicetree/bindings/gpio/gpio-keys.txt. ?(I would personally prefer "linux,key-code", but sometimes it is better to go with existing precidence) You could also use linux,input-type as specified in that binding.

Quoted 6 lines

Ok. For linux, "keypad,key-code" would mean linux keycodes. The property name 'keypad,key-code' was chosen since it can be reused on non-linux platforms as well. I did have a look at Documentation/devicetree/bindings/gpio/gpio-keys.txt while doing this, but preferred using 'keypad,key-code' since it would be generic. Given a choice, I would like to retain this.

This was debated a bit on the gpio-keys binding. The binding *must* specify where it is getting the keycodes from. For the gpio-keys binding, it was decided that the Linux keycodes were sufficient since they are exported to userspace, and therefore part of the stable kernel ABI (they will never change). "keypad,key-code" is completely useless as a generic binding since it doesn't specify where the keycode meanings come from. Besides, "linux,code" can be reused on non-linux platforms too, it just means that the authoritative source of the keycodes is the Linux kernel.

g

#8 lore raw

PATCH v2 2/2 input: samsung-keypad: Add device tree support

Quoted 43 lines · Grant Likely
Quoted 24 lines · Thomas Abraham
Quoted 16 lines · Grant Likely
Quoted 10 lines · Thomas Abraham
Quoted 9 lines · Grant Likely
Quoted 7 lines · Thomas Abraham

+- Keys represented as child nodes: Each key connected to the keypad
+ ?controller is represented as a child node to the keypad controller
+ ?device node and should include the following properties.
+ ?- keypad,row: the row number to which the key is connected.
+ ?- keypad,column: the column number to which the key is connected.
+ ?- keypad,key-code: the key-code to be reported when the key is pressed
+ ? ?and released.

Quoted 4 lines
Quoted 1 line

What defines the meanings of the key codes?

The key-code could be any value which the system would want the keypad driver to report when that key is pressed.

Quoted 6 lines

Are they linux keycodes? ?If so, then this property name can probably be linux,code. ?There is already precedence for that usage in Documentation/devicetree/bindings/gpio/gpio-keys.txt. ?(I would personally prefer "linux,key-code", but sometimes it is better to go with existing precidence) You could also use linux,input-type as specified in that binding.

Quoted 6 lines

Ok. For linux, "keypad,key-code" would mean linux keycodes. The property name 'keypad,key-code' was chosen since it can be reused on non-linux platforms as well. I did have a look at Documentation/devicetree/bindings/gpio/gpio-keys.txt while doing this, but preferred using 'keypad,key-code' since it would be generic. Given a choice, I would like to retain this.

This was debated a bit on the gpio-keys binding. ?The binding *must* specify where it is getting the keycodes from. ?For the gpio-keys binding, it was decided that the Linux keycodes were sufficient since they are exported to userspace, and therefore part of the stable kernel ABI (they will never change). ?"keypad,key-code" is completely useless as a generic binding since it doesn't specify where the keycode meanings come from. ?Besides, "linux,code" can be reused on non-linux platforms too, it just means that the authoritative source of the keycodes is the Linux kernel.

Quoted 2 lines

g

Ok. I understand this now. I will change this to "linux,code" in the next submission.

Thanks,
Thomas.