Skip to contentSkip to conversation

mfd: flexcom: add a driver for Flexcom

PATCH Superseded Cyrille Pitchen 4 participants 16 messages Sep 1, 2015 – Sep 24, 2015

Subsystems (3)

v9 of 11 Superseded Latest is v11 →

lore
Share & tools
lore
#0 lore raw

v9 cover mfd: flexcom: add a driver for Flexcom

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi@f8034400 to spi@400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

v8:
- fix the name of the spi node in the DT example: from spi@f8034400 to spi@2,0
- use the return code of op_property_read_u32_index() instead of -EINVAL to report error.
- add Acked-by from Nicolas Ferre

v7:
- read the operating mode from the very first u32 of the reg property from the first available child node (should be unique).
- update the DT bindings documentation accordingly.

v6:
- select the operating mode according to the "compatible" DT property of the first available child node (should be unique).
- remove the "atmel,flexcom-mode" DT property so the need of a header file defining macros for the possible values of this deprecated property.

v5:
- create a header file containing macros used by DT bindings
- use numeric constants instead of strings to select the Flexcom mode
- change the license to "GPL v2"
- update the DT binding documentation to make it more readable and add references to USART, SPI and I2C DT binding documentations. remove the useless label in the Example section.
- change the register prefix from FX_ to FLEX_ to match the Flexcom programmer datasheet.
- rename some variables to make them more understandable.

v4:
- check clk_prepare_enable() return code in atmel_flexcom_probe()
- add a commit message to the DT binding patch

v3:
- remove MODULE_ALIAS()
- add Acked-by from Boris Brezillon and Alexandre Belloni

v2:
- enhance the documentation of DT bindings and change the way the "ranges" property is used.
- replace __raw_readl() and __raw_writel() by readl() and writel().
- change the module license to "GPL" for v2 or later
- print the selected flexcom mode after the hardware version

v1:
This series of patches a support to the Atmel Flexcom, a wrapper which integrates an USART, a SPI controller and a TWI controller. Only one peripheral can be used at a time. The active function is selected though the Flexcom Mode Register.

Cyrille Pitchen (3):
mfd: atmel-flexcom: create include file with macros used by DT
bindings
mfd: devicetree: add bindings for Atmel Flexcom
mfd: atmel-flexcom: add a driver for Atmel Flexible Serial
Communication Unit

 .../devicetree/bindings/mfd/atmel-flexcom.txt      |  67 +++++++++++++
 drivers/mfd/Kconfig                                |  11 +++
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/atmel-flexcom.c                        | 104 +++++++++++++++++++++
 include/dt-bindings/mfd/atmel-flexcom.h            |  16 ++++
 5 files changed, 199 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
 create mode 100644 drivers/mfd/atmel-flexcom.c
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
Signature · 1 line
1.8.2.2
#1 lore raw

PATCH v9 1/3 mfd: atmel-flexcom: create include file with macros used by DT bindings

This patch defines some macros to be used as value for the "atmel,flexcom-mode" DT property. This value is then written into the Operating Mode (OPMODE) bit field of the Flexcom Mode Register.

---
 include/dt-bindings/mfd/atmel-flexcom.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
include/dt-bindings/mfd/atmel-flexcom.h new file +16 -0
new file mode 100644
index 000000000000..6728f2851b4d
@@ -0,0 +1,16 @@
+/*
+ * This header provides macros for Atmel Flexcom DT bindings.
+ *
+ * Copyright (C) 2015 Cyrille Pitchen <[email protected]>
+ *
+ * GPLv2 only
+ */
+
+#ifndef __DT_BINDINGS_ATMEL_FLEXCOM_H__
+#define __DT_BINDINGS_ATMEL_FLEXCOM_H__
+
+#define ATMEL_FLEXCOM_MODE_USART	1
+#define ATMEL_FLEXCOM_MODE_SPI		2
+#define ATMEL_FLEXCOM_MODE_TWI		3
+
+#endif /* __DT_BINDINGS_ATMEL_FLEXCOM_H__ */
Signature · 1 line
1.8.2.2
#4 lore raw

PATCH v9 2/3 mfd: devicetree: add bindings for Atmel Flexcom

