Message ID | 20221104163833.1289857-7-miquel.raynal@bootlin.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp518157wru; Fri, 4 Nov 2022 09:48:07 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7NRebAUW46zquc8B85YGUkbfn4MVR2b4eY9IU2hSWPGtX3pz7jCBlLSnMZeSuendRbK8F8 X-Received: by 2002:a17:906:6990:b0:7ad:e20f:c405 with SMTP id i16-20020a170906699000b007ade20fc405mr23203085ejr.390.1667580487064; Fri, 04 Nov 2022 09:48:07 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1667580487; cv=none; d=google.com; s=arc-20160816; b=E8jc6eJRFHYg5I0CD2SSXhBkHMatxbBsI5y6uCVVC91mP8e7D6RkDzJDTrtCZXuXCe r4GFSOWCg1Wu5T+L13r2u9AvXaPUIhJNIbLyLIPOa95iADzRFNT3TvIe9R3w7YTj1d5m P5ViHfvSSyL9fEkNa9De+Y2gkCCGjYVCxmqiwz09sQYLoJUUKKer3aau4bGmbEiLXvPg ts2cBzyeMDgQMdjnwd7y0YSlC7be+evg9VIyaAzsQqlhLb/GfHMuWQi696JVKm7ousGw H0OMjVRHrXzoIcBS9Fayw0pZD6JRXgQQ8ND9t3uBOyhhq/eyeMXvCg3+mbO+hpIyB8dc QEDg== 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=+IAKdycEjB3JSBVjZSTycHnanjluSD4CNhAulpC1qcM=; b=UGqqFPNCdaYH1mIyvggKge/lMmBMfpw7y/2XFJYeBoAlZA/C4ma6IBli6XhgZPcIS3 0xQ+NrijbDqCGGY8lxZC7HCMqAQ37ql51S7jFpSMu6H1Wvibsbliprh8Iii+kuAOnKLh dyUzqXt7feuinpd7ulXjfAst/aMNCQ2iYtwMYBASJthAjoZGO5nltWSvfKvF4/ddrTMB xh3dGlbW4Uji20Ak9s7wlJCtnqfmI0duy7ajj606TSwtpuja4L98y/f+poQgZtJ7FsIX QKoqTntgSGPGdvjLgLAd61eKPaNbdyRMT8ez+G4Kyp5WPDxl/7m5BBcCmAby2F1FtloH pCkQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b="li/4x+t9"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p20-20020a1709060dd400b00782c6ab6f01si3984441eji.410.2022.11.04.09.47.42; Fri, 04 Nov 2022 09:48:07 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b="li/4x+t9"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230474AbiKDQj1 (ORCPT <rfc822;jimliu8233@gmail.com> + 99 others); Fri, 4 Nov 2022 12:39:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33646 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231844AbiKDQir (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Fri, 4 Nov 2022 12:38:47 -0400 Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 958952E68D; Fri, 4 Nov 2022 09:38:44 -0700 (PDT) Received: (Authenticated sender: miquel.raynal@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3E999C000E; Fri, 4 Nov 2022 16:38:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1667579923; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=+IAKdycEjB3JSBVjZSTycHnanjluSD4CNhAulpC1qcM=; b=li/4x+t9JqVt/eqjBbXqkyPTrk/zyd+3f2YWAKuTLw56hokHnO6zCEavs/7/GKTe2Tlwtu OwM8suBPNdfWZKU58reA1Q5ZBachcHcTtpQ5epx9AWNoRi/UfgzDnOvzorN1kxf8Vu7hsJ 9UBeGDkzybqSeESNV4DBZEjjMAz2GhI9S1G4NqneiOIqF5VLo90ZfRCjQxtAluNa5afj+5 W2HeJ7eZ5dp/BOF1nQ6EpXQ+1Ye6ODhuvqeCBeFbnW5zIaiRvBuBxniY3+yH6pVQ4Wfofp U9Epm0S7Z21HkSCd/fyiuOmKrtlTHmvVI1aQwIUx/VZKeg3Z2czZNYbnTkTKlw== From: Miquel Raynal <miquel.raynal@bootlin.com> To: Rob Herring <robh+dt@kernel.org>, Krzysztof Kozlowski <krzk+dt@kernel.org>, devicetree@vger.kernel.org Cc: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>, <linux-kernel@vger.kernel.org>, Robert Marko <robert.marko@sartura.hr>, Luka Perkov <luka.perkov@sartura.hr>, Thomas Petazzoni <thomas.petazzoni@bootlin.com>, Michael Walle <michael@walle.cc>, <linux-arm-kernel@lists.infradead.org>, Bartosz Golaszewski <brgl@bgdev.pl>, Christian Eggers <ceggers@arri.de>, Cory Tusar <cory.tusar@pid1solutions.com>, Miquel Raynal <miquel.raynal@bootlin.com> Subject: [PATCH v3 6/6] dt-bindings: nvmem: add YAML schema for the ONIE tlv layout Date: Fri, 4 Nov 2022 17:38:33 +0100 Message-Id: <20221104163833.1289857-7-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221104163833.1289857-1-miquel.raynal@bootlin.com> References: <20221104163833.1289857-1-miquel.raynal@bootlin.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1748584876381550317?= X-GMAIL-MSGID: =?utf-8?q?1748584876381550317?= |
Series |
Bindings for NVMEM layouts
|
|
Commit Message
Miquel Raynal
Nov. 4, 2022, 4:38 p.m. UTC
Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE
compatible networking device.
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
.../bindings/nvmem/layouts/nvmem-layout.yaml | 1 +
.../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++
2 files changed, 116 insertions(+)
create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml
Comments
On Fri, Nov 04, 2022 at 05:38:33PM +0100, Miquel Raynal wrote: > Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE > compatible networking device. > > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> > --- > .../bindings/nvmem/layouts/nvmem-layout.yaml | 1 + > .../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++ > 2 files changed, 116 insertions(+) > create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > index f64ea2fa362d..8512ee538c4c 100644 > --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > @@ -19,6 +19,7 @@ description: | > > oneOf: > - $ref: kontron,sl28-vpd.yaml > + - $ref: onie,tlv-layout.yaml > > properties: > compatible: true > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > new file mode 100644 > index 000000000000..1d91277324ac > --- /dev/null > +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > @@ -0,0 +1,115 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: NVMEM layout of the ONIE tlv table > + > +maintainers: > + - Miquel Raynal <miquel.raynal@bootlin.com> > + > +description: > + Modern networking hardware implementing the Open Compute Project ONIE > + infrastructure shall provide a non-volatile memory with a table whose the > + content is well specified and gives many information about the manufacturer > + (name, country of manufacture, etc) as well as device caracteristics (serial > + number, hardware version, mac addresses, etc). The underlaying device type > + (flash, EEPROM,...) is not specified. The exact location of each value is also > + dynamic and should be discovered at run time because it depends on the > + parameters the manufacturer decided to embed. > + > +properties: > + compatible: > + const: onie,tlv-layout > + > + product-name: true This is a node? If so, you need: type: object additionalProperties: false > + > + part-number: true > + > + serial-number: true > + > + mac-address: > + type: object > + description: > + Base MAC address for all on-module network interfaces. The first > + argument of the phandle will be treated as an offset. > + > + properties: > + "#nvmem-cell-cells": > + const: 1 > + > + additionalProperties: false > + > + manufacture-date: true > + > + device-version: true > + > + label-revision: true > + > + platforn-name: true > + > + onie-version: true > + > + num-macs: true > + > + manufacturer: true > + > + country-code: true > + > + vendor: true > + > + diag-version: true > + > + service-tag: true > + > + vendor-extension: true > + > +required: > + - compatible > + > +additionalProperties: false > + > +examples: > + - | > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + eeprom@56 { > + compatible = "atmel,24c64"; > + read-only; > + reg = <0x56>; > + > + nvmem-layout { > + compatible = "onie,tlv-layout"; > + > + serial-number { > + }; > + }; > + }; > + }; > + > + - | > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + flash@0 { > + compatible = "m25p80", "jedec,spi-nor"; > + reg = <0>; > + > + otp { > + compatible = "user-otp"; > + > + nvmem-layout { > + compatible = "onie,tlv-layout"; > + > + mac-address { > + #nvmem-cell-cells = <1>; > + }; > + }; > + }; > + }; > + }; > +... > -- > 2.34.1 > >
Hi Rob, robh@kernel.org wrote on Wed, 9 Nov 2022 22:00:55 -0600: > On Fri, Nov 04, 2022 at 05:38:33PM +0100, Miquel Raynal wrote: > > Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE > > compatible networking device. > > > > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> > > --- > > .../bindings/nvmem/layouts/nvmem-layout.yaml | 1 + > > .../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++ > > 2 files changed, 116 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > index f64ea2fa362d..8512ee538c4c 100644 > > --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > @@ -19,6 +19,7 @@ description: | > > > > oneOf: > > - $ref: kontron,sl28-vpd.yaml > > + - $ref: onie,tlv-layout.yaml > > > > properties: > > compatible: true > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > new file mode 100644 > > index 000000000000..1d91277324ac > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > @@ -0,0 +1,115 @@ > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: NVMEM layout of the ONIE tlv table > > + > > +maintainers: > > + - Miquel Raynal <miquel.raynal@bootlin.com> > > + > > +description: > > + Modern networking hardware implementing the Open Compute Project ONIE > > + infrastructure shall provide a non-volatile memory with a table whose the > > + content is well specified and gives many information about the manufacturer > > + (name, country of manufacture, etc) as well as device caracteristics (serial > > + number, hardware version, mac addresses, etc). The underlaying device type > > + (flash, EEPROM,...) is not specified. The exact location of each value is also > > + dynamic and should be discovered at run time because it depends on the > > + parameters the manufacturer decided to embed. > > + > > +properties: > > + compatible: > > + const: onie,tlv-layout > > + > > + product-name: true > > This is a node? If so, you need: > > type: object > additionalProperties: false I thought referencing a schema under a property would be enough? Indeed in nvmem.yaml we create the property nvmem-layout and make it reference nvmem-layout.yaml. Then, in nvmem-layout.yaml: oneOf: - $ref: kontron,sl28-vpd.yaml - $ref: onie,tlv-layout.yaml we reference the different layouts that may apply (very much like what you proposed to list the mtd partition parsers, if I got it right). Isn't it enough? Then if you look below there is an "additionalProperties: false" defined. > > + > > + part-number: true > > + [...] > > + service-tag: true > > + > > + vendor-extension: true > > + > > +required: > > + - compatible > > + > > +additionalProperties: false (here) > > + > > +examples: > > + - | > > + spi { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + > > + eeprom@56 { > > + compatible = "atmel,24c64"; > > + read-only; > > + reg = <0x56>; > > + > > + nvmem-layout { > > + compatible = "onie,tlv-layout"; > > + > > + serial-number { > > + }; > > + }; > > + }; > > + }; > > + > > + - | > > + spi { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + > > + flash@0 { > > + compatible = "m25p80", "jedec,spi-nor"; > > + reg = <0>; > > + > > + otp { > > + compatible = "user-otp"; > > + > > + nvmem-layout { > > + compatible = "onie,tlv-layout"; > > + > > + mac-address { > > + #nvmem-cell-cells = <1>; > > + }; > > + }; > > + }; > > + }; > > + }; > > +... > > -- > > 2.34.1 > > > > Thanks, Miquèl
On Thu, Nov 10, 2022 at 09:50:34AM +0100, Miquel Raynal wrote: > Hi Rob, > > robh@kernel.org wrote on Wed, 9 Nov 2022 22:00:55 -0600: > > > On Fri, Nov 04, 2022 at 05:38:33PM +0100, Miquel Raynal wrote: > > > Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE > > > compatible networking device. > > > > > > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> > > > --- > > > .../bindings/nvmem/layouts/nvmem-layout.yaml | 1 + > > > .../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++ > > > 2 files changed, 116 insertions(+) > > > create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > index f64ea2fa362d..8512ee538c4c 100644 > > > --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > @@ -19,6 +19,7 @@ description: | > > > > > > oneOf: > > > - $ref: kontron,sl28-vpd.yaml > > > + - $ref: onie,tlv-layout.yaml > > > > > > properties: > > > compatible: true > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > new file mode 100644 > > > index 000000000000..1d91277324ac > > > --- /dev/null > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > @@ -0,0 +1,115 @@ > > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > > +%YAML 1.2 > > > +--- > > > +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# > > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > > + > > > +title: NVMEM layout of the ONIE tlv table > > > + > > > +maintainers: > > > + - Miquel Raynal <miquel.raynal@bootlin.com> > > > + > > > +description: > > > + Modern networking hardware implementing the Open Compute Project ONIE > > > + infrastructure shall provide a non-volatile memory with a table whose the > > > + content is well specified and gives many information about the manufacturer > > > + (name, country of manufacture, etc) as well as device caracteristics (serial > > > + number, hardware version, mac addresses, etc). The underlaying device type > > > + (flash, EEPROM,...) is not specified. The exact location of each value is also > > > + dynamic and should be discovered at run time because it depends on the > > > + parameters the manufacturer decided to embed. > > > + > > > +properties: > > > + compatible: > > > + const: onie,tlv-layout > > > + > > > + product-name: true > > > > This is a node? If so, you need: > > > > type: object > > additionalProperties: false > > I thought referencing a schema under a property would be enough? > > Indeed in nvmem.yaml we create the property nvmem-layout and make it > reference nvmem-layout.yaml. Then, in nvmem-layout.yaml: > > oneOf: > - $ref: kontron,sl28-vpd.yaml > - $ref: onie,tlv-layout.yaml > > we reference the different layouts that may apply (very much like what > you proposed to list the mtd partition parsers, if I got it right). > > Isn't it enough? No. It is enough to allow the property, but nothing defines what it must be (a node) and what the node contains in the case of empty nodes. Try adding 'product-name = "foo";' and it won't warn. Rob
Hi Rob, robh@kernel.org wrote on Thu, 10 Nov 2022 08:05:45 -0600: > On Thu, Nov 10, 2022 at 09:50:34AM +0100, Miquel Raynal wrote: > > Hi Rob, > > > > robh@kernel.org wrote on Wed, 9 Nov 2022 22:00:55 -0600: > > > > > On Fri, Nov 04, 2022 at 05:38:33PM +0100, Miquel Raynal wrote: > > > > Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE > > > > compatible networking device. > > > > > > > > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> > > > > --- > > > > .../bindings/nvmem/layouts/nvmem-layout.yaml | 1 + > > > > .../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++ > > > > 2 files changed, 116 insertions(+) > > > > create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > index f64ea2fa362d..8512ee538c4c 100644 > > > > --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > @@ -19,6 +19,7 @@ description: | > > > > > > > > oneOf: > > > > - $ref: kontron,sl28-vpd.yaml > > > > + - $ref: onie,tlv-layout.yaml > > > > > > > > properties: > > > > compatible: true > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > new file mode 100644 > > > > index 000000000000..1d91277324ac > > > > --- /dev/null > > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > @@ -0,0 +1,115 @@ > > > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > > > +%YAML 1.2 > > > > +--- > > > > +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# > > > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > > > + > > > > +title: NVMEM layout of the ONIE tlv table > > > > + > > > > +maintainers: > > > > + - Miquel Raynal <miquel.raynal@bootlin.com> > > > > + > > > > +description: > > > > + Modern networking hardware implementing the Open Compute Project ONIE > > > > + infrastructure shall provide a non-volatile memory with a table whose the > > > > + content is well specified and gives many information about the manufacturer > > > > + (name, country of manufacture, etc) as well as device caracteristics (serial > > > > + number, hardware version, mac addresses, etc). The underlaying device type > > > > + (flash, EEPROM,...) is not specified. The exact location of each value is also > > > > + dynamic and should be discovered at run time because it depends on the > > > > + parameters the manufacturer decided to embed. > > > > + > > > > +properties: > > > > + compatible: > > > > + const: onie,tlv-layout > > > > + > > > > + product-name: true > > > > > > This is a node? If so, you need: > > > > > > type: object > > > additionalProperties: false > > > > I thought referencing a schema under a property would be enough? > > > > Indeed in nvmem.yaml we create the property nvmem-layout and make it > > reference nvmem-layout.yaml. Then, in nvmem-layout.yaml: > > > > oneOf: > > - $ref: kontron,sl28-vpd.yaml > > - $ref: onie,tlv-layout.yaml > > > > we reference the different layouts that may apply (very much like what > > you proposed to list the mtd partition parsers, if I got it right). > > > > Isn't it enough? > > No. It is enough to allow the property, but nothing defines what it must > be (a node) and what the node contains in the case of empty nodes. Try > adding 'product-name = "foo";' and it won't warn. There was a misunderstanding on my side. I thought your comment was about the nvmem-layout node. Actually you were commenting about all the sub-nodes defining nvmem-cells inside, so I'm fully aligned with your response. However, if I understood it correctly, you basically said that: property: $ref: foo.yaml is not the same as: property: type: object $ref: foo.yaml If that's the case, then should we consider dropping this patch (which you agreed with in the first place)? https://lore.kernel.org/linux-mtd/20221104164718.1290859-17-miquel.raynal@bootlin.com/T/#u Thanks, Miquèl
On Thu, Nov 10, 2022 at 06:43:34PM +0100, Miquel Raynal wrote: > Hi Rob, > > robh@kernel.org wrote on Thu, 10 Nov 2022 08:05:45 -0600: > > > On Thu, Nov 10, 2022 at 09:50:34AM +0100, Miquel Raynal wrote: > > > Hi Rob, > > > > > > robh@kernel.org wrote on Wed, 9 Nov 2022 22:00:55 -0600: > > > > > > > On Fri, Nov 04, 2022 at 05:38:33PM +0100, Miquel Raynal wrote: > > > > > Add a schema for the ONIE tlv NVMEM layout that can be found on any ONIE > > > > > compatible networking device. > > > > > > > > > > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com> > > > > > --- > > > > > .../bindings/nvmem/layouts/nvmem-layout.yaml | 1 + > > > > > .../nvmem/layouts/onie,tlv-layout.yaml | 115 ++++++++++++++++++ > > > > > 2 files changed, 116 insertions(+) > > > > > create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > > > > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > > index f64ea2fa362d..8512ee538c4c 100644 > > > > > --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml > > > > > @@ -19,6 +19,7 @@ description: | > > > > > > > > > > oneOf: > > > > > - $ref: kontron,sl28-vpd.yaml > > > > > + - $ref: onie,tlv-layout.yaml > > > > > > > > > > properties: > > > > > compatible: true > > > > > diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > > new file mode 100644 > > > > > index 000000000000..1d91277324ac > > > > > --- /dev/null > > > > > +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml > > > > > @@ -0,0 +1,115 @@ > > > > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > > > > > +%YAML 1.2 > > > > > +--- > > > > > +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# > > > > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > > > > + > > > > > +title: NVMEM layout of the ONIE tlv table > > > > > + > > > > > +maintainers: > > > > > + - Miquel Raynal <miquel.raynal@bootlin.com> > > > > > + > > > > > +description: > > > > > + Modern networking hardware implementing the Open Compute Project ONIE > > > > > + infrastructure shall provide a non-volatile memory with a table whose the > > > > > + content is well specified and gives many information about the manufacturer > > > > > + (name, country of manufacture, etc) as well as device caracteristics (serial > > > > > + number, hardware version, mac addresses, etc). The underlaying device type > > > > > + (flash, EEPROM,...) is not specified. The exact location of each value is also > > > > > + dynamic and should be discovered at run time because it depends on the > > > > > + parameters the manufacturer decided to embed. > > > > > + > > > > > +properties: > > > > > + compatible: > > > > > + const: onie,tlv-layout > > > > > + > > > > > + product-name: true > > > > > > > > This is a node? If so, you need: > > > > > > > > type: object > > > > additionalProperties: false > > > > > > I thought referencing a schema under a property would be enough? > > > > > > Indeed in nvmem.yaml we create the property nvmem-layout and make it > > > reference nvmem-layout.yaml. Then, in nvmem-layout.yaml: > > > > > > oneOf: > > > - $ref: kontron,sl28-vpd.yaml > > > - $ref: onie,tlv-layout.yaml > > > > > > we reference the different layouts that may apply (very much like what > > > you proposed to list the mtd partition parsers, if I got it right). > > > > > > Isn't it enough? > > > > No. It is enough to allow the property, but nothing defines what it must > > be (a node) and what the node contains in the case of empty nodes. Try > > adding 'product-name = "foo";' and it won't warn. > > There was a misunderstanding on my side. I thought your comment was > about the nvmem-layout node. Actually you were commenting about all the > sub-nodes defining nvmem-cells inside, so I'm fully aligned with your > response. > > However, if I understood it correctly, you basically said that: > > property: > $ref: foo.yaml > > is not the same as: > > property: > type: object > $ref: foo.yaml > > If that's the case, then should we consider dropping this patch (which > you agreed with in the first place)? From a json-schema standpoint, they may not be the same. You can't know without knowing what's in foo.yaml. They are the same only if foo.yaml contains 'type: object'. It does for us because the tools will add 'type: object' to the top-level of every schema file. properties: property: properties: foo: {} These would all pass validation with the above: property; property = "bar"; More generally, json-schema's behavior is if a keyword doesn't apply for an instance, just silently ignore it. So while 'properties' keyword only makes sense on an object or maxItems on an array, json-schema doesn't care. The dtschema tools do a bit to counteract that. Rob
diff --git a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml index f64ea2fa362d..8512ee538c4c 100644 --- a/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml +++ b/Documentation/devicetree/bindings/nvmem/layouts/nvmem-layout.yaml @@ -19,6 +19,7 @@ description: | oneOf: - $ref: kontron,sl28-vpd.yaml + - $ref: onie,tlv-layout.yaml properties: compatible: true diff --git a/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml new file mode 100644 index 000000000000..1d91277324ac --- /dev/null +++ b/Documentation/devicetree/bindings/nvmem/layouts/onie,tlv-layout.yaml @@ -0,0 +1,115 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/nvmem/layouts/onie,tlv-layout.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NVMEM layout of the ONIE tlv table + +maintainers: + - Miquel Raynal <miquel.raynal@bootlin.com> + +description: + Modern networking hardware implementing the Open Compute Project ONIE + infrastructure shall provide a non-volatile memory with a table whose the + content is well specified and gives many information about the manufacturer + (name, country of manufacture, etc) as well as device caracteristics (serial + number, hardware version, mac addresses, etc). The underlaying device type + (flash, EEPROM,...) is not specified. The exact location of each value is also + dynamic and should be discovered at run time because it depends on the + parameters the manufacturer decided to embed. + +properties: + compatible: + const: onie,tlv-layout + + product-name: true + + part-number: true + + serial-number: true + + mac-address: + type: object + description: + Base MAC address for all on-module network interfaces. The first + argument of the phandle will be treated as an offset. + + properties: + "#nvmem-cell-cells": + const: 1 + + additionalProperties: false + + manufacture-date: true + + device-version: true + + label-revision: true + + platforn-name: true + + onie-version: true + + num-macs: true + + manufacturer: true + + country-code: true + + vendor: true + + diag-version: true + + service-tag: true + + vendor-extension: true + +required: + - compatible + +additionalProperties: false + +examples: + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + + eeprom@56 { + compatible = "atmel,24c64"; + read-only; + reg = <0x56>; + + nvmem-layout { + compatible = "onie,tlv-layout"; + + serial-number { + }; + }; + }; + }; + + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + + flash@0 { + compatible = "m25p80", "jedec,spi-nor"; + reg = <0>; + + otp { + compatible = "user-otp"; + + nvmem-layout { + compatible = "onie,tlv-layout"; + + mac-address { + #nvmem-cell-cells = <1>; + }; + }; + }; + }; + }; +...