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 December 14, 2004
  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 g Ar gap_count
  43 .Op Fl b Ar pri_req
  44 .Op Fl R Ar filename
  45 .Op Fl S Ar filename
  46 .Op Fl m Ar EUI64 | hostname
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility is designed to provide a way for users to access and control the
  51 .Fx
  52 FireWire subsystem.
  53 Without options,
  54 .Nm
  55 will output a list of devices that are/were connected to the bus.
  56 .Pp
  57 The following options are available:
  58 .Bl -tag -width indent
  59 .It Fl u Ar bus_num
  60 Specify the FireWire bus number to be operated on.
  61 .It Fl r
  62 Initiate bus reset.
  63 .It Fl t
  64 Show the topology map.
  65 .It Fl p
  66 Dump PHY registers.
  67 .It Fl c Ar node
  68 Show the configuration ROM on the node.
  69 .It Fl d Ar node
  70 Hex dump of the configuration ROM.
  71 .It Fl o Ar node
  72 Send a link-on PHY packet to the node.
  73 .It Fl s Ar node
  74 Write to the
  75 .Dv RESET_START
  76 register on the node.
  77 .It Fl l Ar file
  78 Load hex dump file of the configuration ROM and parse it.
  79 .It Fl g Ar gap_count
  80 Broadcast
  81 .Ar gap_count
  82 by phy_config packet.
  83 .It Fl i Ar pri_req
  84 Set the
  85 .Dv PRIORITY_BUDGET
  86 register on all supported nodes.
  87 .It Fl R Ar filename
  88 Receive DV stream and dump it to a file.
  89 Use Ctrl-C to stop the receiving.
  90 Some DV cameras seem not to send the stream if a bus manager exits.
  91 If you cannot get the stream, try the following commands:
  92 .Bd -literal -offset indent
  93 sysctl hw.firewire.try_bmr=0
  94 fwcontrol -r
  95 .Ed
  96 .Pp
  97 The resulting file contains raw DV data excluding isochronous header
  98 and CIP header.
  99 It can be handled by
 100 .Nm libdv
 101 in the
 102 .Fx
 103 Ports Collection.
 104 .It Fl S Ar filename
 105 Send a DV file as isochronous stream.
 106 .It Fl m Ar EUI64 | hostname
 107 Set default fwmem target.
 108 Hostname will be converted to EUI64 using
 109 .Xr eui64 5 .
 110 .El
 111 .Sh FILES
 112 .Bl -tag
 113 .It Pa /dev/fw0.0
 114 .El
 115 .Sh EXAMPLES
 116 Each DV frame has a fixed size and it is easy to edit the frame order.
 117 .Pp
 118 .Dl "fwcontrol -R original.dv"
 119 .Pp
 120 Receive stream.
 121 .Pp
 122 .Dl "dd if=original.dv of=first.dv bs=120000 count=30"
 123 .Pp
 124 Get first 30 frames(NTSC).
 125 .Pp
 126 .Dl "dd if=original.dv of=second.dv bs=120000 skip=30 count=30"
 127 .Pp
 128 Get second 30 frames(NTSC).
 129 .Pp
 130 .Dl "cat second.dv first.dv | fwcontrol -S /dev/stdin"
 131 .Pp
 132 Swap first and second 30 frames and send them to DV recorder.
 133 .Pp
 134 For PAL, replace
 135 .Dq Li bs=120000
 136 with
 137 .Dq Li bs=144000 .
 138 .Sh SEE ALSO
 139 .Xr firewire 4 ,
 140 .Xr fwe 4 ,
 141 .Xr fwip 4 ,
 142 .Xr fwohci 4 ,
 143 .Xr sbp 4
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 utility first appeared in
 148 .Fx 5.0 .
 149 .Sh AUTHORS
 150 .An Hidetoshi Shimokawa Aq simokawa@FreeBSD.org
 151 .Sh BUGS
 152 This utility is still under development and provided for debugging purposes.