xref: /dragonfly/share/man/man4/firewire.4 (revision 9dbf638f)
1.\" Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the acknowledgement as bellow:
14.\"
15.\"    This product includes software developed by K. Kobayashi and H. Shimokawa
16.\"
17.\" 4. The name of the author may not be used to endorse or promote products
18.\"    derived from this software without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
24.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
28.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30.\" POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\" $FreeBSD: src/share/man/man4/firewire.4,v 1.1.2.3 2003/02/14 08:22:03 simokawa Exp $
33.\" $DragonFly: src/share/man/man4/firewire.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
34.\"
35.Dd May 23, 2002
36.Dt FIREWIRE 4
37.Os
38.Sh NAME
39.Nm firewire
40.Nd IEEE1394 High-performance Serial Bus
41.Sh SYNOPSIS
42.Cd "kldload firewire"
43.Pp
44or
45.Pp
46.Cd "device firewire"
47.Cd "device fwohci"
48.Pp
49.In dev/firewire/firewire.h
50.Sh DESCRIPTION
51.Fx
52provides machine-independent bus support and raw drivers for
53.Nm
54interfaces.
55.Pp
56The
57.Nm
58driver consists of two layers: the controller and the
59bus layer.
60The controller attaches to a physical bus
61(like
62.Xr pci 4 ) .
63The
64.Nm
65bus attaches to the controller.
66And the additional driver can be attached to the bus.
67.Pp
68Up to 63 devices, including the host itself, can be attached to
69a
70.Nm
71bus.
72The root node is dynamically assigned with PHY device function.
73Also, the other
74.Nm
75bus specific parameters,
76e.g., node ID, cycle master, isochronous resource manager and bus
77manager, are dynamically assigned, after bus reset is initiated.
78On
79.Nm
80bus, every device is identified with EUI 64 address.
81.Sh FILES
82.Bl -tag -width indent -compact
83.It Pa /dev/fw0
84.It Pa /dev/fwmem0
85.El
86.Sh SEE ALSO
87.Xr fwcontrol 8 ,
88.Xr fwe 4 ,
89.Xr fwohci 4 ,
90.Xr kldload 8 ,
91.Xr pci 4 ,
92.Xr sbp 4 ,
93.Xr sysctl 8
94.Sh HISTORY
95The
96.Nm
97driver first appeared in
98.Fx 5.0 .
99.Sh AUTHORS
100.An -nosplit
101The
102.Nm
103driver was written by
104.An Katsushi Kobayashi
105and
106.An Hidetoshi Shimokawa
107for the
108.Fx
109project.
110.Pp
111.Sh BUGS
112See fwohci(4) for security note.
113