In reply to Cyrille Pitchen

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +67 -0
new file mode 100644
index 000000000000..fc3511e41542
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.
+
+The reg property of this child should be:
+- <0x200 0x200> for USART
+- <0x400 0x200> for SPI
+- <0x600 0x200> for I2C
+
+The phandle provided by the clocks property of the child is the same as one for
+the Flexcom parent.
+
+Other properties remain unchanged. See documentation of the respective device:
+- ../serial/atmel-usart.txt
+- ../spi/spi_atmel.txt
+- ../i2c/i2c-at91.txt
+
+Example:
+
+flexcom at f8034000 {
+	compatible = "atmel,sama5d2-flexcom";
+	reg = <0xf8034000 0x200>;
+	clocks = <&flx0_clk>;
+	#address-cells = <1>;
+	#size-cells = <1>;
+	ranges = <0x0 0xf8034000 0x800>;
+	atmel,flexcom-mode = <ATMEL_FLEXCOM_MODE_SPI>;
+
+	spi at 400 {
+		compatible = "atmel,at91rm9200-spi";
+		reg = <0x400 0x200>;
+		interrupts = <19 IRQ_TYPE_LEVEL_HIGH 7>;
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_flx0_default>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		clocks = <&flx0_clk>;
+		clock-names = "spi_clk";
+		atmel,fifo-size = <32>;
+
+		mtd_dataflash at 0 {
+			compatible = "atmel,at25f512b";
+			reg = <0>;
+			spi-max-frequency = <20000000>;
+		};
+	};
+};
Signature · 1 line
1.8.2.2
#10 lore raw

PATCH v9 3/3 mfd: atmel-flexcom: add a driver for Atmel Flexible Serial Communication Unit

In reply to Cyrille Pitchen

This driver supports the new Atmel Flexcom. The Flexcom is a wrapper which integrates one SPI controller, one I2C controller and one USART. Only one function can be enabled at a time. This driver selects the function once for all, when the Flexcom is probed, according to the value of the new "atmel,flexcom-mode" device tree property.

This driver has chosen to present the Flexcom to the system as a MFD so the implementation is seamless for the existing Atmel SPI, I2C and USART drivers.

Also the Flexcom embeds FIFOs: the latest patches of the SPI, I2C and USART drivers take advantage of this new feature.

---
 drivers/mfd/Kconfig         |  11 +++++
 drivers/mfd/Makefile        |   1 +
 drivers/mfd/atmel-flexcom.c | 104 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 116 insertions(+)
 create mode 100644 drivers/mfd/atmel-flexcom.c
drivers/mfd/Kconfig +11 -0
index 99d63675f073..87e84e7c71da 100644
@@ -60,6 +60,17 @@ config MFD_AAT2870_CORE
 	  additional drivers must be enabled in order to use the
 	  functionality of the device.
 
+config MFD_ATMEL_FLEXCOM
+	tristate "Atmel Flexcom (Flexible Serial Communication Unit)"
+	select MFD_CORE
+	depends on OF
+	help
+	  Select this to get support for Atmel Flexcom. This is a wrapper
+	  which embeds a SPI controller, a I2C controller and a USART. Only
+	  one function can be used at a time. The choice is done at boot time
+	  by the probe function of this MFD driver according to a device tree
+	  property.
+
 config MFD_ATMEL_HLCDC
 	tristate "Atmel HLCDC (High-end LCD Controller)"
 	select MFD_CORE
drivers/mfd/Makefile +1 -0
index a59e3fcc8626..f2383e0d1760 100644
@@ -164,6 +164,7 @@ obj-$(CONFIG_MFD_SPMI_PMIC)	+= qcom-spmi-pmic.o
 obj-$(CONFIG_TPS65911_COMPARATOR)	+= tps65911-comparator.o
 obj-$(CONFIG_MFD_TPS65090)	+= tps65090.o
 obj-$(CONFIG_MFD_AAT2870_CORE)	+= aat2870-core.o
+obj-$(CONFIG_MFD_ATMEL_FLEXCOM)	+= atmel-flexcom.o
 obj-$(CONFIG_MFD_ATMEL_HLCDC)	+= atmel-hlcdc.o
 obj-$(CONFIG_MFD_INTEL_LPSS)	+= intel-lpss.o
 obj-$(CONFIG_MFD_INTEL_LPSS_PCI)	+= intel-lpss-pci.o
drivers/mfd/atmel-flexcom.c new file +104 -0

104 lines not on this page · raw message

Signature · 1 line
1.8.2.2
Acked-by on v9 1/3
#2 lore raw

