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 January 23, 2025 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 DEPRECATION NOTICE 53The 54.Nm 55driver is slated to be removed prior to 56.Fx 16.0 . 57.Sh DESCRIPTION 58.Fx 59provides machine-independent bus support and raw drivers for 60.Nm 61interfaces. 62.Pp 63The 64.Nm 65driver consists of two layers: the controller and the 66bus layer. 67The controller attaches to a physical bus 68(like 69.Xr pci 4 ) . 70The 71.Nm 72bus attaches to the controller. 73Additional drivers can be attached to the bus. 74.Pp 75Up to 63 devices, including the host itself, can be attached to 76a 77.Nm 78bus. 79The root node is dynamically assigned with a PHY device function. 80Also, the other 81.Nm 82bus specific parameters, 83e.g., node ID, cycle master, isochronous resource manager and bus 84manager, are dynamically assigned, after bus reset is initiated. 85On the 86.Nm 87bus, every device is identified by an EUI 64 address. 88.Pp 89Debugging over the firewire interface is possible with the 90.Xr dcons 4 91driver. 92Please see 93.Lk https://docs.freebsd.org/en/books/developers-handbook/kerneldebug/#kerneldebug-dcons 94for details on how to setup debugging with firewire. 95.Sh FILES 96.Bl -tag -width "Pa /dev/fwmem0.0" -compact 97.It Pa /dev/fw0.0 98.It Pa /dev/fwmem0.0 99.El 100.Sh SEE ALSO 101.Xr dcons 4 , 102.Xr fwe 4 , 103.Xr fwip 4 , 104.Xr fwohci 4 , 105.Xr pci 4 , 106.Xr sbp 4 , 107.Xr eui64 5 , 108.Xr fwcontrol 8 , 109.Xr kldload 8 , 110.Xr sysctl 8 111.Sh HISTORY 112The 113.Nm 114driver first appeared in 115.Fx 5.0 . 116.Sh AUTHORS 117.An -nosplit 118The 119.Nm 120driver was written by 121.An Katsushi Kobayashi 122and 123.An Hidetoshi Shimokawa 124for the 125.Fx 126project. 127.Sh BUGS 128See 129.Xr fwohci 4 130for security notes. 131