Documentation/devicetree/bindings/ptp/fsl,ptp.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/ptp/fsl,ptp.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/ptp/fsl,ptp.yaml
Extension
.yaml
Size
4790 bytes
Lines
157
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/ptp/fsl,ptp.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Freescale QorIQ 1588 timer based PTP clock

maintainers:
  - Frank Li <Frank.Li@nxp.com>

properties:
  compatible:
    oneOf:
      - enum:
          - fsl,etsec-ptp
          - fsl,fman-ptp-timer
          - fsl,dpaa2-ptp
      - items:
          - const: pci1957,ee02
          - const: fsl,enetc-ptp

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 1

  fsl,cksel:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |
      Timer reference clock source.

      Reference clock source is determined by the value, which is holded
      in CKSEL bits in TMR_CTRL register. "fsl,cksel" property keeps the
      value, which will be directly written in those bits, that is why,
      according to reference manual, the next clock sources can be used:

      For eTSEC,
      <0> - external high precision timer reference clock (TSEC_TMR_CLK
            input is used for this purpose);
      <1> - eTSEC system clock;
      <2> - eTSEC1 transmit clock;
      <3> - RTC clock input.

      For DPAA FMan,
      <0> - external high precision timer reference clock (TMR_1588_CLK)
      <1> - MAC system clock (1/2 FMan clock)
      <2> - reserved
      <3> - RTC clock oscillator

  fsl,tclk-period:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Timer reference clock period in nanoseconds.

  fsl,tmr-prsc:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Prescaler, divides the output clock.

  fsl,tmr-add:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Frequency compensation value.

  fsl,tmr-fiper1:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Fixed interval period pulse generator.

Annotation

Implementation Notes