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 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 create
  50 .Ar type Oo Ar interleave Oc Ar disk0 ... diskN
  51 .Nm
  52 .Ic delete
  53 .Ar raid
  54 .Nm
  55 .Ic rebuild
  56 .Ar raid
  57 .Nm
  58 .Ic status
  59 .Ar raid
  60 .Nm
  61 .Ic mode
  62 .Ar channel
  63 .Op Ar mastermode slavemode
  64 .Nm
  65 .Ic info
  66 .Ar channel
  67 .Nm
  68 .Ic cap
  69 .Ar channel device
  70 .Nm
  71 .Ic enclosure
  72 .Ar channel device
  73 .Nm
  74 .Ic list
  75 .Sh DESCRIPTION
  76 .Nm
  77 is a control program that provides the user access and control to the
  78 .Fx
  79 .Xr ata 4
  80 subsystem.
  81 .Pp
  82 .Nm
  83 can cause severe system crashes and loss of data if used improperly, please
  84 exercise caution when using this command!
  85 .Pp
  86 The
  87 .Ar channel
  88 argument is the number of the ATA channel on which to operate.
  89 The following commands are supported:
  90 .Bl -tag -width "rebuild"
  91 .It Ic attach
  92 Attach an ATA
  93 .Ar channel ,
  94 devices on the channel are probed and attached as
  95 is done on boot.
  96 .It Ic detach
  97 Detach an ATA
  98 .Ar channel ,
  99 devices on the channel are removed from the kernel,
 100 and all outstanding transfers etc. are returned back to the system marked
 101 as failed.
 102 .It Ic reinit
 103 Reinitialize an ATA
 104 .Ar channel .
 105 Both devices on the channel are reset and
 106 initialized to the parameters the ATA driver has stored internally.
 107 Devices that has gone bad and no longer responds to the probe, or devices
 108 that has physically been removed are removed from the kernel.
 109 Likewise are devices that show up during a reset, probed and attached.
 110 .It Ic create
 111 Create a
 112 .Ar type
 113 ATA RAID.
 114 The type can be
 115 .Cm RAID0
 116 (stripe),
 117 .Cm RAID1
 118 (mirror),
 119 .Cm RAID0+1
 120 or
 121 .Cm SPAN
 122 (JBOD).
 123 In case the RAID has a
 124 .Cm RAID0
 125 component,
 126 the
 127 .Ar interleave
 128 must be specified in number of sectors.
 129 The RAID will be created
 130 of the individual disks named
 131 .Bk -words
 132 .Ar disk0 ... diskN .
 133 .Ek
 134 .Pp
 135 Although the ATA driver allows for creating an ATA RAID on disks on any
 136 controller, there are restrictions.
 137 It is only possible to boot on
 138 an array if it is either located on a
 139 .Dq real
 140 ATA RAID controller like
 141 the Promise or Highpoint controllers, or if the RAID declared is of
 142 .Cm RAID1
 143 or
 144 .Cm SPAN
 145 type; in case of a
 146 .Cm SPAN ,
 147 the partition to boot must
 148 reside on the first disk in the SPAN.
 149 .It Ic delete
 150 Delete a RAID array on a RAID capable ATA controller.
 151 .It Ic rebuild
 152 Rebuild a RAID1 array on a RAID capable ATA controller.
 153 .It Ic status
 154 Get the status of an ATA RAID.
 155 .It Ic mode
 156 Without the two mode arguments, the current transfer modes of both
 157 devices are printed.
 158 If the mode arguments are given, the ATA driver
 159 is asked to change the transfer modes to those given.
 160 The ATA driver
 161 will reject modes that are not supported by the hardware.
 162 Modes are given like
 163 .Dq Li PIO3 ,
 164 .Dq Li udma2 ,
 165 .Dq Li udma100 ,
 166 case does not matter.
 167 If one of the devices mode should not be changed, use a nonexisting mode
 168 as argument (i.e.\&
 169 .Dq Li XXX ) ,
 170 and the mode will remain unchanged.
 171 .It Ic info
 172 Show info about the attached devices on the
 173 .Ar channel ,
 174 the device name and manufacture/version strings are shown.
 175 .It Ic cap
 176 Show detailed info about the device on
 177 .Ar channel device
 178 where device is 0 for master and 1 for slave.
 179 .It Ic enclosure
 180 Show detailed info about the encolsure on
 181 .Ar channel device
 182 where device is 0 for master and 1 for slave.
 183 Fan RPM speed, enclosure temperature, 5V and 12V levels are shown.
 184 .It Ic list
 185 Show info about all attached devices on all active controllers.
 186 .El
 187 .Sh SEE ALSO
 188 .Xr ata 4
 189 .Sh HISTORY
 190 The
 191 .Nm
 192 utility first appeared in
 193 .Fx 4.6 .
 194 .Sh AUTHORS
 195 .An -nosplit
 196 The
 197 .Nm
 198 utility was written by
 199 .An S\(/oren Schmidt
 200 .Aq sos@FreeBSD.org .
 201 .Pp
 202 This manual page was written by
 203 .An S\(/oren Schmidt
 204 .Aq sos@FreeBSD.org .