rkcomphy(4)
authorkettenis <kettenis@openbsd.org>
Sun, 12 Mar 2023 19:02:34 +0000 (19:02 +0000)
committerkettenis <kettenis@openbsd.org>
Sun, 12 Mar 2023 19:02:34 +0000 (19:02 +0000)
share/man/man4/Makefile
share/man/man4/rkcomphy.4 [new file with mode: 0644]

index 9cf7c2d..9012311 100644 (file)
@@ -1,4 +1,4 @@
-#      $OpenBSD: Makefile,v 1.832 2023/03/04 22:44:27 kettenis Exp $
+#      $OpenBSD: Makefile,v 1.833 2023/03/12 19:02:34 kettenis Exp $
 
 MAN=   aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \
        acpi.4 acpiac.4 acpials.4 acpiasus.4 acpibat.4 \
@@ -76,7 +76,8 @@ MAN=  aac.4 abcrtc.4 abl.4 ac97.4 acphy.4 acrtc.4 \
        qcpwm.4 qcrtc.4 qcspmi.4 \
        qla.4 qle.4 qlw.4 qsphy.4 \
        radio.4 ral.4 random.4 rdomain.4 rd.4 rdac.4 re.4 rdcphy.4 rgephy.4 \
-       rge.4 ricohrtc.4 rkanxdp.4 rkclock.4 rkdrm.4 rkdwhdmi.4 rkdwusb.4 \
+       rge.4 ricohrtc.4 rkanxdp.4 rkclock.4 rkcomphy.4 \
+       rkdrm.4 rkdwhdmi.4 rkdwusb.4 \
        rkemmcphy.4 rkgpio.4 rkgrf.4 rkiic.4 rkiis.4 rkpcie.4 rkpinctrl.4 \
        rkpmic.4 rkpwm.4 rkrng.4 rktcphy.4 rktemp.4 rkvop.4 \
        rl.4 rlphy.4 route.4 rsu.4 rtsx.4 rum.4 run.4 rtw.4 rtwn.4 \
diff --git a/share/man/man4/rkcomphy.4 b/share/man/man4/rkcomphy.4
new file mode 100644 (file)
index 0000000..26a001a
--- /dev/null
@@ -0,0 +1,48 @@
+.\"    $OpenBSD: rkcomphy.4,v 1.1 2023/03/12 19:02:34 kettenis Exp $
+.\"
+.\" Copyright (c) 2023 Mark Kettenis <kettenis@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: March 12 2023 $
+.Dt RKCOMPHY 4
+.Os
+.Sh NAME
+.Nm rkcomphy
+.Nd Rockchip PCIe/USB3/SATA/QSGMII PHY
+.Sh SYNOPSIS
+.Cd "rkcomphy* at fdt?"
+.Sh DESCRIPTION
+The
+.Nm
+driver controls the combo PIPE PHY integrated on Rockchip
+RK3566/RK3568 and RK3588 SoCs.
+The PHY supports the PCIe 2.0 (2.5 GT/s and 5 GT/s), USB 3.0 (5 Gbps),
+SATA (1.5 Gbit/s, 3 Gbit/s and 6 Gbit/s) and QSGMII (1.25 Gbit/s and 5
+Gbit/s) protocols.
+The
+.nm
+driver does not implement support for QSGMII.
+.Sh SEE ALSO
+.Xr intro 4
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Ox 7.3 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Mark Kettenis Aq Mt kettenis@openbsd.org .