Documentation/devicetree/bindings/clock/idt,versaclock5.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/clock/idt,versaclock5.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Binding for IDT VersaClock 5 and 6 programmable I2C clock generators
   8
   9 description: |
  10   The IDT VersaClock 5 and VersaClock 6 are programmable I2C
  11   clock generators providing from 3 to 12 output clocks.
  12
  13   When referencing the provided clock in the DT using phandle and clock
  14   specifier, the following mapping applies:
  15
  16   - 5P49V5923:
  17     0 -- OUT0_SEL_I2CB
  18     1 -- OUT1
  19     2 -- OUT2
  20
  21   - 5P49V5933:
  22     0 -- OUT0_SEL_I2CB
  23     1 -- OUT1
  24     2 -- OUT4
  25
  26   - other parts:
  27     0 -- OUT0_SEL_I2CB
  28     1 -- OUT1
  29     2 -- OUT2
  30     3 -- OUT3
  31     4 -- OUT4
  32
  33 maintainers:
  34   - Luca Ceresoli <luca@lucaceresoli.net>
  35
  36 properties:
  37   compatible:
  38     enum:
  39       - idt,5p49v5923
  40       - idt,5p49v5925
  41       - idt,5p49v5933
  42       - idt,5p49v5935
  43       - idt,5p49v6901
  44       - idt,5p49v6965
  45
  46   reg:
  47     description: I2C device address
  48     enum: [ 0x68, 0x6a ]
  49
  50   '#clock-cells':
  51     const: 1
  52
  53   clock-names:
  54     minItems: 1
  55     maxItems: 2
  56     items:
  57       enum: [ xin, clkin ]
  58   clocks:
  59     minItems: 1
  60     maxItems: 2
  61
  62   idt,xtal-load-femtofarads:
  63     minimum: 9000
  64     maximum: 22760
  65     description: Optional load capacitor for XTAL1 and XTAL2
  66
  67 patternProperties:
  68   "^OUT[1-4]$":
  69     type: object
  70     description:
  71       Description of one of the outputs (OUT1..OUT4). See "Clock1 Output
  72       Configuration" in the Versaclock 5/6/6E Family Register Description
  73       and Programming Guide.
  74     properties:
  75       idt,mode:
  76         description:
  77           The output drive mode. Values defined in dt-bindings/clk/versaclock.h
  78         $ref: /schemas/types.yaml#/definitions/uint32
  79         minimum: 0
  80         maximum: 6
  81       idt,voltage-microvolt:
  82         description: The output drive voltage.
  83         enum: [ 1800000, 2500000, 3300000 ]
  84       idt,slew-percent:
  85         description: The Slew rate control for CMOS single-ended.
  86         enum: [ 80, 85, 90, 100 ]
  87     additionalProperties: false
  88
  89 required:
  90   - compatible
  91   - reg
  92   - '#clock-cells'
  93
  94 allOf:
  95   - if:
  96       properties:
  97         compatible:
  98           enum:
  99             - idt,5p49v5933
 100             - idt,5p49v5935
 101     then:
 102       # Devices with builtin crystal + optional external input
 103       properties:
 104         clock-names:
 105           const: clkin
 106         clocks:
 107           maxItems: 1
 108     else:
 109       # Devices without builtin crystal
 110       required:
 111         - clock-names
 112         - clocks
 113
 114 additionalProperties: false
 115
 116 examples:
 117   - |
 118     #include <dt-bindings/clk/versaclock.h>
 119
 120     /* 25MHz reference crystal */
 121     ref25: ref25m {
 122         compatible = "fixed-clock";
 123         #clock-cells = <0>;
 124         clock-frequency = <25000000>;
 125     };
 126
 127     i2c@0 {
 128         reg = <0x0 0x100>;
 129         #address-cells = <1>;
 130         #size-cells = <0>;
 131
 132         /* IDT 5P49V5923 I2C clock generator */
 133         vc5: clock-generator@6a {
 134             compatible = "idt,5p49v5923";
 135             reg = <0x6a>;
 136             #clock-cells = <1>;
 137
 138             /* Connect XIN input to 25MHz reference */
 139             clocks = <&ref25m>;
 140             clock-names = "xin";
 141
 142             OUT1 {
 143                 idt,mode = <VC5_CMOSD>;
 144                 idt,voltage-microvolt = <1800000>;
 145                 idt,slew-percent = <80>;
 146             };
 147
 148             OUT4 {
 149                 idt,mode = <VC5_LVDS>;
 150             };
 151         };
 152     };
 153
 154     /* Consumer referencing the 5P49V5923 pin OUT1 */
 155     consumer {
 156         /* ... */
 157         clocks = <&vc5 1>;
 158         /* ... */
 159     };
 160
 161 ...