Re: [PATCH v3] dt-bindings: can: xilinx_can: Convert Xilinx CAN binding to YAML

[Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxxxxx>]

On 15/03/2022 06:38, Amit Kumar Kumar Mahapatra wrote:
> Hello Krzysztof,
> 
>> -----Original Message-----
>> From: Krzysztof Kozlowski <krzysztof.kozlowski@xxxxxxxxxxxxx>
>> Sent: Thursday, March 10, 2022 10:25 PM
>> To: Amit Kumar Kumar Mahapatra <akumarma@xxxxxxxxxx>;
>> wg@xxxxxxxxxxxxxx; mkl@xxxxxxxxxxxxxx; kuba@xxxxxxxxxx;
>> robh+dt@xxxxxxxxxx; Appana Durga Kedareswara Rao
>> <appanad@xxxxxxxxxx>
>> Cc: linux-can@xxxxxxxxxxxxxxx; netdev@xxxxxxxxxxxxxxx;
>> devicetree@xxxxxxxxxxxxxxx; linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; linux-
>> kernel@xxxxxxxxxxxxxxx; Michal Simek <michals@xxxxxxxxxx>; git
>> <git@xxxxxxxxxx>; Amit Kumar Kumar Mahapatra <akumarma@xxxxxxxxxx>
>> Subject: Re: [PATCH v3] dt-bindings: can: xilinx_can: Convert Xilinx CAN
>> binding to YAML
>>
>> On 10/03/2022 16:39, Amit Kumar Mahapatra wrote:
>>> Convert Xilinx CAN binding documentation to YAML.
>>>
>>> Signed-off-by: Amit Kumar Mahapatra <amit.kumar-
>> mahapatra@xxxxxxxxxx>
>>> ---
>>> BRANCH: yaml
>>>
>>> Changes in v2:
>>>  - Added reference to can-controller.yaml
>>>  - Added example node for canfd-2.0
>>>
>>> Changes in v3:
>>>  - Changed yaml file name from xilinx_can.yaml to xilinx,can.yaml
>>>  - Added "power-domains" to fix dts_check warnings
>>>  - Grouped "clock-names" and "clocks" together
>>>  - Added type $ref for all non-standard fields
>>>  - Defined compatible strings as enum
>>>  - Used defines,instead of hard-coded values, for GIC interrupts
>>>  - Droped unused labels in examples
>>>  - Droped description for standard feilds
>>> ---
>>>  .../bindings/net/can/xilinx,can.yaml          | 161 ++++++++++++++++++
>>>  .../bindings/net/can/xilinx_can.txt           |  61 -------
>>>  2 files changed, 161 insertions(+), 61 deletions(-)  create mode
>>> 100644 Documentation/devicetree/bindings/net/can/xilinx,can.yaml
>>>  delete mode 100644
>>> Documentation/devicetree/bindings/net/can/xilinx_can.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/net/can/xilinx,can.yaml
>>> b/Documentation/devicetree/bindings/net/can/xilinx,can.yaml
>>> new file mode 100644
>>> index 000000000000..78398826677d
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/net/can/xilinx,can.yaml
>>> @@ -0,0 +1,161 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/net/can/xilinx,can.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title:
>>> +  Xilinx Axi CAN/Zynq CANPS controller
>>> +
>>> +maintainers:
>>> +  - Appana Durga Kedareswara rao <appana.durga.rao@xxxxxxxxxx>
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - xlnx,zynq-can-1.0
>>> +      - xlnx,axi-can-1.00.a
>>> +      - xlnx,canfd-1.0
>>> +      - xlnx,canfd-2.0
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  clocks:
>>> +    minItems: 1
>>> +    maxItems: 2
>>> +
>>> +  clock-names:
>>> +    maxItems: 2
>>> +
>>> +  power-domains:
>>> +    maxItems: 1
>>> +
>>> +  tx-fifo-depth:
>>> +    $ref: "/schemas/types.yaml#/definitions/uint32"
>>> +    description: CAN Tx fifo depth (Zynq, Axi CAN).
>>> +
>>> +  rx-fifo-depth:
>>> +    $ref: "/schemas/types.yaml#/definitions/uint32"
>>> +    description: CAN Rx fifo depth (Zynq, Axi CAN, CAN FD in
>>> + sequential Rx mode)
>>> +
>>> +  tx-mailbox-count:
>>> +    $ref: "/schemas/types.yaml#/definitions/uint32"
>>> +    description: CAN Tx mailbox buffer count (CAN FD)
>>
>> I asked about vendor prefix and I think I did not get an answer from you
>> about skipping it. Do you think it is not needed?
> 
> Sorry, I went through all your previous comments but I couldn't find the 
> comment where you had asked about vendor prefix. Could you please point
> me to it ?
> We can add vendor prefix to non-standard fields, but we need to update 
> driver to be aligned with it and deprecate original property which has been 
> added in 2018 and acked by Rob and Marc at that time.
> https://github.com/torvalds/linux/commit/7cb0f17f5252874ba0ecbda964e7e01587bf828e

Ah, I am sorry, apologies. I have never asked for the prefix and I
should not mention it here. I think I got confused with different
patchset but this one here is conversion. The prefix is not needed.

Best regards,
Krzysztof