diff mbox series

[v4,1/4] dt-bindings: arm: coresight: Add new compatible for static replicator

Message ID 20190406112145.15184-2-leo.yan@linaro.org
State Superseded, archived
Headers show
Series [v4,1/4] dt-bindings: arm: coresight: Add new compatible for static replicator | expand

Checks

Context Check Description
robh/checkpatch success

Commit Message

Leo Yan April 6, 2019, 11:21 a.m. UTC
CoreSight uses below bindings for replicator:

  Static replicator, aka. non-configurable replicator:
    "arm,coresight-replicator";

  Dynamic replicator, aka. configurable replicator:
    "arm,coresight-dynamic-replicator", "arm,primecell";

The compatible string "arm,coresight-replicator" is not an explicit
naming to express the replicator is 'static'.  To unify the naming
convention, this patch introduces a new compatible string
"arm,coresight-static-replicator" for the static replicator; the
compatible string "arm,coresight-replicator" is still kept thus we
can support the old DT binding, but tag it as obsolete and suggest
to use the new compatible string.

As result CoreSight replicator have below bindings:

  Static replicator:
    "arm,coresight-replicator"; (obsolete)
    "arm,coresight-static-replicator";

  Dynamic replicator:
    "arm,coresight-dynamic-replicator", "arm,primecell";

Signed-off-by: Leo Yan <leo.yan@linaro.org>
---
 Documentation/devicetree/bindings/arm/coresight.txt | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

Suzuki K Poulose April 8, 2019, 10:44 a.m. UTC | #1
On 04/06/2019 12:21 PM, Leo Yan wrote:
> CoreSight uses below bindings for replicator:
> 
>    Static replicator, aka. non-configurable replicator:
>      "arm,coresight-replicator";
> 
>    Dynamic replicator, aka. configurable replicator:
>      "arm,coresight-dynamic-replicator", "arm,primecell";
> 
> The compatible string "arm,coresight-replicator" is not an explicit
> naming to express the replicator is 'static'.  To unify the naming
> convention, this patch introduces a new compatible string
> "arm,coresight-static-replicator" for the static replicator; the
> compatible string "arm,coresight-replicator" is still kept thus we
> can support the old DT binding, but tag it as obsolete and suggest
> to use the new compatible string.
> 
> As result CoreSight replicator have below bindings:
> 
>    Static replicator:
>      "arm,coresight-replicator"; (obsolete)
>      "arm,coresight-static-replicator";
> 
>    Dynamic replicator:
>      "arm,coresight-dynamic-replicator", "arm,primecell";
> 
> Signed-off-by: Leo Yan <leo.yan@linaro.org>
> ---
>   Documentation/devicetree/bindings/arm/coresight.txt | 8 ++++++--
>   1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/arm/coresight.txt b/Documentation/devicetree/bindings/arm/coresight.txt
> index f8aff65ab921..f8f794869af2 100644
> --- a/Documentation/devicetree/bindings/arm/coresight.txt
> +++ b/Documentation/devicetree/bindings/arm/coresight.txt
> @@ -69,7 +69,11 @@ its hardware characteristcs.
>   
>   	* compatible: Currently supported value is (note the absence of the
>   	  AMBA markee):
> -		- "arm,coresight-replicator"
> +		- Coresight Non-configurable Replicator, the compatible string
> +		  "arm,coresight-replicator" is obsolete, keep it to support

To make it more obvious : s/obsolete/OBSOLETE/

> +		  the old DT bindings:
> +			"arm,coresight-replicator";
> +			"arm,coresight-static-replicator";

nit: I would re-order the compatible strings to show the precedence of
choice.

e.g,
	- CoreSight non-configurable Replicator
		"arm,coresight-static-replicator";
		"arm,coresight-replicator"; (OBSOLETE. For
			backward compatibility. Will be removed )


Also, please could we put a warning in the driver when we encounter it
and request to update it ?

Cheers
Suzuki
Leo Yan April 8, 2019, 2:01 p.m. UTC | #2
Hi Suzuki,

On Mon, Apr 08, 2019 at 11:44:56AM +0100, Suzuki K Poulose wrote:
> On 04/06/2019 12:21 PM, Leo Yan wrote:
> > CoreSight uses below bindings for replicator:
> > 
> >    Static replicator, aka. non-configurable replicator:
> >      "arm,coresight-replicator";
> > 
> >    Dynamic replicator, aka. configurable replicator:
> >      "arm,coresight-dynamic-replicator", "arm,primecell";
> > 
> > The compatible string "arm,coresight-replicator" is not an explicit
> > naming to express the replicator is 'static'.  To unify the naming
> > convention, this patch introduces a new compatible string
> > "arm,coresight-static-replicator" for the static replicator; the
> > compatible string "arm,coresight-replicator" is still kept thus we
> > can support the old DT binding, but tag it as obsolete and suggest
> > to use the new compatible string.
> > 
> > As result CoreSight replicator have below bindings:
> > 
> >    Static replicator:
> >      "arm,coresight-replicator"; (obsolete)
> >      "arm,coresight-static-replicator";
> > 
> >    Dynamic replicator:
> >      "arm,coresight-dynamic-replicator", "arm,primecell";
> > 
> > Signed-off-by: Leo Yan <leo.yan@linaro.org>
> > ---
> >   Documentation/devicetree/bindings/arm/coresight.txt | 8 ++++++--
> >   1 file changed, 6 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/arm/coresight.txt b/Documentation/devicetree/bindings/arm/coresight.txt
> > index f8aff65ab921..f8f794869af2 100644
> > --- a/Documentation/devicetree/bindings/arm/coresight.txt
> > +++ b/Documentation/devicetree/bindings/arm/coresight.txt
> > @@ -69,7 +69,11 @@ its hardware characteristcs.
> >   	* compatible: Currently supported value is (note the absence of the
> >   	  AMBA markee):
> > -		- "arm,coresight-replicator"
> > +		- Coresight Non-configurable Replicator, the compatible string
> > +		  "arm,coresight-replicator" is obsolete, keep it to support
> 
> To make it more obvious : s/obsolete/OBSOLETE/
> 
> > +		  the old DT bindings:
> > +			"arm,coresight-replicator";
> > +			"arm,coresight-static-replicator";
> 
> nit: I would re-order the compatible strings to show the precedence of
> choice.
> 
> e.g,
> 	- CoreSight non-configurable Replicator
> 		"arm,coresight-static-replicator";
> 		"arm,coresight-replicator"; (OBSOLETE. For
> 			backward compatibility. Will be removed )

The suggestion looks good to me since it's neat.  Will do it.

> Also, please could we put a warning in the driver when we encounter it
> and request to update it ?

Will do.

Thanks for reviewing!
Leo Yan
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/coresight.txt b/Documentation/devicetree/bindings/arm/coresight.txt
index f8aff65ab921..f8f794869af2 100644
--- a/Documentation/devicetree/bindings/arm/coresight.txt
+++ b/Documentation/devicetree/bindings/arm/coresight.txt
@@ -69,7 +69,11 @@  its hardware characteristcs.
 
 	* compatible: Currently supported value is (note the absence of the
 	  AMBA markee):
-		- "arm,coresight-replicator"
+		- Coresight Non-configurable Replicator, the compatible string
+		  "arm,coresight-replicator" is obsolete, keep it to support
+		  the old DT bindings:
+			"arm,coresight-replicator";
+			"arm,coresight-static-replicator";
 
 	* port or ports: see "Graph bindings for Coresight" below.
 
@@ -169,7 +173,7 @@  Example:
 		/* non-configurable replicators don't show up on the
 		 * AMBA bus.  As such no need to add "arm,primecell".
 		 */
-		compatible = "arm,coresight-replicator";
+		compatible = "arm,coresight-static-replicator";
 
 		out-ports {
 			#address-cells = <1>;