[v5,5/5] ARM: exynos: dts: Add FIMD DT binding Documentation
diff mbox

Message ID 1361954620-20614-6-git-send-email-vikas.sajjan@linaro.org
State New, archived
Headers show

Commit Message

Vikas C Sajjan Feb. 27, 2013, 8:43 a.m. UTC
Adds FIMD DT binding documentation both SoC and Board, with an example

Signed-off-by: Vikas Sajjan <vikas.sajjan@linaro.org>
---
 .../devicetree/bindings/video/exynos-fimd.txt      |   46 ++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/video/exynos-fimd.txt

Comments

Sachin Kamat Feb. 28, 2013, 6:12 a.m. UTC | #1
Hi Vikas,

On 27 February 2013 14:13, Vikas Sajjan <vikas.sajjan@linaro.org> wrote:
> Adds FIMD DT binding documentation both SoC and Board, with an example
>
> Signed-off-by: Vikas Sajjan <vikas.sajjan@linaro.org>
> ---
>  .../devicetree/bindings/video/exynos-fimd.txt      |   46 ++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/video/exynos-fimd.txt
>
> diff --git a/Documentation/devicetree/bindings/video/exynos-fimd.txt b/Documentation/devicetree/bindings/video/exynos-fimd.txt
> new file mode 100644
> index 0000000..b3542b9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/video/exynos-fimd.txt
> @@ -0,0 +1,46 @@
> +Device-Tree bindings for Exynos SoC display controller (FIMD)
> +
> +FIMD stands for Fully Interactive Mobile Display, is the Display Controller for
> +the Exynos series of SoCs which transfers the image data from a video buffer

I think this should be Samsung series of SoCs intead of Exynos series.
As such the file name could be samsung-fimd.txt.

> +located in the system memory to an external LCD interface.
> +
> +Required properties:
> +- compatible := value can be one these below

"value should be one of the following:"


> +               "samsung,s3c2443-fimd"; /* for S3C24XX SoCs */
> +               "samsung,s3c6400-fimd"; /* for S3C64XX SoCs */
> +               "samsung,s5p6440-fimd"; /* for S5P64X0 SoCs */
> +               "samsung,s5pc100-fimd"; /* for S5PC100 SoC  */
> +               "samsung,s5pv210-fimd"; /* for S5PV210 SoC */
> +               "samsung,exynos4210-fimd"; /* for Exynos4 SoCs */
> +               "samsung,exynos5250-fimd"; /* for Exynos5 SoCs */

blank line here would make it more readable?

> +- reg := physical base address of the fimd and length of memory mapped region
> +- interrupt-parent := reference to the interrupt combiner node with phandle
> +- interrupts := interrupt number from the combiner to the cpu
> +               we have 3 interrupts and the Interrupt combiner order is
> +               FIFO Level, VSYNC and LCD_SYSTEM. Make sure to mention order
> +               as VSYNC, FIFO Level and LCD_SYSTEM as show in the example below.

Please rephrase the above as there seems to be difference in order in
the above 2 lines itself. :)
Vikas C Sajjan Feb. 28, 2013, 6:37 a.m. UTC | #2
Hi Sachin,

