From: Linus Walleij <linus.walleij@linaro.org>
To: Dipen Patel <dipenp@nvidia.com>
Cc: "thierry.reding@gmail.com" <thierry.reding@gmail.com>,
Jon Hunter <jonathanh@nvidia.com>,
linux-kernel <linux-kernel@vger.kernel.org>,
linux-tegra <linux-tegra@vger.kernel.org>,
"open list:GPIO SUBSYSTEM" <linux-gpio@vger.kernel.org>,
Bartosz Golaszewski <bgolaszewski@baylibre.com>,
Kent Gibson <warthog618@gmail.com>,
"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS"
<devicetree@vger.kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Rob Herring <robh+dt@kernel.org>
Subject: Re: [RFC 04/11] dt-bindings: Add HTE bindings
Date: Sun, 27 Jun 2021 12:56:54 +0200 [thread overview]
Message-ID: <CACRpkdbazcGqapWMLnj8=UShU0j002SkKRTxgpprfDeaP_nAQQ@mail.gmail.com> (raw)
In-Reply-To: <20210625235532.19575-5-dipenp@nvidia.com>
Hi Dipen,
thanks a lot for this very interesting patch set!
I'm gonna try to review properly, just pointing out some conceptual
things to begin with. Bindings is a good place to start.
On Sat, Jun 26, 2021 at 1:48 AM Dipen Patel <dipenp@nvidia.com> wrote:
> +description: |
> + HTE properties should be named "htes". The exact meaning of each htes
> + property must be documented in the device tree binding for each device.
> + An optional property "hte-names" may contain a list of strings to label
> + each of the HTE devices listed in the "htes" property.
I think this is a bit over-abbreviated. IIO has:
io-channels =...
io-channel-names =...
Given DT:s infatuation with using english plural I would opt for:
hardware-timestamps = ..
hardware-timestamp-names = ...
The "engine" part is a bit of an nVidia:ism I think and a too generic
term. Could as well be "processor" or "automata" but nVidia just
happened to name it an engine. (DMA engine would be a precedent
though, so no hard preference from my side.)
When reading this it is pretty intuitively evident what is going on.
Other than that it looks really good!
> +++ b/Documentation/devicetree/bindings/hte/hte.yaml
I would name this hardware-timestamp-common.yamp or so.
> +title: HTE providers
Spell this out: Hardware timestamp providers
> +properties:
> + $nodename:
> + pattern: "^hte(@.*|-[0-9a-f])*$"
Likewise:
hardware-timestamp@ ...
I think this is good because it is very unambiguous.
> +examples:
> + - |
> + tegra_hte_aon: hte@c1e0000 {
> + compatible = "nvidia,tegra194-gte-aon";
> + reg = <0xc1e0000 0x10000>;
> + interrupts = <0 13 0x4>;
> + int-threshold = <1>;
> + slices = <3>;
> + #hte-cells = <1>;
> + };
The examples can be kept to the tegra194 bindings I think, this
generic binding doesn't need an example as such.
> +$id: http://devicetree.org/schemas/hte/nvidia,tegra194-hte.yaml#
This one should be named like this, that is great.
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Tegra194 on chip generic hardware timestamping engine (HTE)
This is clear and nice.
> + int-threshold:
> + description:
> + HTE device generates its interrupt based on this u32 FIFO threshold
> + value. The recommended value is 1.
> + minimum: 1
> + maximum: 256
Does this mean a single timestamp in the FIFO will generate an IRQ?
Then spell that out so it is clear.
> + slices:
> + description:
> + HTE lines are arranged in 32 bit slice where each bit represents different
> + line/signal that it can enable/configure for the timestamp. It is u32
> + property and depends on the HTE instance in the chip.
> + oneOf:
> + - items:
> + - const: 3
> + - items:
> + - const: 11
Can't you just use
enum: [3, 11]
?
> + '#hte-cells':
> + const: 1
So IMO this would be something like
#hardware-timestamp-cells
Other than this it overall looks very nice to me!
Yours,
Linus Walleij
next prev parent reply other threads:[~2021-06-27 10:57 UTC|newest]
Thread overview: 75+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-25 23:55 [RFC 00/11] Intro to Hardware timestamping engine Dipen Patel
2021-06-25 23:55 ` [RFC 01/11] Documentation: Add HTE subsystem guide Dipen Patel
2021-07-04 18:55 ` Jonathan Cameron
2021-07-27 23:44 ` Dipen Patel
2021-08-01 15:24 ` Jonathan Cameron
2021-06-25 23:55 ` [RFC 02/11] drivers: Add HTE subsystem Dipen Patel
2021-06-27 17:40 ` Randy Dunlap
2021-07-04 20:15 ` Jonathan Cameron
2021-07-04 20:45 ` Jonathan Cameron
2021-07-28 5:12 ` Dipen Patel
2021-08-01 16:48 ` Jonathan Cameron
2021-07-28 4:38 ` Dipen Patel
2021-08-01 16:13 ` Jonathan Cameron
2021-09-14 5:43 ` Dipen Patel
2021-09-26 15:42 ` Jonathan Cameron
2021-07-05 7:30 ` Greg KH
2021-07-28 0:34 ` Dipen Patel
2021-06-25 23:55 ` [RFC 03/11] hte: Add tegra194 HTE kernel provider Dipen Patel
2021-07-01 14:21 ` Kent Gibson
2021-07-28 23:59 ` Dipen Patel
2021-07-30 7:01 ` Dipen Patel
2021-07-31 15:43 ` Kent Gibson
2021-08-03 22:40 ` Dipen Patel
2021-08-03 23:02 ` Kent Gibson
2021-08-07 2:41 ` Dipen Patel
2021-08-07 3:07 ` Kent Gibson
2021-08-07 4:52 ` Dipen Patel
2021-08-07 4:51 ` Kent Gibson
2021-08-07 5:35 ` Dipen Patel
2021-08-07 5:42 ` Kent Gibson
2021-08-07 5:47 ` Dipen Patel
2021-07-04 20:27 ` Jonathan Cameron
2021-07-29 2:42 ` Dipen Patel
2021-07-08 23:33 ` Michał Mirosław
2021-07-29 2:43 ` Dipen Patel
2021-06-25 23:55 ` [RFC 04/11] dt-bindings: Add HTE bindings Dipen Patel
2021-06-27 10:56 ` Linus Walleij [this message]
2021-07-30 1:32 ` Dipen Patel
2021-07-01 14:02 ` Rob Herring
2021-07-30 1:56 ` Dipen Patel
2021-07-01 15:54 ` Rob Herring
2021-07-30 1:58 ` Dipen Patel
2021-06-25 23:55 ` [RFC 05/11] hte: Add Tegra194 IRQ HTE test driver Dipen Patel
2021-06-27 17:42 ` Randy Dunlap
2021-06-25 23:55 ` [RFC 06/11] gpiolib: Add HTE support Dipen Patel
2021-06-27 11:41 ` Linus Walleij
2021-07-01 14:24 ` Kent Gibson
2021-07-30 2:25 ` Dipen Patel
2021-07-31 5:13 ` Kent Gibson
2021-06-25 23:55 ` [RFC 07/11] gpio: tegra186: Add HTE in gpio-tegra186 driver Dipen Patel
2021-06-25 23:55 ` [RFC 08/11] gpiolib: cdev: Add hardware timestamp clock type Dipen Patel
2021-06-27 11:38 ` Linus Walleij
2021-06-27 11:49 ` Linus Walleij
2021-07-30 3:16 ` Dipen Patel
2021-07-01 14:24 ` Kent Gibson
2021-07-30 3:07 ` Dipen Patel
2021-07-31 6:05 ` Kent Gibson
2021-08-03 22:41 ` Dipen Patel
2021-08-03 22:38 ` Kent Gibson
2021-07-09 8:30 ` Jon Hunter
2021-07-30 2:33 ` Dipen Patel
2021-08-03 16:42 ` Jon Hunter
2021-08-03 22:51 ` Dipen Patel
2021-08-03 23:09 ` Kent Gibson
2021-06-25 23:55 ` [RFC 09/11] tools: gpio: Add new hardware " Dipen Patel
2021-06-27 11:36 ` Linus Walleij
2021-07-30 3:17 ` Dipen Patel
2021-07-31 6:16 ` Kent Gibson
2021-08-11 9:11 ` Linus Walleij
2021-06-25 23:55 ` [RFC 10/11] hte: Add tegra GPIO HTE test driver Dipen Patel
2021-06-27 17:43 ` Randy Dunlap
2021-06-25 23:55 ` [RFC 11/11] MAINTAINERS: Added HTE Subsystem Dipen Patel
2021-06-27 13:07 ` [RFC 00/11] Intro to Hardware timestamping engine Andy Shevchenko
2021-06-27 14:40 ` Linus Walleij
2021-06-28 12:02 ` Andy Shevchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CACRpkdbazcGqapWMLnj8=UShU0j002SkKRTxgpprfDeaP_nAQQ@mail.gmail.com' \
--to=linus.walleij@linaro.org \
--cc=bgolaszewski@baylibre.com \
--cc=devicetree@vger.kernel.org \
--cc=dipenp@nvidia.com \
--cc=jonathanh@nvidia.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-tegra@vger.kernel.org \
--cc=robh+dt@kernel.org \
--cc=thierry.reding@gmail.com \
--cc=warthog618@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).