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 September 3, 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 usb" 28.Cd "device umb" 29.Pp 30In 31.Xr loader.conf 5 : 32.Cd umb_load="YES" 33.Sh DESCRIPTION 34The 35.Nm 36driver provides support for USB MBIM devices. 37If the appropriate hardware is detected, 38the driver will be loaded automatically by 39.Xr devmatch 8 . 40To load the driver manually, 41.Cm load 42it in 43.Xr loader.conf 5 44or at the 45.Xr loader 8 46prompt. 47.Pp 48MBIM devices establish connections via cellular networks such as 49GPRS, UMTS, and LTE. 50They appear as a regular point-to-point network interface, 51transporting raw IP frames. 52.Pp 53Required configuration parameters like PIN and APN have to be set 54with 55.Xr umbctl 8 . 56Once the SIM card has been unlocked with the correct PIN, it 57will remain in this state until the MBIM device is power-cycled. 58In case the device is connected to an "always-on" USB port, 59it may be possible to connect to a provider without entering the 60PIN again even if the system was rebooted. 61.Sh HARDWARE 62The 63.Nm 64driver should support any USB device implementing MBIM, including 65the following cellular modems: 66.Pp 67.Bl -bullet -compact 68.It 69Ericsson H5321gw and N5321gw 70.It 71Fibocom L831-EAU 72.It 73Medion Mobile S4222 (MediaTek OEM) 74.It 75Sierra Wireless EM7345 76.It 77Sierra Wireless EM7455 78.It 79Sierra Wireless EM8805 80.It 81Sierra Wireless MC8305 82.El 83.Sh SEE ALSO 84.Xr intro 4 , 85.Xr netintro 4 , 86.Xr usb 4 , 87.Xr ifconfig 8 , 88.Xr umbctl 8 89.Rs 90.%T "Universal Serial Bus Communications Class Subclass Specification for Mobile Broadband Interface Model" 91.%U http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip 92.Re 93.Sh HISTORY 94The 95.Nm 96device driver first appeared in 97.Ox 6.0 , 98.Nx 9.0 , 99and 100.Fx 15.0 . 101.Sh AUTHORS 102.An -nosplit 103The 104.Nm 105driver was written by 106.An Gerhard Roth Aq Mt gerhard@openbsd.org 107and ported from 108.Ox 109by 110.An Pierre Pronchery Aq Mt khorben@defora.org . 111.Sh CAVEATS 112The 113.Nm 114driver does not support IPv6. 115.Pp 116Devices which fail to provide a conforming MBIM implementation will 117probably be attached as some other driver, such as 118.Xr u3g 4 . 119