From patchwork Fri Feb 14 06:26:14 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ikjoon Jang X-Patchwork-Id: 11381735 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 9AD38921 for ; Fri, 14 Feb 2020 06:26:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 671FC222C2 for ; Fri, 14 Feb 2020 06:26:21 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="gVc1c004" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728764AbgBNG0U (ORCPT ); Fri, 14 Feb 2020 01:26:20 -0500 Received: from mail-pj1-f43.google.com ([209.85.216.43]:34734 "EHLO mail-pj1-f43.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726048AbgBNG0U (ORCPT ); Fri, 14 Feb 2020 01:26:20 -0500 Received: by mail-pj1-f43.google.com with SMTP id f2so535296pjq.1 for ; Thu, 13 Feb 2020 22:26:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=j3Xyx8fRbicPOjRu9j2e0LsG8c5+ZnJjBZgg9ohEEXs=; b=gVc1c004qVQWIrfk97TY/QhWJws5yi4ccbyTNrM9uzZ70yUg9lZzt+/G6/ZTAIDUrR foKhCnYhWQOjicaAS2SKv6Gg9p3aHrxhhT+so0UYx7OvD5dK29YdSZ4tMZ5KO+UZkRA6 DmRkhzJsIKb1foTmDgelR3EcHAK9pdzy4qjqQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=j3Xyx8fRbicPOjRu9j2e0LsG8c5+ZnJjBZgg9ohEEXs=; b=MhtQiXYHhFUd/VhdYtKahjF639nyzsgxYl3Dbt7a00yKEQpokqQs+wbkuNfk07kgD5 kDKGo4PFdEyI0gh5DDAFmPFDnHWoQY/rCaUebotg82YF6VruDhraKli/rJ/tWqgLUXSZ qfENJ6rtUNBR5UJsheyny64bF1lqUx0ViEvMavNfNRWr+ztVdVGGJNvV1vq/X7PMe1Im j0DQyG04Cwn1ELioRqPTlDwFb4s5QPkWdPc5OvhAH5OrdowrE1IH+Qq1yXThHzWD4Umw ehfeAkqqo+wKY37+n4Kvc2iZpehzPR5de5da73ylenmiFQUdbi7sDbls2XiZ63f/aEXj lmgg== X-Gm-Message-State: APjAAAXuYWvPJHvJJbbFIt852f3Q25iVwXkPm3eUIGWLjuedjfHahVl0 TkZ6emA2kVdG0U2WtebE7WYiQNta/dE= X-Google-Smtp-Source: APXvYqx3jJCPQiDaPMqTILJKjdDrncHj6OUTkBgV2TDazbHtb84Mg5PdUHrXroM6oC5owWzjZnPNhw== X-Received: by 2002:a17:90b:1110:: with SMTP id gi16mr1587676pjb.110.1581661579697; Thu, 13 Feb 2020 22:26:19 -0800 (PST) Received: from ikjn-p920.tpe.corp.google.com ([2401:fa00:1:10:254e:2b40:ef8:ee17]) by smtp.gmail.com with ESMTPSA id x21sm5409598pfq.76.2020.02.13.22.26.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 22:26:19 -0800 (PST) From: Ikjoon Jang To: devicetree@vger.kernel.org Cc: Rob Herring , Dmitry Torokhov , Gwendal Grignou , Lee Jones , Mark Rutland , Benson Leung , Enric Balletbo i Serra , Guenter Roeck , Jiri Kosina , Benjamin Tissoires , Nicolas Boitchat , linux-input@vger.kernel.org, Ikjoon Jang Subject: [PATCH v4] dt-bindings: mfd: Convert ChromeOS EC bindings to json-schema Date: Fri, 14 Feb 2020 14:26:14 +0800 Message-Id: <20200214062614.220699-1-ikjn@chromium.org> X-Mailer: git-send-email 2.25.0.265.gbab2e86ba0-goog In-Reply-To: <20200114021934.178057-1-ikjn@chromium.org> References: <20200114021934.178057-1-ikjn@chromium.org> MIME-Version: 1.0 Sender: linux-input-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org Convert the ChromeOS EC bindings to json-schema. Signed-off-by: Ikjoon Jang --- v4: text reflows, add type references, and fix examples v3: node name changed in rpmsg example v2: cleanup description, fix typos, remove LPC, and add RPMSG example --- .../devicetree/bindings/mfd/cros-ec.txt | 76 ---------- .../devicetree/bindings/mfd/cros-ec.yaml | 139 ++++++++++++++++++ 2 files changed, 139 insertions(+), 76 deletions(-) delete mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.txt create mode 100644 Documentation/devicetree/bindings/mfd/cros-ec.yaml diff --git a/Documentation/devicetree/bindings/mfd/cros-ec.txt b/Documentation/devicetree/bindings/mfd/cros-ec.txt deleted file mode 100644 index 4860eabd0f72..000000000000 --- a/Documentation/devicetree/bindings/mfd/cros-ec.txt +++ /dev/null @@ -1,76 +0,0 @@ -ChromeOS Embedded Controller - -Google's ChromeOS EC is a Cortex-M device which talks to the AP and -implements various function such as keyboard and battery charging. - -The EC can be connect through various means (I2C, SPI, LPC, RPMSG) and the -compatible string used depends on the interface. Each connection method has -its own driver which connects to the top level interface-agnostic EC driver. -Other Linux driver (such as cros-ec-keyb for the matrix keyboard) connect to -the top-level driver. - -Required properties (I2C): -- compatible: "google,cros-ec-i2c" -- reg: I2C slave address - -Required properties (SPI): -- compatible: "google,cros-ec-spi" -- reg: SPI chip select - -Required properties (RPMSG): -- compatible: "google,cros-ec-rpmsg" - -Optional properties (SPI): -- google,cros-ec-spi-pre-delay: Some implementations of the EC need a little - time to wake up from sleep before they can receive SPI transfers at a high - clock rate. This property specifies the delay, in usecs, between the - assertion of the CS to the start of the first clock pulse. -- google,cros-ec-spi-msg-delay: Some implementations of the EC require some - additional processing time in order to accept new transactions. If the delay - between transactions is not long enough the EC may not be able to respond - properly to subsequent transactions and cause them to hang. This property - specifies the delay, in usecs, introduced between transactions to account - for the time required by the EC to get back into a state in which new data - can be accepted. - -Required properties (LPC): -- compatible: "google,cros-ec-lpc" -- reg: List of (IO address, size) pairs defining the interface uses - -Optional properties (all): -- google,has-vbc-nvram: Some implementations of the EC include a small - nvram space used to store verified boot context data. This boolean flag - is used to specify whether this nvram is present or not. - -Example for I2C: - -i2c@12ca0000 { - cros-ec@1e { - reg = <0x1e>; - compatible = "google,cros-ec-i2c"; - interrupts = <14 0>; - interrupt-parent = <&wakeup_eint>; - wakeup-source; - }; - - -Example for SPI: - -spi@131b0000 { - ec@0 { - compatible = "google,cros-ec-spi"; - reg = <0x0>; - interrupts = <14 0>; - interrupt-parent = <&wakeup_eint>; - wakeup-source; - spi-max-frequency = <5000000>; - controller-data { - cs-gpio = <&gpf0 3 4 3 0>; - samsung,spi-cs; - samsung,spi-feedback-delay = <2>; - }; - }; -}; - - -Example for LPC is not supplied as it is not yet implemented. diff --git a/Documentation/devicetree/bindings/mfd/cros-ec.yaml b/Documentation/devicetree/bindings/mfd/cros-ec.yaml new file mode 100644 index 000000000000..20d54cddc967 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/cros-ec.yaml @@ -0,0 +1,139 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/cros-ec.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: ChromeOS Embedded Controller + +maintainers: + - Benson Leung + - Enric Balletbo i Serra + - Guenter Roeck + +description: + Google's ChromeOS EC is a microcontroller which talks to the AP and + implements various functions such as keyboard and battery charging. + The EC can be connected through various interfaces (I2C, SPI, and others) + and the compatible string specifies which interface is being used. + +properties: + compatible: + oneOf: + - description: + For implementations of the EC is connected through I2C. + const: google,cros-ec-i2c + - description: + For implementations of the EC is connected through SPI. + const: google,cros-ec-spi + - description: + For implementations of the EC is connected through RPMSG. + const: google,cros-ec-rpmsg + + google,has-vbc-nvram: + description: + Some implementations of the EC include a small nvram space used to + store verified boot context data. This boolean flag is used to specify + whether this nvram is present or not. + type: boolean + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + +required: + - compatible + +allOf: + - if: + properties: + compatible: + const: google,cros-ec-i2c + then: + properties: + reg: + description: I2C slave address + maxItems: 1 + + required: + - reg + - if: + properties: + compatible: + const: google,cros-ec-spi + then: + properties: + reg: + description: SPI chip select + maxItems: 1 + + google,cros-ec-spi-pre-delay: + description: + This property specifies the delay in usecs between the + assertion of the CS and the first clock pulse. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32 + - default: 0 + - minimum: 0 + + google,cros-ec-spi-msg-delay: + description: + This property specifies the delay in usecs between messages. + allOf: + - $ref: /schemas/types.yaml#/definitions/uint32 + - default: 0 + - minimum: 0 + + required: + - reg + +additionalProperties: false + +examples: + # Example for I2C + - | + #include + #include + + i2c0 { + #address-cells = <1>; + #size-cells = <0>; + + cros-ec@1e { + compatible = "google,cros-ec-i2c"; + reg = <0x1e>; + interrupts = <6 0>; + interrupt-parent = <&gpio0>; + }; + }; + + # Example for SPI + - | + #include + #include + + spi0 { + #address-cells = <1>; + #size-cells = <0>; + + cros-ec@0 { + compatible = "google,cros-ec-spi"; + reg = <0x0>; + google,cros-ec-spi-msg-delay = <30>; + google,cros-ec-spi-pre-delay = <10>; + interrupts = <99 0>; + interrupt-parent = <&gpio7>; + spi-max-frequency = <5000000>; + }; + }; + + # Example for RPMSG + - | + scp0 { + cros-ec@0 { + compatible = "google,cros-ec-rpmsg"; + }; + }; +...