Add rktcphy(4), a driver for the Type-C PHY controller found on the
authorpatrick <patrick@openbsd.org>
Tue, 29 Jun 2021 12:43:09 +0000 (12:43 +0000)
committerpatrick <patrick@openbsd.org>
Tue, 29 Jun 2021 12:43:09 +0000 (12:43 +0000)
Rockchip RK3399.  While the PHY allows switching between combinations
of USB3 and DisplayPort, this driver enables only USB3 functionality.
This allows USB3 devices to show up on machines where previously only
USB2 devices showed up.  Driver was taken from FreeBSD and adjusted to
fit into our code base.

ok kettenis@

sys/dev/fdt/files.fdt
sys/dev/fdt/rktcphy.c [new file with mode: 0644]

index 3b2b833..3b23523 100644 (file)
@@ -1,4 +1,4 @@
-#      $OpenBSD: files.fdt,v 1.154 2021/06/16 12:37:24 kettenis Exp $
+#      $OpenBSD: files.fdt,v 1.155 2021/06/29 12:43:09 patrick Exp $
 #
 # Config file and device description for machine-independent FDT code.
 # Included by ports that need it.
@@ -367,6 +367,10 @@ device     rkrng
 attach rkrng at fdt
 file   dev/fdt/rkrng.c                 rkrng
 
+device rktcphy: fdt
+attach rktcphy at fdt
+file   dev/fdt/rktcphy.c               rktcphy
+
 device rktemp
 attach rktemp at fdt
 file   dev/fdt/rktemp.c                rktemp
