From nobody Sun Sep 13 15:53:27 2026 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4hjXr75bz3z6s9Hy for ; Sun, 13 Sep 2026 15:53:27 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange x25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "YR2" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4hjXr72xhLz4QVL for ; Sun, 13 Sep 2026 15:53:27 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1789314807; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=YGcBN7oJRkucL+U7hH1dKGXomwNdci4NRbOHXKdtfz8=; b=tyrUEp4ugGLGY7t9EREYxz8DVNjWqEpKOwz8N+SLGLjbANhCFz7bFFcRd0CzRc2Ly+1j9F 4pq3uv8vybSx/USJGiNeYRHrA2CW6Z7QY/AzCvupmJNjAdCocQxzdTr/iFuafYsSJtqLsG 4eqveRTGt8+nhKVNPw0y0dzG4ICdyFTwBuPKOdgwqdrfpBNF/6DDaVHTmlwun46HX/zvqj +LbNRzidA9tO1HO64TH27YjseoRbNTxRfmvaGIwKD59UhCSV2Mv1hQ+T9UTOwxoQWJsh9T W03+9wwCTOOUReWW69GVAFjFcjEsqV3fNpubn877aiPbRpXzHM8laWNj/F/jkQ== ARC-Seal: i=1; a=rsa-sha256; d=freebsd.org; s=dkim; cv=none; t=1789314807; b=DQ44epLpxdOVbh4ELMCyJ1Gwg37qCqCDjeswRjAWuKMWoJpTCl/3dn/tQDVIznf89zlsDz C4qNOwQBzuvs+Qrt2TOq5tPxWpTKN9KBaS4EhQMoB5o4ABIwiwJypVkecx5f1rkv6UIB/w Ipya1S1RM3a3h4lDuqd64Gj9Wzg7PhtmV6t520nWX66H8LNW4GWb551h/3gN+ntkPLH1Yx gIAOiatZ+2RzXJ/SEL53MpmTN2+0hQxSyLBCmYu13tlHEIo24NcUIAv1IBEYEl3/KZGGDE 0tZQod6IE6gyMQA58UXtnKVZDwQEi90S8RQBrJAl9LTeukidU3qvaImQT1dlOg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1789314807; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=YGcBN7oJRkucL+U7hH1dKGXomwNdci4NRbOHXKdtfz8=; b=D/jhdd3GEvngzlhA8hALaw6WV/PhQGUhcBJq4NSQHuK4eZZqpGKt8cq7c5zLcQcrBAJX23 Rs+SQUCeXXLrBUUzQYL028XPFROrNQ/AYVnmdI6eUnRdHig3q8fhr3e2jwaP7YU6T5D4Vj KRE5XsKF+MrsTqe3XahzSSVw0QXJdOrakAYvUNDlA+yqvS4isKlZ3n0ANQgCMiNcpI32Bh n0KZDCXIyA8lBWq8PUwEHVNE6j6gGQQ05/alrqk6t+tvMgD3j1dHj5kQ7s27PRsLoZuypg kR6dyEd/ChQlokVmeXPOJh3MR9fFXZMUq/sIX/WPAy9/qpU4Vs6eNFZnubIZfA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4hjXr71lMZzq6s for ; Sun, 13 Sep 2026 15:53:27 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 3a3cd by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Sun, 13 Sep 2026 15:53:27 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Alexander Ziaee Subject: git: bba2aebcebc1 - main - udbp.4: Canonicalize SYNOPSIS, structure, SPDX List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: bba2aebcebc1d46b15e1b6d86c041186dc8d49f0 Auto-Submitted: auto-generated Date: Sun, 13 Sep 2026 15:53:27 +0000 Message-Id: <6aa6c6f7.3a3cd.481adaf8@gitrepo.freebsd.org> The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=bba2aebcebc1d46b15e1b6d86c041186dc8d49f0 commit bba2aebcebc1d46b15e1b6d86c041186dc8d49f0 Author: Alexander Ziaee AuthorDate: 2026-09-13 15:41:51 +0000 Commit: Alexander Ziaee CommitDate: 2026-09-13 15:43:20 +0000 udbp.4: Canonicalize SYNOPSIS, structure, SPDX Event: EuroBSDcon 2026 MFC after: 3 days --- share/man/man4/udbp.4 | 94 ++++++++++++++++++--------------------------------- 1 file changed, 33 insertions(+), 61 deletions(-) diff --git a/share/man/man4/udbp.4 b/share/man/man4/udbp.4 index f6ec43ae8b2d..53283ac5b531 100644 --- a/share/man/man4/udbp.4 +++ b/share/man/man4/udbp.4 @@ -1,3 +1,6 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" .\" Copyright (c) 1999 .\" Nick Hibma . All rights reserved. .\" @@ -22,26 +25,20 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.Dd October 20, 2017 +.Dd September 13, 2026 .Dt UDBP 4 .Os .Sh NAME .Nm udbp .Nd USB Double Bulk Pipe driver .Sh SYNOPSIS -To compile this driver into the kernel, -place the following line in your -kernel configuration file: -.Bd -ragged -offset indent -.Cd "device udbp" -.Ed +.Cd device netgraph +.Cd device udbp .Pp -Alternatively, to load the driver as a -module at boot time, place the following line in +In .Xr loader.conf 5 : -.Bd -literal -offset indent -udbp_load="YES" -.Ed +.Cd netgraph_load="YES" +.Cd udbp_load="YES" .Sh DESCRIPTION The .Nm @@ -55,56 +52,30 @@ is listed in the .Sx SEE ALSO section below. .Pp -.\" XXX The description of how to add netgraph to the kernel -.\" is out of place here. It should be limited to the -.\" netgraph(4) manpage only. However, that page does -.\" not yet give instructions for kldload(8) for the -.\" clueless. Working on it -- sheldonh It requires .Xr netgraph 4 to be available. -This can be done either by adding -.Cd "options NETGRAPH" -to your kernel configuration file, or alternatively loading -.Xr netgraph 4 -as a module, either from -.Pa /boot/loader.conf -or from the command line, before the -.Nm -module. .Sh EXAMPLES -.Dl options NETGRAPH -.Dl device udbp -.Pp -Add the -.Nm -driver to the kernel. -.Pp -.Dl kldload netgraph -.Dl kldload udbp -.Pp -Load the -.Xr netgraph 4 -module and then the +Create a new Ethernet network interface node +and connect its ether hook to the data hook of the .Nm -driver. +driver: .Pp .Dl ngctl mkpeer udbp0: eiface data ether .Dl ifconfig ngeth0 ether aa:dd:xx:xx:xx .Dl ifconfig ngeth0 inet 169.254.x.x/16 .Pp -Create a new Ethernet network interface node -and connect its ether hook to the data hook of the -.Nm -driver. -.Pp -This enables FreeBSD to communicate with a Linux peer (e.g. using the +This enables +.Fx +to communicate with a Linux peer (e.g. using the .Sy plusb driver). The Linux node should be configured to prefer link-local IPv4 addresses (e.g. using Network Manager in Debian and Red Hat derived distributions). .Pp -Whilst both FreeBSD and Linux are able to interoperate by +Whilst both +.Fx +and Linux are able to interoperate by loosely following CDC EEM 1.0 in their behaviour, neither implementation has been expressly designed to follow its specification. .Sh SEE ALSO @@ -128,25 +99,11 @@ has been expressly designed to follow its specification. .%I Ghisler Software GmbH. .%U https://www.ghisler.com/cables/index.htm .Re -.Sh CAVEATS -The point-to-point nature and additional latency of USB host-host links -makes them unsuitable as a "drop-in" replacement for an Ethernet LAN; -for a USB 3.0 SuperSpeed cable, latency is comparable to 100BaseTX Ethernet -(but often worse), with throughput comparable to 2.5GBASE-T. -.Pp -However, their energy efficiency makes them attractive for embedded applications. -A Plugable PL27A1 cable claims 24mA of USB3 bus power, -as compared to 150mA for a typical USB 3.0 to Gigabit Ethernet interface. .Sh HISTORY The .Nm driver first appeared in .Fx 5.0 . -.Sh BUGS -The -.Nm -driver does not support the special packets described in section 5.1 -of the CDC EEM specification. .Sh AUTHORS .An -nosplit The @@ -161,3 +118,18 @@ This manual page was written by .An Nick Hibma Aq Mt n_hibma@FreeBSD.org and updated by .An Bruce Simpson Aq Mt bms@FreeBSD.org . +.Sh CAVEATS +The point-to-point nature and additional latency of USB host-host links +makes them unsuitable as a "drop-in" replacement for an Ethernet LAN; +for a USB 3.0 SuperSpeed cable, latency is comparable to 100BaseTX Ethernet +(but often worse), with throughput comparable to 2.5GBASE-T. +.Pp +However, +their energy efficiency makes them attractive for embedded applications. +A Plugable PL27A1 cable claims 24mA of USB3 bus power, +as compared to 150mA for a typical USB 3.0 to Gigabit Ethernet interface. +.Sh BUGS +The +.Nm +driver does not support the special packets described in section 5.1 +of the CDC EEM specification.