Re: [PATCH linux-next v9 1/3] mfd: atmel-flexcom: create include file with macros used by DT bindings

In reply to Cyrille Pitchen

Le 01/09/2015 16:46, Cyrille Pitchen a ?crit :

Quoted 5 lines

This patch defines some macros to be used as value for the "atmel,flexcom-mode" DT property. This value is then written into the Operating Mode (OPMODE) bit field of the Flexcom Mode Register.

Quoted 28 lines
---
 include/dt-bindings/mfd/atmel-flexcom.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
include/dt-bindings/mfd/atmel-flexcom.h new file +16 -0
new file mode 100644
index 000000000000..6728f2851b4d
@@ -0,0 +1,16 @@
+/*
+ * This header provides macros for Atmel Flexcom DT bindings.
+ *
+ * Copyright (C) 2015 Cyrille Pitchen <[email protected]>
+ *
+ * GPLv2 only
+ */
+
+#ifndef __DT_BINDINGS_ATMEL_FLEXCOM_H__
+#define __DT_BINDINGS_ATMEL_FLEXCOM_H__
+
+#define ATMEL_FLEXCOM_MODE_USART	1
+#define ATMEL_FLEXCOM_MODE_SPI		2
+#define ATMEL_FLEXCOM_MODE_TWI		3
+
+#endif /* __DT_BINDINGS_ATMEL_FLEXCOM_H__ */
Signature · 1 line
Nicolas Ferre
Acked-by on v9 2/3
#5 lore raw

Re: [PATCH linux-next v9 2/3] mfd: devicetree: add bindings for Atmel Flexcom

In reply to Cyrille Pitchen

Le 01/09/2015 16:46, Cyrille Pitchen a ?crit :

Quoted 7 lines

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

After all, this approach is far more simple and obvious than the use of the "reg" property, so coming back to this "atmel,flexcom-mode" option make a lot of sense.

Bye,

Quoted 79 lines
---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +67 -0
new file mode 100644
index 000000000000..fc3511e41542
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.
+
+The reg property of this child should be:
+- <0x200 0x200> for USART
+- <0x400 0x200> for SPI
+- <0x600 0x200> for I2C
+
+The phandle provided by the clocks property of the child is the same as one for
+the Flexcom parent.
+
+Other properties remain unchanged. See documentation of the respective device:
+- ../serial/atmel-usart.txt
+- ../spi/spi_atmel.txt
+- ../i2c/i2c-at91.txt
+
+Example:
+
+flexcom at f8034000 {
+	compatible = "atmel,sama5d2-flexcom";
+	reg = <0xf8034000 0x200>;
+	clocks = <&flx0_clk>;
+	#address-cells = <1>;
+	#size-cells = <1>;
+	ranges = <0x0 0xf8034000 0x800>;
+	atmel,flexcom-mode = <ATMEL_FLEXCOM_MODE_SPI>;
+
+	spi at 400 {
+		compatible = "atmel,at91rm9200-spi";
+		reg = <0x400 0x200>;
+		interrupts = <19 IRQ_TYPE_LEVEL_HIGH 7>;
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_flx0_default>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		clocks = <&flx0_clk>;
+		clock-names = "spi_clk";
+		atmel,fifo-size = <32>;
+
+		mtd_dataflash at 0 {
+			compatible = "atmel,at25f512b";
+			reg = <0>;
+			spi-max-frequency = <20000000>;
+		};
+	};
+};
Signature · 1 line
Nicolas Ferre
#11 lore raw
In reply to Cyrille Pitchen

Hi all,

Le 01/09/2015 16:46, Cyrille Pitchen a ?crit :

Quoted 9 lines

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

[...]

Are there any remaining blocking points for this series ?

Best Regards,

Cyrille

#12 lore raw
Quoted 12 lines · Cyrille Pitchen

Hi all,

Le 01/09/2015 16:46, Cyrille Pitchen a ?crit :

Quoted 9 lines

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

Quoted 3 lines

[...]

Are there any remaining blocking points for this series ?

Yes. The merge window is open, so it's Maintainer sleepy time [0].

Will get back to reviewing next week probably.

[0] AKA: Breath out and catch up with real-work for a bit.

Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org ? Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
maintainer Acked-by on v9 1/3
#3 lore raw

Re: [PATCH linux-next v9 1/3] mfd: atmel-flexcom: create include file with macros used by DT bindings

