Message ID | 20230913211449.668796-2-jcmvbkbc@gmail.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:172:b0:3f2:4152:657d with SMTP id h50csp140669vqi; Wed, 13 Sep 2023 23:08:58 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHaKNl9TjlcGkCQve85vgPnCGP/e10qFJm+a3oAkNY4phljR01yFWpA8LszfoTiX7E9c/pY X-Received: by 2002:a05:6a00:1a10:b0:68c:b30:8fcc with SMTP id g16-20020a056a001a1000b0068c0b308fccmr4750957pfv.20.1694671738415; Wed, 13 Sep 2023 23:08:58 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1694671738; cv=none; d=google.com; s=arc-20160816; b=vHUkaPFdmHZhS0UJcWhF/vmglxI06hqmPGI4FIyFGN1bYI48VueOTiesUuCa6imR9a o56cOufkHnDHvo1+p2e5ESrsfaT9PF4xa2s2DANRbNxeNGtoZAo7Wi1IyAETyrt1XaHL oCHRayS6GKP0GNq6VhQRiw1mQnZnUQcBcPAScx6xWJEI658Sef59jn8PA6b8QvJ6BrTI MS77yZ53A3lq/R6f5DYt8psGB+HFhPONkiG5dyhPSdpkBabSXR9cuQlFiu+kPTm6uUQ1 dWlaVeijtyMZgV2bq+CN1WdCtVI4M8ZGl+oo3qf2WYv3tTjGk1Ixb3eJX2a4lnL1QyW6 8+Zw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=19SLO/zUKSfrcqDZcxEA8NzdSRIAbKzNr6b76vhY/g4=; fh=acVikVMbwFOwamUuHB8M0QgaAfnMDk6x8tH4oLYsdrw=; b=1AcVxMl6fSU/4nXdc5gAAzEww53N5SWdv3+C1djGUd1STBVhDQNTO9tQna2y6E+Pxv pFd6rT/bh/AlIUIvmFuRKTFZ8IqbVX8eiTLSX53blvkgAw66Nxhjnw/E9rv118WVJiSz tiNZlBPVQGsgAgjSQVbrQYbe0vIOvnhEOF3tIUzbifyAxV36LJkJeW35W3Kw5M1ux2Fo 2jstowvyokar2/hGSArL27YX2iZ9m+Z9ijVp6Tcj1B0howQ1Uy/C4/cUyTYkS5eX1pRX YqTXRv9qgnpdNW1eT/DhVjHAI89f5t8DmwqTffbFSLp5Lw5sWi/UE+YsBnELS1m96kHz s1JA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20221208 header.b=FDmvN+x2; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from howler.vger.email (howler.vger.email. [2620:137:e000::3:4]) by mx.google.com with ESMTPS id ch11-20020a056a00288b00b00690208f6d56si897350pfb.340.2023.09.13.23.08.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Sep 2023 23:08:58 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) client-ip=2620:137:e000::3:4; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20221208 header.b=FDmvN+x2; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by howler.vger.email (Postfix) with ESMTP id A99028514B33; Wed, 13 Sep 2023 14:15:22 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at howler.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232827AbjIMVPU (ORCPT <rfc822;pwkd43@gmail.com> + 34 others); Wed, 13 Sep 2023 17:15:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40160 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232803AbjIMVPP (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 13 Sep 2023 17:15:15 -0400 Received: from mail-pf1-x429.google.com (mail-pf1-x429.google.com [IPv6:2607:f8b0:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D83F11724; Wed, 13 Sep 2023 14:15:11 -0700 (PDT) Received: by mail-pf1-x429.google.com with SMTP id d2e1a72fcca58-68fbd31d9ddso200084b3a.0; Wed, 13 Sep 2023 14:15:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1694639711; x=1695244511; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=19SLO/zUKSfrcqDZcxEA8NzdSRIAbKzNr6b76vhY/g4=; b=FDmvN+x2z8IFTkycWhM4Nkgnwz+S1WR7/Jf/dlqQlSoxTIw0kAyVM5N+mBHhj2VGOi CAko0RyJ6vyZr4LsywWdZROQc8AqlUMzbL0SmpX0ugdKUSXew7XmKEy9sNO98zZBPeY6 hDMFVyf8LMwSSgNz2n1DnyaFHf7Xg+Ex1tpC3gEak28feWl9tr5HFUsAZ4FuiKI3EWPx 6yf9UAlMt6/6Ifp1E8VEnznDQSD5Kd7U+tEDLNYFnSSnatU5AjDzgsDg/nwiADCiQuYf 5JogRX6W9YRdGzFNSt0GHZyAMwrNNNCI1SqkaKd46i3yX2ZNM5pZkC4N8fJZP6/9HYgh 2Q6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1694639711; x=1695244511; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=19SLO/zUKSfrcqDZcxEA8NzdSRIAbKzNr6b76vhY/g4=; b=PAIvTqOPSPcujr8L2Q73Wf/rB54U88sEqoNlvwHErrIXa76oYfPDJu/fUKmwikFwlU 10QFhVPvxwAjwCfBFoT+Yf2Hwf77FPp8R1l2mRckpNPfkYykqadtpW/F+5EHMedB2RVp 1A+y/ADo0AfAGg5UlaotPDQh863O+4Bqx92g2DBn/j0f5dMGH7SAJf02oiCCsB5oVaCo yiGrdERI4iuP3LKTuLqruN3GuJs7UyXrD3kGSbqdAwf+fIc7MAwkSkTovNtcaSqm5dge sKhdiV8T1nbbaXpaEFmHR63j9YITNb5F7TdikolfqJFGrOMRkoXvnPRFK2IoMRPa7hcP /Ufw== X-Gm-Message-State: AOJu0YyjAdvV19sFmj+ZlM9PjMMShH6cPkKVjCrg8wED9GVY/tvN7WoN g65zebA3+uEBCvThD1iqZFS9HDufIEs= X-Received: by 2002:a05:6a20:9717:b0:104:ad71:f080 with SMTP id hr23-20020a056a20971700b00104ad71f080mr3484683pzc.34.1694639711012; Wed, 13 Sep 2023 14:15:11 -0700 (PDT) Received: from octofox.hsd1.ca.comcast.net ([2601:646:a201:19d0:82b1:d7c2:2eaf:61e7]) by smtp.gmail.com with ESMTPSA id e18-20020a17090301d200b001b8c689060dsm73707plh.28.2023.09.13.14.15.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Sep 2023 14:15:10 -0700 (PDT) From: Max Filippov <jcmvbkbc@gmail.com> To: linux-kernel@vger.kernel.org, linux-serial@vger.kernel.org, devicetree@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Jiri Slaby <jirislaby@kernel.org>, Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, Conor Dooley <conor+dt@kernel.org>, Max Filippov <jcmvbkbc@gmail.com> Subject: [PATCH 1/4] dt-bindings: serial: document esp32-uart bindings Date: Wed, 13 Sep 2023 14:14:46 -0700 Message-Id: <20230913211449.668796-2-jcmvbkbc@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230913211449.668796-1-jcmvbkbc@gmail.com> References: <20230913211449.668796-1-jcmvbkbc@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (howler.vger.email [0.0.0.0]); Wed, 13 Sep 2023 14:15:22 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1776992113246134579 X-GMAIL-MSGID: 1776992113246134579 |
Series |
serial: add drivers for the ESP32xx serial devices
|
|
Commit Message
Max Filippov
Sept. 13, 2023, 9:14 p.m. UTC
Add documentation for the ESP32xx UART controllers.
Signed-off-by: Max Filippov <jcmvbkbc@gmail.com>
---
.../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++
1 file changed, 48 insertions(+)
create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml
Comments
On 13/09/2023 23:14, Max Filippov wrote: > Add documentation for the ESP32xx UART controllers. > > Signed-off-by: Max Filippov <jcmvbkbc@gmail.com> > --- > .../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > new file mode 100644 > index 000000000000..8b45ef808107 > --- /dev/null > +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > @@ -0,0 +1,48 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > + > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: ESP32 UART controller > + > +maintainers: > + - Max Filippov <jcmvbkbc@gmail.com> > + > +description: | Do not need '|' unless you need to preserve formatting. > + ESP32 UART controller is a part of ESP32 SoC series. > + > +properties: > + compatible: > + oneOf: That's just enum. Your descriptions are useless - tell nothing - so drop them. > + - description: UART controller for the ESP32 SoC > + const: esp,esp32-uart Looks quite generic, so just to be sure? This is not a family name, right? Neither family names nor wildcards are allowed. > + - description: UART controller for the ESP32S3 SoC > + const: esp,esp32s3-uart > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + clocks: > + maxItems: 1 > + > +required: > + - compatible > + - reg > + - interrupts > + - clocks > + > +additionalProperties: false > + > +examples: > + - | > + serial0: serial@60000000 { Drop unused label. > + compatible = "esp,esp32s3-uart"; Use 4 spaces for example indentation. > + reg = <0x60000000 0x80>; > + interrupts = <27 1 0>; Use proper define for IRQ flags. > + clocks = <&serial_clk>; > + }; Best regards, Krzysztof
On 13/09/2023 23:14, Max Filippov wrote: > Add documentation for the ESP32xx UART controllers. > > Signed-off-by: Max Filippov <jcmvbkbc@gmail.com> > --- > .../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > new file mode 100644 > index 000000000000..8b45ef808107 > --- /dev/null > +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > @@ -0,0 +1,48 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > + > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: ESP32 UART controller > + > +maintainers: > + - Max Filippov <jcmvbkbc@gmail.com> > + > +description: | > + ESP32 UART controller is a part of ESP32 SoC series. 1. Company name? 2. ESP32 SoC series suggests esp32 is a series. > + > +properties: > + compatible: > + oneOf: > + - description: UART controller for the ESP32 SoC > + const: esp,esp32-uart Also, the vendor prefix looks incorrect, so again - what is the company name? Best regards, Krzysztof
On Thu, Sep 14, 2023 at 07:55:35AM +0200, Krzysztof Kozlowski wrote: > On 13/09/2023 23:14, Max Filippov wrote: > > Add documentation for the ESP32xx UART controllers. > > > > Signed-off-by: Max Filippov <jcmvbkbc@gmail.com> > > --- > > .../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++ > > 1 file changed, 48 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > > > diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > new file mode 100644 > > index 000000000000..8b45ef808107 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > @@ -0,0 +1,48 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > + > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: ESP32 UART controller > > + > > +maintainers: > > + - Max Filippov <jcmvbkbc@gmail.com> > > + > > +description: | > > + ESP32 UART controller is a part of ESP32 SoC series. > > 1. Company name? > 2. ESP32 SoC series suggests esp32 is a series. > > > + > > +properties: > > + compatible: > > + oneOf: > > + - description: UART controller for the ESP32 SoC > > + const: esp,esp32-uart > > Also, the vendor prefix looks incorrect, so again - what is the company > name? esp32 is made by expressif, which would match with "esp" as a vendor prefix.
On Wed, Sep 13, 2023 at 10:54 PM Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote: > > On 13/09/2023 23:14, Max Filippov wrote: > > Add documentation for the ESP32xx UART controllers. > > > > Signed-off-by: Max Filippov <jcmvbkbc@gmail.com> > > --- > > .../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++ > > 1 file changed, 48 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > > > diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > new file mode 100644 > > index 000000000000..8b45ef808107 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml > > @@ -0,0 +1,48 @@ > > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > > + > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: ESP32 UART controller > > + > > +maintainers: > > + - Max Filippov <jcmvbkbc@gmail.com> > > + > > +description: | > > Do not need '|' unless you need to preserve formatting. Ok. > > + ESP32 UART controller is a part of ESP32 SoC series. > > + > > +properties: > > + compatible: > > + oneOf: > > That's just enum. Your descriptions are useless - tell nothing - so drop > them. Ok. > > + - description: UART controller for the ESP32 SoC > > + const: esp,esp32-uart > > Looks quite generic, so just to be sure? This is not a family name, > right? Neither family names nor wildcards are allowed. ESP32 is the official name of a specific SoC. More recent SoC models of that family are named ESP32-S2 and ESP32-S3, sometimes they are collectively referred to as the 'ESP32 series'. In this binding 'esp32' is used for the ESP32 SoC and 'esp32s3' is used for the ESP32-S3. > > + - description: UART controller for the ESP32S3 SoC > > + const: esp,esp32s3-uart > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + maxItems: 1 > > + > > + clocks: > > + maxItems: 1 > > + > > +required: > > + - compatible > > + - reg > > + - interrupts > > + - clocks > > + > > +additionalProperties: false > > + > > +examples: > > + - | > > + serial0: serial@60000000 { > > Drop unused label. Ok. > > + compatible = "esp,esp32s3-uart"; > > Use 4 spaces for example indentation. Ok. > > + reg = <0x60000000 0x80>; > > + interrupts = <27 1 0>; > > Use proper define for IRQ flags. These are not IRQ flags. 1 and 0 are the routing parts of the IRQ specification.
On Thu, Sep 14, 2023 at 7:48 AM Conor Dooley <conor@kernel.org> wrote: > On Thu, Sep 14, 2023 at 07:55:35AM +0200, Krzysztof Kozlowski wrote: > > On 13/09/2023 23:14, Max Filippov wrote: > > > +description: | > > > + ESP32 UART controller is a part of ESP32 SoC series. > > > > 1. Company name? > > 2. ESP32 SoC series suggests esp32 is a series. > > > > > + > > > +properties: > > > + compatible: > > > + oneOf: > > > + - description: UART controller for the ESP32 SoC > > > + const: esp,esp32-uart > > > > Also, the vendor prefix looks incorrect, so again - what is the company > > name? > > esp32 is made by expressif, which would match with "esp" as a vendor > prefix. It's 'Espressif', but otherwise yes, this is a registered vendor prefix. See https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/vendor-prefixes.yaml?h=v6.6-rc1#n443
diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml new file mode 100644 index 000000000000..8b45ef808107 --- /dev/null +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml @@ -0,0 +1,48 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause + +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: ESP32 UART controller + +maintainers: + - Max Filippov <jcmvbkbc@gmail.com> + +description: | + ESP32 UART controller is a part of ESP32 SoC series. + +properties: + compatible: + oneOf: + - description: UART controller for the ESP32 SoC + const: esp,esp32-uart + - description: UART controller for the ESP32S3 SoC + const: esp,esp32s3-uart + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + +required: + - compatible + - reg + - interrupts + - clocks + +additionalProperties: false + +examples: + - | + serial0: serial@60000000 { + compatible = "esp,esp32s3-uart"; + reg = <0x60000000 0x80>; + interrupts = <27 1 0>; + clocks = <&serial_clk>; + };