xref: /openbsd/share/man/man4/umb.4 (revision 9ea232b5)
1.\"	$OpenBSD: umb.4,v 1.17 2024/01/01 13:04:35 kevlo Exp $
2.\"
3.\" Copyright (c) 2016 genua mbH
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: January 1 2024 $
18.Dt UMB 4
19.Os
20.Sh NAME
21.Nm umb
22.Nd USB Mobile Broadband Interface Model (MBIM)
23.Sh SYNOPSIS
24.Cd "umb*  at uhub?"
25.Sh DESCRIPTION
26The
27.Nm
28driver provides support for USB MBIM devices.
29.Pp
30MBIM devices establish connections via cellular networks such as
31GPRS, UMTS, and LTE.
32They appear as a regular point-to-point network interface,
33transporting raw IP frames.
34Once a connection is established,
35the device will automatically set an IP address
36and send out a nameserver proposal,
37which
38.Xr resolvd 8
39can act on.
40.Pp
41Required configuration parameters like PIN and APN have to be set
42with
43.Xr ifconfig 8 .
44Once the SIM card has been unlocked with the correct PIN, it
45will remain in this state until the MBIM device is power-cycled.
46In case the device is connected to an "always-on" USB port,
47it may be possible to connect to a provider without entering the
48PIN again even if the system was rebooted.
49.Sh HARDWARE
50The following devices should work:
51.Pp
52.Bl -tag -width Ds -offset indent -compact
53.It Dell DW5821e
54.It Ericsson H5321gw and N5321gw
55.It Fibocom L831-EAU
56.\" .It Huawei ME906s -- attaches but needs more work
57.It Medion Mobile S4222 (MediaTek OEM)
58.It Quectel EC25
59.It Quectel RM500Q
60.It SIMCom SIM7600
61.It SIMCom SIM8262E-M2
62.It Sierra Wireless EM7345
63.It Sierra Wireless EM7455
64.It Sierra Wireless EM8805
65.It Sierra Wireless MC8305
66.El
67.Sh SEE ALSO
68.Xr intro 4 ,
69.Xr netintro 4 ,
70.Xr usb 4 ,
71.Xr hostname.if 5 ,
72.Xr ifconfig 8 ,
73.Xr route 8
74.Rs
75.%T "Universal Serial Bus Communications Class Subclass Specification for Mobile Broadband Interface Model"
76.%U https://www.usb.org/document-library/mobile-broadband-interface-model-v10-errata-1-and-adopters-agreement
77.Re
78.Sh CAVEATS
79Devices which fail to provide a conforming MBIM implementation will
80probably be attached as some other driver, such as
81.Xr umsm 4 .
82