In reply to Cyrille Pitchen
Quoted 5 lines · Cyrille Pitchen

This patch defines some macros to be used as value for the "atmel,flexcom-mode" DT property. This value is then written into the Operating Mode (OPMODE) bit field of the Flexcom Mode Register.

In the future, you can combine headers with the binding doc as they are part of the binding.

Rob

Quoted 28 lines
---
 include/dt-bindings/mfd/atmel-flexcom.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
include/dt-bindings/mfd/atmel-flexcom.h new file +16 -0
new file mode 100644
index 000000000000..6728f2851b4d
@@ -0,0 +1,16 @@
+/*
+ * This header provides macros for Atmel Flexcom DT bindings.
+ *
+ * Copyright (C) 2015 Cyrille Pitchen <[email protected]>
+ *
+ * GPLv2 only
+ */
+
+#ifndef __DT_BINDINGS_ATMEL_FLEXCOM_H__
+#define __DT_BINDINGS_ATMEL_FLEXCOM_H__
+
+#define ATMEL_FLEXCOM_MODE_USART	1
+#define ATMEL_FLEXCOM_MODE_SPI		2
+#define ATMEL_FLEXCOM_MODE_TWI		3
+
+#endif /* __DT_BINDINGS_ATMEL_FLEXCOM_H__ */
maintainer
#6 lore raw

Re: [PATCH linux-next v9 2/3] mfd: devicetree: add bindings for Atmel Flexcom

In reply to Cyrille Pitchen
Quoted 7 lines · Cyrille Pitchen

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

A few comments, but in general looks fine.

Quoted 11 lines
---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +0 -0
new file mode 100644
index 000000000000..fc3511e41542

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 5

Quoted 5 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +5 -0
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.

Doesn't the board design choose (unless pins go to a header)?

Quoted 8 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +8 -0
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 23

Quoted 10 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +10 -0
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.

Okay, but why not allow all children and use "status"?

Quoted 45 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +44 -0
+
+The reg property of this child should be:
+- <0x200 0x200> for USART
+- <0x400 0x200> for SPI
+- <0x600 0x200> for I2C
+
+The phandle provided by the clocks property of the child is the same as one for
+the Flexcom parent.
+
+Other properties remain unchanged. See documentation of the respective device:
+- ../serial/atmel-usart.txt
+- ../spi/spi_atmel.txt
+- ../i2c/i2c-at91.txt
+
+Example:
+
+flexcom at f8034000 {
+	compatible = "atmel,sama5d2-flexcom";
+	reg = <0xf8034000 0x200>;
+	clocks = <&flx0_clk>;
+	#address-cells = <1>;
+	#size-cells = <1>;
+	ranges = <0x0 0xf8034000 0x800>;
+	atmel,flexcom-mode = <ATMEL_FLEXCOM_MODE_SPI>;
+
+	spi at 400 {
+		compatible = "atmel,at91rm9200-spi";
+		reg = <0x400 0x200>;
+		interrupts = <19 IRQ_TYPE_LEVEL_HIGH 7>;
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_flx0_default>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		clocks = <&flx0_clk>;
+		clock-names = "spi_clk";
+		atmel,fifo-size = <32>;
+
+		mtd_dataflash at 0 {
+			compatible = "atmel,at25f512b";
+			reg = <0>;
+			spi-max-frequency = <20000000>;
+		};
+	};
+};
#7 lore raw

Re: [PATCH linux-next v9 2/3] mfd: devicetree: add bindings for Atmel Flexcom

Hi Rob,

Le 09/09/2015 01:40, Rob Herring a ?crit :

Quoted 16 lines · Cyrille Pitchen
Quoted 7 lines

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

A few comments, but in general looks fine.

Quoted 5 lines
---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Quoted 14 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 5

Quoted 11 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +5 -0
new file mode 100644
index 000000000000..fc3511e41542
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.

Doesn't the board design choose (unless pins go to a header)?

The function may be chosen once for all by the board design but if we take the sama5d2 xplained board as an example, most Flexcoms output their pins to headers.

Quoted 12 lines
Quoted 12 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +12 -0
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
Quoted 9 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 23

Quoted 6 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +6 -0
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.

Okay, but why not allow all children and use "status"?

That is exactly what was proposed in v6 of this series: allow more than one child so possibly all children but only one "available" child (status = "okay").

