Skip to contentSkip to conversation

arm: sunxi: IR support for A83T

PATCH Superseded Philipp Rossak 5 participants 13 messages Dec 17, 2017 – Dec 18, 2017

Subsystems (4)

v1 of 7 Superseded Latest is v7 →

lore
Share & tools
lore
#0 lore raw

cover arm: sunxi: IR support for A83T

This patch series adds support for the sunxi A83T ir module and enhances the sunxi-ir driver. Right now the base clock frequency for the ir driver is a hard coded define and is set to 8 MHz. This works for the most common ir receivers. On the Sinovoip Bananapi M3 the ir receiver needs, a 3 MHz base clock frequency to work without problems with this driver.

This patch series adds support for an optinal property that makes it able to override the default base clock frequency and enables the ir interface on the a83t and the Bananapi M3.

changes since rfc:
* The property is now optinal. If the property is not available in the dtb the driver uses the default base clock frequency.
* the driver prints out the the selected base clock frequency.
* changed devicetree property from base-clk-frequency to clock-frequency

Regards,
Philipp

rfc: https://www.mail-archive.com/linux-media at vger.kernel.org/msg123359.html

Philipp Rossak (5):
media: rc: update sunxi-ir driver to get base clock frequency from
devicetree
media: dt: bindings: Update binding documentation for sunxi IR
controller
arm: dts: sun8i: a83t: Add the ir pin for the A83T
arm: dts: sun8i: a83t: Add support for the ir interface
arm: dts: sun8i: a83t: bananapi-m3: Enable IR controller

 Documentation/devicetree/bindings/media/sunxi-ir.txt |  2 ++
 arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts         |  7 +++++++
 arch/arm/boot/dts/sun8i-a83t.dtsi                    | 15 +++++++++++++++
 drivers/media/rc/sunxi-cir.c                         | 20 ++++++++++++--------
 4 files changed, 36 insertions(+), 8 deletions(-)
Signature · 1 line
2.11.0
#1 lore raw

PATCH 1/5 media: rc: update sunxi-ir driver to get base clock frequency from devicetree

This patch updates the sunxi-ir driver to set the base clock frequency from devicetree.

This is neccessary since there are different ir recievers on the market, that operate with different frequencys. So this value could be set if the attached ir receiver needs an other base clock frequency, than the default 8 MHz.

---
 drivers/media/rc/sunxi-cir.c | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)
drivers/media/rc/sunxi-cir.c +12 -8
index 97f367b446c4..9bbe55a76860 100644
@@ -72,12 +72,8 @@
 /* CIR_REG register idle threshold */
 #define REG_CIR_ITHR(val)    (((val) << 8) & (GENMASK(15, 8)))
 
-/* Required frequency for IR0 or IR1 clock in CIR mode */
+/* Required frequency for IR0 or IR1 clock in CIR mode (default) */
 #define SUNXI_IR_BASE_CLK     8000000
-/* Frequency after IR internal divider  */
-#define SUNXI_IR_CLK          (SUNXI_IR_BASE_CLK / 64)
-/* Sample period in ns */
-#define SUNXI_IR_SAMPLE       (1000000000ul / SUNXI_IR_CLK)
 /* Noise threshold in samples  */
 #define SUNXI_IR_RXNOISE      1
 /* Idle Threshold in samples */
@@ -122,7 +118,7 @@ static irqreturn_t sunxi_ir_irq(int irqno, void *dev_id)
 			/* for each bit in fifo */
 			dt = readb(ir->base + SUNXI_IR_RXFIFO_REG);
 			rawir.pulse = (dt & 0x80) != 0;
-			rawir.duration = ((dt & 0x7f) + 1) * SUNXI_IR_SAMPLE;
+			rawir.duration = ((dt & 0x7f) + 1) * ir->rc->rx_resolution;
 			ir_raw_event_store_with_filter(ir->rc, &rawir);
 		}
 	}
