summaryrefslogtreecommitdiff
path: root/share/man/man4/usbf.4
blob: 1fe2c841be2783f235baba681d444512988c8e66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.\"	$OpenBSD: usbf.4,v 1.7 2013/07/16 16:05:49 schwarze Exp $
.\"
.\" Uwe Stuehler, 2006. Public Domain.
.\"
.Dd $Mdocdate: July 16 2013 $
.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?	# zaurus"
.Cd "cdcef* at usbf?"
.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 cdcef 4 ,
.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 Mt uwe@openbsd.org .