The Flexocm driver still needs to find out the type of device of this available child to know which function is to be enabled (USART, I2C or SPI). So the "compatible" attribute was parsed using strstr() to search on of the patterns "usart", "spi" or "i2c".

However the use of strstr() was discussed to know whether the driver should looks for a partial or an exact match of the "compatible" string. An exact match would require to keep the Flexcom driver synchonized with the 3 other drivers every time one of them introduces a new compatibility string, which whould have made every driver more difficult to maintain by creating a useless dependency.
So this implementation relying on the "compatible" attribute was abandoned.

To sum up, no other reliable (and simple) means to guess/extact the device type from its DT node was found so we got back to the "atmel,flexcom-mode" property.

Quoted 37 lines
Quoted 37 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +37 -0
+
+The reg property of this child should be:
+- <0x200 0x200> for USART
+- <0x400 0x200> for SPI
+- <0x600 0x200> for I2C
+
+The phandle provided by the clocks property of the child is the same as one for
+the Flexcom parent.
+
+Other properties remain unchanged. See documentation of the respective device:
+- ../serial/atmel-usart.txt
+- ../spi/spi_atmel.txt
+- ../i2c/i2c-at91.txt
+
+Example:
+
+flexcom at f8034000 {
+	compatible = "atmel,sama5d2-flexcom";
+	reg = <0xf8034000 0x200>;
+	clocks = <&flx0_clk>;
+	#address-cells = <1>;
+	#size-cells = <1>;
+	ranges = <0x0 0xf8034000 0x800>;
+	atmel,flexcom-mode = <ATMEL_FLEXCOM_MODE_SPI>;
+
+	spi at 400 {
+		compatible = "atmel,at91rm9200-spi";
+		reg = <0x400 0x200>;
+		interrupts = <19 IRQ_TYPE_LEVEL_HIGH 7>;
+		pinctrl-names = "default";
+		pinctrl-0 = <&pinctrl_flx0_default>;
+		#address-cells = <1>;
+		#size-cells = <0>;
+		clocks = <&flx0_clk>;
+		clock-names = "spi_clk";
+		atmel,fifo-size = <32>;
+
Quoted 9 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 67

Quoted 8 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +7 -0
+		mtd_dataflash at 0 {
+			compatible = "atmel,at25f512b";
+			reg = <0>;
+			spi-max-frequency = <20000000>;
+		};
+	};
+};

Best Regards,

Cyrille

maintainer
#8 lore raw

Re: [PATCH linux-next v9 2/3] mfd: devicetree: add bindings for Atmel Flexcom

Quoted 77 lines · Cyrille Pitchen

Hi Rob,

Le 09/09/2015 01:40, Rob Herring a ?crit :

Quoted 16 lines · Cyrille Pitchen
Quoted 7 lines

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

A few comments, but in general looks fine.

Quoted 5 lines
---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Quoted 14 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 5

Quoted 11 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +5 -0
new file mode 100644
index 000000000000..fc3511e41542
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.

Doesn't the board design choose (unless pins go to a header)?

The function may be chosen once for all by the board design but if we take the sama5d2 xplained board as an example, most Flexcoms output their pins to headers.

Quoted 12 lines
Quoted 12 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +12 -0
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
Quoted 9 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 23

Quoted 6 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +6 -0
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.

Okay, but why not allow all children and use "status"?

That is exactly what was proposed in v6 of this series: allow more than one child so possibly all children but only one "available" child (status = "okay").

The Flexocm driver still needs to find out the type of device of this available child to know which function is to be enabled (USART, I2C or SPI). So the "compatible" attribute was parsed using strstr() to search on of the patterns "usart", "spi" or "i2c".

However the use of strstr() was discussed to know whether the driver should looks for a partial or an exact match of the "compatible" string. An exact match would require to keep the Flexcom driver synchonized with the 3 other drivers every time one of them introduces a new compatibility string, which whould have made every driver more difficult to maintain by creating a useless dependency.
So this implementation relying on the "compatible" attribute was abandoned.

Quoted 3 lines

To sum up, no other reliable (and simple) means to guess/extact the device type from its DT node was found so we got back to the "atmel,flexcom-mode" property.

I wasn't thinking removing this property. If the mode is configured by the bootloader, then you want to make updates to the configuration as simple as possible. Updating atmel,flexcom-mode and status for the children would be much more simple than creating the whole child node. If that's not a valid usecase, then never mind.

Rob

