From: Camel Guo <[email protected]>
Document the TMP401, TMP411 and TMP43x device devicetree bindings
Signed-off-by: Camel Guo <[email protected]>
---
.../devicetree/bindings/hwmon/ti,tmp401.yaml | 111 ++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 112 insertions(+)
create mode 100644 Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
diff --git a/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml b/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
new file mode 100644
index 000000000000..28be5cbb009b
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/ti,tmp401.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TMP401, TPM411 and TMP43x temperature sensor
+
+maintainers:
+ - Guenter Roeck <[email protected]>
+
+description: |
+ ±1°C Remote and Local temperature sensor
+
+ Datasheets:
+ https://www.ti.com/lit/ds/symlink/tmp401.pdf
+ https://www.ti.com/lit/ds/symlink/tmp411.pdf
+ https://www.ti.com/lit/ds/symlink/tmp431.pdf
+ https://www.ti.com/lit/ds/symlink/tmp435.pdf
+
+properties:
+ compatible:
+ enum:
+ - ti,tmp401
+ - ti,tmp411
+ - ti,tmp431
+ - ti,tmp432
+ - ti,tmp435
+ reg:
+ maxItems: 1
+
+ '#address-cells':
+ const: 1
+
+ '#size-cells':
+ const: 0
+
+ ti,extended-range-enable:
+ description: |
+ When set, this sensor measures over extended temperature range.
+ type: boolean
+
+ ti,n-factor:
+ description: |
+ The value (two's complement) to be programmed in the n-factor correction
+ register.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ items:
+ minimum: 0
+ maximum: 255
+
+ ti,beta-compensation:
+ description: |
+ The value to be programmed in the beta range register.
+ $ref: /schemas/types.yaml#/definitions/uint32
+ items:
+ minimum: 0
+ maximum: 15
+
+allOf:
+ - if:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - ti,tmp401
+ then:
+ properties:
+ ti,n-factor: false
+
+ - if:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - ti,tmp401
+ - ti,tmp411
+ then:
+ properties:
+ ti,beta-compensation: false
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: false
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ sensor@4c {
+ compatible = "ti,tmp401";
+ reg = <0x4c>;
+ };
+ };
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ sensor@4c {
+ compatible = "ti,tmp431";
+ reg = <0x4c>;
+ ti,extended-range-enable;
+ ti,n-factor = <0x3b>;
+ ti,beta-compensation = <0x7>;
+ };
+ };
diff --git a/MAINTAINERS b/MAINTAINERS
index 61d9f114c37f..6b0d8f5cc68e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -19838,6 +19838,7 @@ TMP401 HARDWARE MONITOR DRIVER
M: Guenter Roeck <[email protected]>
L: [email protected]
S: Maintained
+F: Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
F: Documentation/hwmon/tmp401.rst
F: drivers/hwmon/tmp401.c
--
2.30.2
On 11/04/2022 12:03, Camel Guo wrote:
> From: Camel Guo <[email protected]>
>
> Document the TMP401, TMP411 and TMP43x device devicetree bindings
>
> Signed-off-by: Camel Guo <[email protected]>
> ---
> .../devicetree/bindings/hwmon/ti,tmp401.yaml | 111 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 112 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
>
Thank you for your patch. There is something to discuss/improve.
> diff --git a/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml b/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
> new file mode 100644
> index 000000000000..28be5cbb009b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
> @@ -0,0 +1,111 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/ti,tmp401.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: TMP401, TPM411 and TMP43x temperature sensor
> +
> +maintainers:
> + - Guenter Roeck <[email protected]>
> +
> +description: |
> + ±1°C Remote and Local temperature sensor
> +
> + Datasheets:
> + https://www.ti.com/lit/ds/symlink/tmp401.pdf
> + https://www.ti.com/lit/ds/symlink/tmp411.pdf
> + https://www.ti.com/lit/ds/symlink/tmp431.pdf
> + https://www.ti.com/lit/ds/symlink/tmp435.pdf
> +
> +properties:
> + compatible:
> + enum:
> + - ti,tmp401
> + - ti,tmp411
> + - ti,tmp431
> + - ti,tmp432
> + - ti,tmp435
Blank line, please.
> + reg:
> + maxItems: 1
> +
> + '#address-cells':
> + const: 1
> +
> + '#size-cells':
> + const: 0
> +
> + ti,extended-range-enable:
> + description: |
No need for "|". Here and in most of other cases below.
> + When set, this sensor measures over extended temperature range.
> + type: boolean
> +
> + ti,n-factor:
> + description: |
> + The value (two's complement) to be programmed in the n-factor correction
> + register.
Do not describe the programming model (registers) but hardware property
instead.
> + $ref: /schemas/types.yaml#/definitions/uint32
> + items:
> + minimum: 0
> + maximum: 255
> +
> + ti,beta-compensation:
> + description: |
> + The value to be programmed in the beta range register.
The same, register values should not be stored in DT.
> + $ref: /schemas/types.yaml#/definitions/uint32
> + items:
> + minimum: 0
> + maximum: 15
> +
Best regards,
Krzysztof
On 4/12/22 13:53, Krzysztof Kozlowski wrote:
> On 11/04/2022 12:03, Camel Guo wrote:
>> From: Camel Guo <[email protected]>
>>
>> Document the TMP401, TMP411 and TMP43x device devicetree bindings
>>
>> Signed-off-by: Camel Guo <[email protected]>
>> ---
>> .../devicetree/bindings/hwmon/ti,tmp401.yaml | 111 ++++++++++++++++++
>> MAINTAINERS | 1 +
>> 2 files changed, 112 insertions(+)
>> create mode 100644 Documentation/devicetree/bindings/hwmon/ti,tmp401.yaml
>>
>> + - ti,tmp401
>> + - ti,tmp411
>> + - ti,tmp431
>> + - ti,tmp432
>> + - ti,tmp435
>
> Blank line, please.
Fixed
>
>> + reg:
>> + maxItems: 1
>> +
>> + '#address-cells':
>> + const: 1
>> +
>> + '#size-cells':
>> + const: 0
>> +
>> + ti,extended-range-enable:
>> + description: |
>
> No need for "|". Here and in most of other cases below.
Fixed
>
>> + When set, this sensor measures over extended temperature range.
>> + type: boolean
>> +
>> + ti,n-factor:
>> + description: |
>> + The value (two's complement) to be programmed in the n-factor correction
>> + register.
>
> Do not describe the programming model (registers) but hardware property
> instead.
Make another try. Hope it is clear now.
>
>> + $ref: /schemas/types.yaml#/definitions/uint32
>> + items:
>> + minimum: 0
>> + maximum: 255
>> +
>> + ti,beta-compensation:
>> + description: |
>> + The value to be programmed in the beta range register.
>
> The same, register values should not be stored in DT.
>
>> + $ref: /schemas/types.yaml#/definitions/uint32
>> + items:
>> + minimum: 0
>> + maximum: 15
>> +
>
>
> Best regards,
> Krzysztof
Fixed in v2. Please review that instead.