xref: /freebsd/share/man/man4/firewire.4 (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
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 below:
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.Dd June 6, 2022
33.Dt FIREWIRE 4
34.Os
35.Sh NAME
36.Nm firewire
37.Nd IEEE1394 High-performance Serial Bus
38.Sh SYNOPSIS
39To compile this driver into the kernel,
40place the following line in your
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device firewire"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50firewire_load="YES"
51.Ed
52.Sh DESCRIPTION
53.Fx
54provides machine-independent bus support and raw drivers for
55.Nm
56interfaces.
57.Pp
58The
59.Nm
60driver consists of two layers: the controller and the
61bus layer.
62The controller attaches to a physical bus
63(like
64.Xr pci 4 ) .
65The
66.Nm
67bus attaches to the controller.
68Additional drivers can be attached to the bus.
69.Pp
70Up to 63 devices, including the host itself, can be attached to
71a
72.Nm
73bus.
74The root node is dynamically assigned with a PHY device function.
75Also, the other
76.Nm
77bus specific parameters,
78e.g., node ID, cycle master, isochronous resource manager and bus
79manager, are dynamically assigned, after bus reset is initiated.
80On the
81.Nm
82bus, every device is identified by an EUI 64 address.
83.Pp
84Debugging over the firewire interface is possible with the
85.Xr dcons 4
86driver.
87Please see
88.Lk https://docs.freebsd.org/en/books/developers-handbook/kerneldebug/#kerneldebug-dcons
89for details on how to setup debugging with firewire.
90.Sh FILES
91.Bl -tag -width "Pa /dev/fwmem0.0" -compact
92.It Pa /dev/fw0.0
93.It Pa /dev/fwmem0.0
94.El
95.Sh SEE ALSO
96.Xr dcons 4 ,
97.Xr fwe 4 ,
98.Xr fwip 4 ,
99.Xr fwohci 4 ,
100.Xr pci 4 ,
101.Xr sbp 4 ,
102.Xr eui64 5 ,
103.Xr fwcontrol 8 ,
104.Xr kldload 8 ,
105.Xr sysctl 8
106.Sh HISTORY
107The
108.Nm
109driver first appeared in
110.Fx 5.0 .
111.Sh AUTHORS
112.An -nosplit
113The
114.Nm
115driver was written by
116.An Katsushi Kobayashi
117and
118.An Hidetoshi Shimokawa
119for the
120.Fx
121project.
122.Sh BUGS
123See
124.Xr fwohci 4
125for security notes.
126