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: <60f09bc9-2399-29aa-123e-db48c1aa77a7@nvidia.com>
Date:   Tue, 22 Mar 2022 16:10:38 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.5.0
Subject: Re: [PATCH v4 04/11] dt-bindings: Add HTE bindings
Content-Language: en-US
To:     Rob Herring <robh@kernel.org>
Cc:     smangipudi@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, bgolaszewski@baylibre.com,
        warthog618@gmail.com, devicetree@vger.kernel.org,
        linux-doc@vger.kernel.org
References: <20220201222630.21246-1-dipenp@nvidia.com>
 <20220201222630.21246-5-dipenp@nvidia.com>
 <Yf24nR9drkBAnYA5@robh.at.kernel.org>
From:   Dipen Patel <dipenp@nvidia.com>
In-Reply-To: <Yf24nR9drkBAnYA5@robh.at.kernel.org>
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?T0VNUlozQWlBamJSWVMvaHBlN0djYkVZK0U4TWEyb1lrNmtIeW5QQ2VKZ3Bn?=
 =?utf-8?B?QllHS1V4VjlvSkh2aWoxWmVrYjhralU1UUhKMDAyck9wZmIzS2pqUXhURU1R?=
 =?utf-8?B?YlE2QUxSZnQxd3Jtd1JNUTh5dGJKREdSZDZBQzhZZ0hzMktUeitrU3lvUHIz?=
 =?utf-8?B?elQ1bkF0a3Y0RUI2RDFCK2FlS3ZHSGxNMUR1akZrWDRxeW9NOGpDVXlNT0dW?=
 =?utf-8?B?TFZ0a3BFVVhkSlJwWEZ6eWFTUlNUbkZBNXJRaUlkc285YllEczNJRlBleFRz?=
 =?utf-8?B?dElBM1EvRkdxdTBSTmFCbVJPb0JwcHI2UzhicTNmMTE4REVVWjI4K2dOSmZB?=
 =?utf-8?B?Y3VmMkg5ZFVXVTdNVXpqSnUrbWdqN0hHYWRYSkt4bkRSVGVMbW1tbHpGK2ln?=
 =?utf-8?B?QTQ4eXN3V2NURVF0S3R0NXcxWGRZOExzSFNlUnJmN2lxZUxWeldweDlYa3BS?=
 =?utf-8?B?R2xlUmVuOXJEd2d5RURsTTNOMm9FWHg1N0ZFTW1HRkpQWHhFWFVXZm5Xbk03?=
 =?utf-8?B?UEl2Mng5czJFS3lyQUQ0N1JIRXFtZldlcC9zR3V1c1VvQ3pUN1p2bGxVck9j?=
 =?utf-8?B?VTQ0bEhFTTJKYVh2aXFOVG9HK1ZyNk05ZVFXc2hIZ01paDhPVEwxVXNZb2p0?=
 =?utf-8?B?YlZsVHBISFdJSUhIcjB1SGxDNnRqUXlJMzNKV3VKQ2lmdHFlN2JmSEU2eW5S?=
 =?utf-8?B?VUpwMUhRdHJLYVk4cUJCSWc5VC9KTEVySGVGNE55eTJmbHoxRUlEMXBnVkha?=
 =?utf-8?B?S3ltWVZRbk0rMis2K1VkSHVEc1B5KzZZMUdsMlF0TXhlK05HeW4yaXFZbWdB?=
 =?utf-8?B?QkxFanFLNFhrNE9mSTA3bTlZRHRsUlExOW11VXVLTWo0VzRCYStRTjJvazk4?=
 =?utf-8?B?cFp2YS84UUludlRZOXNJSzRuSVl4OHcyNFYvZ2VTN2pFeE5PblljZXc5Slpt?=
 =?utf-8?B?Zk5leG5lMi9GazU3K3FNNURjcU1OcnkzQUQ5U1o3SlJPQkZKbTJHL2M3djV3?=
 =?utf-8?B?enhGQnF0eW0xbWxQTzFucGNXL216bytEUUYyK054UXV0Zzkwd0VPa3FEa2g5?=
 =?utf-8?B?Mm91b1U2UVNKMjk0WmovNzB4bUJWTnlXbHNmTHZLd21ETWt3cUtpTnk5OXZq?=
 =?utf-8?B?YWttTlZoa0IwajczV0NOTzA4RHQwRlBRS1BvVzlTTHdWaUhXZEp5ZXpSYmlj?=
 =?utf-8?B?UWI4VkFFbXV6M1NOYjBqSHhkS3Bhd0pTZldoZWdtWm5CNWt0K2ZGSG4wczFM?=
 =?utf-8?B?NCt2dituQlgxMUljQkJYTHVkWkk2NjRIc1lLZGpKOWZuQlljT0tGRStXZGl0?=
 =?utf-8?B?YVIzWnQ5TWMxQnUrcUYwU2hQdmZ2ekRSWlptWUI1UDlNR3dnb0JnV2syWDV0?=
 =?utf-8?B?L2IzTVJFNFB4TERGZWFxUVdLei9oK3hTV0J5ZWZSNWFWeXBzd0l5UmloUmlk?=
 =?utf-8?B?Y2NmQlZmZzNqeW5IYmh2T2wyZWVpTzlQRW1MMnM3Y3c2dFhrT0RycmlKNi8y?=
 =?utf-8?B?Y1pxT3BxeC9aK1Q5SUhNRFdmaEJtWWgvbk54NnQ2UVVJK29xcUpNSWxicDd5?=
 =?utf-8?B?TjY5VDFnOU9OTmxxeTk4czRUdmsvWUg4QTY2V2xubkVWeS9uZU83NXI3dEJy?=
 =?utf-8?B?dlkvZFR5M1NKTnpOYm5OYjlzeFhWMWR6L3UyN2hxTkJwRnFoNDBNSWtSeGFF?=
 =?utf-8?B?Z0RGTzMxQndsWWM5MFQyUFJvekpNTVB5T0prMHVPeUNYbGc5aTFpNEhlTDg1?=
 =?utf-8?B?SnB2RmVNZkNURUQ4dGE1dTZqTUZmQVFIbGxLbXB0cXBlbjZjUnZvWlJ2Mnhi?=
 =?utf-8?B?WmY5bURNK0VNbnI4SmY3cDFneXU5OHhhU3ZJN004MzdrY3k5QXJBRXNvT2cy?=
 =?utf-8?B?NnRNTFE0bWsrWTZXbXRwRU5QY2l5YXNrajRPY0c1emxRNk1EdzhJZW9kZmRU?=
 =?utf-8?Q?y3aFdvRjaQ/zdbzt6BsKGMf60SY62mmg?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b058da33-1f4b-4315-56df-08da0c59790b
