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: src/usr.sbin/fwcontrol/fwcontrol.8,v 1.1.2.6 2003/05/01 06:35:00 simokawa Exp $
  26 .\"
  27 .Dd December 30, 2002
  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 rt
  36 .Op Fl c Ar node
  37 .Op Fl d Ar node
  38 .Op Fl o Ar node
  39 .Op Fl s Ar node
  40 .Op Fl l Ar file
  41 .Op Fl g Ar gap_count
  42 .Op Fl b Ar pri_req
  43 .Op Fl R Ar filename
  44 .Op Fl S Ar filename
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is designed to provide a way for users to access and control the
  49 FireWire subsystem.
  50 Without options,
  51 .Nm
  52 will output a list of devices those are/were connected to the bus.
  53 .Bl -tag -width indent
  54 .It Fl r
  55 Initiate bus reset.
  56 .It Fl t
  57 Show the topology map.
  58 .It Fl c Ar node
  59 Show the configuration ROM on the node.
  60 .It Fl d Ar node
  61 Hex dump of the configuration ROM.
  62 .It Fl o Ar node
  63 Send a link-on phy packet to the node.
  64 .It Fl s Ar node
  65 Write to RESET_START register on the node.
  66 .It Fl l Ar file
  67 Load hex dump file of the configuration ROM and parse it.
  68 .It Fl g Ar gap_count
  69 Broadcast gap_count by phy_config packet.
  70 .It Fl i Ar pri_req
  71 Set PRIORITY_BUDGET register on all supported nodes.
  72 .It Fl R Ar filename
  73 Receive DV stream and dump it to a file. Use Ctl-C to stop the receiving.
  74 Some DV cameras seem not to send the stream if a bus manager exits.
  75 If you cannot get the stream, try the following commands.
  76 .Bd -literal -offset indent
  77 sysctl hw.firewire.try_bmr=0; fwcontrol -r
  78 .Ed
  79 .Pp
  80 The resulting file contains raw DV data excluding isochronous header
  81 and CIP header. It can be handled by
  82 .Ic libdv
  83 in the
  84 .Xr dports 7
  85 collection.
  86 .It Fl S Ar filename
  87 Send a DV file as isochronous stream.
  88 .El
  89 .Sh FILES
  90 .Bl -tag -width indent
  91 .It Pa /dev/fw0
  92 .El
  93 .Sh EXAMPLES
  94 Each DV frame has fixed size and it is easy to edit those frame order.
  95 .Bd -literal -offset indent
  96 fwcontrol -R original.dv
  97 .Ed
  98 .Pp
  99 Receive stream.
 100 .Bd -literal -offset indent
 101 dd if=original.dv of=first.dv bs=120000 count=30
 102 .Ed
 103 .Pp
 104 Get first 30 frames(NTSC).
 105 .Bd -literal -offset indent
 106 dd if=original.dv of=second.dv bs=120000 skip=30 count=30
 107 .Ed
 108 .Pp
 109 Get second 30 frames(NTSC).
 110 .Bd -literal -offset indent
 111 cat second.dv first.dv | fwcontrol -S /dev/stdin
 112 .Ed
 113 .Pp
 114 Swap first and second 30 frames and send them to DV recorder.
 115 .Pp
 116 For PAL, replace 'bs=120000' with 'bs=144000'.
 117 .Sh SEE ALSO
 118 .Xr firewire 4 ,
 119 .Xr fwe 4 ,
 120 .Xr fwohci 4 ,
 121 .Xr sbp 4
 122 .Sh HISTORY
 123 The
 124 .Nm
 125 utility first appeared in
 126 .Fx 5.0 .
 127 .Sh AUTHORS
 128 .An Hidetoshi Shimokawa Aq Mt simokawa@FreeBSD.org
 129 .Sh BUGS
 130 This utility is still under development and provided for debug purpose.