From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Dipen Patel <dipenp@nvidia.com>,
thierry.reding@gmail.com, jonathanh@nvidia.com,
linux-kernel@vger.kernel.org, linux-tegra@vger.kernel.org,
linux-gpio@vger.kernel.org, linus.walleij@linaro.org,
devicetree@vger.kernel.org, linux-doc@vger.kernel.org,
robh+dt@kernel.org, timestamp@lists.linux.dev,
krzysztof.kozlowski+dt@linaro.org, brgl@bgdev.pl, corbet@lwn.net,
gregkh@linuxfoundation.org
Subject: Re: [PATCH V4 06/10] hte: Re-phrase tegra API document
Date: Wed, 5 Apr 2023 09:24:30 +0700 [thread overview]
Message-ID: <364610b8-2c40-6a71-513e-4e154b077055@gmail.com> (raw)
In-Reply-To: <20230323012929.10815-7-dipenp@nvidia.com>
On 3/23/23 08:29, Dipen Patel wrote:
> Make Tegra194 API document generic to make it applicable for
> current and future tegra hte providers.
>
> Signed-off-by: Dipen Patel <dipenp@nvidia.com>
> ---
> Documentation/driver-api/hte/tegra194-hte.rst | 33 +++++++++----------
> 1 file changed, 16 insertions(+), 17 deletions(-)
>
While generalizing the doc, the doc file name should also be renamed
(i.e. to tegra-hte.rst).
> diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentation/driver-api/hte/tegra194-hte.rst
> index f2d617265546..85e654772782 100644
> --- a/Documentation/driver-api/hte/tegra194-hte.rst
> +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> @@ -5,25 +5,25 @@ HTE Kernel provider driver
>
> Description
> -----------
> -The Nvidia tegra194 HTE provider driver implements two GTE
> -(Generic Timestamping Engine) instances: 1) GPIO GTE and 2) LIC
> -(Legacy Interrupt Controller) IRQ GTE. Both GTE instances get the
> -timestamp from the system counter TSC which has 31.25MHz clock rate, and the
> -driver converts clock tick rate to nanoseconds before storing it as timestamp
> -value.
> +The Nvidia tegra HTE provider also known as GTE (Generic Timestamping Engine)
> +driver implements two GTE instances: 1) GPIO GTE and 2) LIC
> +(Legacy Interrupt Controller) IRQ GTE. Both GTE instances get the timestamp
> +from the system counter TSC which has 31.25MHz clock rate, and the driver
> +converts clock tick rate to nanoseconds before storing it as timestamp value.
>
> GPIO GTE
> --------
>
> This GTE instance timestamps GPIO in real time. For that to happen GPIO
> -needs to be configured as input. The always on (AON) GPIO controller instance
> -supports timestamping GPIOs in real time and it has 39 GPIO lines. The GPIO GTE
> -and AON GPIO controller are tightly coupled as it requires very specific bits
> -to be set in GPIO config register before GPIO GTE can be used, for that GPIOLIB
> -adds two optional APIs as below. The GPIO GTE code supports both kernel
> -and userspace consumers. The kernel space consumers can directly talk to HTE
> -subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV
> -framework to HTE subsystem.
> +needs to be configured as input. Only the always on (AON) GPIO controller
> +instance supports timestamping GPIOs in real time as it is tightly coupled with
> +the GPIO GTE. To support this, GPIOLIB adds two optional APIs as mentioned
> +below. The GPIO GTE code supports both kernel and userspace consumers. The
> +kernel space consumers can directly talk to HTE subsystem while userspace
> +consumers timestamp requests go through GPIOLIB CDEV framework to HTE
> +subsystem. The hte devicetree binding described at
> +``Documentation/devicetree/bindings/timestamp`` provides an example of how a
> +consumer can request an GPIO line.
>
> See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns().
>
> @@ -34,9 +34,8 @@ returns the timestamp in nanoseconds.
> LIC (Legacy Interrupt Controller) IRQ GTE
> -----------------------------------------
>
> -This GTE instance timestamps LIC IRQ lines in real time. There are 352 IRQ
> -lines which this instance can add timestamps to in real time. The hte
> -devicetree binding described at ``Documentation/devicetree/bindings/timestamp``
> +This GTE instance timestamps LIC IRQ lines in real time. The hte devicetree
> +binding described at ``Documentation/devicetree/bindings/timestamp``
> provides an example of how a consumer can request an IRQ line. Since it is a
> one-to-one mapping with IRQ GTE provider, consumers can simply specify the IRQ
> number that they are interested in. There is no userspace consumer support for
The wording LGTM, thanks!
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2023-04-05 2:24 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-23 1:29 [PATCH V4 00/10] Add Tegra234 HTE support Dipen Patel
2023-03-23 1:29 ` [PATCH V4 01/10] MAINTAINERS: Add HTE/timestamp subsystem details Dipen Patel
2023-03-23 1:29 ` [PATCH V4 02/10] dt-bindings: timestamp: Add Tegra234 support Dipen Patel
2023-03-25 11:04 ` Krzysztof Kozlowski
2023-03-25 11:06 ` Krzysztof Kozlowski
2023-03-23 1:29 ` [PATCH V4 03/10] dt-bindings: timestamp: Deprecate nvidia,slices property Dipen Patel
2023-03-23 8:34 ` Linus Walleij
2023-03-25 11:05 ` Krzysztof Kozlowski
2023-04-03 18:49 ` Dipen Patel
2023-03-23 1:29 ` [PATCH V4 04/10] dt-bindings: timestamp: Add nvidia,gpio-controller Dipen Patel
2023-03-23 8:36 ` Linus Walleij
2023-03-23 13:58 ` Rob Herring
2023-03-24 17:13 ` Rob Herring
2023-03-24 18:51 ` Dipen Patel
2023-03-25 11:09 ` Krzysztof Kozlowski
2023-04-04 4:24 ` Dipen Patel
2023-04-04 5:33 ` Krzysztof Kozlowski
2023-04-04 17:31 ` Dipen Patel
2023-04-04 10:28 ` Thierry Reding
2023-04-04 17:30 ` Dipen Patel
2023-03-25 11:07 ` Krzysztof Kozlowski
2023-03-27 16:58 ` Dipen Patel
2023-04-04 10:30 ` Thierry Reding
2023-04-04 17:20 ` Dipen Patel
2023-03-23 1:29 ` [PATCH V4 05/10] arm64: tegra: Add Tegra234 GTE nodes Dipen Patel
2023-03-23 1:29 ` [PATCH V4 06/10] hte: Re-phrase tegra API document Dipen Patel
2023-04-05 2:24 ` Bagas Sanjaya [this message]
2023-04-06 0:03 ` Dipen Patel
2023-03-23 1:29 ` [PATCH V4 07/10] hte: Add Tegra234 provider Dipen Patel
2023-03-23 1:29 ` [PATCH V4 08/10] hte: Deprecate nvidia,slices property Dipen Patel
2023-03-23 1:29 ` [PATCH V4 09/10] hte: handle nvidia,gpio-controller property Dipen Patel
2023-03-23 8:37 ` Linus Walleij
2023-03-23 1:29 ` [PATCH V4 10/10] gpio: tegra186: Add Tegra234 hte support Dipen Patel
2023-03-23 8:38 ` Linus Walleij
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=364610b8-2c40-6a71-513e-4e154b077055@gmail.com \
--to=bagasdotme@gmail.com \
--cc=brgl@bgdev.pl \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=dipenp@nvidia.com \
--cc=gregkh@linuxfoundation.org \
--cc=jonathanh@nvidia.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linus.walleij@linaro.org \
--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=timestamp@lists.linux.dev \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.