@@ -148,6 +144,7 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	struct device_node *dn = dev->of_node;
 	struct resource *res;
 	struct sunxi_ir *ir;
+	u32 b_clk_freq;
 
 	ir = devm_kzalloc(dev, sizeof(struct sunxi_ir), GFP_KERNEL);
 	if (!ir)
@@ -172,6 +169,11 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 		return PTR_ERR(ir->clk);
 	}
 
+	/* Base clock frequency (optional) */
+	if (of_property_read_u32(dn, "clock-frequency", &b_clk_freq)) {
+		b_clk_freq = SUNXI_IR_BASE_CLK;
+	}
+
 	/* Reset (optional) */
 	ir->rst = devm_reset_control_get_optional_exclusive(dev, NULL);
 	if (IS_ERR(ir->rst))
@@ -180,11 +182,12 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	if (ret)
 		return ret;
 
-	ret = clk_set_rate(ir->clk, SUNXI_IR_BASE_CLK);
+	ret = clk_set_rate(ir->clk, b_clk_freq);
 	if (ret) {
 		dev_err(dev, "set ir base clock failed!\n");
 		goto exit_reset_assert;
 	}
+	dev_info(dev, "set base clock frequency to %d Hz.\n", b_clk_freq);
 
 	if (clk_prepare_enable(ir->apb_clk)) {
 		dev_err(dev, "try to enable apb_ir_clk failed\n");
@@ -225,7 +228,8 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	ir->rc->map_name = ir->map_name ?: RC_MAP_EMPTY;
 	ir->rc->dev.parent = dev;
 	ir->rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
-	ir->rc->rx_resolution = SUNXI_IR_SAMPLE;
+	/* Frequency after IR internal divider with sample period in ns */
+	ir->rc->rx_resolution = (1000000000ul / (b_clk_freq / 64));
 	ir->rc->timeout = MS_TO_NS(SUNXI_IR_TIMEOUT);
 	ir->rc->driver_name = SUNXI_IR_DEV;
 
Signature · 1 line
2.11.0
maintainer
#2 lore raw

Re: [PATCH 1/5] media: rc: update sunxi-ir driver to get base clock frequency from devicetree

Quoted 5 lines · Philipp Rossak

This patch updates the sunxi-ir driver to set the base clock frequency from devicetree.

This is neccessary since there are different ir recievers on the market, that operate with different frequencys. So this value could be

s/neccessary/necessary/
s/recievers/receivers/
s/frequencys/frequencies/

Quoted 2 lines

set if the attached ir receiver needs an other base clock frequency, than the default 8 MHz.

s/other/different/

Quoted 25 lines
---
 drivers/media/rc/sunxi-cir.c | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)
drivers/media/rc/sunxi-cir.c +1 -5
index 97f367b446c4..9bbe55a76860 100644
@@ -72,12 +72,8 @@
 /* CIR_REG register idle threshold */
 #define REG_CIR_ITHR(val)    (((val) << 8) & (GENMASK(15, 8)))
 
-/* Required frequency for IR0 or IR1 clock in CIR mode */
+/* Required frequency for IR0 or IR1 clock in CIR mode (default) */
 #define SUNXI_IR_BASE_CLK     8000000
-/* Frequency after IR internal divider  */
-#define SUNXI_IR_CLK          (SUNXI_IR_BASE_CLK / 64)
-/* Sample period in ns */
-#define SUNXI_IR_SAMPLE       (1000000000ul / SUNXI_IR_CLK)
 /* Noise threshold in samples  */
 #define SUNXI_IR_RXNOISE      1
 /* Idle Threshold in samples */

drivers/media/rc/sunxi-cir.c static irqreturn_t sunxi_ir_irq(int irqno, void *dev_id) · line 121

