GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / clock / microchip,pic32.txt
1 Microchip PIC32 Clock Controller Binding
2 ----------------------------------------
3 Microchip clock controller is consists of few oscillators, PLL, multiplexer
4 and few divider modules.
5
6 This binding uses common clock bindings.
7 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
8
9 Required properties:
10 - compatible: shall be "microchip,pic32mzda-clk".
11 - reg: shall contain base address and length of clock registers.
12 - #clock-cells: shall be 1.
13
14 Optional properties:
15 - microchip,pic32mzda-sosc: shall be added only if platform has
16   secondary oscillator connected.
17
18 Example:
19         rootclk: clock-controller@1f801200 {
20                 compatible = "microchip,pic32mzda-clk";
21                 reg = <0x1f801200 0x200>;
22                 #clock-cells = <1>;
23                 /* optional */
24                 microchip,pic32mzda-sosc;
25         };
26
27
28 The clock consumer shall specify the desired clock-output of the clock
29 controller (as defined in [2]) by specifying output-id in its "clock"
30 phandle cell.
31 [2] include/dt-bindings/clock/microchip,pic32-clock.h
32
33 For example for UART2:
34 uart2: serial@2 {
35         compatible = "microchip,pic32mzda-uart";
36         reg = <>;
37         interrupts = <>;
38         clocks = <&rootclk PB2CLK>;
39 };