xref: /dragonfly/share/man/man4/firewire.4 (revision 91dc43dd)
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.9 2003/12/17 01:13:13 brueffer Exp $
33.\"
34.Dd May 23, 2002
35.Dt FIREWIRE 4
36.Os
37.Sh NAME
38.Nm firewire
39.Nd IEEE1394 High-performance Serial Bus
40.Sh SYNOPSIS
41.Cd "kldload firewire"
42.Pp
43or
44.Pp
45.Cd "device firewire"
46.Pp
47.In bus/firewire/firewire.h
48.Sh DESCRIPTION
49.Dx
50provides machine-independent bus support and raw drivers for
51.Nm
52interfaces.
53.Pp
54The
55.Nm
56driver consists of two layers: the controller and the
57bus layer.
58The controller attaches to a physical bus
59(like
60.Xr pci 4 ) .
61The
62.Nm
63bus attaches to the controller.
64Additional drivers can be attached to the bus.
65.Pp
66Up to 63 devices, including the host itself, can be attached to
67a
68.Nm
69bus.
70The root node is dynamically assigned with a PHY device function.
71Also, the other
72.Nm
73bus specific parameters,
74e.g., node ID, cycle master, isochronous resource manager and bus
75manager, are dynamically assigned, after bus reset is initiated.
76On the
77.Nm
78bus, every device is identified by an EUI 64 address.
79.Sh FILES
80.Bl -tag -compact -width ".Pa /dev/fwmem0"
81.It Pa /dev/fw0
82.It Pa /dev/fwmem0
83.El
84.Sh SEE ALSO
85.Xr fwe 4 ,
86.Xr fwohci 4 ,
87.Xr pci 4 ,
88.Xr sbp 4 ,
89.Xr fwcontrol 8 ,
90.Xr kldload 8 ,
91.Xr sysctl 8
92.Sh HISTORY
93The
94.Nm
95driver first appeared in
96.Fx 5.0 .
97.Sh AUTHORS
98.An -nosplit
99The
100.Nm
101driver was written by
102.An Katsushi Kobayashi
103and
104.An Hidetoshi Shimokawa
105for the
106.Fx
107project.
108.Sh BUGS
109See
110.Xr fwohci 4
111for security note.
112