usr.sbin/fwctl/fwctl.8

   1 .\"     $NetBSD: fwctl.8,v 1.7 2009/04/08 14:33:12 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2005 KIYOHARA Takashi
   4 .\" All rights reserved.
   5 .\"
   6 .\" Copyright (c) 2002 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  22 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD: src/usr.sbin/fwcontrol/fwcontrol.8,v 1.21 2007/10/31 05:59:17 brueffer Exp $
  31 .\"
  32 .Dd May 18, 2009
  33 .Dt FWCTL 8
  34 .Os
  35 .Sh NAME
  36 .Nm fwctl
  37 .Nd IEEE1394 control utility
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl prt
  41 .Op Fl b Ar pri_req
  42 .Op Fl c Ar node
  43 .Op Fl d Ar node
  44 .Op Fl g Ar gap_count
  45 .Op Fl l Ar file
  46 .Op Fl M Ar mode
  47 .Op Fl m Ar EUI64 | hostname
  48 .Op Fl o Ar node
  49 .Op Fl R Ar filename
  50 .Op Fl S Ar filename
  51 .Op Fl s Ar node
  52 .Op Fl u Ar bus_num
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility is designed to provide a way for users to access and control
  57 the
  58 .Nx
  59 IEEE1394 subsystem.
  60 Without options,
  61 .Nm
  62 will output a list of devices that are/were connected to the bus.
  63 .Pp
  64 The following options are available:
  65 .Bl -tag -width XmXEUI64XhostnameXX -offset indent
  66 .It Fl b Ar pri_req
  67 Set the
  68 .Dv PRIORITY_BUDGET
  69 register on all supported nodes.
  70 .It Fl c Ar node
  71 Show the configuration ROM on the node.
  72 .It Fl d Ar node
  73 Hex dump of the configuration ROM.
  74 .It Fl g Ar gap_count
  75 Broadcast
  76 .Ar gap_count
  77 by phy_config packet.
  78 .It Fl l Ar file
  79 Load hex dump file of the configuration ROM and parse it.
  80 .It Fl M Ar modeExplicitly specify either
  81 .Ar dv
  82 or
  83 .Ar mpeg
  84 mode for the incoming stream.
  85 Only meaningful in case of and must precede the
  86 .Fl R
  87 option.
  88 If not specified, the program will try to guess.
  89 If you get an error complaining about
  90 .Dq format 0x20 ,
  91 try to force the
  92 .Ar mpeg
  93 mode.
  94 .It Fl m Ar EUI64 | hostname
  95 Set default fwmem target.
  96 Hostname will be converted to EUI64.
  97 .It Fl o Ar node
  98 Send a link-on PHY packet to the node.
  99 .It Fl p
 100 Dump PHY registers.
 101 .It Fl R Ar filename
 102 Receive DV or MPEG TS stream and dump it to a file.
 103 Use Ctrl-C to stop receiving.
 104 Some DV cameras seem not to send the stream if a bus manager exits.
 105 If you cannot get the stream, try the following commands:
 106 .Bd -literal -offset indent
 107 sysctl hw.ieee1394if.try_bmr=0
 108 fwctl -r
 109 .Ed
 110 .Pp
 111 The resulting file contains raw DV data excluding isochronous header
 112 and CIP header.
 113 It can be handled by the
 114 .Pa pkgsrc/multimedia/libdv
 115 package.
 116 The resulting MPEG TS stream can be played and sent over a network using
 117 the VideoLAN tool
 118 .Pa ( pkgsrc/multimedia/vlc ) .
 119 The stream can be piped directly to
 120 .Nm vlc ,
 121 see
 122 .Sx EXAMPLES .
 123 .It Fl r
 124 Initiate bus reset.
 125 .It Fl S Ar filename
 126 Send a DV file as isochronous stream.
 127 .It Fl s Ar node
 128 Write to the
 129 .Dv RESET_START
 130 register on the node.
 131 .It Fl t
 132 Show the topology map.
 133 .It Fl u Ar bus_num
 134 Specify the IEEE1394 bus number to be operated on.
 135 .El
 136 .Sh FILES
 137 .Bl -tag
 138 .It Pa /dev/fw0.0
 139 .El
 140 .Sh EXAMPLES
 141 Each DV frame has a fixed size and it is easy to edit the frame order.
 142 .Pp
 143 .Dl "fwctl -R original.dv"
 144 .Pp
 145 Receive a DV stream with DV camera attached.
 146 .Pp
 147 .Dl "dd if=original.dv of=first.dv bs=120000 count=30"
 148 .Pp
 149 Get first 30 frames (NTSC).
 150 .Pp
 151 .Dl "dd if=original.dv of=second.dv bs=120000 skip=30 count=30"
 152 .Pp
 153 Get second 30 frames (NTSC).
 154 .Pp
 155 .Dl "cat second.dv first.dv | fwctl -S /dev/stdin"
 156 .Pp
 157 Swap first and second 30 frames and send them to DV recorder.
 158 .Pp
 159 For PAL, replace
 160 .Dq Li bs=120000
 161 with
 162 .Dq Li bs=144000 .
 163 .Pp
 164 .Dl "fwcontrol -R file.m2t"
 165 .Pp
 166 Receive an MPEG TS stream from a camera producing MPEG transport stream.
 167 This has been tested with SONY HDR-FX1E camera that produces HD
 168 MPEG-2 stream at 25 Mbps bandwidth.
 169 .Pp
 170 To send the stream from the camera over the network using TCP (which
 171 supprisingly works better with vlc), you can use
 172 .Dl "fwcontrol -R - | nc 192.168.10.11 9000"
 173 with
 174 .Pa pkgsrc/net/netcat
 175 and to receive the stream, use
 176 .Dl nc -l -p 9000 | vlc -
 177 .Pp
 178 To netcast via UDP, you need to use
 179 .Pa pkgsrc/misc/buffer ,
 180 since vlc is not fast enough to read UDP packets from
 181 buffers and thus it experiences dropouts when run directly.
 182 The sending side can use
 183 .Dl "fwcontrol -R - | nc 192.168.10.11 9000"
 184 and to receive the stream, use
 185 .Dl nc -l -u -p 9000 | buffer -s 10k -b 1000 -m 20m -p 5 | vlc -
 186 .Pp
 187 For more information on how to work with
 188 .Nm vlc
 189 see its documentation.
 190 .Sh SEE ALSO
 191 .Xr mplayer 1 ,
 192 .Xr vlc 1 ,
 193 .Xr fwip 4 ,
 194 .Xr fwohci 4 ,
 195 .Xr ieee1394if 4 ,
 196 .Xr sbp 4
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 command first appeared in
 201 .Fx 5.0 ,
 202 as
 203 .Ic fwcontrol .
 204 It was added to
 205 .Nx 4.0
 206 under its present name.
 207 .Sh AUTHORS
 208 .An Hidetoshi Shimokawa Aq simokawa@FreeBSD.org
 209 .An Petr Holub Aq hopet@ics.muni.cz
 210 - MPEG TS mode.
 211 .An KIYOHARA Takashi Aq kiyohara@NetBSD.org
 212 .Sh BUGS
 213 This utility is still under development and provided for debugging
 214 purposes.
 215 Especially MPEG TS reception support is very rudimental and supports only
 216 high-bandwidth MPEG-2 streams (fn field in CIP header equals 3).