#13 lore raw
In reply to Cyrille Pitchen

Patch set description?

Once Rob is satisfied, please re-submit this set with Nicolas' Acks and I will re-review.

Quoted 76 lines

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

v8:
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 2,0
- use the return code of op_property_read_u32_index() instead of -EINVAL to report error.
- add Acked-by from Nicolas Ferre

v7:
- read the operating mode from the very first u32 of the reg property from the first available child node (should be unique).
- update the DT bindings documentation accordingly.

v6:
- select the operating mode according to the "compatible" DT property of the first available child node (should be unique).
- remove the "atmel,flexcom-mode" DT property so the need of a header file defining macros for the possible values of this deprecated property.

v5:
- create a header file containing macros used by DT bindings
- use numeric constants instead of strings to select the Flexcom mode
- change the license to "GPL v2"
- update the DT binding documentation to make it more readable and add references to USART, SPI and I2C DT binding documentations. remove the useless label in the Example section.
- change the register prefix from FX_ to FLEX_ to match the Flexcom programmer datasheet.
- rename some variables to make them more understandable.

v4:
- check clk_prepare_enable() return code in atmel_flexcom_probe()
- add a commit message to the DT binding patch

v3:
- remove MODULE_ALIAS()
- add Acked-by from Boris Brezillon and Alexandre Belloni

v2:
- enhance the documentation of DT bindings and change the way the "ranges" property is used.
- replace __raw_readl() and __raw_writel() by readl() and writel().
- change the module license to "GPL" for v2 or later
- print the selected flexcom mode after the hardware version

v1:
This series of patches a support to the Atmel Flexcom, a wrapper which integrates an USART, a SPI controller and a TWI controller. Only one peripheral can be used at a time. The active function is selected though the Flexcom Mode Register.

Cyrille Pitchen (3):
mfd: atmel-flexcom: create include file with macros used by DT
bindings
mfd: devicetree: add bindings for Atmel Flexcom
mfd: atmel-flexcom: add a driver for Atmel Flexible Serial
Communication Unit

 .../devicetree/bindings/mfd/atmel-flexcom.txt      |  67 +++++++++++++
 drivers/mfd/Kconfig                                |  11 +++
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/atmel-flexcom.c                        | 104 +++++++++++++++++++++
 include/dt-bindings/mfd/atmel-flexcom.h            |  16 ++++
 5 files changed, 199 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
 create mode 100644 drivers/mfd/atmel-flexcom.c
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org ? Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
#9 lore raw

Re: [PATCH linux-next v9 2/3] mfd: devicetree: add bindings for Atmel Flexcom

In reply to Rob Herring

Hi Rob,

Le 10/09/2015 02:06, Rob Herring a ?crit :

Quoted 82 lines · Cyrille Pitchen
Quoted 77 lines

Hi Rob,

Le 09/09/2015 01:40, Rob Herring a ?crit :

Quoted 16 lines · Cyrille Pitchen
Quoted 7 lines

This patch documents the DT bindings for the Atmel Flexcom which will be introduced by sama5d2x SoCs. These bindings will be used by the actual Flexcom driver to be sent in another patch.

A few comments, but in general looks fine.

Quoted 5 lines
---
 .../devicetree/bindings/mfd/atmel-flexcom.txt      | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
Quoted 14 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 5

Quoted 11 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +5 -0
new file mode 100644
index 000000000000..fc3511e41542
@@ -0,0 +1,67 @@
+* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit)
+
+The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C
+controller and an USART. Only one function can be used at a time and is chosen
+at boot time according to the device tree.

Doesn't the board design choose (unless pins go to a header)?

The function may be chosen once for all by the board design but if we take the sama5d2 xplained board as an example, most Flexcoms output their pins to headers.

Quoted 12 lines
Quoted 12 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +12 -0
+
+Required properties:
+- compatible:		Should be "atmel,sama5d2-flexcom"
+- reg:			Should be the offset/length value for Flexcom dedicated
+			I/O registers (without USART, TWI or SPI registers).
+- clocks:		Should be the Flexcom peripheral clock from PMC.
+- #address-cells:	Should be <1>
+- #size-cells:		Should be <1>
+- ranges:		Should be one range for the full I/O register region
+			(including USART, TWI and SPI registers).
+- atmel,flexcom-mode:	Should be one of the 3 following macros as defined in
+			include/dt-bindings/mfd/atmel-flexcom.h:
Quoted 9 lines

