Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   29 May 2020 11:41:53 +0900
Message-ID: <87imgfzclq.wl-kuninori.morimoto.gx@renesas.com>
From:   Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
To:     Rob Herring <robh@kernel.org>
Cc:     Liam Girdwood <lgirdwood@gmail.com>,
        Mark Brown <broonie@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        devicetree@vger.kernel.org, alsa-devel@alsa-project.org,
        linux-kernel@vger.kernel.org
Subject: Question about "xxx,yyy" style property
In-Reply-To: <20200528223916.GA804926@bogus>
References: <87pnay3ptb.wl-kuninori.morimoto.gx@renesas.com>
        <20200528223916.GA804926@bogus>
User-Agent: Wanderlust/2.15.9 Emacs/25.2 Mule/6.0
MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue")
Content-Type: text/plain; charset=US-ASCII
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


The Subject was "Re: [PATCH] ASoC: dt-bindings: simple-card: care missing address #address-cells"

Hi Rob

I'm trying to create v2 of simple-card patch,
And got issue which I can't solve by myself.

I think "xxx,yyy" (= which has "," at the property name)
needs special care, but it is very un-understandable...
Now, I'm give up.
So, can I ask you 2 things about Yaml Doc "xxx,yyy" type property ?

========================
1) reference own definitions from "xxx,yyy"
========================

I guess "xxx,yyy" naming property needs to has "description", right ?

But, it is OK if it references "/schemas/xxxx"

	--- OK ------
	xxx,yyy:
	  description: xxx
	  $ref: /schemas/types.yaml#/definitions/phandle-array
	-------------

but, will be error if it references own definitions

	--- NG ------
	xxx,yyy:
	  description: xxx
	  $ref: "#/definitions/mydef"
	-------------

This is the related error

	-- error(?) --
	xxx.yaml: properties:xxx,yyy:\
	  $ref: '#/definitions/mydef' does not match 'types.yaml#[/]{0,1}definitions/.*'
	--------------

# but, there is no problem if it was defined as "patternProperties"

Q. The "xxx,yyy" property can't references own definitions,
   or needs some magical extra settings ??

========================
2) phandle for "xxx,yyy"
========================

I noticed that it seems "xxx,yyy" property can't be referenced.
Here, "xxx,yyy" has "type: object" and "additionalProperties: false"
(below didn't happen if it doesn't have "additionalProperties: false")

If "xxx,yyy" has phandle, but not referenced,
This is not a problem.

	--- OK ---
	...
	foo = <&bar>;
	...
	xxx_yyy: xxx,yyy {
	  ...
	};
	--------------

But will be error if it is referenced.

	--- NG ---
	foo = <&xxx_yyy>;
	...
	xxx_yyy: xxx,yyy {
	  ...
	};
	------------

The error is

	-- error ---
	xxx.yaml: xxx.yyy: \
	Additional properties are not allowed ('phandle' was unexpected)
	------------

Q. The "xxx,yyy" needs magical settings to be referenced, or can't be ?