Quoted 5 lines
drivers/media/rc/sunxi-cir.c +1 -1
@@ -122,7 +118,7 @@ static irqreturn_t sunxi_ir_irq(int irqno, void *dev_id)
 			/* for each bit in fifo */
 			dt = readb(ir->base + SUNXI_IR_RXFIFO_REG);
 			rawir.pulse = (dt & 0x80) != 0;
-			rawir.duration = ((dt & 0x7f) + 1) * SUNXI_IR_SAMPLE;
+			rawir.duration = ((dt & 0x7f) + 1) * ir->rc->rx_resolution;

Line over 80 characters.

Quoted 12 lines
drivers/media/rc/sunxi-cir.c +1 -0
 			ir_raw_event_store_with_filter(ir->rc, &rawir);
 		}
 	}
@@ -148,6 +144,7 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	struct device_node *dn = dev->of_node;
 	struct resource *res;
 	struct sunxi_ir *ir;
+	u32 b_clk_freq;
 
 	ir = devm_kzalloc(dev, sizeof(struct sunxi_ir), GFP_KERNEL);
 	if (!ir)

drivers/media/rc/sunxi-cir.c static int sunxi_ir_probe(struct platform_device *pdev) · line 175

Quoted 7 lines
drivers/media/rc/sunxi-cir.c +4 -0
@@ -172,6 +169,11 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 		return PTR_ERR(ir->clk);
 	}
 
+	/* Base clock frequency (optional) */
+	if (of_property_read_u32(dn, "clock-frequency", &b_clk_freq)) {
+		b_clk_freq = SUNXI_IR_BASE_CLK;
+	}

No braces here please; please use ./scripts/checkpatch.pl to find issues like this.

Quoted 30 lines
drivers/media/rc/sunxi-cir.c +5 -2
+
 	/* Reset (optional) */
 	ir->rst = devm_reset_control_get_optional_exclusive(dev, NULL);
 	if (IS_ERR(ir->rst))
@@ -180,11 +182,12 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	if (ret)
 		return ret;
 
-	ret = clk_set_rate(ir->clk, SUNXI_IR_BASE_CLK);
+	ret = clk_set_rate(ir->clk, b_clk_freq);
 	if (ret) {
 		dev_err(dev, "set ir base clock failed!\n");
 		goto exit_reset_assert;
 	}
