xref: /freebsd/sys/contrib/device-tree/Bindings/clock/silabs,si570.txt (revision 5def4c47d4bd90b209b9b4a4ba9faec15846d8fd)
1c66ec88fSEmmanuel VadotBinding for Silicon Labs 570, 571, 598 and 599 programmable
2c66ec88fSEmmanuel VadotI2C clock generators.
3c66ec88fSEmmanuel Vadot
4c66ec88fSEmmanuel VadotReference
5c66ec88fSEmmanuel VadotThis binding uses the common clock binding[1]. Details about the devices can be
6c66ec88fSEmmanuel Vadotfound in the data sheets[2][3].
7c66ec88fSEmmanuel Vadot
8c66ec88fSEmmanuel Vadot[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
9c66ec88fSEmmanuel Vadot[2] Si570/571 Data Sheet
10c66ec88fSEmmanuel Vadot    https://www.silabs.com/Support%20Documents/TechnicalDocs/si570.pdf
11c66ec88fSEmmanuel Vadot[3] Si598/599 Data Sheet
12c66ec88fSEmmanuel Vadot    https://www.silabs.com/Support%20Documents/TechnicalDocs/si598-99.pdf
13c66ec88fSEmmanuel Vadot
14c66ec88fSEmmanuel VadotRequired properties:
15c66ec88fSEmmanuel Vadot - compatible: Shall be one of "silabs,si570", "silabs,si571",
16c66ec88fSEmmanuel Vadot			       "silabs,si598", "silabs,si599"
17c66ec88fSEmmanuel Vadot - reg: I2C device address.
18c66ec88fSEmmanuel Vadot - #clock-cells: From common clock bindings: Shall be 0.
19c66ec88fSEmmanuel Vadot - factory-fout: Factory set default frequency. This frequency is part specific.
20c66ec88fSEmmanuel Vadot		 The correct frequency for the part used has to be provided in
21c66ec88fSEmmanuel Vadot		 order to generate the correct output frequencies. For more
22c66ec88fSEmmanuel Vadot		 details, please refer to the data sheet.
23c66ec88fSEmmanuel Vadot - temperature-stability: Temperature stability of the device in PPM. Should be
24c66ec88fSEmmanuel Vadot			  one of: 7, 20, 50 or 100.
25c66ec88fSEmmanuel Vadot
26c66ec88fSEmmanuel VadotOptional properties:
27c66ec88fSEmmanuel Vadot - clock-output-names: From common clock bindings. Recommended to be "si570".
28c66ec88fSEmmanuel Vadot - clock-frequency: Output frequency to generate. This defines the output
29c66ec88fSEmmanuel Vadot		    frequency set during boot. It can be reprogrammed during
30c66ec88fSEmmanuel Vadot		    runtime through the common clock framework.
31*5def4c47SEmmanuel Vadot - silabs,skip-recall: Do not perform NVM->RAM recall operation. It will rely
32*5def4c47SEmmanuel Vadot		       on hardware loading of RAM from NVM at power on.
33c66ec88fSEmmanuel Vadot
34c66ec88fSEmmanuel VadotExample:
35c66ec88fSEmmanuel Vadot	si570: clock-generator@5d {
36c66ec88fSEmmanuel Vadot		#clock-cells = <0>;
37c66ec88fSEmmanuel Vadot		compatible = "silabs,si570";
38c66ec88fSEmmanuel Vadot		temperature-stability = <50>;
39c66ec88fSEmmanuel Vadot		reg = <0x5d>;
40c66ec88fSEmmanuel Vadot		factory-fout = <156250000>;
41c66ec88fSEmmanuel Vadot	};
42