sbin/atacontrol/atacontrol.8

   1 .\"
   2 .\" Copyright (c) 2000,2001,2002 Søren Schmidt <sos@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd May 17, 2001
  29 .Dt ATACONTROL 8
  30 .Os
  31 .Sh NAME
  32 .Nm atacontrol
  33 .Nd ATA device driver control program
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Aq Ar command
  37 .Ar channel Op Ar args
  38 .Pp
  39 .Nm
  40 .Ic attach
  41 .Ar channel
  42 .Nm
  43 .Ic detach
  44 .Ar channel
  45 .Nm
  46 .Ic reinit
  47 .Ar channel
  48 .Nm
  49 .Ic rebuild
  50 .Ar raid
  51 .Nm
  52 .Ic mode
  53 .Ar channel
  54 .Op Ar mastermode slavemode
  55 .Nm
  56 .Ic info
  57 .Ar channel
  58 .Nm
  59 .Ic list
  60 .Sh DESCRIPTION
  61 .Nm
  62 is a control program that provides the user access and control to the
  63 .Fx
  64 .Xr ata 4
  65 subsystem.
  66 .Pp
  67 .Nm
  68 can cause severe system crashes and loss of data if used improperly, please
  69 exercise caution when using this command!
  70 .Pp
  71 The
  72 .Ar channel
  73 argument is the number of the ATA channel on which to operate.
  74 The following commands are supported:
  75 .Bl -tag -width "rebuild"
  76 .It Ic attach
  77 Attach an ATA
  78 .Ar channel ,
  79 devices on the channel are probed and attached as
  80 is done on boot.
  81 .It Ic detach
  82 Detach an ATA
  83 .Ar channel ,
  84 devices on the channel are removed from the kernel,
  85 and all outstanding transfers etc. are returned back to the system marked
  86 as failed.
  87 .It Ic reinit
  88 Reinitialize an ATA
  89 .Ar channel .
  90 Both devices on the channel are reset and
  91 initialized to the parameters the ATA driver has stored internally.
  92 Devices that has gone bad and no longer responds to the probe, or devices
  93 that has physically been removed are removed from the kernel.
  94 Likewise are devices that show up during a reset, probed and attached.
  95 .It Ic rebuild
  96 Rebuild a RAID1 array on a RAID capable ATA controller.
  97 .It Ic mode
  98 Without the two mode arguments the current transfer modes of both
  99 devices are printed.
 100 If the mode arguments are given, the ATA driver
 101 is asked to change the transfer modes to those given.
 102 The ATA driver
 103 will reject modes that is not supported by the hardware.
 104 Modes are given like
 105 .Dq Li PIO3 ,
 106 .Dq Li udma2 ,
 107 .Dq Li udma100 ,
 108 case does not matter.
 109 If one of the devices mode should not be changed, use a nonexisting mode
 110 as argument (i.e.\&
 111 .Dq Li XXX ) ,
 112 and the mode will remain unchanged.
 113 .It Ic info
 114 Show info about the attached devices on the
 115 .Ar channel ,
 116 currently only the device
 117 name and manufacture/version strings are shown.
 118 .It Ic list
 119 Show info about all attached devices on all active controllers.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr ata 4
 123 .Sh HISTORY
 124 The
 125 .Nm
 126 utility first appeared in
 127 .Fx 4.6 .
 128 .Sh AUTHORS
 129 .An -nosplit
 130 The
 131 .Nm
 132 utility was written by
 133 .An S\(/oren Schmidt
 134 .Aq sos@FreeBSD.org .
 135 .Pp
 136 This manual page was written by
 137 .An S\(/oren Schmidt
 138 .Aq sos@FreeBSD.org .