+	dev_info(dev, "set base clock frequency to %d Hz.\n", b_clk_freq);
 
 	if (clk_prepare_enable(ir->apb_clk)) {
 		dev_err(dev, "try to enable apb_ir_clk failed\n");
@@ -225,7 +228,8 @@ static int sunxi_ir_probe(struct platform_device *pdev)
 	ir->rc->map_name = ir->map_name ?: RC_MAP_EMPTY;
 	ir->rc->dev.parent = dev;
 	ir->rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
-	ir->rc->rx_resolution = SUNXI_IR_SAMPLE;
+	/* Frequency after IR internal divider with sample period in ns */
+	ir->rc->rx_resolution = (1000000000ul / (b_clk_freq / 64));
 	ir->rc->timeout = MS_TO_NS(SUNXI_IR_TIMEOUT);
 	ir->rc->driver_name = SUNXI_IR_DEV;
 
Signature · 1 line
2.11.0
#3 lore raw

Re: [PATCH 1/5] media: rc: update sunxi-ir driver to get base clock frequency from devicetree

In reply to Philipp Rossak

Hi Philipp,

just a couple of small nitpicks.

Quoted 1 line
drivers/media/rc/sunxi-cir.c +1 -0
+	u32 b_clk_freq;

[...]

drivers/media/rc/sunxi-cir.c static int sunxi_ir_probe(struct platform_device *pdev) · line 176

Quoted 5 lines
drivers/media/rc/sunxi-cir.c +5 -0
+	/* Base clock frequency (optional) */
+	if (of_property_read_u32(dn, "clock-frequency", &b_clk_freq)) {
+		b_clk_freq = SUNXI_IR_BASE_CLK;
+	}
+

how about you intialize 'b_clk_freq' to 'SUNXI_IR_BASE_CLK' and just call 'of_property_read_u32' without if statement. 'b_clk_freq' value should not be changed if "clock-frequency" is not present in the DTS.

This might avoid misinterpretation from static analyzers that might think that 'b_clk_freq' is used uninitialized.

drivers/media/rc/sunxi-cir.c static int sunxi_ir_probe(struct platform_device *pdev) · line 190

Quoted 1 line
drivers/media/rc/sunxi-cir.c +1 -0
+	dev_info(dev, "set base clock frequency to %d Hz.\n", b_clk_freq);

Please use dev_dbg().

Andi

#4 lore raw

Re: [PATCH 1/5] media: rc: update sunxi-ir driver to get base clock frequency from devicetree

Hey Andi,

thanks for the feedback. I will fix that in the next version of this patch series!

Quoted 19 lines · Andi Shyti

Hi Philipp,

just a couple of small nitpicks.

Quoted 1 line
drivers/media/rc/sunxi-cir.c +1 -0
+	u32 b_clk_freq;

[...]

drivers/media/rc/sunxi-cir.c static int sunxi_ir_probe(struct platform_device *pdev) · line 176

Quoted 5 lines
drivers/media/rc/sunxi-cir.c +5 -0
+	/* Base clock frequency (optional) */
+	if (of_property_read_u32(dn, "clock-frequency", &b_clk_freq)) {
+		b_clk_freq = SUNXI_IR_BASE_CLK;
+	}
+

how about you intialize 'b_clk_freq' to 'SUNXI_IR_BASE_CLK' and just call 'of_property_read_u32' without if statement. 'b_clk_freq' value should not be changed if "clock-frequency" is not present in the DTS.

Quoted 9 lines

This might avoid misinterpretation from static analyzers that might think that 'b_clk_freq' is used uninitialized.

drivers/media/rc/sunxi-cir.c static int sunxi_ir_probe(struct platform_device *pdev) · line 190

Quoted 1 line
drivers/media/rc/sunxi-cir.c +1 -0
+	dev_info(dev, "set base clock frequency to %d Hz.\n", b_clk_freq);

Please use dev_dbg().

Andi

--
Philipp

#5 lore raw

PATCH 2/5 media: dt: bindings: Update binding documentation for sunxi IR controller

In reply to Philipp Rossak

This patch updates documentation for Device-Tree bindings for sunxi IR controller and adds the new optional property for the base clock frequency.

---
 Documentation/devicetree/bindings/media/sunxi-ir.txt | 2 ++
 1 file changed, 2 insertions(+)
Documentation/devicetree/bindings/media/sunxi-ir.txt +2 -0
index 91648c569b1e..9f45bab07d6e 100644
@@ -11,6 +11,7 @@ Required properties:
 Optional properties:
 - linux,rc-map-name: see rc.txt file in the same directory.
 - resets : phandle + reset specifier pair
+- clock-frequency  : overrides the default base clock frequency (8 MHz)
 
 Example:
 
@@ -18,6 +19,7 @@ ir0: ir at 1c21800 {
 	compatible = "allwinner,sun4i-a10-ir";
 	clocks = <&apb0_gates 6>, <&ir0_clk>;
 	clock-names = "apb", "ir";
+	clock-frequency = <3000000>;
 	resets = <&apb0_rst 1>;
 	interrupts = <0 5 1>;
 	reg = <0x01C21800 0x40>;
Signature · 1 line
2.11.0
#6 lore raw

Re: [PATCH 2/5] media: dt: bindings: Update binding documentation for sunxi IR controller

Hi,

Quoted 14 lines · Philipp Rossak

This patch updates documentation for Device-Tree bindings for sunxi IR controller and adds the new optional property for the base clock frequency.

---
 Documentation/devicetree/bindings/media/sunxi-ir.txt | 2 ++
 1 file changed, 2 insertions(+)
Documentation/devicetree/bindings/media/sunxi-ir.txt +0 -0
index 91648c569b1e..9f45bab07d6e 100644

Documentation/devicetree/bindings/media/sunxi-ir.txt Required properties: · line 14

Quoted 4 lines
Documentation/devicetree/bindings/media/sunxi-ir.txt +1 -0
@@ -11,6 +11,7 @@ Required properties:
 Optional properties:
 - linux,rc-map-name: see rc.txt file in the same directory.
 - resets : phandle + reset specifier pair
+- clock-frequency  : overrides the default base clock frequency (8 MHz)

You're at least missing the unit one needs to use, but something like:
IR Receiver clock frequency, in Hertz. Defaults to 8MHz if missing.

Maxime

Signature · 10 lines
Maxime Ripard, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20171218/b30f0dbc/attachment.sig>
#7 lore raw

PATCH 3/5 arm: dts: sun8i: a83t: Add the ir pin for the A83T

In reply to Philipp Rossak

The CIR Pin of the A83T is located at PL12.

---
 arch/arm/boot/dts/sun8i-a83t.dtsi | 5 +++++
 1 file changed, 5 insertions(+)
arch/arm/boot/dts/sun8i-a83t.dtsi +5 -0
index a384b766f3dc..954c2393325f 100644
@@ -521,6 +521,11 @@
 				drive-strength = <20>;
 				bias-pull-up;
 			};
+
+			ir_pins_a: ir at 0 {
+				pins = "PL12";
+				function = "s_cir_rx";
+			};
 		};
 
 		r_rsb: rsb at 1f03400 {
Signature · 1 line
2.11.0
#8 lore raw

Re: [PATCH 3/5] arm: dts: sun8i: a83t: Add the ir pin for the A83T

Quoted 12 lines · Philipp Rossak

The CIR Pin of the A83T is located at PL12.

---
 arch/arm/boot/dts/sun8i-a83t.dtsi | 5 +++++
 1 file changed, 5 insertions(+)
arch/arm/boot/dts/sun8i-a83t.dtsi +0 -0
index a384b766f3dc..954c2393325f 100644

arch/arm/boot/dts/sun8i-a83t.dtsi line 525

Quoted 5 lines
arch/arm/boot/dts/sun8i-a83t.dtsi +2 -0
@@ -521,6 +521,11 @@
                                drive-strength = <20>;
                                bias-pull-up;
                        };