Documentation/devicetree/bindings/mfd/atmel-flexcom.txt line 23

Quoted 6 lines
Documentation/devicetree/bindings/mfd/atmel-flexcom.txt new file +6 -0
+			- ATMEL_FLEXCOM_MODE_USART for USART
+			- ATMEL_FLEXCOM_MODE_SPI for SPI
+			- ATMEL_FLEXCOM_MODE_TWI for I2C
+
+Required child:
+a single child device of type matching the "atmel,flexcom-mode" property.

Okay, but why not allow all children and use "status"?

That is exactly what was proposed in v6 of this series: allow more than one child so possibly all children but only one "available" child (status = "okay").

The Flexocm driver still needs to find out the type of device of this available child to know which function is to be enabled (USART, I2C or SPI). So the "compatible" attribute was parsed using strstr() to search on of the patterns "usart", "spi" or "i2c".

However the use of strstr() was discussed to know whether the driver should looks for a partial or an exact match of the "compatible" string. An exact match would require to keep the Flexcom driver synchonized with the 3 other drivers every time one of them introduces a new compatibility string, which whould have made every driver more difficult to maintain by creating a useless dependency.
So this implementation relying on the "compatible" attribute was abandoned.

Quoted 3 lines

To sum up, no other reliable (and simple) means to guess/extact the device type from its DT node was found so we got back to the "atmel,flexcom-mode" property.

Quoted 8 lines

I wasn't thinking removing this property. If the mode is configured by the bootloader, then you want to make updates to the configuration as simple as possible. Updating atmel,flexcom-mode and status for the children would be much more simple than creating the whole child node. If that's not a valid usecase, then never mind.

Rob

The Flexcom driver calls of_platform_populate(), so yes it's allowed and supported to put the 3 children in the DT as long as only one is available.

Should I update the documentation to deal with optional children or leave it as it is?

Best Regards,

Cyrille

#14 lore raw
In reply to Lee Jones

Le 20/09/2015 06:19, Lee Jones a ?crit :

Quoted 1 line

Patch set description?

Cyrille actually placed it as the v1 changelog below...

Quoted 1 line

Once Rob is satisfied, please re-submit this set with Nicolas' Acks

I think that Rob was okay with the DT binding: "A few comments, but in general looks fine." and it may not be important to tack Rob for addition of his formal tag...

Or maybe this message can act as a "ping" for Rob...

Quoted 1 line

and I will re-review.

We wait one or two days before Cyrille re-send the series. We are looking forward to using this driver in Linux-next soon.

Bye,

Quoted 77 lines
Quoted 76 lines

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

v8:
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 2,0
- use the return code of op_property_read_u32_index() instead of -EINVAL to report error.
- add Acked-by from Nicolas Ferre

v7:
- read the operating mode from the very first u32 of the reg property from the first available child node (should be unique).
- update the DT bindings documentation accordingly.

v6:
- select the operating mode according to the "compatible" DT property of the first available child node (should be unique).
- remove the "atmel,flexcom-mode" DT property so the need of a header file defining macros for the possible values of this deprecated property.

v5:
- create a header file containing macros used by DT bindings
- use numeric constants instead of strings to select the Flexcom mode
- change the license to "GPL v2"
- update the DT binding documentation to make it more readable and add references to USART, SPI and I2C DT binding documentations. remove the useless label in the Example section.
- change the register prefix from FX_ to FLEX_ to match the Flexcom programmer datasheet.
- rename some variables to make them more understandable.

v4:
- check clk_prepare_enable() return code in atmel_flexcom_probe()
- add a commit message to the DT binding patch

v3:
- remove MODULE_ALIAS()
- add Acked-by from Boris Brezillon and Alexandre Belloni

v2:
- enhance the documentation of DT bindings and change the way the "ranges" property is used.
- replace __raw_readl() and __raw_writel() by readl() and writel().
- change the module license to "GPL" for v2 or later
- print the selected flexcom mode after the hardware version

v1:
This series of patches a support to the Atmel Flexcom, a wrapper which integrates an USART, a SPI controller and a TWI controller. Only one peripheral can be used at a time. The active function is selected though the Flexcom Mode Register.

