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