+
+                       ir_pins_a: ir at 0 {

ir_pins: ir-pins

And it really should be cir, to distinguish it from IrDA.

ChenYu

Quoted 9 lines
arch/arm/boot/dts/sun8i-a83t.dtsi +3 -1
+                               pins = "PL12";
+                               function = "s_cir_rx";
+                       };
                };
 
                r_rsb: rsb at 1f03400 {
--

2.11.0

#9 lore raw

PATCH 4/5 arm: dts: sun8i: a83t: Add support for the ir interface

In reply to Philipp Rossak

The ir interface is like on the H3 located at 0x01f02000 and is exactly the same. This patch adds support for the ir interface on the A83T.

---
 arch/arm/boot/dts/sun8i-a83t.dtsi | 10 ++++++++++
 1 file changed, 10 insertions(+)
arch/arm/boot/dts/sun8i-a83t.dtsi +10 -0
index 954c2393325f..9e7ed3b9a6b8 100644
@@ -503,6 +503,16 @@
 			#reset-cells = <1>;
 		};
 
+		ir: ir at 01f02000 {
+			compatible = "allwinner,sun5i-a13-ir";
+			clocks = <&r_ccu CLK_APB0_IR>, <&r_ccu CLK_IR>;
+			clock-names = "apb", "ir";
+			resets = <&r_ccu RST_APB0_IR>;
+			interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
+			reg = <0x01f02000 0x40>;
+			status = "disabled";
+		};
+
 		r_pio: pinctrl at 1f02c00 {
 			compatible = "allwinner,sun8i-a83t-r-pinctrl";
 			reg = <0x01f02c00 0x400>;
Signature · 1 line
2.11.0
#10 lore raw

Re: [PATCH 4/5] arm: dts: sun8i: a83t: Add support for the ir interface

Quoted 13 lines · Philipp Rossak

The ir interface is like on the H3 located at 0x01f02000 and is exactly the same. This patch adds support for the ir interface on the A83T.

---
 arch/arm/boot/dts/sun8i-a83t.dtsi | 10 ++++++++++
 1 file changed, 10 insertions(+)
arch/arm/boot/dts/sun8i-a83t.dtsi +0 -0
index 954c2393325f..9e7ed3b9a6b8 100644

arch/arm/boot/dts/sun8i-a83t.dtsi line 512

Quoted 10 lines
arch/arm/boot/dts/sun8i-a83t.dtsi +7 -0
@@ -503,6 +503,16 @@
 			#reset-cells = <1>;
 		};
 
