| Message ID | 20211009024430.3322230-1-osk@google.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v3,1/2] dt-bindings: hwmon: Add nct7802 bindings | expand |
Hi Oskar, On 10/8/21 7:44 PM, Oskar Senft wrote: > Document bindings for the Nuvoton NCT7802Y driver. > > Signed-off-by: Oskar Senft <osk@google.com> Please pdon't expect from reviewers to figure out what changed between versions and provide change logs. Thanks, Guenter > --- > .../bindings/hwmon/nuvoton,nct7802.yaml | 142 ++++++++++++++++++ > 1 file changed, 142 insertions(+) > create mode 100644 Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml > > diff --git a/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml b/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml > new file mode 100644 > index 000000000000..a97b89d0d197 > --- /dev/null > +++ b/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml > @@ -0,0 +1,142 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > + > +$id: http://devicetree.org/schemas/hwmon/nuvoton,nct7802.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Nuvoton NCT7802Y Hardware Monitoring IC > + > +maintainers: > + - Guenter Roeck <linux@roeck-us.net> > + > +description: | > + The NCT7802Y is a hardware monitor IC which supports one on-die and up to > + 5 remote temperature sensors with SMBus interface. > + > + Datasheets: > + https://www.nuvoton.com/export/resource-files/Nuvoton_NCT7802Y_Datasheet_V12.pdf > + > +properties: > + compatible: > + enum: > + - nuvoton,nct7802 > + > + reg: > + maxItems: 1 > + > + "#address-cells": > + const: 1 > + > + "#size-cells": > + const: 0 > + > + input@0: > + type: object > + description: Local Temperature Sensor ("LTD") > + properties: > + reg: > + const: 0 > + required: > + - reg > + > + input@1: > + type: object > + description: Remote Temperature Sensor or Voltage Sensor ("RTD1") > + properties: > + reg: > + const: 1 > + sensor-type: > + items: > + - enum: > + - temperature > + - voltage > + temperature-mode: > + items: > + - enum: > + - thermistor > + - thermal-diode > + required: > + - reg > + - sensor-type > + > + input@2: > + type: object > + description: Remote Temperature Sensor or Voltage Sensor ("RTD2") > + properties: > + reg: > + const: 2 > + sensor-type: > + items: > + - enum: > + - temperature > + - voltage > + temperature-mode: > + items: > + - enum: > + - thermistor > + - thermal-diode > + required: > + - reg > + - sensor-type > + > + input@3: > + type: object > + description: Remote Temperature Sensor or Voltage Sensor ("RTD3") > + properties: > + reg: > + const: 3 > + sensor-type: > + items: > + - enum: > + - temperature > + - voltage > + required: > + - reg > + - sensor-type > + > +required: > + - compatible > + - reg > + > +additionalProperties: false > + > +examples: > + - | > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + > + nct7802@28 { > + compatible = "nuvoton,nct7802"; > + reg = <0x28>; > + > + #address-cells = <1>; > + #size-cells = <0>; > + > + input@0 { /* LTD */ > + reg = <0>; > + status = "okay"; > + }; > + > + input@1 { /* RTD1 */ > + reg = <1>; > + status = "okay"; > + sensor-type = "temperature"; > + temperature-mode = "thermistor"; > + }; > + > + input@2 { /* RTD2 */ > + reg = <2>; > + status = "okay"; > + sensor-type = "temperature"; > + temperature-mode = "thermal-diode"; > + }; > + > + input@3 { /* RTD3 */ > + reg = <3>; > + status = "okay"; > + sensor-type = "voltage"; > + }; > + }; > + }; >
Hi everyone > > Document bindings for the Nuvoton NCT7802Y driver. > > > > Signed-off-by: Oskar Senft <osk@google.com> > > Please pdon't expect from reviewers to figure out what changed > between versions and provide change logs. Uh, I'm sorry, I'm new to the Linux upstreaming game. I'm used to using code review tools like Gerrit, which help with that. Changes from "PATCH v2 1/2" to "PATCH v4 1/2" (v3 was sent with a typo, so please ignore v3): - Removed extra layer "temperature-sensors" as discussed. - Renamed "sensor" to "input" as discussed. - Renamed "mode" to "sensor-type" to indicate temperature or voltage. - Added "temperature-mode" to indicate "thermistor" or "thermal-diode". - Removed description attributes from "sensor-type" and didn't add for "temperature-mode", since they would have just repeated the names of the properties. - Numbered sensors 0 (LTD) and 1..3 (RTD1..3). Some notes: - While 1..3 are "natural numberings", there's no equivalent for "0" in the datasheet - the name "0" is arbitrary. An alternative would be to name this sensor "ltd" instead of "input", since it's not configurable (beyond disabling it). - I wasn't sure what the correct way is to enforce a match from "input@X" to "reg = <X>", so I listed the inputs individually. Technically RTD1 and RTD2 could be done as "patternProperties", if we could enforce the match between @X and reg. I hope I included all the various comments and discussion points both from PATCH v2 and from the "tmp421" thread [1]. Please let me know if I missed anything. Does this proposal match the general thinking and goals for dt-bindings for hwmon devices? Thanks Oskar. [1] https://lore.kernel.org/linux-hwmon/20210924114636.GB2694238@roeck-us.net/
diff --git a/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml b/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml new file mode 100644 index 000000000000..a97b89d0d197 --- /dev/null +++ b/Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml @@ -0,0 +1,142 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- + +$id: http://devicetree.org/schemas/hwmon/nuvoton,nct7802.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Nuvoton NCT7802Y Hardware Monitoring IC + +maintainers: + - Guenter Roeck <linux@roeck-us.net> + +description: | + The NCT7802Y is a hardware monitor IC which supports one on-die and up to + 5 remote temperature sensors with SMBus interface. + + Datasheets: + https://www.nuvoton.com/export/resource-files/Nuvoton_NCT7802Y_Datasheet_V12.pdf + +properties: + compatible: + enum: + - nuvoton,nct7802 + + reg: + maxItems: 1 + + "#address-cells": + const: 1 + + "#size-cells": + const: 0 + + input@0: + type: object + description: Local Temperature Sensor ("LTD") + properties: + reg: + const: 0 + required: + - reg + + input@1: + type: object + description: Remote Temperature Sensor or Voltage Sensor ("RTD1") + properties: + reg: + const: 1 + sensor-type: + items: + - enum: + - temperature + - voltage + temperature-mode: + items: + - enum: + - thermistor + - thermal-diode + required: + - reg + - sensor-type + + input@2: + type: object + description: Remote Temperature Sensor or Voltage Sensor ("RTD2") + properties: + reg: + const: 2 + sensor-type: + items: + - enum: + - temperature + - voltage + temperature-mode: + items: + - enum: + - thermistor + - thermal-diode + required: + - reg + - sensor-type + + input@3: + type: object + description: Remote Temperature Sensor or Voltage Sensor ("RTD3") + properties: + reg: + const: 3 + sensor-type: + items: + - enum: + - temperature + - voltage + required: + - reg + - sensor-type + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + i2c { + #address-cells = <1>; + #size-cells = <0>; + + nct7802@28 { + compatible = "nuvoton,nct7802"; + reg = <0x28>; + + #address-cells = <1>; + #size-cells = <0>; + + input@0 { /* LTD */ + reg = <0>; + status = "okay"; + }; + + input@1 { /* RTD1 */ + reg = <1>; + status = "okay"; + sensor-type = "temperature"; + temperature-mode = "thermistor"; + }; + + input@2 { /* RTD2 */ + reg = <2>; + status = "okay"; + sensor-type = "temperature"; + temperature-mode = "thermal-diode"; + }; + + input@3 { /* RTD3 */ + reg = <3>; + status = "okay"; + sensor-type = "voltage"; + }; + }; + };
Document bindings for the Nuvoton NCT7802Y driver. Signed-off-by: Oskar Senft <osk@google.com> --- .../bindings/hwmon/nuvoton,nct7802.yaml | 142 ++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 Documentation/devicetree/bindings/hwmon/nuvoton,nct7802.yaml