diff --git a/sys/dev/fdt/rktcphy.c b/sys/dev/fdt/rktcphy.c
new file mode 100644 (file)
index 0000000..cd68538
--- /dev/null
@@ -0,0 +1,315 @@
+/* $OpenBSD: rktcphy.c,v 1.1 2021/06/29 12:43:09 patrick Exp $ */
+/*-
+ * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
+ *
+ * Copyright (c) 2019 Emmanuel Vadot <manu@FreeBSD.Org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+ */
+
+/*
+ * Rockchip PHY TYPEC
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/device.h>
+
+#include <machine/intr.h>
+#include <machine/bus.h>
+#include <machine/fdt.h>
+
+#include <dev/ofw/openfirm.h>
+#include <dev/ofw/ofw_clock.h>
+#include <dev/ofw/ofw_misc.h>
+#include <dev/ofw/fdt.h>
+
+#define        GRF_USB3OTG_BASE(x)     (0x2430 + (0x10 * x))
+#define        GRF_USB3OTG_CON0(x)     (GRF_USB3OTG_BASE(x) + 0x0)
+#define        GRF_USB3OTG_CON1(x)     (GRF_USB3OTG_BASE(x) + 0x4)
+#define         USB3OTG_CON1_U3_DIS    (1 << 0)
+
+#define        GRF_USB3PHY_BASE(x)     (0x0e580 + (0xc * (x)))
+#define        GRF_USB3PHY_CON0(x)     (GRF_USB3PHY_BASE(x) + 0x0)
+#define         USB3PHY_CON0_USB2_ONLY (1 << 3)
+#define        GRF_USB3PHY_CON1(x)     (GRF_USB3PHY_BASE(x) + 0x4)
+#define        GRF_USB3PHY_CON2(x)     (GRF_USB3PHY_BASE(x) + 0x8)
+#define        GRF_USB3PHY_STATUS0     0x0e5c0
+#define        GRF_USB3PHY_STATUS1     0x0e5c4
+
+#define        CMN_PLL0_VCOCAL_INIT            (0x84 << 2)
+#define        CMN_PLL0_VCOCAL_ITER            (0x85 << 2)
+#define        CMN_PLL0_INTDIV                 (0x94 << 2)
+#define        CMN_PLL0_FRACDIV                (0x95 << 2)
+#define        CMN_PLL0_HIGH_THR               (0x96 << 2)
+#define        CMN_PLL0_DSM_DIAG               (0x97 << 2)
+#define        CMN_PLL0_SS_CTRL1               (0x98 << 2)
+#define        CMN_PLL0_SS_CTRL2               (0x99 << 2)
+#define        CMN_DIAG_PLL0_FBH_OVRD          (0x1c0 << 2)
+#define        CMN_DIAG_PLL0_FBL_OVRD          (0x1c1 << 2)
+#define        CMN_DIAG_PLL0_OVRD              (0x1c2 << 2)
+#define        CMN_DIAG_PLL0_V2I_TUNE          (0x1c5 << 2)
+#define        CMN_DIAG_PLL0_CP_TUNE           (0x1c6 << 2)
+#define        CMN_DIAG_PLL0_LF_PROG           (0x1c7 << 2)
+#define        CMN_DIAG_HSCLK_SEL              (0x1e0 << 2)
+#define         CMN_DIAG_HSCLK_SEL_PLL_CONFIG  0x30
+#define         CMN_DIAG_HSCLK_SEL_PLL_MASK    0x33
+
+#define        TX_TXCC_MGNFS_MULT_000(lane)    ((0x4050 | ((lane) << 9)) << 2)
+#define        XCVR_DIAG_BIDI_CTRL(lane)       ((0x40e8 | ((lane) << 9)) << 2)
+#define        XCVR_DIAG_LANE_FCM_EN_MGN(lane) ((0x40f2 | ((lane) << 9)) << 2)
+#define        TX_PSC_A0(lane)                 ((0x4100 | ((lane) << 9)) << 2)
+#define        TX_PSC_A1(lane)                 ((0x4101 | ((lane) << 9)) << 2)
+#define        TX_PSC_A2(lane)                 ((0x4102 | ((lane) << 9)) << 2)
+#define        TX_PSC_A3(lane)                 ((0x4103 | ((lane) << 9)) << 2)
+#define        TX_RCVDET_EN_TMR(lane)          ((0x4122 | ((lane) << 9)) << 2)
+#define        TX_RCVDET_ST_TMR(lane)          ((0x4123 | ((lane) << 9)) << 2)
+
+#define        RX_PSC_A0(lane)                 ((0x8000 | ((lane) << 9)) << 2)
+#define        RX_PSC_A1(lane)                 ((0x8001 | ((lane) << 9)) << 2)
+#define        RX_PSC_A2(lane)                 ((0x8002 | ((lane) << 9)) << 2)
+#define        RX_PSC_A3(lane)                 ((0x8003 | ((lane) << 9)) << 2)
+#define        RX_PSC_CAL(lane)                ((0x8006 | ((lane) << 9)) << 2)
+#define        RX_PSC_RDY(lane)                ((0x8007 | ((lane) << 9)) << 2)
+#define        RX_SIGDET_HL_FILT_TMR(lane)     ((0x8090 | ((lane) << 9)) << 2)
+#define        RX_REE_CTRL_DATA_MASK(lane)     ((0x81bb | ((lane) << 9)) << 2)
+#define        RX_DIAG_SIGDET_TUNE(lane)       ((0x81dc | ((lane) << 9)) << 2)
+
+#define        PMA_LANE_CFG                    (0xc000 << 2)
+#define        PIN_ASSIGN_D_F                  0x5100
+#define        DP_MODE_CTL                     (0xc008 << 2)
+#define        DP_MODE_ENTER_A2                0xc104
+#define        PMA_CMN_CTRL1                   (0xc800 << 2)
+#define         PMA_CMN_CTRL1_READY            (1 << 0)
+
+#define HREAD4(sc, reg)                                                        \
+       (bus_space_read_4((sc)->sc_iot, (sc)->sc_ioh, (reg)))
+#define HWRITE4(sc, reg, val)                                          \
+       bus_space_write_4((sc)->sc_iot, (sc)->sc_ioh, (reg), (val))
+#define HSET4(sc, reg, bits)                                           \
+       HWRITE4((sc), (reg), HREAD4((sc), (reg)) | (bits))
+#define HCLR4(sc, reg, bits)                                           \
+       HWRITE4((sc), (reg), HREAD4((sc), (reg)) & ~(bits))
+
+struct rktcphy_softc {
+       struct device           sc_dev;
+       bus_space_tag_t         sc_iot;
+       bus_space_handle_t      sc_ioh;
+       int                     sc_node;
+       struct regmap           *sc_grf;
+
+       struct phy_device       sc_pd;
+       int                     sc_mode;
+       int                     sc_phy_ctrl_id;
+};
+
+int rktcphy_match(struct device *, void *, void *);
+void rktcphy_attach(struct device *, struct device *, void *);
+
+void rktcphy_set_usb2_only(struct rktcphy_softc *, int);
+int rktcphy_enable(void *, uint32_t *);
+
+struct cfattach        rktcphy_ca = {
+       sizeof (struct rktcphy_softc), rktcphy_match, rktcphy_attach
+};
+
+struct cfdriver rktcphy_cd = {
+       NULL, "rktcphy", DV_DULL
+};
+
+int
+rktcphy_match(struct device *parent, void *match, void *aux)
+{
+       struct fdt_attach_args *faa = aux;
+
+       return OF_is_compatible(faa->fa_node, "rockchip,rk3399-typec-phy");
+}
+
+void
+rktcphy_attach(struct device *parent, struct device *self, void *aux)
+{
+       struct rktcphy_softc *sc = (struct rktcphy_softc *)self;
+       struct fdt_attach_args *faa = aux;
+       uint32_t grf;
+       int usb3;
+
+       if (faa->fa_nreg < 1) {
+               printf(": no registers\n");
+               return;
+       }
+
+       sc->sc_node = faa->fa_node;
+       sc->sc_iot = faa->fa_iot;
+
+       if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr,
+           faa->fa_reg[0].size, 0, &sc->sc_ioh)) {
+               printf(": can't map registers\n");
+               return;
+       }
+
+       /*
+        * Find out which phy we are.  There is no property for this so we need
+        * to know the address to use the correct GRF registers.
+        */
+       switch (faa->fa_reg[0].addr) {
+       case 0xff7c0000:
+               sc->sc_phy_ctrl_id = 0;
+               break;
+       case 0xff800000:
+               sc->sc_phy_ctrl_id = 1;
+               break;
+       default:
+               printf(": unknown address 0x%llx\n", faa->fa_reg[0].addr);
+               return;
+       }
+
+       grf = OF_getpropint(sc->sc_node, "rockchip,grf", 0);
+       sc->sc_grf = regmap_byphandle(grf);
+
+       reset_assert(sc->sc_node, "uphy");
+       reset_assert(sc->sc_node, "uphy-pipe");
+       reset_assert(sc->sc_node, "uphy-tcphy");
+
+       clock_set_assigned(sc->sc_node);
+
+       /* Only usb3 port is supported right now */
+       usb3 = OF_getnodebyname(sc->sc_node, "usb3-port");
+       if (usb3 == 0) {
+               printf(": no usb3-port child node\n");
+               return;
+       }
+
+       printf("\n");
+
+       sc->sc_pd.pd_node = usb3;
+       sc->sc_pd.pd_cookie = sc;
+       sc->sc_pd.pd_enable = rktcphy_enable;
+       phy_register(&sc->sc_pd);
+}
+
+void
+rktcphy_set_usb2_only(struct rktcphy_softc *sc, int usb2only)
+{
+       uint32_t reg;
+
+       /* Disable usb3tousb2 only */
+       reg = regmap_read_4(sc->sc_grf, GRF_USB3PHY_CON0(sc->sc_phy_ctrl_id));
+       if (usb2only)
+               reg |= USB3PHY_CON0_USB2_ONLY;
+       else
+               reg &= ~USB3PHY_CON0_USB2_ONLY;
+       /* Write Mask */
+       reg |= (USB3PHY_CON0_USB2_ONLY) << 16;
+       regmap_write_4(sc->sc_grf, GRF_USB3PHY_CON0(sc->sc_phy_ctrl_id), reg);
+
+       /* Enable the USB3 Super Speed port */
+       reg = regmap_read_4(sc->sc_grf, GRF_USB3OTG_CON1(sc->sc_phy_ctrl_id));
+       if (usb2only)
+               reg |= USB3OTG_CON1_U3_DIS;
+       else
+               reg &= ~USB3OTG_CON1_U3_DIS;
+       /* Write Mask */
+       reg |= (USB3OTG_CON1_U3_DIS) << 16;
+       regmap_write_4(sc->sc_grf, GRF_USB3OTG_CON1(sc->sc_phy_ctrl_id), reg);
+}
+
+int
+rktcphy_enable(void *cookie, uint32_t *cells)
+{
+       struct rktcphy_softc *sc = cookie;
+       uint32_t reg;
+       int i;
+
+       rktcphy_set_usb2_only(sc, false);
+
+       clock_enable(sc->sc_node, "tcpdcore");
+       clock_enable(sc->sc_node, "tcpdphy-ref");
+
+       reset_deassert(sc->sc_node, "uphy-tcphy");
+
+       /* 24M configuration, magic values from rockchip */
+       HWRITE4(sc, PMA_CMN_CTRL1, 0x830);
+       for (i = 0; i < 4; i++) {
+               HWRITE4(sc, XCVR_DIAG_LANE_FCM_EN_MGN(i), 0x90);
+               HWRITE4(sc, TX_RCVDET_EN_TMR(i), 0x960);
+               HWRITE4(sc, TX_RCVDET_ST_TMR(i), 0x30);
+       }
+       reg = HREAD4(sc, CMN_DIAG_HSCLK_SEL);
+       reg &= ~CMN_DIAG_HSCLK_SEL_PLL_MASK;
+       reg |= CMN_DIAG_HSCLK_SEL_PLL_CONFIG;
+       HWRITE4(sc, CMN_DIAG_HSCLK_SEL, reg);
+
+       /* PLL configuration, magic values from rockchip */
+       HWRITE4(sc, CMN_PLL0_VCOCAL_INIT, 0xf0);
+       HWRITE4(sc, CMN_PLL0_VCOCAL_ITER, 0x18);
+       HWRITE4(sc, CMN_PLL0_INTDIV, 0xd0);
+       HWRITE4(sc, CMN_PLL0_FRACDIV, 0x4a4a);
+       HWRITE4(sc, CMN_PLL0_HIGH_THR, 0x34);
+       HWRITE4(sc, CMN_PLL0_SS_CTRL1, 0x1ee);
+       HWRITE4(sc, CMN_PLL0_SS_CTRL2, 0x7f03);
+       HWRITE4(sc, CMN_PLL0_DSM_DIAG, 0x20);
+       HWRITE4(sc, CMN_DIAG_PLL0_OVRD, 0);
+       HWRITE4(sc, CMN_DIAG_PLL0_FBH_OVRD, 0);
+       HWRITE4(sc, CMN_DIAG_PLL0_FBL_OVRD, 0);
+       HWRITE4(sc, CMN_DIAG_PLL0_V2I_TUNE, 0x7);
+       HWRITE4(sc, CMN_DIAG_PLL0_CP_TUNE, 0x45);
+       HWRITE4(sc, CMN_DIAG_PLL0_LF_PROG, 0x8);
+
+       /* Configure the TX and RX line, magic values from rockchip */
+       HWRITE4(sc, TX_PSC_A0(0), 0x7799);
+       HWRITE4(sc, TX_PSC_A1(0), 0x7798);
+       HWRITE4(sc, TX_PSC_A2(0), 0x5098);
+       HWRITE4(sc, TX_PSC_A3(0), 0x5098);
+       HWRITE4(sc, TX_TXCC_MGNFS_MULT_000(0), 0x0);
+       HWRITE4(sc, XCVR_DIAG_BIDI_CTRL(0), 0xbf);
+
+       HWRITE4(sc, RX_PSC_A0(1), 0xa6fd);
+       HWRITE4(sc, RX_PSC_A1(1), 0xa6fd);
+       HWRITE4(sc, RX_PSC_A2(1), 0xa410);
+       HWRITE4(sc, RX_PSC_A3(1), 0x2410);
+       HWRITE4(sc, RX_PSC_CAL(1), 0x23ff);
+       HWRITE4(sc, RX_SIGDET_HL_FILT_TMR(1), 0x13);
+       HWRITE4(sc, RX_REE_CTRL_DATA_MASK(1), 0x03e7);
+       HWRITE4(sc, RX_DIAG_SIGDET_TUNE(1), 0x1004);
+       HWRITE4(sc, RX_PSC_RDY(1), 0x2010);
+       HWRITE4(sc, XCVR_DIAG_BIDI_CTRL(1), 0xfb);
+
+       HWRITE4(sc, PMA_LANE_CFG, PIN_ASSIGN_D_F);
+
+       HWRITE4(sc, DP_MODE_CTL, DP_MODE_ENTER_A2);
+
+       reset_deassert(sc->sc_node, "uphy");
+
+       for (i = 10000; i > 0; i--) {
+               reg = HREAD4(sc, PMA_CMN_CTRL1);
+               if (reg & PMA_CMN_CTRL1_READY)
+                       break;
+               delay(10);
+       }
+       if (i == 0) {
+               printf("%s: timeout waiting for PMA\n", sc->sc_dev.dv_xname);
+               return ENXIO;
+       }
+
+       reset_deassert(sc->sc_node, "uphy-pipe");
+       return 0;
+}