X-MS-Exchange-CrossTenant-AuthSource: BY5PR12MB4116.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2022 23:12:45.9837
 (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: +F8xBeQIgt9lGXRzJsqxBteMy8mcrwNYmrk5urXbeyYXtVosmxgoPDORFG+o5r31G28OtgQX8lyDd9Bv9Aio7g==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR12MB4842
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,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,T_SCC_BODY_TEXT_LINE 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

Hi Rob,

I will implement your review comments in next patch. Thanks for the review.

On 2/4/22 3:37 PM, Rob Herring wrote:
> On Tue, Feb 01, 2022 at 02:26:23PM -0800, Dipen Patel wrote:
>> Introduces HTE devicetree binding details for the HTE subsystem. It
>> includes examples for the consumers, binding details for the providers
>> and specific binding details for the Tegra194 based HTE providers.
>>
>> Signed-off-by: Dipen Patel <dipenp@nvidia.com>
>> Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
>> ---
>>  .../hte/hardware-timestamps-common.yaml       | 29 +++++++
>>  .../devicetree/bindings/hte/hte-consumer.yaml | 44 ++++++++++
>>  .../bindings/hte/nvidia,tegra194-hte.yaml     | 82 +++++++++++++++++++
>>  3 files changed, 155 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/hte/hardware-timestamps-common.yaml
>>  create mode 100644 Documentation/devicetree/bindings/hte/hte-consumer.yaml
>>  create mode 100644 Documentation/devicetree/bindings/hte/nvidia,tegra194-hte.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/hte/hardware-timestamps-common.yaml b/Documentation/devicetree/bindings/hte/hardware-timestamps-common.yaml
>> new file mode 100644
>> index 000000000000..ee6f94890695
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/hte/hardware-timestamps-common.yaml
>> @@ -0,0 +1,29 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/hte/hardware-timestamps-common.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Hardware timestamp providers
>> +
>> +maintainers:
>> +  - Dipen Patel <dipenp@nvidia.com>
>> +
>> +description: |
>> +  Some devices/SoCs have hardware time stamping engines which can use hardware
>> +  means to timestamp entity in realtime. The entity could be anything from
>> +  GPIOs, IRQs, Bus and so on. The hardware timestamp engine (HTE) present
>> +  itself as a provider with the bindings described in this document.
>> +
>> +properties:
>> +  $nodename:
>> +    pattern: "^hardware-timestamp(@.*|-[0-9a-f])?$"
>> +
>> +  "#hardware-timestamp-cells":
>> +    description:
>> +      Number of cells in a HTE specifier.
>> +
>> +required:
>> +  - "#hardware-timestamp-cells"
>> +
>> +additionalProperties: true
>> diff --git a/Documentation/devicetree/bindings/hte/hte-consumer.yaml b/Documentation/devicetree/bindings/hte/hte-consumer.yaml
>> new file mode 100644
>> index 000000000000..bb1232b31455
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/hte/hte-consumer.yaml
>> @@ -0,0 +1,44 @@
>> +# SPDX-License-Identifier: GPL-2.0
> dual license
>
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/hte/hte-consumer.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: HTE Consumer Device Tree Bindings
>> +
>> +maintainers:
>> +  - Dipen Patel <dipenp@nvidia.com>
> select: true
>
> Or this is never applied.
>
>> +
>> +description: |
>> +  HTE properties should be named "hardware-timestamps". The exact meaning of
>> +  each hardware-timestamps property must be documented in the device tree
>> +  binding for each device. An optional property "hardware-timestamp-names" may
>> +  contain a list of strings to label each of the HTE devices listed in the
>> +  "hardware-timestamps" property.
>> +
>> +properties:
>> +  hardware-timestamps:
>> +    $ref: /schemas/types.yaml#/definitions/phandle-array
>> +    description:
>> +      The list of HTE provider phandle. The provider must document the number
>> +      of cell that must be passed in this property along with phandle.
>> +
>> +  hardware-timestamp-names:
>> +    $ref: /schemas/types.yaml#/definitions/string-array
>> +    description:
>> +      An optional string property.
>> +
>> +required:
>> +  - hardware-timestamps
> And drop this or it will then fail everywhere.
>
>> +
>> +dependencies:
>> +  hardware-timestamp-names: [ hardware-timestamps ]
>> +
>> +additionalProperties: true
>> +
>> +examples:
>> +  - |
>> +    hte_irq_consumer {
>> +              hardware-timestamps = <&tegra_hte_lic 0x19>;
>> +              hardware-timestamp-names = "hte-irq";
>> +    };
>> diff --git a/Documentation/devicetree/bindings/hte/nvidia,tegra194-hte.yaml b/Documentation/devicetree/bindings/hte/nvidia,tegra194-hte.yaml
>> new file mode 100644
>> index 000000000000..c7d2acdb862e
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/hte/nvidia,tegra194-hte.yaml
>> @@ -0,0 +1,82 @@
>> +# SPDX-License-Identifier: GPL-2.0
> Dual license.
>
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/hte/nvidia,tegra194-hte.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Tegra194 on chip generic hardware timestamping engine (HTE)
>> +
>> +maintainers:
>> +  - Dipen Patel <dipenp@nvidia.com>
>> +
>> +description: |
> Don't need '|' if no formatting.
>
>> +  Tegra194 SoC has multiple generic hardware timestamping engines (GTE) which
>> +  can monitor subset of GPIO and on chip IRQ lines for the state change, upon
>> +  detection it will record timestamp (taken from system counter) in its
>> +  internal hardware FIFO. It has a bitmap array arranged in 32bit slices where
>> +  each bit represent signal/line to enable or disable for the hardware
>> +  timestamping.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - nvidia,tegra194-gte-aon
>> +      - nvidia,tegra194-gte-lic
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  nvidia,int-threshold:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    description:
>> +      HTE device generates its interrupt based on this u32 FIFO threshold
>> +      value. The recommended value is 1.
>> +    minimum: 1
>> +    maximum: 256
>> +
>> +  nvidia,slices:
>> +    $ref: /schemas/types.yaml#/definitions/uint32
>> +    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. The value 3 is for
>> +      GPIO GTE and 11 for IRQ GTE.
>> +    enum: [3, 11]
>> +
>> +  '#hardware-timestamp-cells':
>> +    const: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - nvidia,slices
>> +  - "#hardware-timestamp-cells"
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    tegra_hte_aon: hardware-timestamp@c1e0000 {
>> +              compatible = "nvidia,tegra194-gte-aon";
>> +              reg = <0xc1e0000 0x10000>;
>> +              interrupts = <0 13 0x4>;
>> +              nvidia,int-threshold = <1>;
>> +              nvidia,slices = <3>;
>> +              #hardware-timestamp-cells = <1>;
>> +    };
>> +
>> +  - |
>> +    tegra_hte_lic: hardware-timestamp@3aa0000 {
>> +              compatible = "nvidia,tegra194-gte-lic";
>> +              reg = <0x3aa0000 0x10000>;
>> +              interrupts = <0 11 0x4>;
>> +              nvidia,int-threshold = <1>;
>> +              nvidia,slices = <11>;
>> +              #hardware-timestamp-cells = <1>;
>> +    };
>> +
>> +...
>> -- 
>> 2.17.1
>>
>>