xref: /netbsd/sbin/atactl/atactl.8 (revision c4a72b64)
1.\"	$NetBSD: atactl.8,v 1.13 2002/10/01 13:40:23 wiz Exp $
2.\"
3.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Ken Hornstein.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd November 18, 1998
38.Dt ATACTL 8
39.Os
40.Sh NAME
41.Nm atactl
42.Nd a program to manipulate ATA (IDE) devices
43.Sh SYNOPSIS
44.Nm
45.Ar device
46.Ar command
47.Oo
48.Ar arg Oo ...
49.Oc
50.Oc
51.Sh DESCRIPTION
52.Nm
53allows a user or system administrator to issue commands to and otherwise
54control devices which reside on standard IDE and ATA controllers.
55It is used by specifying a device to manipulate,
56the command to perform, and any arguments the command may require.
57.Sh DEVICE COMMANDS
58The following commands may be used on IDE and ATA devices.
59Note that not all devices support all commands.
60.Pp
61.Cm identify
62.Pp
63Identify the specified device, displaying the device's vendor, product,
64revision strings, and the device's capabilities.
65.Pp
66.Cm idle
67.Pp
68Place the specified device into Idle mode.
69This mode may consume less power than Active mode.
70.Pp
71.Cm standby
72.Pp
73Place the specified device into Standby mode.
74This mode will consume less power than Idle mode.
75.Pp
76.Cm sleep
77.Pp
78Place the specified device into Sleep mode.
79This mode will consume less power than Standby mode,
80but requires a device reset to resume operation.
81Typically the
82.Xr wd 4
83driver performs this reset automatically,
84but this should still be used with caution.
85.Pp
86.Cm setidle
87.Ar idle-timer
88.Pp
89Places the specified device into Idle mode,
90and sets the Idle timer to
91.Ar idle-timer
92seconds.
93A value of 0 will disable the Idle timer.
94.Pp
95.Cm setstandby
96.Ar standby-timer
97.Pp
98Places the specified device into Standby mode,
99and sets the Standby timer to
100.Ar standby-timer
101seconds.
102A value of 0 will disable the Standby timer.
103.Pp
104.Cm checkpower
105.Pp
106Will print out if the device is in Active, Idle, or Standby power
107management mode.
108.Pp
109.Cm smart
110.Ar [enable | disable | status]
111.Pp
112Controls SMART feature set of the specified device.
113SMART stands for Self-Monitoring, Analysis, and Reporting Technology.
114It provides an early warning system by comparing subtle operation
115characteristics to those determined in vendor testing
116to precede device failures.
117.Pp
118.Ar enable
119.Pp
120Enables access to SMART capabilities within the device.
121Prior to being enabled, a SMART capable device neither
122monitors nor saves SMART attribute values.
123The state of SMART, either enabled or disabled, will
124be preserved by the device across power cycles.
125.Pp
126.Ar disable
127.Pp
128Disables access to SMART capabilities within the device.
129Attribute values will be saved, and will no longer be monitored.
130.Pp
131.Ar status
132.Pp
133Reports whether SMART is supported by the device, and whether SMART is
134enabled on the device (can only be determined on ATA6 or better devices).
135If SMART is enabled, then a table of attribute information is printed.
136Attributes are the specific performance or calibration parameters that
137are used in analyzing the status of the device.
138The specific set of attributes being used and the identity of
139these attributes is vendor specific and proprietary.
140.Pp
141Attribute values are used to represent the relative reliability of
142individual performance or calibration parameters.
143The valid range of attribute values is from 1 to 253 decimal.
144Lower values indicate that the analysis algorithms being used by the device
145are predicting a higher probability of a degrading or faulty condition.
146.Pp
147Each attribute value has a corresponding threshold limit which is used for
148direct comparison to the attribute value to indicate the existence of a
149degrading or faulty condition.
150The numerical value of the attribute thresholds are determined by the
151device manufacturer through design and reliability testing and analysis.
152Each attribute threshold represents the lowest limit to which its
153corresponding attribute value can equal while still retaining a
154positive reliability status.
155.Pp
156If the crit field is "yes" then negative reliability of this attribute
157predicts imminent data loss.
158Otherwise it merely indicates that the intended design life period
159of usage or age has been exceeded.
160The collect field indicates whether this attribute is updated while the
161device is online.
162The reliability field indicates whether the attribute
163value is within the acceptable threshold.
164.Sh SEE ALSO
165.Xr ioctl 2 ,
166.Xr wd 4
167.Sh HISTORY
168The
169.Nm
170command first appeared in
171.Nx 1.4 .
172.Sh AUTHORS
173The
174.Nm
175command was written by Ken Hornstein.
176It was based heavily on the
177.Xr scsictl 8
178command written by Jason R. Thorpe.
179.Sh BUGS
180The output from the
181.Cm identify
182command is rather ugly.
183