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