xref: /netbsd-src/share/man/man4/umb.4 (revision be3f18998694e4e64adfe2a6875417a1fb7bcb68)
1.\" $NetBSD: umb.4,v 1.4 2019/08/30 09:22:17 wiz 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 August 24, 2019
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? port?"
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.
34.Pp
35Required configuration parameters like PIN and APN have to be set
36with
37.Xr umbctl 8 .
38Once the SIM card has been unlocked with the correct PIN, it
39will remain in this state until the MBIM device is power-cycled.
40In case the device is connected to an "always-on" USB port,
41it may be possible to connect to a provider without entering the
42PIN again even if the system was rebooted.
43.Sh HARDWARE
44The following devices should work:
45.Pp
46.Bl -tag -width Ds -offset indent -compact
47.It Ericsson H5321gw and N5321gw
48.It Fibocom L831-EAU
49.It Medion Mobile S4222 (MediaTek OEM)
50.It Sierra Wireless EM7345
51.It Sierra Wireless EM7455
52.It Sierra Wireless EM8805
53.It Sierra Wireless MC8305
54.El
55.Sh SEE ALSO
56.Xr intro 4 ,
57.Xr netintro 4 ,
58.Xr usb 4 ,
59.Xr ifconfig.if 5 ,
60.Xr ifconfig 8 ,
61.Xr umbctl 8
62.Rs
63.%T "Universal Serial Bus Communications Class Subclass Specification for Mobile Broadband Interface Model"
64.%U http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip
65.Re
66.Sh HISTORY
67The
68.Nm
69device driver first appeared in
70.Ox 6.0
71and
72.Nx 9.0 .
73.Sh AUTHORS
74.An -nosplit
75The
76.Nm
77driver was written by
78.An Gerhard Roth Aq Mt gerhard@openbsd.org
79and ported from
80.Ox
81by
82.An Pierre Pronchery Aq Mt khorben@defora.org .
83.Sh CAVEATS
84The
85.Nm
86driver does not support IPv6.
87.Pp
88Devices which fail to provide a conforming MBIM implementation will
89probably be attached as some other driver, such as
90.Xr u3g 4 .
91