Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / ieee1394if.4
blob7aefdc83303918bd4b77be38cc5baaf55482e450
1 .\"     $NetBSD: ieee1394if.4,v 1.2 2005/07/12 07:28:46 wiz Exp $
2 .\"
3 .\" Copyright (c) 2005 KIYOHARA Takashi
4 .\" All rights reserved.
5 .\"
6 .\" Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
7 .\" All rights reserved.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. All advertising materials mentioning features or use of this software
18 .\"    must display the acknowledgement as bellow:
19 .\"
20 .\"    This product includes software developed by K. Kobayashi and H. Shimokawa
21 .\"
22 .\" 4. The name of the author may not be used to endorse or promote products
23 .\"    derived from this software without specific prior written permission.
24 .\"
25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
27 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
29 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 .\" POSSIBILITY OF SUCH DAMAGE.
36 .\"
37 .\" $FreeBSD: /repoman/r/ncvs/src/share/man/man4/firewire.4,v 1.11 2004/12/14 19:53:30 brueffer Exp $
38 .\"
39 .Dd June 18, 2005
40 .Dt IEEE1394IF 4
41 .Os
42 .Sh NAME
43 .Nm ieee1394if
44 .Nd IEEE1394 High-performance Serial Bus
45 .Sh SYNOPSIS
46 .Cd "ieee1394if* at fwohci?"
47 .Sh DESCRIPTION
48 .Nx
49 provides machine-independent bus support and raw drivers for IEEE1394
50 interfaces.
51 .Pp
52 The
53 .Nm
54 driver consists of two layers: the controller and the
55 bus layer.
56 The controller attaches to a physical bus
57 (like
58 .Xr pci 4 ) .
59 The
60 .Nm
61 bus attaches to the controller.
62 Additional drivers can be attached to the bus.
63 .Pp
64 Up to 63 devices, including the host itself, can be attached to
65 a IEEE1394 bus.
66 The root node is dynamically assigned with a PHY device function.
67 Also, the other IEEE1394 bus specific parameters,
68 e.g., node ID, cycle master, isochronous resource manager and bus
69 manager, are dynamically assigned, after bus reset is initiated.
70 On the
71 .Nm
72 bus, every device is identified by an EUI 64 address.
73 .Sh FILES
74 .Bl -tag -compact
75 .It Pa /dev/fw0.0
76 .It Pa /dev/fwmem0.0
77 .El
78 .Sh SEE ALSO
79 .Xr fwip 4 ,
80 .Xr fwohci 4 ,
81 .Xr pci 4 ,
82 .Xr sbp 4 ,
83 .Xr fwctl 8 ,
84 .Xr sysctl 8
85 .Sh HISTORY
86 The
87 .Nm
88 driver first appeared in
89 .Fx 5.0 ,
91 .Ic firewire .
92 It was added to
93 .Nx 4.0
94 under its present name.
95 .Sh AUTHORS
96 .An -nosplit
97 The
98 .Nm
99 driver was written by
100 .An Katsushi Kobayashi
102 .An Hidetoshi Shimokawa
103 for the
105 project.
106 It was added to
107 .Nx 4.0
109 .An KIYOHARA Takashi .
110 .Sh BUGS
112 .Xr fwohci 4
113 for security notes.