Cyrille Pitchen (3):
mfd: atmel-flexcom: create include file with macros used by DT
bindings
mfd: devicetree: add bindings for Atmel Flexcom
mfd: atmel-flexcom: add a driver for Atmel Flexible Serial
Communication Unit

 .../devicetree/bindings/mfd/atmel-flexcom.txt      |  67 +++++++++++++
 drivers/mfd/Kconfig                                |  11 +++
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/atmel-flexcom.c                        | 104 +++++++++++++++++++++
 include/dt-bindings/mfd/atmel-flexcom.h            |  16 ++++
 5 files changed, 199 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
 create mode 100644 drivers/mfd/atmel-flexcom.c
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
Signature · 1 line
Nicolas Ferre
#15 lore raw
Quoted 4 lines · Nicolas Ferre

Le 20/09/2015 06:19, Lee Jones a ?crit :

Quoted 1 line

Patch set description?

Cyrille actually placed it as the v1 changelog below...

I see it now, but that's not a very intuitive way of representing the set description. Please use the normal format with the description at the top. Normally all I care about is the description and the latest changes (although please keep in the previous changelogs, as they can also prove useful).

Quoted 7 lines
Quoted 1 line

Once Rob is satisfied, please re-submit this set with Nicolas' Acks

I think that Rob was okay with the DT binding: "A few comments, but in general looks fine." and it may not be important to tack Rob for addition of his formal tag...

Or maybe this message can act as a "ping" for Rob...

I'm not asking for that, although it's never UNwanted. I'm asking for the discussion between the submitter and other interested parties to play out, then adapt and re-submit accordingly. I receive far too many submissions to keep track of all of the discussions.

Quoted 84 lines
Quoted 1 line

and I will re-review.

We wait one or two days before Cyrille re-send the series. We are looking forward to using this driver in Linux-next soon.

Quoted 77 lines
Quoted 76 lines

ChangeLog

v9:
- go back to v5 (use the new "atmel,flexcom-mode" DT property).
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 400
- align the fields of the struct platform_driver atmel_flexcom_driver as suggested by Lee Jones.

v8:
- fix the name of the spi node in the DT example: from spi at f8034400 to spi at 2,0
- use the return code of op_property_read_u32_index() instead of -EINVAL to report error.
- add Acked-by from Nicolas Ferre

v7:
- read the operating mode from the very first u32 of the reg property from the first available child node (should be unique).
- update the DT bindings documentation accordingly.

v6:
- select the operating mode according to the "compatible" DT property of the first available child node (should be unique).
- remove the "atmel,flexcom-mode" DT property so the need of a header file defining macros for the possible values of this deprecated property.

v5:
- create a header file containing macros used by DT bindings
- use numeric constants instead of strings to select the Flexcom mode
- change the license to "GPL v2"
- update the DT binding documentation to make it more readable and add references to USART, SPI and I2C DT binding documentations. remove the useless label in the Example section.
- change the register prefix from FX_ to FLEX_ to match the Flexcom programmer datasheet.
- rename some variables to make them more understandable.

v4:
- check clk_prepare_enable() return code in atmel_flexcom_probe()
- add a commit message to the DT binding patch

v3:
- remove MODULE_ALIAS()
- add Acked-by from Boris Brezillon and Alexandre Belloni

v2:
- enhance the documentation of DT bindings and change the way the "ranges" property is used.
- replace __raw_readl() and __raw_writel() by readl() and writel().
- change the module license to "GPL" for v2 or later
- print the selected flexcom mode after the hardware version

v1:
This series of patches a support to the Atmel Flexcom, a wrapper which integrates an USART, a SPI controller and a TWI controller. Only one peripheral can be used at a time. The active function is selected though the Flexcom Mode Register.

Cyrille Pitchen (3):
mfd: atmel-flexcom: create include file with macros used by DT
bindings
mfd: devicetree: add bindings for Atmel Flexcom
mfd: atmel-flexcom: add a driver for Atmel Flexible Serial
Communication Unit

 .../devicetree/bindings/mfd/atmel-flexcom.txt      |  67 +++++++++++++
 drivers/mfd/Kconfig                                |  11 +++
 drivers/mfd/Makefile                               |   1 +
 drivers/mfd/atmel-flexcom.c                        | 104 +++++++++++++++++++++
 include/dt-bindings/mfd/atmel-flexcom.h            |  16 ++++
 5 files changed, 199 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt
 create mode 100644 drivers/mfd/atmel-flexcom.c
 create mode 100644 include/dt-bindings/mfd/atmel-flexcom.h
Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org ? Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog