From patchwork Tue Mar 17 17:00:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tim Harvey X-Patchwork-Id: 203174 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4B297C10F29 for ; Tue, 17 Mar 2020 17:01:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 2D14820735 for ; Tue, 17 Mar 2020 17:01:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726754AbgCQRBN (ORCPT ); Tue, 17 Mar 2020 13:01:13 -0400 Received: from lists.gateworks.com ([108.161.130.12]:51777 "EHLO lists.gateworks.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726680AbgCQRBL (ORCPT ); Tue, 17 Mar 2020 13:01:11 -0400 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 1jEFbn-00005R-SB; Tue, 17 Mar 2020 17:02:27 +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 v6 1/3] dt-bindings: mfd: Add Gateworks System Controller bindings Date: Tue, 17 Mar 2020 10:00:51 -0700 Message-Id: <1584464453-28200-2-git-send-email-tharvey@gateworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1584464453-28200-1-git-send-email-tharvey@gateworks.com> References: <1584464453-28200-1-git-send-email-tharvey@gateworks.com> Sender: devicetree-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org This patch adds documentation of device-tree bindings for the Gateworks System Controller (GSC). Signed-off-by: Tim Harvey --- v6: - fix commit message typo - drop invalid description from #interrupt-cells property - fix adc pattern property - add unit suffix - replace hwmon/adc with adc/channel - changed adc type to gw,mode - add unit suffix and drop ref for voltage-divider - add unit suffix for voltage-offset - moved fan to its own subnode with base register 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 | 172 +++++++++++++++++++++ 1 file changed, 172 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..e921e67 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/gateworks-gsc.yaml @@ -0,0 +1,172 @@ +# 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 Monitor 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 + + adc: + type: object + description: Optional Hardware Monitoring module + + properties: + compatible: + const: gw,gsc-adc + + "#address-cells": + const: 1 + + "#size-cells": + const: 0 + + patternProperties: + "^channel@[0-9]+$": + 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 + + gw,mode: + description: | + conversion mode: + 0 - temperature, in C*10 + 1 - pre-scaled voltage value + 2 - scaled voltage based on an optional resistor divider + and optional offset + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32 + enum: [0, 1, 2] + + gw,voltage-divider-milli-ohms: + description: values of resistors for divider on raw ADC input + items: + - description: R1 + - description: R2 + + gw,voltage-offset-microvolt: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + A positive voltage offset to apply to a raw ADC + (ie to compensate for a diode drop). + + required: + - gw,mode + - reg + - label + + required: + - compatible + - "#address-cells" + - "#size-cells" + + fan: + type: object + description: Optional FAN controller + + properties: + compatible: + const: gw,gsc-fan + + base: + $ref: /schemas/types.yaml#/definitions/uint32 + description: The fan controller base address + maxItems: 1 + + required: + - compatible + - base + +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>; + + adc { + compatible = "gw,gsc-adc"; + #address-cells = <1>; + #size-cells = <0>; + + channel@0 { /* A0: Board Temperature */ + gw,mode = <0>; + reg = <0x00>; + label = "temp"; + }; + + channel@2 { /* A1: Input Voltage (raw ADC) */ + gw,mode = <1>; + reg = <0x02>; + label = "vdd_vin"; + gw,voltage-divider-milli-ohms = <22100 1000>; + gw,voltage-offset-microvolt = <800000>; + }; + + channel@b { /* A2: Battery voltage */ + gw,mode = <1>; + reg = <0x0b>; + label = "vdd_bat"; + }; + }; + + fan { + compatible = "gw,gsc-fan"; + base = <0x2c>; + }; + }; + };