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