[v3,2/2] media: atmel-isc: Update device tree binding documentation

Message ID 20190204141756.234563-2-ksloat@aampglobal.com
State Changes Requested
Headers show
Series
  • Untitled series #89901
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Ken Sloat Feb. 4, 2019, 2:18 p.m.
From: Ken Sloat <ksloat@aampglobal.com>

Update device tree binding documentation specifying how to
enable BT656 with CRC decoding and specify properties for
default parallel bus type.

Signed-off-by: Ken Sloat <ksloat@aampglobal.com>
---
 Changes in v2:
 -Use correct media "bus-type" dt property.

 Changes in v3:
 -Specify default bus type.
 -Document optional parallel bus flags.

 .../devicetree/bindings/media/atmel-isc.txt       | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

sakari.ailus@iki.fi Feb. 6, 2019, 12:56 p.m. | #1
On Mon, Feb 04, 2019 at 02:18:14PM +0000, Ken Sloat wrote:
> From: Ken Sloat <ksloat@aampglobal.com>
> 
> Update device tree binding documentation specifying how to
> enable BT656 with CRC decoding and specify properties for
> default parallel bus type.
> 
> Signed-off-by: Ken Sloat <ksloat@aampglobal.com>

The patch looks nice; I'll just wait for Rob's ack.
Rob Herring Feb. 14, 2019, 3:44 p.m. | #2
On Mon, Feb 04, 2019 at 02:18:14PM +0000, Ken Sloat wrote:
> From: Ken Sloat <ksloat@aampglobal.com>

Needs a better subject, not one that applies to any change. Update with 
what?

> Update device tree binding documentation specifying how to
> enable BT656 with CRC decoding and specify properties for
> default parallel bus type.
> 
> Signed-off-by: Ken Sloat <ksloat@aampglobal.com>
> ---
>  Changes in v2:
>  -Use correct media "bus-type" dt property.
> 
>  Changes in v3:
>  -Specify default bus type.
>  -Document optional parallel bus flags.
> 
>  .../devicetree/bindings/media/atmel-isc.txt       | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/media/atmel-isc.txt b/Documentation/devicetree/bindings/media/atmel-isc.txt
> index bbe0e87c6188..db3749a3964f 100644
> --- a/Documentation/devicetree/bindings/media/atmel-isc.txt
> +++ b/Documentation/devicetree/bindings/media/atmel-isc.txt
> @@ -21,6 +21,21 @@ Required properties for ISC:
>  - pinctrl-names, pinctrl-0
>  	Please refer to pinctrl-bindings.txt.
>  
> +Optional properties for ISC:
> +- bus-type
> +	When set to 6, Bt.656 decoding (embedded sync) with CRC decoding
> +	is enabled. If omitted, then the default bus-type is parallel and
> +	the additional properties to follow can be specified:
> +- hsync-active
> +	Active state of the HSYNC signal, 0/1 for LOW/HIGH respectively.
> +	If unspecified, this signal is set as active HIGH.
> +- vsync-active
> +	Active state of the VSYNC signal, 0/1 for LOW/HIGH respectively.
> +	If unspecified, this signal is set as active HIGH.
> +- pclk-sample
> +	Sample data on rising (1) or falling (0) edge of the pixel clock
> +	signal. If unspecified, data is sampled on the rising edge.

These are all common properties, right? No need to redefine them. Just 
reference the common doc. Maybe the default needs to be stated here if 
different or not defined.

> +
>  ISC supports a single port node with parallel bus. It should contain one
>  'port' child node with child 'endpoint' node. Please refer to the bindings
>  defined in Documentation/devicetree/bindings/media/video-interfaces.txt.
> -- 
> 2.17.1
>
sakari.ailus@iki.fi Feb. 18, 2019, 11:59 a.m. | #3
On Thu, Feb 14, 2019 at 09:44:22AM -0600, Rob Herring wrote:
> On Mon, Feb 04, 2019 at 02:18:14PM +0000, Ken Sloat wrote:
> > From: Ken Sloat <ksloat@aampglobal.com>
> 
> Needs a better subject, not one that applies to any change. Update with 
> what?
> 
> > Update device tree binding documentation specifying how to
> > enable BT656 with CRC decoding and specify properties for
> > default parallel bus type.
> > 
> > Signed-off-by: Ken Sloat <ksloat@aampglobal.com>
> > ---
> >  Changes in v2:
> >  -Use correct media "bus-type" dt property.
> > 
> >  Changes in v3:
> >  -Specify default bus type.
> >  -Document optional parallel bus flags.
> > 
> >  .../devicetree/bindings/media/atmel-isc.txt       | 15 +++++++++++++++
> >  1 file changed, 15 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/media/atmel-isc.txt b/Documentation/devicetree/bindings/media/atmel-isc.txt
> > index bbe0e87c6188..db3749a3964f 100644
> > --- a/Documentation/devicetree/bindings/media/atmel-isc.txt
> > +++ b/Documentation/devicetree/bindings/media/atmel-isc.txt
> > @@ -21,6 +21,21 @@ Required properties for ISC:
> >  - pinctrl-names, pinctrl-0
> >  	Please refer to pinctrl-bindings.txt.
> >  
> > +Optional properties for ISC:
> > +- bus-type
> > +	When set to 6, Bt.656 decoding (embedded sync) with CRC decoding
> > +	is enabled. If omitted, then the default bus-type is parallel and
> > +	the additional properties to follow can be specified:
> > +- hsync-active
> > +	Active state of the HSYNC signal, 0/1 for LOW/HIGH respectively.
> > +	If unspecified, this signal is set as active HIGH.
> > +- vsync-active
> > +	Active state of the VSYNC signal, 0/1 for LOW/HIGH respectively.
> > +	If unspecified, this signal is set as active HIGH.
> > +- pclk-sample
> > +	Sample data on rising (1) or falling (0) edge of the pixel clock
> > +	signal. If unspecified, data is sampled on the rising edge.
> 
> These are all common properties, right? No need to redefine them. Just 
> reference the common doc. Maybe the default needs to be stated here if 
> different or not defined.

Yeah, video-interfaces.txt does not define the defaults; it's hardware
specific.

Patch

diff --git a/Documentation/devicetree/bindings/media/atmel-isc.txt b/Documentation/devicetree/bindings/media/atmel-isc.txt
index bbe0e87c6188..db3749a3964f 100644
--- a/Documentation/devicetree/bindings/media/atmel-isc.txt
+++ b/Documentation/devicetree/bindings/media/atmel-isc.txt
@@ -21,6 +21,21 @@  Required properties for ISC:
 - pinctrl-names, pinctrl-0
 	Please refer to pinctrl-bindings.txt.
 
+Optional properties for ISC:
+- bus-type
+	When set to 6, Bt.656 decoding (embedded sync) with CRC decoding
+	is enabled. If omitted, then the default bus-type is parallel and
+	the additional properties to follow can be specified:
+- hsync-active
+	Active state of the HSYNC signal, 0/1 for LOW/HIGH respectively.
+	If unspecified, this signal is set as active HIGH.
+- vsync-active
+	Active state of the VSYNC signal, 0/1 for LOW/HIGH respectively.
+	If unspecified, this signal is set as active HIGH.
+- pclk-sample
+	Sample data on rising (1) or falling (0) edge of the pixel clock
+	signal. If unspecified, data is sampled on the rising edge.
+
 ISC supports a single port node with parallel bus. It should contain one
 'port' child node with child 'endpoint' node. Please refer to the bindings
 defined in Documentation/devicetree/bindings/media/video-interfaces.txt.