sbin/atacontrol/atacontrol.8

   1 .\"
   2 .\" Copyright (c) 2000,2001 Søren Schmidt
   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 mode
  50 .Ar channel
  51 .Op Ar mastermode slavemode
  52 .Nm
  53 .Ic info
  54 .Ar channel
  55 .Nm
  56 .Ic list
  57 .Sh DESCRIPTION
  58 .Nm
  59 is a control program that provides the user access and control to the
  60 .Fx
  61 .Xr ata 4
  62 subsystem.
  63 .Pp
  64 .Nm
  65 can cause severe system crashes and loss of data if used improperly, please
  66 exercise caution when using this command!
  67 .Pp
  68 .Nm
  69 supports the following commands:
  70 .Bl -tag -width "attach"
  71 .It Ic attach
  72 Attach an ATA
  73 .Ar channel ,
  74 devices on the channel are probed and attached as
  75 is done on boot.
  76 .It Ic detach
  77 Detach an ATA
  78 .Ar channel ,
  79 devices on the channel are removed from the kernel,
  80 and all outstanding transfers etc. are returned back to the system marked
  81 as failed.
  82 .It Ic reinit
  83 Reinitialize an ATA
  84 .Ar channel .
  85 Both devices on the channel are reset and
  86 initialized to the parameters the ATA driver has stored internally.
  87 Devices that has gone bad and no longer responds to the probe, or devices
  88 that has physically been removed are removed from the kernel.
  89 Likewise
  90 are devices that show up during a reset, probed and attached.
  91 .It Ic mode
  92 Without the two mode arguments the current transfer modes of both
  93 devices are printed.
  94 If the mode arguments are given, the ATA driver
  95 is asked to change the transfer modes to those given.
  96 The ATA driver
  97 will reject modes that is not supported by the hardware.
  98 Modes are given like
  99 .Dq Li PIO3 ,
 100 .Dq Li udma2 ,
 101 .Dq Li udma100 ,
 102 case does not matter.
 103 If one of the devices mode should not be changed, use a nonexisting mode
 104 as argument (i.e.\&
 105 .Dq Li XXX ) ,
 106 and the mode will remain unchanged.
 107 .It Ic info
 108 Show info about the attached devices on the
 109 .Ar channel ,
 110 currently only the device
 111 name and manufacture/version strings are shown.
 112 .It Ic list
 113 Show info about all attached devices on all active controllers.
 114 .El
 115 .Sh SEE ALSO
 116 .Xr ata 4
 117 .Sh HISTORY
 118 The
 119 .Nm
 120 utility first appeared in
 121 .Fx 5.0 .
 122 .Sh AUTHORS
 123 .An -nosplit
 124 The
 125 .Nm
 126 utility was written by
 127 .An S\(/oren Schmidt
 128 .Aq sos@FreeBSD.org .
 129 .Pp
 130 This manual page was written by
 131 .An S\(/oren Schmidt
 132 .Aq sos@FreeBSD.org .