From c9b31da3ef1504b43dd8e5fc75f977e16b9dd9dd Mon Sep 17 00:00:00 2001 From: Constantine Sapuntzakis Date: Tue, 21 Sep 1999 04:58:15 +0000 Subject: Add atactl utility from NetBSD. This utility gives detailed inquiry info as well as letting you spin down disks, set standby times, etc. --- sbin/atactl/Makefile | 12 ++ sbin/atactl/atactl.8 | 124 ++++++++++++ sbin/atactl/atactl.c | 540 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 676 insertions(+) create mode 100644 sbin/atactl/Makefile create mode 100644 sbin/atactl/atactl.8 create mode 100644 sbin/atactl/atactl.c (limited to 'sbin/atactl') diff --git a/sbin/atactl/Makefile b/sbin/atactl/Makefile new file mode 100644 index 00000000000..d04a4ccdf40 --- /dev/null +++ b/sbin/atactl/Makefile @@ -0,0 +1,12 @@ +# $OpenBSD: Makefile,v 1.1 1999/09/21 04:58:14 csapuntz Exp $ +# $NetBSD: Makefile,v 1.1 1998/11/19 23:54:59 kenh Exp $ + +SRCS= atactl.c + +PROG= atactl +MAN= atactl.8 + +LDADD+=-lutil +DPADD+=${LIBUTIL} + +.include diff --git a/sbin/atactl/atactl.8 b/sbin/atactl/atactl.8 new file mode 100644 index 00000000000..c2e57b53208 --- /dev/null +++ b/sbin/atactl/atactl.8 @@ -0,0 +1,124 @@ +.\" $OpenBSD: atactl.8,v 1.1 1999/09/21 04:58:14 csapuntz Exp $ +.\" $NetBSD: atactl.8,v 1.5 1999/02/24 18:49:14 jwise Exp $ +.\" +.\" Copyright (c) 1998 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Ken Hornstein. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. Neither the name of The NetBSD Foundation nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd November 18, 1998 +.Dt ATACTL 8 +.Os NetBSD +.Sh NAME +.Nm atactl +.Nd a program to manipulate ATA (IDE) devices +.Sh SYNOPSIS +.Nm +.Ar device +.Ar command +.Oo +.Ar arg Oo ... +.Oc +.Oc +.Sh DESCRIPTION +.Nm +allows a user or system administrator to issue commands to and otherwise +control devices which reside on standard IDE and ATA controllers. It is +used by specifying +a device to manipulate, the command to perform, and any arguments +the command may require. +.Sh DEVICE COMMANDS +The following commands may be used on IDE and ATA devices. Note +that not all devices support all commands. +.Pp +.Cm identify +.Pp +Identify the specified device, displaying the device's vendor, product, +revision strings, and the device's capabilities. +.Pp +.Cm idle +.Pp +Place the specified device into Idle mode. This mode may consume less +power than Active mode. +.Pp +.Cm standby +.Pp +Place the specified device into Standby mode. This mode will consume +less power than Idle mode. +.Pp +.Cm sleep +.Pp +Place he specified device into Sleep mode. This mode will consume +less power than Standby mode, but requires a device reset to resume +operation. Typically the +.Xr wd 4 +driver performs this reset automatically, but this should still be +used with caution. +.Pp +.Cm setidle +.Ar standby-timer +.Pp +Places the specified device into Idle mode, and sets the Standby timer +to +.Ar standby-timer +seconds. A value of 0 will disable the Standby timer. +.Pp +.Cm setstandby +.Ar standby-timer +.Pp +Places the specified device into Standby mode, and sets the Standby timer +to +.Ar standby-timer +seconds. A value of 0 will disable the Standby timer. +.Pp +.Cm checkpower +.Pp +Will print out if the device is in Active, Idle, or Standby power +management mode. +.Sh BUGS +The output from the +.Cm identify +command is rather ugly. +.Sh SEE ALSO +.Xr ioctl 2 , +.Xr wd 4 +.Sh AUTHOR +The +.Nm +command was written by Ken Hornstein. It was based heavily on the +.Xr scsictl 8 +command written by Jason R. Thorpe. +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.4 . diff --git a/sbin/atactl/atactl.c b/sbin/atactl/atactl.c new file mode 100644 index 00000000000..fed9f06f252 --- /dev/null +++ b/sbin/atactl/atactl.c @@ -0,0 +1,540 @@ +/* $OpenBSD: atactl.c,v 1.1 1999/09/21 04:58:14 csapuntz Exp $ */ +/* $NetBSD: atactl.c,v 1.4 1999/02/24 18:49:14 jwise Exp $ */ + +/*- + * Copyright (c) 1998 The NetBSD Foundation, Inc. + * All rights reserved. + * + * This code is derived from software contributed to The NetBSD Foundation + * by Ken Hornstein. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by the NetBSD + * Foundation, Inc. and its contributors. + * 4. Neither the name of The NetBSD Foundation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS + * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS + * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * atactl(8) - a program to control ATA devices. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +struct command { + const char *cmd_name; + void (*cmd_func) __P((int, char *[])); +}; + +struct bitinfo { + u_int bitmask; + const char *string; +}; + +int main __P((int, char *[])); +void usage __P((void)); +void ata_command __P((struct atareq *)); +void print_bitinfo __P((const char *, u_int, struct bitinfo *)); + +int fd; /* file descriptor for device */ +const char *dvname; /* device name */ +char dvname_store[MAXPATHLEN]; /* for opendisk(3) */ +const char *cmdname; /* command user issued */ + +extern const char *__progname; /* from crt0.o */ + +void device_identify __P((int, char *[])); +void device_setidle __P((int, char *[])); +void device_idle __P((int, char *[])); +void device_checkpower __P((int, char *[])); + +struct command commands[] = { + { "identify", device_identify }, + { "setidle", device_setidle }, + { "setstandby", device_setidle }, + { "idle", device_idle }, + { "standby", device_idle }, + { "sleep", device_idle }, + { "checkpower", device_checkpower }, + { NULL, NULL }, +}; + +/* + * Tables containing bitmasks used for error reporting and + * device identification. + */ + +struct bitinfo ata_caps[] = { + { ATA_CAP_STBY, "ATA standby timer values" }, + { WDC_CAP_IORDY, "IORDY operation" }, + { WDC_CAP_IORDY_DSBL, "IORDY disabling" }, + { NULL, NULL }, +}; + +struct bitinfo ata_vers[] = { + { WDC_VER_ATA1, "ATA-1" }, + { WDC_VER_ATA2, "ATA-2" }, + { WDC_VER_ATA3, "ATA-3" }, + { WDC_VER_ATA4, "ATA-4" }, + { NULL, NULL }, +}; + +struct bitinfo ata_cmd_set1[] = { + { WDC_CMD1_NOP, "NOP command" }, + { WDC_CMD1_RB, "READ BUFFER command" }, + { WDC_CMD1_WB, "WRITE BUFFER command" }, + { WDC_CMD1_HPA, "Host Protected Area feature set" }, + { WDC_CMD1_DVRST, "DEVICE RESET command" }, + { WDC_CMD1_SRV, "SERVICE interrupt" }, + { WDC_CMD1_RLSE, "release interrupt" }, + { WDC_CMD1_AHEAD, "look-ahead" }, + { WDC_CMD1_CACHE, "write cache" }, + { WDC_CMD1_PKT, "PACKET command feature set" }, + { WDC_CMD1_PM, "Power Management feature set" }, + { WDC_CMD1_REMOV, "Removable Media feature set" }, + { WDC_CMD1_SEC, "Security Mode feature set" }, + { WDC_CMD1_SMART, "SMART feature set" }, + { NULL, NULL }, +}; + +struct bitinfo ata_cmd_set2[] = { + { WDC_CMD2_RMSN, "Removable Media Status Notification feature set" }, + { ATA_CMD2_APM, "Advanced Power Management feature set" }, + { ATA_CMD2_CFA, "CFA feature set" }, + { ATA_CMD2_RWQ, "READ/WRITE DMS QUEUED commands" }, + { WDC_CMD2_DM, "DOWNLOAD MICROCODE command" }, + { NULL, NULL }, +}; + +int +main(argc, argv) + int argc; + char *argv[]; +{ + int i; + + /* Must have at least: device command */ + if (argc < 3) + usage(); + + /* Skip program name, get and skip device name and command. */ + dvname = argv[1]; + cmdname = argv[2]; + argv += 3; + argc -= 3; + + /* + * Open the device + */ + fd = opendisk(dvname, O_RDWR, dvname_store, sizeof(dvname_store), 0); + if (fd == -1) { + if (errno == ENOENT) { + /* + * Device doesn't exist. Probably trying to open + * a device which doesn't use disk semantics for + * device name. Try again, specifying "cooked", + * which leaves off the "r" in front of the device's + * name. + */ + fd = opendisk(dvname, O_RDWR, dvname_store, + sizeof(dvname_store), 1); + if (fd == -1) + err(1, "%s", dvname); + } else + err(1, "%s", dvname); + } + + /* + * Point the dvname at the actual device name that opendisk() opened. + */ + dvname = dvname_store; + + /* Look up and call the command. */ + for (i = 0; commands[i].cmd_name != NULL; i++) + if (strcmp(cmdname, commands[i].cmd_name) == 0) + break; + if (commands[i].cmd_name == NULL) + errx(1, "unknown command: %s\n", cmdname); + + (*commands[i].cmd_func)(argc, argv); + exit(0); +} + +void +usage() +{ + + fprintf(stderr, "usage: %s device command [arg [...]]\n", + __progname); + exit(1); +} + +/* + * Wrapper that calls ATAIOCCOMMAND and checks for errors + */ + +void +ata_command(req) + struct atareq *req; +{ + int error; + + error = ioctl(fd, ATAIOCCOMMAND, req); + + if (error == -1) + err(1, "ATAIOCCOMMAND failed"); + + switch (req->retsts) { + + case ATACMD_OK: + return; + case ATACMD_TIMEOUT: + fprintf(stderr, "ATA command timed out\n"); + exit(1); + case ATACMD_DF: + fprintf(stderr, "ATA device returned a Device Fault\n"); + exit(1); + case ATACMD_ERROR: + if (req->error & WDCE_ABRT) + fprintf(stderr, "ATA device returned Aborted " + "Command\n"); + else + fprintf(stderr, "ATA device returned error register " + "%0x\n", req->error); + exit(1); + default: + fprintf(stderr, "ATAIOCCOMMAND returned unknown result code " + "%d\n", req->retsts); + exit(1); + } +} + +/* + * Print out strings associated with particular bitmasks + */ + +void +print_bitinfo(f, bits, binfo) + const char *f; + u_int bits; + struct bitinfo *binfo; +{ + + for (; binfo->bitmask != NULL; binfo++) + if (bits & binfo->bitmask) + printf(f, binfo->string); +} + +/* + * DEVICE COMMANDS + */ + +/* + * device_identify: + * + * Display the identity of the device + */ +void +device_identify(argc, argv) + int argc; + char *argv[]; +{ + struct ataparams *inqbuf; + struct atareq req; + unsigned char inbuf[DEV_BSIZE]; +#if BYTE_ORDER == LITTLE_ENDIAN + int i; + u_int16_t *p; +#endif + + /* No arguments. */ + if (argc != 0) + goto usage; + + memset(&inbuf, 0, sizeof(inbuf)); + memset(&req, 0, sizeof(req)); + + inqbuf = (struct ataparams *) inbuf; + + req.flags = ATACMD_READ; + req.command = WDCC_IDENTIFY; + req.databuf = (caddr_t) inbuf; + req.datalen = sizeof(inbuf); + req.timeout = 1000; + + ata_command(&req); + +#if BYTE_ORDER == LITTLE_ENDIAN + /* + * On little endian machines, we need to shuffle the string + * byte order. However, we don't have to do this for NEC or + * Mitsumi ATAPI devices + */ + + if (!((inqbuf->atap_config & WDC_CFG_ATAPI_MASK) == WDC_CFG_ATAPI && + ((inqbuf->atap_model[0] == 'N' && + inqbuf->atap_model[1] == 'E') || + (inqbuf->atap_model[0] == 'F' && + inqbuf->atap_model[1] == 'X')))) { + for (i = 0 ; i < sizeof(inqbuf->atap_model); i += 2) { + p = (u_short *) (inqbuf->atap_model + i); + *p = ntohs(*p); + } + for (i = 0 ; i < sizeof(inqbuf->atap_serial); i += 2) { + p = (u_short *) (inqbuf->atap_serial + i); + *p = ntohs(*p); + } + for (i = 0 ; i < sizeof(inqbuf->atap_revision); i += 2) { + p = (u_short *) (inqbuf->atap_revision + i); + *p = ntohs(*p); + } + } +#endif + + /* + * Strip blanks off of the info strings. Yuck, I wish this was + * cleaner. + */ + + if (inqbuf->atap_model[sizeof(inqbuf->atap_model) - 1] == ' ') { + inqbuf->atap_model[sizeof(inqbuf->atap_model) - 1] = '\0'; + while (inqbuf->atap_model[strlen(inqbuf->atap_model) - 1] == ' ') + inqbuf->atap_model[strlen(inqbuf->atap_model) - 1] = '\0'; + } + + if (inqbuf->atap_revision[sizeof(inqbuf->atap_revision) - 1] == ' ') { + inqbuf->atap_revision[sizeof(inqbuf->atap_revision) - 1] = '\0'; + while (inqbuf->atap_revision[strlen(inqbuf->atap_revision) - 1] == ' ') + inqbuf->atap_revision[strlen(inqbuf->atap_revision) - 1] = '\0'; + } + + if (inqbuf->atap_serial[sizeof(inqbuf->atap_serial) - 1] == ' ') { + inqbuf->atap_serial[sizeof(inqbuf->atap_serial) - 1] = '\0'; + while (inqbuf->atap_serial[strlen(inqbuf->atap_serial) - 1] == ' ') + inqbuf->atap_serial[strlen(inqbuf->atap_serial) - 1] = '\0'; + } + + printf("Model: %.*s, Rev: %.*s, Serial #: %.*s\n", + (int) sizeof(inqbuf->atap_model), inqbuf->atap_model, + (int) sizeof(inqbuf->atap_revision), inqbuf->atap_revision, + (int) sizeof(inqbuf->atap_serial), inqbuf->atap_serial); + + printf("Device type: %s, %s\n", inqbuf->atap_config & WDC_CFG_ATAPI ? + "ATAPI" : "ATA", inqbuf->atap_config & ATA_CFG_FIXED ? "fixed" : + "removable"); + + if ((inqbuf->atap_config & WDC_CFG_ATAPI_MASK) == 0) + printf("Cylinders: %d, heads: %d, sec/track: %d, total " + "sectors: %d\n", inqbuf->atap_cylinders, + inqbuf->atap_heads, inqbuf->atap_sectors, + (inqbuf->atap_capacity[1] << 16) | + inqbuf->atap_capacity[0]); + + if (inqbuf->atap_queuedepth & WDC_QUEUE_DEPTH_MASK) + printf("Device supports command queue depth of %d\n", + inqbuf->atap_queuedepth & 0xf); + + printf("Device capabilities:\n"); + print_bitinfo("\t%s\n", inqbuf->atap_capabilities1, ata_caps); + + if (inqbuf->atap_ata_major != 0 && inqbuf->atap_ata_major != 0xffff) { + printf("Device supports following standards:\n"); + print_bitinfo("%s ", inqbuf->atap_ata_major, ata_vers); + printf("\n"); + } + + if (inqbuf->atap_cmd_set1 != 0 && inqbuf->atap_cmd_set1 != 0xffff && + inqbuf->atap_cmd_set2 != 0 && inqbuf->atap_cmd_set2 != 0xffff) { + printf("Command set support:\n"); + print_bitinfo("\t%s\n", inqbuf->atap_cmd_set1, ata_cmd_set1); + print_bitinfo("\t%s\n", inqbuf->atap_cmd_set2, ata_cmd_set2); + } + + if (inqbuf->atap_cmd_def != 0 && inqbuf->atap_cmd_def != 0xffff) { + printf("Command sets/features enabled:\n"); + print_bitinfo("\t%s\n", inqbuf->atap_cmd_set1 & + (WDC_CMD1_SRV | WDC_CMD1_RLSE | WDC_CMD1_AHEAD | + WDC_CMD1_CACHE | WDC_CMD1_SEC | WDC_CMD1_SMART), + ata_cmd_set1); + print_bitinfo("\t%s\n", inqbuf->atap_cmd_set2 & + (WDC_CMD2_RMSN | ATA_CMD2_APM), ata_cmd_set2); + } + + return; + +usage: + fprintf(stderr, "usage: %s device %s\n", __progname, cmdname); + exit(1); +} + +/* + * device idle: + * + * issue the IDLE IMMEDIATE command to the drive + */ + +void +device_idle(argc, argv) + int argc; + char *argv[]; +{ + struct atareq req; + + /* No arguments. */ + if (argc != 0) + goto usage; + + memset(&req, 0, sizeof(req)); + + if (strcmp(cmdname, "idle") == 0) + req.command = WDCC_IDLE_IMMED; + else if (strcmp(cmdname, "standby") == 0) + req.command = WDCC_STANDBY_IMMED; + else + req.command = WDCC_SLEEP; + + req.timeout = 1000; + + ata_command(&req); + + return; +usage: + fprintf(stderr, "usage: %s device %s\n", __progname, cmdname); + exit(1); +} + +/* + * Set the idle timer on the disk. Set it for either idle mode or + * standby mode, depending on how we were invoked. + */ + +void +device_setidle(argc, argv) + int argc; + char *argv[]; +{ + unsigned long idle; + struct atareq req; + char *end; + + /* Only one argument */ + if (argc != 1) + goto usage; + + idle = strtoul(argv[0], &end, 0); + + if (*end != '\0') { + fprintf(stderr, "Invalid idle time: \"%s\"\n", argv[0]); + exit(1); + } + + if (idle > 19800) { + fprintf(stderr, "Idle time has a maximum value of 5.5 " + "hours\n"); + exit(1); + } + + if (idle != 0 && idle < 5) { + fprintf(stderr, "Idle timer must be at least 5 seconds\n"); + exit(1); + } + + memset(&req, 0, sizeof(req)); + + if (idle <= 240*5) + req.sec_count = idle / 5; + else + req.sec_count = idle / (30*60) + 240; + + req.command = cmdname[3] == 's' ? WDCC_STANDBY : WDCC_IDLE; + req.timeout = 1000; + + ata_command(&req); + + return; + +usage: + fprintf(stderr, "usage; %s device %s idle-time\n", __progname, + cmdname); + exit(1); +} + +/* + * Query the device for the current power mode + */ + +void +device_checkpower(argc, argv) + int argc; + char *argv[]; +{ + struct atareq req; + + /* No arguments. */ + if (argc != 0) + goto usage; + + memset(&req, 0, sizeof(req)); + + req.command = WDCC_CHECK_PWR; + req.timeout = 1000; + req.flags = ATACMD_READREG; + + ata_command(&req); + + printf("Current power status: "); + + switch (req.sec_count) { + case 0x00: + printf("Standby mode\n"); + break; + case 0x80: + printf("Idle mode\n"); + break; + case 0xff: + printf("Active mode\n"); + break; + default: + printf("Unknown power code (%02x)\n", req.sec_count); + } + + return; +usage: + fprintf(stderr, "usage: %s device %s\n", __progname, cmdname); + exit(1); +} -- cgit v1.2.3