From patchwork Mon Feb 24 20:54:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tim Harvey X-Patchwork-Id: 11401553 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 54B61138D for ; Mon, 24 Feb 2020 20:54:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3DFBF21D7E for ; Mon, 24 Feb 2020 20:54:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727421AbgBXUyn (ORCPT ); Mon, 24 Feb 2020 15:54:43 -0500 Received: from lists.gateworks.com ([108.161.130.12]:58475 "EHLO lists.gateworks.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726722AbgBXUyn (ORCPT ); Mon, 24 Feb 2020 15:54:43 -0500 Received: from 68-189-91-139.static.snlo.ca.charter.com ([68.189.91.139] helo=tharvey.pdc.gateworks.com) by lists.gateworks.com with esmtp (Exim 4.82) (envelope-from ) id 1j6KlQ-0005EU-10; Mon, 24 Feb 2020 20:55:40 +0000 From: Tim Harvey To: Lee Jones , Jean Delvare , Guenter Roeck , linux-hwmon@vger.kernel.org, Rob Herring , Frank Rowand , devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Robert Jones Cc: Tim Harvey Subject: [PATCH v5 1/3] dt-bindings: mfd: Add Gateworks System Controller bindings Date: Mon, 24 Feb 2020 12:54:23 -0800 Message-Id: <1582577665-13554-2-git-send-email-tharvey@gateworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1582577665-13554-1-git-send-email-tharvey@gateworks.com> References: <1582577665-13554-1-git-send-email-tharvey@gateworks.com> Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org This patch adds documentation of device-tree bindings for the Gateworks System Controller (GSC). Signed-off-by: Tim Harvey --- v5: - resolve dt_binding_check issues v4: - move to using pwm_auto_point_{pwm,temp} for FAN PWM - remove unncessary resolution/scaling properties for ADCs - update to yaml - remove watchdog v3: - replaced _ with - - remove input bindings - added full description of hwmon - fix unit address of hwmon child nodes --- .../devicetree/bindings/mfd/gateworks-gsc.yaml | 158 +++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 Documentation/devicetree/bindings/mfd/gateworks-gsc.yaml diff --git a/Documentation/devicetree/bindings/mfd/gateworks-gsc.yaml b/Documentation/devicetree/bindings/mfd/gateworks-gsc.yaml new file mode 100644 index 00000000..f7c1a05 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/gateworks-gsc.yaml @@ -0,0 +1,158 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/gateworks-gsc.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Gateworks System Controller multi-function device + +description: | + The GSC is a Multifunction I2C slave device with the following submodules: + - Watchdog Timer + - GPIO + - Pushbutton controller + - Hardware Monitore with ADC's for temperature and voltage rails and + fan controller + +maintainers: + - Tim Harvey + - Robert Jones + +properties: + $nodename: + pattern: "gsc@[0-9a-f]{1,2}" + compatible: + const: gw,gsc + + reg: + description: I2C device address + maxItems: 1 + + interrupts: + maxItems: 1 + + interrupt-controller: true + + "#interrupt-cells": + const: 1 + description: The IRQ number + + hwmon: + type: object + description: Optional Hardware Monitoring module + + properties: + compatible: + const: gw,gsc-hwmon + + "#address-cells": + const: 1 + + "#size-cells": + const: 0 + + gw,fan-base: + $ref: /schemas/types.yaml#/definitions/uint32 + description: The fan controller base address + + patternProperties: + "^adc@[0-2]$": + type: object + description: | + Properties for a single ADC which can report cooked values + (ie temperature sensor based on thermister), raw values + (ie voltage rail with a pre-scaling resistor divider). + + properties: + reg: + description: Register of the ADC + maxItems: 1 + + label: + description: Name of the ADC input + + type: + description: | + temperature in C*10 (temperature), + pre-scaled voltage value (voltage), + or scaled based on an optional resistor divider and optional + offset (voltage-raw) + enum: + - temperature + - voltage + - voltage-raw + + gw,voltage-divider: + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32-array + description: values of resistors for divider on raw ADC input + items: + - description: R1 + - description: R2 + + gw,voltage-offset: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + A positive uV voltage offset to apply to a raw ADC + (ie to compensate for a diode drop). + + required: + - type + - reg + - label + + required: + - compatible + - "#address-cells" + - "#size-cells" + +required: + - compatible + - reg + - interrupts + - interrupt-controller + - "#interrupt-cells" + +examples: + - | + #include + i2c { + #address-cells = <1>; + #size-cells = <0>; + + gsc@20 { + compatible = "gw,gsc"; + reg = <0x20>; + interrupt-parent = <&gpio1>; + interrupts = <4 GPIO_ACTIVE_LOW>; + interrupt-controller; + #interrupt-cells = <1>; + + hwmon { + compatible = "gw,gsc-hwmon"; + #address-cells = <1>; + #size-cells = <0>; + gw,fan-base = <0x2c>; + + adc@0 { /* A0: Board Temperature */ + type = "temperature"; + reg = <0x00>; + label = "temp"; + }; + + adc@2 { /* A1: Input Voltage (raw ADC) */ + type = "voltage-raw"; + reg = <0x02>; + label = "vdd_vin"; + gw,voltage-divider = <22100 1000>; + gw,voltage-offset = <800000>; + }; + + adc@b { /* A2: Battery voltage */ + type = "voltage"; + reg = <0x0b>; + label = "vdd_bat"; + }; + }; + }; + };