tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1Broadcom iProc Family Clocks
2
3This binding uses the common clock binding:
4 Documentation/devicetree/bindings/clock/clock-bindings.txt
5
6The iProc clock controller manages clocks that are common to the iProc family.
7An SoC from the iProc family may have several PPLs, e.g., ARMPLL, GENPLL,
8LCPLL0, MIPIPLL, and etc., all derived from an onboard crystal. Each PLL
9comprises of several leaf clocks
10
11Required properties for a PLL and its leaf clocks:
12
13- compatible:
14 Should have a value of the form "brcm,<soc>-<pll>". For example, GENPLL on
15Cygnus has a compatible string of "brcm,cygnus-genpll"
16
17- #clock-cells:
18 Have a value of <1> since there are more than 1 leaf clock of a given PLL
19
20- reg:
21 Define the base and range of the I/O address space that contain the iProc
22clock control registers required for the PLL
23
24- clocks:
25 The input parent clock phandle for the PLL. For most iProc PLLs, this is an
26onboard crystal with a fixed rate
27
28- clock-output-names:
29 An ordered list of strings defining the names of the clocks
30
31Example:
32
33 osc: oscillator {
34 #clock-cells = <0>;
35 compatible = "fixed-clock";
36 clock-frequency = <25000000>;
37 };
38
39 genpll: genpll {
40 #clock-cells = <1>;
41 compatible = "brcm,cygnus-genpll";
42 reg = <0x0301d000 0x2c>, <0x0301c020 0x4>;
43 clocks = <&osc>;
44 clock-output-names = "genpll", "axi21", "250mhz", "ihost_sys",
45 "enet_sw", "audio_125", "can";
46 };
47
48Required properties for ASIU clocks:
49
50ASIU clocks are a special case. These clocks are derived directly from the
51reference clock of the onboard crystal
52
53- compatible:
54 Should have a value of the form "brcm,<soc>-asiu-clk". For example, ASIU
55clocks for Cygnus have a compatible string of "brcm,cygnus-asiu-clk"
56
57- #clock-cells:
58 Have a value of <1> since there are more than 1 ASIU clocks
59
60- reg:
61 Define the base and range of the I/O address space that contain the iProc
62clock control registers required for ASIU clocks
63
64- clocks:
65 The input parent clock phandle for the ASIU clock, i.e., the onboard
66crystal
67
68- clock-output-names:
69 An ordered list of strings defining the names of the ASIU clocks
70
71Example:
72
73 osc: oscillator {
74 #clock-cells = <0>;
75 compatible = "fixed-clock";
76 clock-frequency = <25000000>;
77 };
78
79 asiu_clks: asiu_clks {
80 #clock-cells = <1>;
81 compatible = "brcm,cygnus-asiu-clk";
82 reg = <0x0301d048 0xc>, <0x180aa024 0x4>;
83 clocks = <&osc>;
84 clock-output-names = "keypad", "adc/touch", "pwm";
85 };
86
87Cygnus
88------
89PLL and leaf clock compatible strings for Cygnus are:
90 "brcm,cygnus-armpll"
91 "brcm,cygnus-genpll"
92 "brcm,cygnus-lcpll0"
93 "brcm,cygnus-mipipll"
94 "brcm,cygnus-asiu-clk"
95 "brcm,cygnus-audiopll"
96
97The following table defines the set of PLL/clock index and ID for Cygnus.
98These clock IDs are defined in:
99 "include/dt-bindings/clock/bcm-cygnus.h"
100
101 Clock Source (Parent) Index ID
102 --- ----- ----- ---------
103 crystal N/A N/A N/A
104
105 armpll crystal N/A N/A
106
107 keypad crystal (ASIU) 0 BCM_CYGNUS_ASIU_KEYPAD_CLK
108 adc/tsc crystal (ASIU) 1 BCM_CYGNUS_ASIU_ADC_CLK
109 pwm crystal (ASIU) 2 BCM_CYGNUS_ASIU_PWM_CLK
110
111 genpll crystal 0 BCM_CYGNUS_GENPLL
112 axi21 genpll 1 BCM_CYGNUS_GENPLL_AXI21_CLK
113 250mhz genpll 2 BCM_CYGNUS_GENPLL_250MHZ_CLK
114 ihost_sys genpll 3 BCM_CYGNUS_GENPLL_IHOST_SYS_CLK
115 enet_sw genpll 4 BCM_CYGNUS_GENPLL_ENET_SW_CLK
116 audio_125 genpll 5 BCM_CYGNUS_GENPLL_AUDIO_125_CLK
117 can genpll 6 BCM_CYGNUS_GENPLL_CAN_CLK
118
119 lcpll0 crystal 0 BCM_CYGNUS_LCPLL0
120 pcie_phy lcpll0 1 BCM_CYGNUS_LCPLL0_PCIE_PHY_REF_CLK
121 ddr_phy lcpll0 2 BCM_CYGNUS_LCPLL0_DDR_PHY_CLK
122 sdio lcpll0 3 BCM_CYGNUS_LCPLL0_SDIO_CLK
123 usb_phy lcpll0 4 BCM_CYGNUS_LCPLL0_USB_PHY_REF_CLK
124 smart_card lcpll0 5 BCM_CYGNUS_LCPLL0_SMART_CARD_CLK
125 ch5_unused lcpll0 6 BCM_CYGNUS_LCPLL0_CH5_UNUSED
126
127 mipipll crystal 0 BCM_CYGNUS_MIPIPLL
128 ch0_unused mipipll 1 BCM_CYGNUS_MIPIPLL_CH0_UNUSED
129 ch1_lcd mipipll 2 BCM_CYGNUS_MIPIPLL_CH1_LCD
130 ch2_v3d mipipll 3 BCM_CYGNUS_MIPIPLL_CH2_V3D
131 ch3_unused mipipll 4 BCM_CYGNUS_MIPIPLL_CH3_UNUSED
132 ch4_unused mipipll 5 BCM_CYGNUS_MIPIPLL_CH4_UNUSED
133 ch5_unused mipipll 6 BCM_CYGNUS_MIPIPLL_CH5_UNUSED
134
135 audiopll crystal 0 BCM_CYGNUS_AUDIOPLL
136 ch0_audio audiopll 1 BCM_CYGNUS_AUDIOPLL_CH0
137 ch1_audio audiopll 2 BCM_CYGNUS_AUDIOPLL_CH1
138 ch2_audio audiopll 3 BCM_CYGNUS_AUDIOPLL_CH2
139
140Northstar and Northstar Plus
141------
142PLL and leaf clock compatible strings for Northstar and Northstar Plus are:
143 "brcm,nsp-armpll"
144 "brcm,nsp-genpll"
145 "brcm,nsp-lcpll0"
146
147The following table defines the set of PLL/clock index and ID for Northstar and
148Northstar Plus. These clock IDs are defined in:
149 "include/dt-bindings/clock/bcm-nsp.h"
150
151 Clock Source Index ID
152 --- ----- ----- ---------
153 crystal N/A N/A N/A
154
155 armpll crystal N/A N/A
156
157 genpll crystal 0 BCM_NSP_GENPLL
158 phy genpll 1 BCM_NSP_GENPLL_PHY_CLK
159 ethernetclk genpll 2 BCM_NSP_GENPLL_ENET_SW_CLK
160 usbclk genpll 3 BCM_NSP_GENPLL_USB_PHY_REF_CLK
161 iprocfast genpll 4 BCM_NSP_GENPLL_IPROCFAST_CLK
162 sata1 genpll 5 BCM_NSP_GENPLL_SATA1_CLK
163 sata2 genpll 6 BCM_NSP_GENPLL_SATA2_CLK
164
165 lcpll0 crystal 0 BCM_NSP_LCPLL0
166 pcie_phy lcpll0 1 BCM_NSP_LCPLL0_PCIE_PHY_REF_CLK
167 sdio lcpll0 2 BCM_NSP_LCPLL0_SDIO_CLK
168 ddr_phy lcpll0 3 BCM_NSP_LCPLL0_DDR_PHY_CLK
169
170Northstar 2
171-----------
172PLL and leaf clock compatible strings for Northstar 2 are:
173 "brcm,ns2-genpll-scr"
174 "brcm,ns2-genpll-sw"
175 "brcm,ns2-lcpll-ddr"
176 "brcm,ns2-lcpll-ports"
177
178The following table defines the set of PLL/clock index and ID for Northstar 2.
179These clock IDs are defined in:
180 "include/dt-bindings/clock/bcm-ns2.h"
181
182 Clock Source Index ID
183 --- ----- ----- ---------
184 crystal N/A N/A N/A
185
186 genpll_scr crystal 0 BCM_NS2_GENPLL_SCR
187 scr genpll_scr 1 BCM_NS2_GENPLL_SCR_SCR_CLK
188 fs genpll_scr 2 BCM_NS2_GENPLL_SCR_FS_CLK
189 audio_ref genpll_scr 3 BCM_NS2_GENPLL_SCR_AUDIO_CLK
190 ch3_unused genpll_scr 4 BCM_NS2_GENPLL_SCR_CH3_UNUSED
191 ch4_unused genpll_scr 5 BCM_NS2_GENPLL_SCR_CH4_UNUSED
192 ch5_unused genpll_scr 6 BCM_NS2_GENPLL_SCR_CH5_UNUSED
193
194 genpll_sw crystal 0 BCM_NS2_GENPLL_SW
195 rpe genpll_sw 1 BCM_NS2_GENPLL_SW_RPE_CLK
196 250 genpll_sw 2 BCM_NS2_GENPLL_SW_250_CLK
197 nic genpll_sw 3 BCM_NS2_GENPLL_SW_NIC_CLK
198 chimp genpll_sw 4 BCM_NS2_GENPLL_SW_CHIMP_CLK
199 port genpll_sw 5 BCM_NS2_GENPLL_SW_PORT_CLK
200 sdio genpll_sw 6 BCM_NS2_GENPLL_SW_SDIO_CLK
201
202 lcpll_ddr crystal 0 BCM_NS2_LCPLL_DDR
203 pcie_sata_usb lcpll_ddr 1 BCM_NS2_LCPLL_DDR_PCIE_SATA_USB_CLK
204 ddr lcpll_ddr 2 BCM_NS2_LCPLL_DDR_DDR_CLK
205 ch2_unused lcpll_ddr 3 BCM_NS2_LCPLL_DDR_CH2_UNUSED
206 ch3_unused lcpll_ddr 4 BCM_NS2_LCPLL_DDR_CH3_UNUSED
207 ch4_unused lcpll_ddr 5 BCM_NS2_LCPLL_DDR_CH4_UNUSED
208 ch5_unused lcpll_ddr 6 BCM_NS2_LCPLL_DDR_CH5_UNUSED
209
210 lcpll_ports crystal 0 BCM_NS2_LCPLL_PORTS
211 wan lcpll_ports 1 BCM_NS2_LCPLL_PORTS_WAN_CLK
212 rgmii lcpll_ports 2 BCM_NS2_LCPLL_PORTS_RGMII_CLK
213 ch2_unused lcpll_ports 3 BCM_NS2_LCPLL_PORTS_CH2_UNUSED
214 ch3_unused lcpll_ports 4 BCM_NS2_LCPLL_PORTS_CH3_UNUSED
215 ch4_unused lcpll_ports 5 BCM_NS2_LCPLL_PORTS_CH4_UNUSED
216 ch5_unused lcpll_ports 6 BCM_NS2_LCPLL_PORTS_CH5_UNUSED
217
218BCM63138
219--------
220PLL and leaf clock compatible strings for BCM63138 are:
221 "brcm,bcm63138-armpll"