Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/umb.4
- This file was added.
| .\" $NetBSD: umb.4,v 1.4 2019/08/30 09:22:17 wiz Exp $ | ||||||||||||||||||||||||||||||||||||
| .\" | ||||||||||||||||||||||||||||||||||||
| .\" Copyright (c) 2016 genua mbH | ||||||||||||||||||||||||||||||||||||
| .\" | ||||||||||||||||||||||||||||||||||||
| .\" Permission to use, copy, modify, and distribute this software for any | ||||||||||||||||||||||||||||||||||||
| .\" purpose with or without fee is hereby granted, provided that the above | ||||||||||||||||||||||||||||||||||||
| .\" copyright notice and this permission notice appear in all copies. | ||||||||||||||||||||||||||||||||||||
| .\" | ||||||||||||||||||||||||||||||||||||
| .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||||||||||||||||||||||||||||||||||||
| .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||||||||||||||||||||||||||||||||||||
| .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||||||||||||||||||||||||||||||||||||
| .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||||||||||||||||||||||||||||||||||||
| .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||||||||||||||||||||||||||||||||||||
| .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||||||||||||||||||||||||||||||||||||
| .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||||||||||||||||||||||||||||||||||||
| .\" | ||||||||||||||||||||||||||||||||||||
| .Dd August 24, 2019 | ||||||||||||||||||||||||||||||||||||
| .Dt UMB 4 | ||||||||||||||||||||||||||||||||||||
| .Os | ||||||||||||||||||||||||||||||||||||
| .Sh NAME | ||||||||||||||||||||||||||||||||||||
| .Nm umb | ||||||||||||||||||||||||||||||||||||
| .Nd USB Mobile Broadband Interface Model (MBIM) | ||||||||||||||||||||||||||||||||||||
| .Sh SYNOPSIS | ||||||||||||||||||||||||||||||||||||
| .Cd "umb* at uhub? port?" | ||||||||||||||||||||||||||||||||||||
ziaee: We usually put what options are needed to build it into the kernel, and any sysctls that can be… | ||||||||||||||||||||||||||||||||||||
| .Sh DESCRIPTION | ||||||||||||||||||||||||||||||||||||
| The | ||||||||||||||||||||||||||||||||||||
| .Nm | ||||||||||||||||||||||||||||||||||||
| driver provides support for USB MBIM devices. | ||||||||||||||||||||||||||||||||||||
| .Pp | ||||||||||||||||||||||||||||||||||||
| MBIM devices establish connections via cellular networks such as | ||||||||||||||||||||||||||||||||||||
| GPRS, UMTS, and LTE. | ||||||||||||||||||||||||||||||||||||
| They appear as a regular point-to-point network interface, | ||||||||||||||||||||||||||||||||||||
| transporting raw IP frames. | ||||||||||||||||||||||||||||||||||||
| .Pp | ||||||||||||||||||||||||||||||||||||
| Required configuration parameters like PIN and APN have to be set | ||||||||||||||||||||||||||||||||||||
| with | ||||||||||||||||||||||||||||||||||||
| .Xr umbctl 8 . | ||||||||||||||||||||||||||||||||||||
| Once the SIM card has been unlocked with the correct PIN, it | ||||||||||||||||||||||||||||||||||||
| will remain in this state until the MBIM device is power-cycled. | ||||||||||||||||||||||||||||||||||||
| In case the device is connected to an "always-on" USB port, | ||||||||||||||||||||||||||||||||||||
| it may be possible to connect to a provider without entering the | ||||||||||||||||||||||||||||||||||||
| PIN again even if the system was rebooted. | ||||||||||||||||||||||||||||||||||||
| .Sh HARDWARE | ||||||||||||||||||||||||||||||||||||
| The following devices should work: | ||||||||||||||||||||||||||||||||||||
| .Pp | ||||||||||||||||||||||||||||||||||||
| .Bl -tag -width Ds -offset indent -compact | ||||||||||||||||||||||||||||||||||||
| .It Ericsson H5321gw and N5321gw | ||||||||||||||||||||||||||||||||||||
| .It Fibocom L831-EAU | ||||||||||||||||||||||||||||||||||||
| .It Medion Mobile S4222 (MediaTek OEM) | ||||||||||||||||||||||||||||||||||||
| .It Sierra Wireless EM7345 | ||||||||||||||||||||||||||||||||||||
| .It Sierra Wireless EM7455 | ||||||||||||||||||||||||||||||||||||
| .It Sierra Wireless EM8805 | ||||||||||||||||||||||||||||||||||||
| .It Sierra Wireless MC8305 | ||||||||||||||||||||||||||||||||||||
ziaeeUnsubmitted Done Inline Actions
This section gets pulled into the hardware notes, so it needs to have the driver name and device type for searching. I've been writing a section for style.mdoc but it's maybe not ready yet. Bullet lists make a really nice subsections. https://www.freebsd.org/releases/14.2R/hardware/#misc-network ziaee: This section gets pulled into the hardware notes, so it needs to have the driver name and… | ||||||||||||||||||||||||||||||||||||
ziaeeUnsubmitted Done Inline ActionsIf it goes in this way, it will render super ragged in the hardware notes with no description. Here's what we have so far for the HARDWARE section style guide: https://reviews.freebsd.org/D48343 ziaee: If it goes in this way, it will render super ragged in the hardware notes with no description. | ||||||||||||||||||||||||||||||||||||
| .El | ||||||||||||||||||||||||||||||||||||
| .Sh SEE ALSO | ||||||||||||||||||||||||||||||||||||
| .Xr intro 4 , | ||||||||||||||||||||||||||||||||||||
| .Xr netintro 4 , | ||||||||||||||||||||||||||||||||||||
| .Xr usb 4 , | ||||||||||||||||||||||||||||||||||||
| .Xr ifconfig.if 5 , | ||||||||||||||||||||||||||||||||||||
ziaeeUnsubmitted Done Inline ActionsWe don't have this one. ziaee: We don't have this one. | ||||||||||||||||||||||||||||||||||||
| .Xr ifconfig 8 , | ||||||||||||||||||||||||||||||||||||
| .Xr umbctl 8 | ||||||||||||||||||||||||||||||||||||
| .Rs | ||||||||||||||||||||||||||||||||||||
| .%T "Universal Serial Bus Communications Class Subclass Specification for Mobile Broadband Interface Model" | ||||||||||||||||||||||||||||||||||||
| .%U http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip | ||||||||||||||||||||||||||||||||||||
| .Re | ||||||||||||||||||||||||||||||||||||
| .Sh HISTORY | ||||||||||||||||||||||||||||||||||||
| The | ||||||||||||||||||||||||||||||||||||
| .Nm | ||||||||||||||||||||||||||||||||||||
| device driver first appeared in | ||||||||||||||||||||||||||||||||||||
| .Ox 6.0 | ||||||||||||||||||||||||||||||||||||
| and | ||||||||||||||||||||||||||||||||||||
| .Nx 9.0 . | ||||||||||||||||||||||||||||||||||||
ziaeeUnsubmitted Done Inline Actions
ziaee: | ||||||||||||||||||||||||||||||||||||
| .Sh AUTHORS | ||||||||||||||||||||||||||||||||||||
| .An -nosplit | ||||||||||||||||||||||||||||||||||||
| The | ||||||||||||||||||||||||||||||||||||
| .Nm | ||||||||||||||||||||||||||||||||||||
| driver was written by | ||||||||||||||||||||||||||||||||||||
| .An Gerhard Roth Aq Mt gerhard@openbsd.org | ||||||||||||||||||||||||||||||||||||
| and ported from | ||||||||||||||||||||||||||||||||||||
| .Ox | ||||||||||||||||||||||||||||||||||||
| by | ||||||||||||||||||||||||||||||||||||
| .An Pierre Pronchery Aq Mt khorben@defora.org . | ||||||||||||||||||||||||||||||||||||
| .Sh CAVEATS | ||||||||||||||||||||||||||||||||||||
| The | ||||||||||||||||||||||||||||||||||||
| .Nm | ||||||||||||||||||||||||||||||||||||
| driver does not support IPv6. | ||||||||||||||||||||||||||||||||||||
| .Pp | ||||||||||||||||||||||||||||||||||||
| Devices which fail to provide a conforming MBIM implementation will | ||||||||||||||||||||||||||||||||||||
| probably be attached as some other driver, such as | ||||||||||||||||||||||||||||||||||||
| .Xr u3g 4 . | ||||||||||||||||||||||||||||||||||||
We usually put what options are needed to build it into the kernel, and any sysctls that can be used to configure it. Lately a little about devmatch. u3g(4) is how I normally see it, vt(4) is the absolute best one I know of, and rtw89(4) for the most recent one with the devmatch example.