Re: [PATCH v3 net-next 01/15] dt-bindings: ptp: add NETC Timer PTP clock

Krzysztof Kozlowski
2025-08-14T08:25:16Z

On Tue, Aug 12, 2025 at 05:46:20PM +0800, Wei Fang wrote:
> NXP NETC (Ethernet Controller) is a multi-function PCIe Root Complex
> Integrated Endpoint (RCiEP), the Timer is one of its functions which
> provides current time with nanosecond resolution, precise periodic
> pulse, pulse on timeout (alarm), and time capture on external pulse
> support. And also supports time synchronization as required for IEEE
> 1588 and IEEE 802.1AS-2020. So add device tree binding doc for the
> PTP clock based on NETC Timer.
>
> Signed-off-by: Wei Fang <wei.fang@nxp.com>
>
> ---
> v2 changes:
> 1. Refine the subject and the commit message
> 2. Remove "nxp,pps-channel"
> 3. Add description to "clocks" and "clock-names"
> v3 changes:
> 1. Remove the "system" clock from clock-names
> ---
> .../devicetree/bindings/ptp/nxp,ptp-netc.yaml | 63 +++++++++++++++++++
> 1 file changed, 63 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/ptp/nxp,ptp-netc.yaml
>
> diff --git a/Documentation/devicetree/bindings/ptp/nxp,ptp-netc.yaml b/Documentation/devicetree/bindings/ptp/nxp,ptp-netc.yaml
> new file mode 100644
> index 000000000000..60fb2513fd76
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ptp/nxp,ptp-netc.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/ptp/nxp,ptp-netc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP NETC V4 Timer PTP clock
> +
> +description:
> + NETC V4 Timer provides current time with nanosecond resolution, precise
> + periodic pulse, pulse on timeout (alarm), and time capture on external
> + pulse support. And it supports time synchronization as required for
> + IEEE 1588 and IEEE 802.1AS-2020.
> +
> +maintainers:
> + - Wei Fang <wei.fang@nxp.com>
> + - Clark Wang <xiaoning.wang@nxp.com>
> +
> +properties:
> + compatible:
> + enum:
> + - pci1131,ee02
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> + description:
> + The reference clock of NETC Timer, if not present, indicates that
> + the system clock of NETC IP is selected as the reference clock.
> +
> + clock-names:
> + description:
> + The "ccm_timer" means the reference clock comes from CCM of SoC.
> + The "ext_1588" means the reference clock comes from external IO
> + pins.
> + enum:
> + - ccm_timer

You should name here how the input pin is called, not the source. Pin is
"ref"?

> + - ext_1588

This should be just "ext"? We probably talked about this, but this feels
like you describe one input in different ways.

You will get the same questions in the future, if commit msg does not
reflect previous talks.

> +
> +required:
> + - compatible
> + - reg
> +
> +allOf:
> + - $ref: /schemas/pci/pci-device.yaml
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + pcie {
> + #address-cells = <3>;
> + #size-cells = <2>;
> +
> + ethernet@18,0 {

That's rather timer or ptp-timer or your binding is incorrect. Please
describe COMPLETE device in your binding.

> + compatible = "pci1131,ee02";
> + reg = <0x00c000 0 0 0 0>;

Best regards,
Krzysztof