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

   1 Binding for IDT VersaClock5 programmable i2c clock generator.
   2
   3 The IDT VersaClock5 are programmable i2c clock generators providing
   4 from 3 to 12 output clocks.
   5
   6 ==I2C device node==
   7
   8 Required properties:
   9 - compatible:   shall be one of "idt,5p49v5923" , "idt,5p49v5933".
  10 - reg:          i2c device address, shall be 0x68 or 0x6a.
  11 - #clock-cells: from common clock binding; shall be set to 1.
  12 - clocks:       from common clock binding; list of parent clock handles,
  13                 - 5p49v5923: (required) either or both of XTAL or CLKIN
  14                                         reference clock.
  15                 - 5p49v5933: (optional) property not present (internal
  16                                         Xtal used) or CLKIN reference
  17                                         clock.
  18 - clock-names:  from common clock binding; clock input names, can be
  19                 - 5p49v5923: (required) either or both of "xin", "clkin".
  20                 - 5p49v5933: (optional) property not present or "clkin".
  21
  22 ==Mapping between clock specifier and physical pins==
  23
  24 When referencing the provided clock in the DT using phandle and
  25 clock specifier, the following mapping applies:
  26
  27 5P49V5923:
  28         0 -- OUT0_SEL_I2CB
  29         1 -- OUT1
  30         2 -- OUT2
  31
  32 5P49V5933:
  33         0 -- OUT0_SEL_I2CB
  34         1 -- OUT1
  35         2 -- OUT4
  36
  37 ==Example==
  38
  39 /* 25MHz reference crystal */
  40 ref25: ref25m {
  41         compatible = "fixed-clock";
  42         #clock-cells = <0>;
  43         clock-frequency = <25000000>;
  44 };
  45
  46 i2c-master-node {
  47
  48         /* IDT 5P49V5923 i2c clock generator */
  49         vc5: clock-generator@6a {
  50                 compatible = "idt,5p49v5923";
  51                 reg = <0x6a>;
  52                 #clock-cells = <1>;
  53
  54                 /* Connect XIN input to 25MHz reference */
  55                 clocks = <&ref25m>;
  56                 clock-names = "xin";
  57         };
  58 };
  59
  60 /* Consumer referencing the 5P49V5923 pin OUT1 */
  61 consumer {
  62         ...
  63         clocks = <&vc5 1>;
  64         ...
  65 }