1.\"- 2.\" SPDX-License-Identifier: 0BSD 3.\" 4.\" Copyright (c) 2016 genua mbH 5.\" 6.\" Permission to use, copy, modify, and distribute this software for any 7.\" purpose with or without fee is hereby granted, provided that the above 8.\" copyright notice and this permission notice appear in all copies. 9.\" 10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17.\" 18.\" $NetBSD: umb.4,v 1.4 2019/08/30 09:22:17 wiz Exp $ 19.\" 20.Dd August 4, 2025 21.Dt UMB 4 22.Os 23.Sh NAME 24.Nm umb 25.Nd USB Mobile Broadband Interface Model (MBIM) cellular modem driver 26.Sh SYNOPSIS 27.Cd "device netmap" 28.Cd "device usb" 29.Cd "device umb" 30.Pp 31In 32.Xr loader.conf 5 : 33.Cd umb_load="YES" 34.Sh DESCRIPTION 35The 36.Nm 37driver provides support for USB MBIM devices. 38If the appropriate hardware is detected, 39the driver will be loaded automatically by 40.Xr devmatch 8 . 41To load the driver manually, 42.Cm load 43it in 44.Xr loader.conf 5 45or at the 46.Xr loader 8 47prompt. 48.Pp 49MBIM devices establish connections via cellular networks such as 50GPRS, UMTS, and LTE. 51They appear as a regular point-to-point network interface, 52transporting raw IP frames. 53.Pp 54Required configuration parameters like PIN and APN have to be set 55with 56.Xr umbctl 8 . 57Once the SIM card has been unlocked with the correct PIN, it 58will remain in this state until the MBIM device is power-cycled. 59In case the device is connected to an "always-on" USB port, 60it may be possible to connect to a provider without entering the 61PIN again even if the system was rebooted. 62.Sh HARDWARE 63The 64.Nm 65driver should support any USB device implementing MBIM, including 66the following cellular modems: 67.Pp 68.Bl -bullet -compact 69.It 70Ericsson H5321gw and N5321gw 71.It 72Fibocom L831-EAU 73.It 74Medion Mobile S4222 (MediaTek OEM) 75.It 76Sierra Wireless EM7345 77.It 78Sierra Wireless EM7455 79.It 80Sierra Wireless EM8805 81.It 82Sierra Wireless MC8305 83.El 84.Sh SEE ALSO 85.Xr intro 4 , 86.Xr netintro 4 , 87.Xr usb 4 , 88.Xr ifconfig 8 , 89.Xr umbctl 8 90.Rs 91.%T "Universal Serial Bus Communications Class Subclass Specification for Mobile Broadband Interface Model" 92.%U http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip 93.Re 94.Sh HISTORY 95The 96.Nm 97device driver first appeared in 98.Ox 6.0 , 99.Nx 9.0 , 100and 101.Fx 15.0 . 102.Sh AUTHORS 103.An -nosplit 104The 105.Nm 106driver was written by 107.An Gerhard Roth Aq Mt gerhard@openbsd.org 108and ported from 109.Ox 110by 111.An Pierre Pronchery Aq Mt khorben@defora.org . 112.Sh CAVEATS 113The 114.Nm 115driver does not support IPv6. 116.Pp 117Devices which fail to provide a conforming MBIM implementation will 118probably be attached as some other driver, such as 119.Xr u3g 4 . 120