+		ir: ir at 01f02000 {
+			compatible = "allwinner,sun5i-a13-ir";
+			clocks = <&r_ccu CLK_APB0_IR>, <&r_ccu CLK_IR>;
+			clock-names = "apb", "ir";
+			resets = <&r_ccu RST_APB0_IR>;
+			interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
+			reg = <0x01f02000 0x40>;

The size should be the size of the whole memory block, not just the registers you need.

Maxime

Signature · 10 lines
Maxime Ripard, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20171218/f0fc4225/attachment-0001.sig>
#11 lore raw

PATCH 5/5 arm: dts: sun8i: a83t: bananapi-m3: Enable IR controller

In reply to Philipp Rossak

The Bananapi M3 has an onboard IR receiver.
This enables the onboard IR receiver subnode.
Other than the other IR receivers this one needs a base clock frequency of 3000000 Hz (3 MHz), to be able to work.

---
 arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts | 7 +++++++
 1 file changed, 7 insertions(+)
arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts +7 -0
index 6550bf0e594b..2bf25ca64133 100644
@@ -100,6 +100,13 @@
 	status = "okay";
 };
 
+&ir {
+	pinctrl-names = "default";
+	pinctrl-0 = <&ir_pins_a>;
+	clock-frequency = <3000000>;
+	status = "okay";
+};
+
 &mdio {
 	rgmii_phy: ethernet-phy at 1 {
 		compatible = "ethernet-phy-ieee802.3-c22";
Signature · 1 line
2.11.0
Acked-by on v1 5/5
#12 lore raw

Re: [PATCH 5/5] arm: dts: sun8i: a83t: bananapi-m3: Enable IR controller

Quoted 3 lines · Philipp Rossak

The Bananapi M3 has an onboard IR receiver.
This enables the onboard IR receiver subnode.
Other than the other IR receivers this one needs a base clock frequency

Unlike the other...

Quoted 12 lines

of 3000000 Hz (3 MHz), to be able to work.

---
 arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts | 7 +++++++
 1 file changed, 7 insertions(+)
arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts +0 -0
index 6550bf0e594b..2bf25ca64133 100644

arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts line 103

Quoted 4 lines
arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts +1 -0
@@ -100,6 +100,13 @@
        status = "okay";
 };
 
+&ir {

See my other reply about the name.

Otherwise,

Quoted 12 lines
arch/arm/boot/dts/sun8i-a83t-bananapi-m3.dts +6 -1
+       pinctrl-names = "default";
+       pinctrl-0 = <&ir_pins_a>;
+       clock-frequency = <3000000>;
+       status = "okay";
+};
+
 &mdio {
        rgmii_phy: ethernet-phy at 1 {
                compatible = "ethernet-phy-ieee802.3-c22";
--

2.11.0