[3/4] Documentation: bindings: Add missing Amlogic SCPI sensor bindings

Message ID 20181108135352.8459-4-jbrunet@baylibre.com
State New
Headers show
Series
  • arm64: dts: meson-axg: enable SCPI
Related show

Commit Message

Jerome Brunet Nov. 8, 2018, 1:53 p.m.
amlogic,meson-gxbb-scpi-sensors is both the driver and DT but is not
documented. Just add it to amlogic's scpi documentation

Signed-off-by: Jerome Brunet <jbrunet@baylibre.com>

---
 Documentation/devicetree/bindings/arm/amlogic,scpi.txt | 7 +++++++
 1 file changed, 7 insertions(+)

-- 
2.19.1

Comments

Jerome Brunet Nov. 8, 2018, 4:29 p.m. | #1
On Thu, 2018-11-08 at 16:04 +0000, Sudeep Holla wrote:
> On Thu, Nov 08, 2018 at 02:53:51PM +0100, Jerome Brunet wrote:

> > amlogic,meson-gxbb-scpi-sensors is both the driver and DT but is not

> > documented. Just add it to amlogic's scpi documentation

> > 

> > Signed-off-by: Jerome Brunet <jbrunet@baylibre.com>

> > ---

> >  Documentation/devicetree/bindings/arm/amlogic,scpi.txt | 7 +++++++

> >  1 file changed, 7 insertions(+)

> > 

> > diff --git a/Documentation/devicetree/bindings/arm/amlogic,scpi.txt

> > b/Documentation/devicetree/bindings/arm/amlogic,scpi.txt

> > index 7b9a861e9306..5ab59da052df 100644

> > --- a/Documentation/devicetree/bindings/arm/amlogic,scpi.txt

> > +++ b/Documentation/devicetree/bindings/arm/amlogic,scpi.txt

> > @@ -17,4 +17,11 @@ Required sub-node properties:

> >  - compatible : should be "amlogic,meson-gxbb-scp-shmem" for SRAM based

> > shared

> >  		memory on Amlogic GXBB SoC.

> >  

> > +Sensor bindings for the sensors based on SCPI Message Protocol

> > +--------------------------------------------------------------

> > +SCPI provides an API to access the various sensors on the SoC.

> > +

> > +Required properties:

> > +- compatible : should be "amlogic,meson-gxbb-scpi-sensors".

> > +

> 

> Not sure if it's worth mentioning the reason for being able to identify

> amlogic,meson-gxbb sensors from generic scpi ones. IIRC it was for the

> unit values of these sensors are different ? But I will leave that to

> DT or platform maintainers' taste.


Yes Sudeep, the unit are different.
If we probe on the generic one, it will "work" but the result is just not
good. 

BTW, the point of this patch is merely to remove an existing issue.
The scpi driver and meson-gx.dtsi are both refering to an undocumented
compatible.

> 

> --

> Regards,

> Sudeep
Rob Herring Nov. 17, 2018, 4:21 p.m. | #2
On Thu,  8 Nov 2018 14:53:51 +0100, Jerome Brunet wrote:
> amlogic,meson-gxbb-scpi-sensors is both the driver and DT but is not

> documented. Just add it to amlogic's scpi documentation

> 

> Signed-off-by: Jerome Brunet <jbrunet@baylibre.com>

> ---

>  Documentation/devicetree/bindings/arm/amlogic,scpi.txt | 7 +++++++

>  1 file changed, 7 insertions(+)

> 


Reviewed-by: Rob Herring <robh@kernel.org>

Patch

diff --git a/Documentation/devicetree/bindings/arm/amlogic,scpi.txt b/Documentation/devicetree/bindings/arm/amlogic,scpi.txt
index 7b9a861e9306..5ab59da052df 100644
--- a/Documentation/devicetree/bindings/arm/amlogic,scpi.txt
+++ b/Documentation/devicetree/bindings/arm/amlogic,scpi.txt
@@ -17,4 +17,11 @@  Required sub-node properties:
 - compatible : should be "amlogic,meson-gxbb-scp-shmem" for SRAM based shared
 		memory on Amlogic GXBB SoC.
 
+Sensor bindings for the sensors based on SCPI Message Protocol
+--------------------------------------------------------------
+SCPI provides an API to access the various sensors on the SoC.
+
+Required properties:
+- compatible : should be "amlogic,meson-gxbb-scpi-sensors".
+
 [0] Documentation/devicetree/bindings/arm/arm,scpi.txt