summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorUwe Stuehler <uwe@cvs.openbsd.org>2006-11-26 22:49:25 +0000
committerUwe Stuehler <uwe@cvs.openbsd.org>2006-11-26 22:49:25 +0000
commit9df5979372f7a14f6a3ebb5b293e0d6f3132ed61 (patch)
tree01c288cb60b4d9f066774dbe05cc93b4fc978032 /share
parenta108069814040bbcff4f3afa287821fd5bfa95fc (diff)
Introduction to Universal Serial Bus function support.
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/Makefile14
-rw-r--r--share/man/man4/usbf.473
2 files changed, 80 insertions, 7 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 657c0ad6ae1..491b6b28b6e 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.393 2006/11/25 17:18:31 mbalmer Exp $
+# $OpenBSD: Makefile,v 1.394 2006/11/26 22:49:24 uwe Exp $
MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
@@ -45,12 +45,12 @@ MAN= aac.4 ac97.4 acphy.4 acpi.4 acx.4 \
udav.4 udcf.4 udp.4 udsbr.4 \
ueagle.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uipaq.4 uk.4 ukbd.4 \
ukphy.4 ulpt.4 umass.4 umct.4 umidi.4 umodem.4 ums.4 umsm.4 \
- unix.4 uow.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 uscanner.4 \
- uslcom.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 vgafb.4 vge.4 \
- viaenv.4 viapm.4 viasio.4 vic.4 vlan.4 vnd.4 vr.4 watchdog.4 wb.4 \
- wbenv.4 wd.4 wdc.4 we.4 wi.4tbl wpi.4 wscons.4 wsdisplay.4 wskbd.4 \
- wsmouse.4 wsmux.4 xe.4 xf86.4 xge.4 xl.4 xmphy.4 yds.4 ym.4 zero.4 \
- zyd.4
+ unix.4 uow.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 usbf.4 \
+ uscanner.4 uslcom.4 usscanner.4 uvisor.4 uvscom.4 uyap.4 vga.4 \
+ vgafb.4 vge.4 viaenv.4 viapm.4 viasio.4 vic.4 vlan.4 vnd.4 vr.4 \
+ watchdog.4 wb.4 wbenv.4 wd.4 wdc.4 we.4 wi.4tbl wpi.4 wscons.4 \
+ wsdisplay.4 wskbd.4 wsmouse.4 wsmux.4 xe.4 xf86.4 xge.4 xl.4 \
+ xmphy.4 yds.4 ym.4 zero.4 zyd.4
MLINKS+=acpi.4 acpiac.4 acpi.4 acpibat.4 acpi.4 acpibtn.4
MLINKS+=acpi.4 acpiec.4 acpi.4 acpihpet.4 acpi.4 acpitimer.4
diff --git a/share/man/man4/usbf.4 b/share/man/man4/usbf.4
new file mode 100644
index 00000000000..4655a3de3d6
--- /dev/null
+++ b/share/man/man4/usbf.4
@@ -0,0 +1,73 @@
+.\" $OpenBSD: usbf.4,v 1.1 2006/11/26 22:49:24 uwe Exp $
+.\"
+.\" Uwe Stuehler, 2006. Public Domain.
+.\"
+.Dd August 9, 2006
+.Dt USBF 4
+.Os
+.Sh NAME
+.Nm usbf
+.Nd introduction to Universal Serial Bus function support
+.Sh SYNOPSIS
+.\" XXX SYNOPSIS should be similar to usb.4
+.Cd "usbf* at pxaudc?"
+.Sh DESCRIPTION
+.Ox
+provides machine-independent bus support and drivers for Universal Serial
+Bus
+.Pq Tn USB
+functions, making it possible in principle for machines running
+.Ox
+to act as
+.Tn USB
+device to a
+.Tn USB
+host.
+.Pp
+The
+.Ox
+.Nm
+driver has three layers: the controller, the logical device, and the
+function layer.
+The controller attaches to a physical bus.
+The logical device attaches to the controller and the function attaches
+to the logical device.
+.Pp
+Function drivers implement the characteristics of a particular
+.Tn USB
+device class that the
+.Tn USB
+host will see when the device is connected to the bus.
+.Pp
+.\" See
+.\" .Xr usbf 9
+.\" for a description of the kernel programming interfaces for
+.\" .Tn USB
+.\" function support.
+.Sh SUPPORTED FUNCTIONS
+.Ox
+includes the following machine-independent
+.Tn USB
+function drivers, sorted by device type and driver name:
+.Ss Communication devices
+.Bl -tag -width 12n -offset ind -compact
+.It Xr cdcef 4
+Communication Device Class Ethernet Emulation Model
+.Tn USB
+network adapter.
+.El
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr pxaudc 4 ,
+.Xr usbf 9
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.1 .
+.\" .Sh AUTHORS
+.\" .An -nosplit
+.\" The
+.\" .Nm
+.\" driver was written by
+.\" .An Uwe Stuehler Aq uwe@openbsd.org .