usr.sbin/fwcontrol/fwcontrol.8

   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$
  26 .\"
  27 .Dd October 30, 2007
  28 .Dt FWCONTROL 8
  29 .Os
  30 .Sh NAME
  31 .Nm fwcontrol
  32 .Nd FireWire control utility
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl u Ar bus_num
  36 .Op Fl prt
  37 .Op Fl c Ar node
  38 .Op Fl d Ar node
  39 .Op Fl o Ar node
  40 .Op Fl s Ar node
  41 .Op Fl l Ar file
  42 .Op Fl f Ar node
  43 .Op Fl g Ar gap_count
  44 .Op Fl b Ar pri_req
  45 .Op Fl M Ar mode
  46 .Op Fl R Ar filename
  47 .Op Fl S Ar filename
  48 .Op Fl m Ar EUI64 | hostname
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility is designed to provide a way for users to access and control the
  53 .Fx
  54 FireWire subsystem.
  55 Without options,
  56 .Nm
  57 will output a list of devices that are/were connected to the bus.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width indent
  61 .It Fl u Ar bus_num
  62 Specify the FireWire bus number to be operated on.
  63 .It Fl r
  64 Initiate bus reset.
  65 .It Fl t
  66 Show the topology map.
  67 .It Fl p
  68 Dump PHY registers.
  69 .It Fl c Ar node
  70 Show the configuration ROM on the node.
  71 .It Fl d Ar node
  72 Hex dump of the configuration ROM.
  73 .It Fl o Ar node
  74 Send a link-on PHY packet to the node.
  75 .It Fl s Ar node
  76 Write to the
  77 .Dv RESET_START
  78 register on the node.
  79 .It Fl l Ar file
  80 Load hex dump file of the configuration ROM and parse it.
  81 .It Fl f Ar node
  82 Force specified
  83 .Ar node
  84 to be the root node on the next bus reset.
  85 .It Fl g Ar gap_count
  86 Broadcast
  87 .Ar gap_count
  88 by phy_config packet.
  89 .It Fl i Ar pri_req
  90 Set the
  91 .Dv PRIORITY_BUDGET
  92 register on all supported nodes.
  93 .It Fl M Ar mode
  94 Explicitly specify either
  95 .Ar dv
  96 or
  97 .Ar mpeg
  98 mode for the incoming stream.
  99 Only meaningful in case of and must precede the
 100 .Fl R
 101 option. If not specified, the program will try to guess. If you get
 102 an error complaining about "format 0x20", try to force the "mpeg" mode.
 103 .It Fl R Ar filename
 104 Receive DV or MPEG TS stream and dump it to a file.
 105 Use Ctrl-C to stop the receiving.
 106 Some DV cameras seem not to send the stream if a bus manager exists.
 107 If you cannot get the stream, try the following commands:
 108 .Bd -literal -offset indent
 109 sysctl hw.firewire.try_bmr=0
 110 fwcontrol -r
 111 .Ed
 112 .Pp
 113 The resulting file contains raw DV data excluding isochronous header
 114 and CIP header.
 115 It can be handled by
 116 .Nm libdv
 117 in the
 118 .Fx
 119 Ports Collection. Resulting MPEG TS stream can be played and sent over a
 120 network using the VideoLAN
 121 .Nm vlc
 122 tool in the
 123 .Fx
 124 Ports Collection. The stream can be piped directly to
 125 .Nm vlc,
 126 see EXAMPLES.
 127 .It Fl S Ar filename
 128 Send a DV file as isochronous stream.
 129 .It Fl m Ar EUI64 | hostname
 130 Set default fwmem target.
 131 Hostname will be converted to EUI64 using
 132 .Xr eui64 5 .
 133 .El
 134 .Sh FILES
 135 .Bl -tag
 136 .It Pa /dev/fw0.0
 137 .El
 138 .Sh EXAMPLES
 139 Each DV frame has a fixed size and it is easy to edit the frame order.
 140 .Pp
 141 .Dl "fwcontrol -R original.dv"
 142 .Pp
 143 Receive a DV stream with DV camera attached.
 144 .Pp
 145 .Dl "dd if=original.dv of=first.dv bs=120000 count=30"
 146 .Pp
 147 Get first 30 frames(NTSC).
 148 .Pp
 149 .Dl "dd if=original.dv of=second.dv bs=120000 skip=30 count=30"
 150 .Pp
 151 Get second 30 frames(NTSC).
 152 .Pp
 153 .Dl "cat second.dv first.dv | fwcontrol -S /dev/stdin"
 154 .Pp
 155 Swap first and second 30 frames and send them to DV recorder.
 156 .Pp
 157 For PAL, replace
 158 .Dq Li bs=120000
 159 with
 160 .Dq Li bs=144000 .
 161 .Pp
 162 .Dl "fwcontrol -R file.m2t
 163 .Pp
 164 Receive an MPEG TS stream from a camera producing MPEG transport stream.  This
 165 has been tested with SONY HDR-FX1E camera that produces HD MPEG-2 stream at
 166 25 Mbps bandwidth.
 167 .Pp
 168 To send the stream from the camera over the network using TCP (which supprisingly works better with vlc), you can use
 169 .Dl "fwcontrol -R - | nc 192.168.10.11 9000
 170 with
 171 .Nm netcat
 172 from ports and to receive the stream, use
 173 .Dl nc -l -p 9000 | vlc -
 174 .Pp
 175 To netcast via UDP, you need to use
 176 .Nm buffer
 177 program from ports, since vlc is not fast enough to read UDP packets from
 178 buffers and thus it experiences dropouts when run directly. The sending side
 179 can use
 180 .Dl "fwcontrol -R - | nc 192.168.10.11 9000
 181 and to receive the stream, use
 182 .Dl nc -l -u -p 9000 | buffer -s 10k -b 1000 -m 20m -p 5 | vlc -
 183 .Pp
 184 .Pp
 185 For more information on how to work with
 186 .Nm vlc
 187 see its docs.
 188 .Sh SEE ALSO
 189 .Xr firewire 4 ,
 190 .Xr fwe 4 ,
 191 .Xr fwip 4 ,
 192 .Xr fwohci 4 ,
 193 .Xr sbp 4 ,
 194 .Xr mplayer 1 ,
 195 .Xr vlc 1
 196 .Sh HISTORY
 197 The
 198 .Nm
 199 utility first appeared in
 200 .Fx 5.0 .
 201 .Sh AUTHORS
 202 .An Hidetoshi Shimokawa Aq simokawa@FreeBSD.org
 203 .An Petr Holub Aq hopet@ics.muni.cz
 204 - MPEG TS mode.
 205 .Sh BUGS
 206 This utility is still under development and provided for debugging purposes.
 207 Especially MPEG TS reception support is very rudimental and supports only
 208 high-bandwidth MPEG-2 streams (fn field in CIP header equals 3).