xref: /dragonfly/usr.sbin/fwcontrol/fwcontrol.8 (revision 3641b7ca)
1.\" Copyright (c) 2002 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
17.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
22.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23.\" POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/usr.sbin/fwcontrol/fwcontrol.8,v 1.1.2.6 2003/05/01 06:35:00 simokawa Exp $
26.\" $DragonFly: src/usr.sbin/fwcontrol/fwcontrol.8,v 1.11 2008/05/02 02:05:07 swildner Exp $
27.\"
28.\"
29.Dd December 30, 2002
30.Dt FWCONTROL 8
31.Os
32.Sh NAME
33.Nm fwcontrol
34.Nd FireWire control utility
35.Sh SYNOPSIS
36.Nm
37.Op Fl rt
38.Op Fl c Ar node
39.Op Fl d Ar node
40.Op Fl o Ar node
41.Op Fl s Ar node
42.Op Fl l Ar file
43.Op Fl g Ar gap_count
44.Op Fl b Ar pri_req
45.Op Fl R Ar filename
46.Op Fl S Ar filename
47.Sh DESCRIPTION
48The
49.Nm
50utility is designed to provide a way for users to access and control the
51FireWire subsystem.
52Without options,
53.Nm
54will output a list of devices those are/were connected to the bus.
55.Bl -tag -width indent
56.It Fl r
57Initiate bus reset.
58.It Fl t
59Show the topology map.
60.It Fl c Ar node
61Show the configuration ROM on the node.
62.It Fl d Ar node
63Hex dump of the configuration ROM.
64.It Fl o Ar node
65Send a link-on phy packet to the node.
66.It Fl s Ar node
67Write to RESET_START register on the node.
68.It Fl l Ar file
69Load hex dump file of the configuration ROM and parse it.
70.It Fl g Ar gap_count
71Broadcast gap_count by phy_config packet.
72.It Fl i Ar pri_req
73Set PRIORITY_BUDGET register on all supported nodes.
74.It Fl R Ar filename
75Receive DV stream and dump it to a file. Use Ctl-C to stop the receiving.
76Some DV cameras seem not to send the stream if a bus manager exits.
77If you cannot get the stream, try the following commands.
78.Bd -literal -offset indent
79sysctl hw.firewire.try_bmr=0; fwcontrol -r
80.Ed
81.Pp
82The resulting file contains raw DV data excluding isochronous header
83and CIP header. It can be handled by
84.Ic libdv
85in the
86.Xr pkgsrc 7
87collection.
88.It Fl S Ar filename
89Send a DV file as isochronous stream.
90.El
91.Sh FILES
92.Bl -tag -width indent
93.It Pa /dev/fw0
94.El
95.Sh EXAMPLES
96Each DV frame has fixed size and it is easy to edit those frame order.
97.Bd -literal -offset indent
98fwcontrol -R original.dv
99.Ed
100.Pp
101Receive stream.
102.Bd -literal -offset indent
103dd if=original.dv of=first.dv bs=120000 count=30
104.Ed
105.Pp
106Get first 30 frames(NTSC).
107.Bd -literal -offset indent
108dd if=original.dv of=second.dv bs=120000 skip=30 count=30
109.Ed
110.Pp
111Get second 30 frames(NTSC).
112.Bd -literal -offset indent
113cat second.dv first.dv | fwcontrol -S /dev/stdin
114.Ed
115.Pp
116Swap first and second 30 frames and send them to DV recorder.
117.Pp
118For PAL, replace 'bs=120000' with 'bs=144000'.
119.Sh SEE ALSO
120.Xr firewire 4 ,
121.Xr fwe 4 ,
122.Xr fwohci 4 ,
123.Xr sbp 4
124.Sh HISTORY
125The
126.Nm
127utility first appeared in
128.Fx 5.0 .
129.Sh AUTHORS
130.An Hidetoshi Shimokawa Aq simokawa@FreeBSD.org
131.Sh BUGS
132This utility is still under development and provided for debug purpose.
133.Pp
134