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;
Message-ID: <f0aff7ad-0b9f-c9e0-df27-23b8ec9b011e@nvidia.com>
Date:   Wed, 5 Apr 2023 17:03:36 -0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0)
 Gecko/20100101 Thunderbird/102.9.1
Subject: Re: [PATCH V4 06/10] hte: Re-phrase tegra API document
To:     Bagas Sanjaya <bagasdotme@gmail.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
References: <20230323012929.10815-1-dipenp@nvidia.com>
 <20230323012929.10815-7-dipenp@nvidia.com>
 <364610b8-2c40-6a71-513e-4e154b077055@gmail.com>
Content-Language: en-US
From:   Dipen Patel <dipenp@nvidia.com>
In-Reply-To: <364610b8-2c40-6a71-513e-4e154b077055@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?SDNLZHg1T3ZoUlRBYWxJZldqV3BhVk5KbWJXaHpXN2ZtTW1haEV6YktZZjdP?=
 =?utf-8?B?ekI2RlZjYnlFMGppVVA5aXV0Q2pWWVJoRktvUldxRjQvUEg2V0FONGtFL2lJ?=
 =?utf-8?B?VzhmUGY0NTBCaDJrUWVhbkZpc05jbmk3ZlBiMERVbTREYnROTUtha0FuZk9Y?=
 =?utf-8?B?K0wvUGtrWk1CSk1FaFlrSnZjR2hGRDlqVnIvV0F5MUxLTkk4YmZPRHJkMXBP?=
 =?utf-8?B?NDVzTDJYYVpHZWZVSlUvUVRnRkNFbFJsRWdyN3FqR0dzMU1UKzltd3VXU1RF?=
 =?utf-8?B?dkkwai9OYk5lNGlEZFZUbkFkc2hxaGZBUkxPWW5qSDhJZUZRNHBEcjFhMEpW?=
 =?utf-8?B?SWRuL3VOT1ByRVVBSDJMc1E0TVBjUHRwUjhXdG1wUE5YdU54MmFzUGlFRk4y?=
 =?utf-8?B?RVRvSjlXczdsYnhWMEFidExrWDYrbytWNUxTei9lbHdFemZCc01kMWg4QlJn?=
 =?utf-8?B?a0VFc3Y5K3A5T2Y3cWJUZ05IbExNeGdWMkxHTnRpSFhlZVBQZG1FNG40TTdC?=
 =?utf-8?B?Y3dZY1V4R3A4bnVJSmoybStxTjl3UXNZQXJnSUJKMzBBMUswS1RyRGFOQXEy?=
 =?utf-8?B?T3FEdVhCV1ZZbXZQQ2JTOEJYUGhuVlFNOVRDWkNZbEdWVlZKaTNIbk1wdkx3?=
 =?utf-8?B?TXBuWEhpT2JJSmVBR1I3OXRmcXZ4TlBEMTZrM2RhUmN4Wm1OMkE1MnZYb0do?=
 =?utf-8?B?Z2hiU0xtK3ZteVZpd0lxS3BMUzVLUzh6ZGhoaXRBK0pOQXBDcVV3Z3lGcG5o?=
 =?utf-8?B?L2RZTTVKM09nZHpEOTJrbGpYaGFmTkZwUFBZQUdjQk40WVZYa0N0SUc2dVVI?=
 =?utf-8?B?RVlBSDhVTG9OL0JjcG5HOHR3WWJwVktrT3NwME55YXhhOVBQak9lKyt1MzZ6?=
 =?utf-8?B?Z0M0MktxQm8xd3hjY2ZSNXBPdGtJTERuRWpReWorNGMxdHE2L0c5N044cllw?=
 =?utf-8?B?bzRUSTdkOVc3MlpHaEFoRWRYVEgrNHNKTUw3K2ovczdWK2ovWTVmWGxHYjR0?=
 =?utf-8?B?Q29Bd0VacXk4VlArN21tclg5SEpsTDV3dTNBZjA1c1NVY0NaRVVOTzNWem1o?=
 =?utf-8?B?T20rRXNGc1d2NWFQYVdOWmszYTJuT3I4QjFaMFJzZUxaeWRENFlDYzVQTitx?=
 =?utf-8?B?WXNTTlcrY1dvbG9jV1JYM3FVeTJaTUhkc1FGTWNtcnVoL01WeFhQdkd3VjhE?=
 =?utf-8?B?SzdyM3JVNGx6WDdXQXR5cVdsWUxIcmF1dWFTK1UzMVNjNjE4QnB0cWRUakJO?=
 =?utf-8?B?QzREWFQ0cTE3Zk1rVXZJYk5JbjMxV1BQQnhqamlFOTRDbVMvV3lDcVFaM2Fu?=
 =?utf-8?B?VGQxNnYxbHhsSEJ0NUd2S0dESEM3YmNDaHU4YjlFMzV6d1BJOCtNL3BtMSsy?=
 =?utf-8?B?ZUd1dmEvdnJWUDVMazlnUUVITEZURldORW0vNGw5L2pHdUlxZXk1U0xGclNJ?=
 =?utf-8?B?T2NDV2xDWG5Rd1AxaTE0SjJyMWxscXVla05WWStJOEkvekJvUFJ6MXF1NkZa?=
 =?utf-8?B?TmZTRFAwOVVDTVdBTk9wNUxmc1owMlA1QUlPdkVhNnE3SnowYUdRQS9odDg2?=
 =?utf-8?B?ZzBuMzVKQVRLSVVEaEZ1ZHJDYi91eVU3Wk9zL0wvOUd5U01sK0xiYUw1bVFY?=
 =?utf-8?B?ZUJ2dStRZE5Rbk1xd2pEZkJQK1VCditrM3grZW5EQmd3a0hzRm1vMDlYRUt3?=
 =?utf-8?B?ZmMwRjJOUHpQZWxSWVRGdy9PRDJ5UGNnZjBIQnNKdmlTRWw5MlNKbW5PQkZP?=
 =?utf-8?B?RExKYjZhR3FuWW4xZ1FRaHdwLytTL3ZMSlpDeU16eVd0dDc4U2ZVSnlyRnM4?=
 =?utf-8?B?eWhOU3E2Z3VBdm5Rb1BvVjNpeG1saVA1ZEJxV3R2Z25RcUMxQzVzOXp0a1Yv?=
 =?utf-8?B?bDVxTG9XRitDaEM2MEhHMWFQK1VxaC9xWTBFWVArZ1J5WlNPVExzR1ZtbjF2?=
 =?utf-8?B?Y0xZdlh6cnBjOVEvczVIcEd1WlJRcFFjenB0TEZFWFdMWFBYbkcxSmNFc0Vm?=
 =?utf-8?B?SHhoekduVVI4WlIxNTJ6K2VTMjRQVjB0dDRWaGF6MW04OGlMbWtMLzBlcGxI?=
 =?utf-8?B?RUpySlVDYkhCOXN2RXU3aC8yamd0ZWVRd2paOEwvMXkzTG10UzhiaytWQ0xl?=
 =?utf-8?Q?Mni5yLYDxXkW0sZYdT892v4YX?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 0f4f5f6a-6498-402e-48b3-08db36326401
X-MS-Exchange-CrossTenant-AuthSource: IA1PR12MB6604.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Apr 2023 00:03:45.9530
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: pCrBbTYQdCn2jvacuWo8QNjL8uLbQ/7tx8uNvYr0TTd+/6e0PRfat5pprl6AlOREKalPiuVUR1PwC4z4gmhAmA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR12MB8192
X-Spam-Status: No, score=-0.6 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,NICE_REPLY_A,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE
        autolearn=unavailable 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

On 4/4/23 7:24 PM, Bagas Sanjaya wrote:
> 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).

make sense, I will do rename it in the next patch series.
> 
>> 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>
>