On 28 February 2013 11:42, Sachin Kamat <sachin.kamat@linaro.org> wrote:
> Hi Vikas,
>
> On 27 February 2013 14:13, Vikas Sajjan <vikas.sajjan@linaro.org> wrote:
>> Adds FIMD DT binding documentation both SoC and Board, with an example
>>
>> Signed-off-by: Vikas Sajjan <vikas.sajjan@linaro.org>
>> ---
>>  .../devicetree/bindings/video/exynos-fimd.txt      |   46 ++++++++++++++++++++
>>  1 file changed, 46 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/video/exynos-fimd.txt
>>
>> diff --git a/Documentation/devicetree/bindings/video/exynos-fimd.txt b/Documentation/devicetree/bindings/video/exynos-fimd.txt
>> new file mode 100644
>> index 0000000..b3542b9
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/video/exynos-fimd.txt
>> @@ -0,0 +1,46 @@
>> +Device-Tree bindings for Exynos SoC display controller (FIMD)
>> +
>> +FIMD stands for Fully Interactive Mobile Display, is the Display Controller for
>> +the Exynos series of SoCs which transfers the image data from a video buffer
>
> I think this should be Samsung series of SoCs intead of Exynos series.
> As such the file name could be samsung-fimd.txt.
Right.
>
>> +located in the system memory to an external LCD interface.
>> +
>> +Required properties:
>> +- compatible := value can be one these below
>
> "value should be one of the following:"
Ok.
>
>
>> +               "samsung,s3c2443-fimd"; /* for S3C24XX SoCs */
>> +               "samsung,s3c6400-fimd"; /* for S3C64XX SoCs */
>> +               "samsung,s5p6440-fimd"; /* for S5P64X0 SoCs */
>> +               "samsung,s5pc100-fimd"; /* for S5PC100 SoC  */
>> +               "samsung,s5pv210-fimd"; /* for S5PV210 SoC */
>> +               "samsung,exynos4210-fimd"; /* for Exynos4 SoCs */
>> +               "samsung,exynos5250-fimd"; /* for Exynos5 SoCs */
>
> blank line here would make it more readable?
>
>> +- reg := physical base address of the fimd and length of memory mapped region
>> +- interrupt-parent := reference to the interrupt combiner node with phandle
>> +- interrupts := interrupt number from the combiner to the cpu
>> +               we have 3 interrupts and the Interrupt combiner order is
>> +               FIFO Level, VSYNC and LCD_SYSTEM. Make sure to mention order
>> +               as VSYNC, FIFO Level and LCD_SYSTEM as show in the example below.
>
> Please rephrase the above as there seems to be difference in order in
> the above 2 lines itself. :)

 what it means is the Interrupt combiner order is : FIFO Level, VSYNC
and LCD_SYSTEM
but since we use only the VSYNC interrupt and in the driver while
getting IRQ number we pass 0 as index,
hence the documentation says
Make sure to mention order as VSYNC, FIFO Level and LCD_SYSTEM, as
show in the example below
 interrupts = <11 1>, <11 0>, <11 2>;
>
>
> --
> With warm regards,
> Sachin

Patch
diff mbox

diff --git a/Documentation/devicetree/bindings/video/exynos-fimd.txt b/Documentation/devicetree/bindings/video/exynos-fimd.txt
new file mode 100644
index 0000000..b3542b9
--- /dev/null
+++ b/Documentation/devicetree/bindings/video/exynos-fimd.txt
@@ -0,0 +1,46 @@ 
+Device-Tree bindings for Exynos SoC display controller (FIMD)
+
+FIMD stands for Fully Interactive Mobile Display, is the Display Controller for
+the Exynos series of SoCs which transfers the image data from a video buffer
+located in the system memory to an external LCD interface.
+
+Required properties:
+- compatible := value can be one these below
+		"samsung,s3c2443-fimd"; /* for S3C24XX SoCs */
+		"samsung,s3c6400-fimd"; /* for S3C64XX SoCs */
+		"samsung,s5p6440-fimd"; /* for S5P64X0 SoCs */
+		"samsung,s5pc100-fimd"; /* for S5PC100 SoC  */
+		"samsung,s5pv210-fimd"; /* for S5PV210 SoC */
+		"samsung,exynos4210-fimd"; /* for Exynos4 SoCs */
+		"samsung,exynos5250-fimd"; /* for Exynos5 SoCs */
+- reg := physical base address of the fimd and length of memory mapped region
+- interrupt-parent := reference to the interrupt combiner node with phandle
+- interrupts := interrupt number from the combiner to the cpu
+		we have 3 interrupts and the Interrupt combiner order is
+		FIFO Level, VSYNC and LCD_SYSTEM. Make sure to mention order
+		as VSYNC, FIFO Level and LCD_SYSTEM as show in the example below.
+- pinctrl := property defining the pinctrl configurations with a phandle
+- pinctrl-names := name of the pinctrl
+
+Optional Properties:
+- samsung,power-domain := power domain property defined with a phandle
+
+Example:
+
+SoC specific DT Entry:
+
+	fimd@11c00000 {
+		compatible = "samsung,exynos4210-fimd";
+		interrupt-parent = <&combiner>;
+		reg = <0x11c00000 0x20000>;
+		interrupts = <11 1>, <11 0>, <11 2>;
+	};
+
+Board specific DT Entry:
+
+	fimd@11c00000 {
+		samsung,power-domain = <&pd_lcd0>;
+		pinctrl-0 = <&lcd_sync &lcd_clk &lcd_en &lcd0_data &pwm1_out>;
+		pinctrl-names = "default";
+		status = "okay";
+	};