xref: /freebsd/share/man/man4/firewire.4 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
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$
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 "device firewire"
42.Cd "device fwohci"
43.Pp
44.In dev/firewire/firewire.h
45.Sh DESCRIPTION
46.Fx
47provides machine-independent bus support and raw drivers for
48.Nm
49interfaces.
50.Pp
51The
52.Nm
53driver consists of two layers: the controller and the
54bus layer.
55The controller attaches to a physical bus
56(like
57.Xr pci 4 ) .
58The
59.Nm
60bus attaches to the controller.
61And the additional driver can be attached to the bus.
62.Pp
63Up to 63 devices, including the host itself, can be attached to
64a
65.Nm
66bus.
67The root node is dynamically assigned with PHY device function.
68Also, the other
69.Nm
70bus specific parameters,
71e.g., node ID, cycle master, isochronous resource manager and bus
72manager, are dynamically assigned, after bus reset is initiated.
73On
74.Nm
75bus, every device is identified with EUI 64 address.
76.Sh SEE ALSO
77.Xr fwcontrol 8 ,
78.Xr fwe 4 ,
79.Xr fwohci 4 ,
80.Xr pci 4 ,
81.Xr sbp 4
82.Sh HISTORY
83The
84.Nm
85driver first appeared in
86.Fx 5.0 .
87.Sh AUTHORS
88.An -nosplit
89The
90.Nm
91driver was written by
92.An Katsushi Kobayashi
93and
94.An Hidetoshi Shimokawa
95for the
96.Fx
97project.
98