dt-bindings: clk: Extend binding doc for Stingray SOC
authorSandeep Tripathy <sandeep.tripathy@broadcom.com>
Fri, 2 Jun 2017 06:34:26 +0000 (12:04 +0530)
committerStephen Boyd <sboyd@codeaurora.org>
Tue, 20 Jun 2017 02:02:45 +0000 (19:02 -0700)
Update iproc clock dt-binding documentation with
Stingray pll and clock details.

Signed-off-by: Sandeep Tripathy <sandeep.tripathy@broadcom.com>
Reviewed-by: Ray Jui <ray.jui@broadcom.com>
Reviewed-by: Scott Branden <scott.branden@broadcom.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Documentation/devicetree/bindings/clock/brcm,iproc-clocks.txt
include/dt-bindings/clock/bcm-sr.h [new file with mode: 0644]

index 6f66e9aa354c1996beb76e3e9c830dc25b288159..f2c5f0e4a363a5f247ccda48cc45d7a96f74362a 100644 (file)
@@ -219,3 +219,79 @@ BCM63138
 --------
 PLL and leaf clock compatible strings for BCM63138 are:
     "brcm,bcm63138-armpll"
+
+Stingray
+-----------
+PLL and leaf clock compatible strings for Stingray are:
+    "brcm,sr-genpll0"
+    "brcm,sr-genpll1"
+    "brcm,sr-genpll2"
+    "brcm,sr-genpll3"
+    "brcm,sr-genpll4"
+    "brcm,sr-genpll5"
+    "brcm,sr-genpll6"
+
+    "brcm,sr-lcpll0"
+    "brcm,sr-lcpll1"
+    "brcm,sr-lcpll-pcie"
+
+
+The following table defines the set of PLL/clock index and ID for Stingray.
+These clock IDs are defined in:
+    "include/dt-bindings/clock/bcm-sr.h"
+
+    Clock              Source          Index   ID
+    ---                        -----           -----   ---------
+    crystal            N/A             N/A     N/A
+    crmu_ref25m                crystal         N/A     N/A
+
+    genpll0            crystal         0       BCM_SR_GENPLL0
+    clk_125m           genpll0         1       BCM_SR_GENPLL0_125M_CLK
+    clk_scr            genpll0         2       BCM_SR_GENPLL0_SCR_CLK
+    clk_250            genpll0         3       BCM_SR_GENPLL0_250M_CLK
+    clk_pcie_axi       genpll0         4       BCM_SR_GENPLL0_PCIE_AXI_CLK
+    clk_paxc_axi_x2    genpll0         5       BCM_SR_GENPLL0_PAXC_AXI_X2_CLK
+    clk_paxc_axi       genpll0         6       BCM_SR_GENPLL0_PAXC_AXI_CLK
+
+    genpll1            crystal         0       BCM_SR_GENPLL1
+    clk_pcie_tl                genpll1         1       BCM_SR_GENPLL1_PCIE_TL_CLK
+    clk_mhb_apb                genpll1         2       BCM_SR_GENPLL1_MHB_APB_CLK
+
+    genpll2            crystal         0       BCM_SR_GENPLL2
+    clk_nic            genpll2         1       BCM_SR_GENPLL2_NIC_CLK
+    clk_ts_500_ref     genpll2         2       BCM_SR_GENPLL2_TS_500_REF_CLK
+    clk_125_nitro      genpll2         3       BCM_SR_GENPLL2_125_NITRO_CLK
+    clk_chimp          genpll2         4       BCM_SR_GENPLL2_CHIMP_CLK
+    clk_nic_flash      genpll2         5       BCM_SR_GENPLL2_NIC_FLASH
+
+    genpll3            crystal         0       BCM_SR_GENPLL3
+    clk_hsls           genpll3         1       BCM_SR_GENPLL3_HSLS_CLK
+    clk_sdio           genpll3         2       BCM_SR_GENPLL3_SDIO_CLK
+
+    genpll4            crystal         0       BCM_SR_GENPLL4
+    ccn                        genpll4         1       BCM_SR_GENPLL4_CCN_CLK
+    clk_tpiu_pll       genpll4         2       BCM_SR_GENPLL4_TPIU_PLL_CLK
+    noc_clk            genpll4         3       BCM_SR_GENPLL4_NOC_CLK
+    clk_chclk_fs4      genpll4         4       BCM_SR_GENPLL4_CHCLK_FS4_CLK
+    clk_bridge_fscpu   genpll4         5       BCM_SR_GENPLL4_BRIDGE_FSCPU_CLK
+
+
+    genpll5            crystal         0       BCM_SR_GENPLL5
+    fs4_hf_clk         genpll5         1       BCM_SR_GENPLL5_FS4_HF_CLK
+    crypto_ae_clk      genpll5         2       BCM_SR_GENPLL5_CRYPTO_AE_CLK
+    raid_ae_clk                genpll5         3       BCM_SR_GENPLL5_RAID_AE_CLK
+
+    genpll6            crystal         0       BCM_SR_GENPLL6
+    48_usb             genpll6         1       BCM_SR_GENPLL6_48_USB_CLK
+
+    lcpll0             crystal         0       BCM_SR_LCPLL0
+    clk_sata_refp      lcpll0          1       BCM_SR_LCPLL0_SATA_REFP_CLK
+    clk_sata_refn      lcpll0          2       BCM_SR_LCPLL0_SATA_REFN_CLK
+    clk_usb_ref                lcpll0          3       BCM_SR_LCPLL0_USB_REF_CLK
+    sata_refpn         lcpll0          3       BCM_SR_LCPLL0_SATA_REFPN_CLK
+
+    lcpll1             crystal         0       BCM_SR_LCPLL1
+    wan                lcpll1          1       BCM_SR_LCPLL0_WAN_CLK
+
+    lcpll_pcie         crystal         0       BCM_SR_LCPLL_PCIE
+    pcie_phy_ref       lcpll1          1       BCM_SR_LCPLL_PCIE_PHY_REF_CLK
diff --git a/include/dt-bindings/clock/bcm-sr.h b/include/dt-bindings/clock/bcm-sr.h
new file mode 100644 (file)
index 0000000..cff6c6f
--- /dev/null
@@ -0,0 +1,101 @@
+/*
+ *  BSD LICENSE
+ *
+ *  Copyright(c) 2017 Broadcom. All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *    * Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *    * Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in
+ *      the documentation and/or other materials provided with the
+ *      distribution.
+ *    * Neither the name of Broadcom Corporation nor the names of its
+ *      contributors may be used to endorse or promote products derived
+ *      from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _CLOCK_BCM_SR_H
+#define _CLOCK_BCM_SR_H
+
+/* GENPLL 0 clock channel ID SCR HSLS FS PCIE */
+#define BCM_SR_GENPLL0                 0
+#define BCM_SR_GENPLL0_SATA_CLK                1
+#define BCM_SR_GENPLL0_SCR_CLK         2
+#define BCM_SR_GENPLL0_250M_CLK                3
+#define BCM_SR_GENPLL0_PCIE_AXI_CLK    4
+#define BCM_SR_GENPLL0_PAXC_AXI_X2_CLK 5
+#define BCM_SR_GENPLL0_PAXC_AXI_CLK    6
+
+/* GENPLL 1 clock channel ID MHB PCIE NITRO */
+#define BCM_SR_GENPLL1                 0
+#define BCM_SR_GENPLL1_PCIE_TL_CLK     1
+#define BCM_SR_GENPLL1_MHB_APB_CLK     2
+
+/* GENPLL 2 clock channel ID NITRO MHB*/
+#define BCM_SR_GENPLL2                 0
+#define BCM_SR_GENPLL2_NIC_CLK         1
+#define BCM_SR_GENPLL2_250_NITRO_CLK   2
+#define BCM_SR_GENPLL2_125_NITRO_CLK   3
+#define BCM_SR_GENPLL2_CHIMP_CLK       4
+
+/* GENPLL 3 HSLS clock channel ID */
+#define BCM_SR_GENPLL3                 0
+#define BCM_SR_GENPLL3_HSLS_CLK                1
+#define BCM_SR_GENPLL3_SDIO_CLK                2
+
+/* GENPLL 4 SCR clock channel ID */
+#define BCM_SR_GENPLL4                 0
+#define BCM_SR_GENPLL4_CCN_CLK         1
+
+/* GENPLL 5 FS4 clock channel ID */
+#define BCM_SR_GENPLL5                 0
+#define BCM_SR_GENPLL5_FS_CLK          1
+#define BCM_SR_GENPLL5_SPU_CLK         2
+
+/* GENPLL 6 NITRO clock channel ID */
+#define BCM_SR_GENPLL6                 0
+#define BCM_SR_GENPLL6_48_USB_CLK      1
+
+/* LCPLL0  clock channel ID */
+#define BCM_SR_LCPLL0                  0
+#define BCM_SR_LCPLL0_SATA_REF_CLK     1
+#define BCM_SR_LCPLL0_USB_REF_CLK      2
+#define BCM_SR_LCPLL0_SATA_REFPN_CLK   3
+
+/* LCPLL1  clock channel ID */
+#define BCM_SR_LCPLL1                  0
+#define BCM_SR_LCPLL1_WAN_CLK          1
+
+/* LCPLL PCIE  clock channel ID */
+#define BCM_SR_LCPLL_PCIE              0
+#define BCM_SR_LCPLL_PCIE_PHY_REF_CLK  1
+
+/* GENPLL EMEM0 clock channel ID */
+#define BCM_SR_EMEMPLL0                        0
+#define BCM_SR_EMEMPLL0_EMEM_CLK       1
+
+/* GENPLL EMEM0 clock channel ID */
+#define BCM_SR_EMEMPLL1                        0
+#define BCM_SR_EMEMPLL1_EMEM_CLK       1
+
+/* GENPLL EMEM0 clock channel ID */
+#define BCM_SR_EMEMPLL2                        0
+#define BCM_SR_EMEMPLL2_EMEM_CLK       1
+
+#endif /* _CLOCK_BCM_SR_H */