share/man/man4/firewire.4

   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: src/share/man/man4/firewire.4,v 1.9 2003/12/17 01:13:13 brueffer Exp $
  33 .\" $DragonFly: src/share/man/man4/firewire.4,v 1.6 2008/04/15 19:19:49 swildner Exp $
  34 .\"
  35 .Dd May 23, 2002
  36 .Dt FIREWIRE 4
  37 .Os
  38 .Sh NAME
  39 .Nm firewire
  40 .Nd IEEE1394 High-performance Serial Bus
  41 .Sh SYNOPSIS
  42 .Cd "kldload firewire"
  43 .Pp
  44 or
  45 .Pp
  46 .Cd "device firewire"
  47 .Pp
  48 .In bus/firewire/firewire.h
  49 .Sh DESCRIPTION
  50 .Dx
  51 provides machine-independent bus support and raw drivers for
  52 .Nm
  53 interfaces.
  54 .Pp
  55 The
  56 .Nm
  57 driver consists of two layers: the controller and the
  58 bus layer.
  59 The controller attaches to a physical bus
  60 (like
  61 .Xr pci 4 ) .
  62 The
  63 .Nm
  64 bus attaches to the controller.
  65 Additional drivers can be attached to the bus.
  66 .Pp
  67 Up to 63 devices, including the host itself, can be attached to
  68 a
  69 .Nm
  70 bus.
  71 The root node is dynamically assigned with a PHY device function.
  72 Also, the other
  73 .Nm
  74 bus specific parameters,
  75 e.g., node ID, cycle master, isochronous resource manager and bus
  76 manager, are dynamically assigned, after bus reset is initiated.
  77 On the
  78 .Nm
  79 bus, every device is identified by an EUI 64 address.
  80 .Sh FILES
  81 .Bl -tag -compact
  82 .It Pa /dev/fw0
  83 .It Pa /dev/fwmem0
  84 .El
  85 .Sh SEE ALSO
  86 .Xr fwe 4 ,
  87 .Xr fwohci 4 ,
  88 .Xr pci 4 ,
  89 .Xr sbp 4 ,
  90 .Xr fwcontrol 8 ,
  91 .Xr kldload 8 ,
  92 .Xr sysctl 8
  93 .Sh HISTORY
  94 The
  95 .Nm
  96 driver first appeared in
  97 .Fx 5.0 .
  98 .Sh AUTHORS
  99 .An -nosplit
 100 The
 101 .Nm
 102 driver was written by
 103 .An Katsushi Kobayashi
 104 and
 105 .An Hidetoshi Shimokawa
 106 for the
 107 .Fx
 108 project.
 109 .Sh BUGS
 110 See
 111 .Xr fwohci 4
 112 for security note.