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 .Nm
  72 supports the following commands:
  73 .Bl -tag -width "attach"
  74 .It Ic attach
  75 Attach an ATA
  76 .Ar channel ,
  77 devices on the channel are probed and attached as
  78 is done on boot.
  79 .It Ic detach
  80 Detach an ATA
  81 .Ar channel ,
  82 devices on the channel are removed from the kernel,
  83 and all outstanding transfers etc. are returned back to the system marked
  84 as failed.
  85 .It Ic reinit
  86 Reinitialize an ATA
  87 .Ar channel .
  88 Both devices on the channel are reset and
  89 initialized to the parameters the ATA driver has stored internally.
  90 Devices that has gone bad and no longer responds to the probe, or devices
  91 that has physically been removed are removed from the kernel.
  92 Likewise are devices that show up during a reset, probed and attached.
  93 .It Ic rebuild
  94 Rebuild a RAID1 array on a RAID capable ATA controller.
  95 .It Ic mode
  96 Without the two mode arguments the current transfer modes of both
  97 devices are printed.
  98 If the mode arguments are given, the ATA driver
  99 is asked to change the transfer modes to those given.
 100 The ATA driver
 101 will reject modes that is not supported by the hardware.
 102 Modes are given like
 103 .Dq Li PIO3 ,
 104 .Dq Li udma2 ,
 105 .Dq Li udma100 ,
 106 case does not matter.
 107 If one of the devices mode should not be changed, use a nonexisting mode
 108 as argument (i.e.\&
 109 .Dq Li XXX ) ,
 110 and the mode will remain unchanged.
 111 .It Ic info
 112 Show info about the attached devices on the
 113 .Ar channel ,
 114 currently only the device
 115 name and manufacture/version strings are shown.
 116 .It Ic list
 117 Show info about all attached devices on all active controllers.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr ata 4
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 utility first appeared in
 125 .Fx 5.0 .
 126 .Sh AUTHORS
 127 .An -nosplit
 128 The
 129 .Nm
 130 utility was written by
 131 .An S\(/oren Schmidt
 132 .Aq sos@FreeBSD.org .
 133 .Pp
 134 This manual page was written by
 135 .An S\(/oren Schmidt
 136 .Aq sos@FreeBSD.org .