From nobody Tue Jan 7 16:47:09 2025 X-Original-To: dev-commits-doc-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 4YSH5V0gsGz5kqK8 for ; Tue, 07 Jan 2025 16:47:10 +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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4YSH5T74fPz4bDB; Tue, 7 Jan 2025 16:47:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1736268430; 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=JcSe+IbyFIZLJRWzdsonPMyPfJmPxJaBbwcyClxsCq0=; b=ZsjSBqYG16BcRpLrFQtB1BO6MrwO0F6cZF5THD0xHxab3Vh4E0YNKR8HubfTOj2phElsho RdNyzLXFfQo4BjEaFWCrWAgUbqiQcKVGqinaAXzYS2Jx4vF7Rx0SdxijfQCj45xF7u/scA 60KdvcJrUjrdxGa4By2qmvkyoqKfMd0J6ToNAwzLGSCH+YIT3iGxvr8K7yQtbm8NsXZR5H QywQkIwhSpMpTufvs8MSWS3/7JE/KsAdF1gbB/AWW3H46pjLuPtBAWz6nxvyDly1k2298t Qb0f1xfCY/C7AnbCDecdSAVFANdkWe6hVzii6JO6d0D0oJ5qy2zEUCiHaxCqow== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1736268430; 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=JcSe+IbyFIZLJRWzdsonPMyPfJmPxJaBbwcyClxsCq0=; b=YYzfMIEZYYEptjqiZVc5x65vB/I28sy2bOYQRfIDeASRkcX/XF5xtjfGmIJhjoYUkzCX9O mN136qA70NmU3Nyupt7gtOsVbC6yrOUrbP9LlZ9nPPUv62RkQ/hp0HF7QI7uFBI9et4z2Z Z+ARbGN1NXTARQi+30BVdRVWOehfNDJnV1ioENhQJjoqQwqNBuGdEP7WAKkXAXjy9V84O+ 6eNFSsNoZBDI274UA10TlQ+gSbOJPpyuHPVr+IcZtIM2E2HFu6kjlMz5ZSu0FYZyzlQj/o 5HHf4Kg2TOjLZqu6HWT78iR0gYqzMTXU9EiihAcfnQmW9btulWmmf4DPyIQoeA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1736268430; a=rsa-sha256; cv=none; b=ICBljx3IpxvKxjFriUuL4Z+jxl4X/lOJqEPEASMp1kqguB2T3MvPx5tcpoefrRJjRsf0Cj jzsI15vgQJ5Gq/nmMc1fQYTnuX9KM1QkSg3lGq7E75p/Hsm4Wi00+imyAJAXwWfNTg45wg aofq/OdeQ4t06/VXL0Q3FLjGx/F/d6cDfylgxOXqOyBlMD3NQV9RBKmZKwNBauHbUqhYH6 KjEUuWiB7DcvhCXNNz8oTxOqfesTf7jq5g4H6fXnG9tYJ0ji3ReKJUQYGY3YCiJ2a+5r0y tgLqFP2v2ALupT0b+GsqhWG/tmJMdaRjDT5Ih0dhkDhlc21FgIrP4jnPK/vNfQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (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 did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4YSH5T6MqHz3W1; Tue, 07 Jan 2025 16:47:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 507Gl92Q061142; Tue, 7 Jan 2025 16:47:09 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 507Gl9Z3061139; Tue, 7 Jan 2025 16:47:09 GMT (envelope-from git) Date: Tue, 7 Jan 2025 16:47:09 GMT Message-Id: <202501071647.507Gl9Z3061139@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 3d94a379e2 - main - Status: Add umb[4] status report List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 3d94a379e25d8afc15193339209e80c35c03c8d6 Auto-Submitted: auto-generated The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=3d94a379e25d8afc15193339209e80c35c03c8d6 commit 3d94a379e25d8afc15193339209e80c35c03c8d6 Author: Pierre Pronchery AuthorDate: 2025-01-07 16:46:32 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2025-01-07 16:46:32 +0000 Status: Add umb[4] status report Reviewed by: Pau Amma Pull Request: https://github.com/freebsd/freebsd-doc/pull/453 --- .../en/status/report-2024-10-2024-12/umb.adoc | 33 ++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/website/content/en/status/report-2024-10-2024-12/umb.adoc b/website/content/en/status/report-2024-10-2024-12/umb.adoc new file mode 100644 index 0000000000..72745b9800 --- /dev/null +++ b/website/content/en/status/report-2024-10-2024-12/umb.adoc @@ -0,0 +1,33 @@ +=== umb(4) driver for MBIM USB 4G/5G modems + +Links: + +link:https://man.openbsd.org/umb[UMB(4) - OpenBSD Device Drivers Manual] URL: link:https://man.openbsd.org/umb[] + +link:https://man.netbsd.org/umb.4[UMB(4) - NetBSD Kernel Interfaces Manual] URL: link:https://man.netbsd.org/umb.4[] + +link:https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263783[Bug 263783 - USB MBIM: Support for LTE/4G USB modems] URL: link:https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=263783[] + +link:https://reviews.freebsd.org/D48167[Introduce the USB umb(4) network driver] URL: link:https://reviews.freebsd.org/D48167[] + +Contact: Pierre Pronchery + +The Mobile Broadband Interface Model (MBIM) is a protocol for communication with network USB devices, transmitting packet data over mobile broadband networks. +Implementing this protocol adds support for a whole range of USB devices providing connectivity to mobile networks, such as 4G, 5G, and their subsequent technological evolutions. + +A first implementation for this protocol was performed for OpenBSD in 2016, under the name umb(4). +I have ported it myself to NetBSD under the same name, back in 2019. +I was then contracted to make it work with OPNSense, and authorized to publish it as Open Source in 2022. +Unfortunately, by this time, some changes in FreeBSD effectively broke the driver, and it could not be merged until fixed. + +This quarter I have managed to offer an updated version and confirmed it working (thanks Mike and Zhenlei!). +This version is now under review in Phabricator as D48167. +The submission is still based on code from 2020, and behind progress made by OpenBSD since that time. +As such, it is currently restricted to IPv4. +However, I believe it makes sense to keep the review simple and focus on the design decisions and integration, before progressively importing the improvements made upstream since then in OpenBSD (notably IPv6 support). + +In its current form, the driver was modified from being out of tree and available as a plug-in for OPNSense, into a kernel module and its companion binary, umbconfig(8). +This management binary effectively allows the umb(4) driver to be configured beyond the capabilities of ifconfig(8): the PIN or PUK code, APN, username/password, or roaming parameters can be setup, and the connectivity tracked as well (network provider, speed...). + +Should you want to give it a spin yourself and get hardware supported by this driver, the single most important feature to look for is support for the MBIM specification. +The manual page for OpenBSD provides a list of devices that should be compliant; note that some of them require preliminary configuration in order to effectively expose the MBIM interface. +The exact procedure is vendor-specific, and can also depend on the model and current configuration of the device. +You should refer to the documentation offered for your device for any steps necessary. + +Sponsored by: The FreeBSD Foundation