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