1/*-
2 * Copyright (c) 2008, 2009 Yahoo!, Inc.
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 * 3. The names of the authors may not be used to endorse or promote
14 *    products derived from this software without specific prior written
15 *    permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: releng/11.0/usr.sbin/mfiutil/mfiutil.c 258053 2013-11-12 17:10:56Z sbruno $
30 */
31
32#include <sys/errno.h>
33#include <err.h>
34#include <stdio.h>
35#include <stdlib.h>
36#include <string.h>
37#include <unistd.h>
38#include "mfiutil.h"
39
40SET_DECLARE(MFI_DATASET(top), struct mfiutil_command);
41
42MFI_TABLE(top, start);
43MFI_TABLE(top, stop);
44MFI_TABLE(top, abort);
45
46int mfi_unit;
47u_int mfi_opts;
48static int fw_name_width, fw_version_width, fw_date_width, fw_time_width;
49
50static void
51usage(void)
52{
53
54	fprintf(stderr, "usage: mfiutil [-de] [-u unit] <command> ...\n\n");
55	fprintf(stderr, "Commands include:\n");
56	fprintf(stderr, "    version\n");
57	fprintf(stderr, "    show adapter              - display controller information\n");
58	fprintf(stderr, "    show battery              - display battery information\n");
59	fprintf(stderr, "    show config               - display RAID configuration\n");
60	fprintf(stderr, "    show drives               - list physical drives\n");
61	fprintf(stderr, "    show events               - display event log\n");
62	fprintf(stderr, "    show firmware             - list firmware images\n");
63	fprintf(stderr, "    show foreign              - display detected foreign volumes\n");
64	fprintf(stderr, "    show logstate             - display event log sequence numbers\n");
65	fprintf(stderr, "    show volumes              - list logical volumes\n");
66	fprintf(stderr, "    show patrol               - display patrol read status\n");
67	fprintf(stderr, "    show progress             - display status of active operations\n");
68	fprintf(stderr, "    fail <drive>              - fail a physical drive\n");
69	fprintf(stderr, "    good <drive>              - set a failed/SYSPD drive as UNCONFIGURED\n");
70	fprintf(stderr, "    rebuild <drive>           - mark failed drive ready for rebuild\n");
71	fprintf(stderr, "    syspd <drive>             - set drive into use as SYSPD JBOD\n");
72	fprintf(stderr, "    drive progress <drive>    - display status of active operations\n");
73	fprintf(stderr, "    drive clear <drive> <start|stop> - clear a drive with all 0x00\n");
74	fprintf(stderr, "    start rebuild <drive>\n");
75	fprintf(stderr, "    abort rebuild <drive>\n");
76	fprintf(stderr, "    locate <drive> <on|off>   - toggle drive LED\n");
77	fprintf(stderr, "    cache <volume> [command [setting]]\n");
78	fprintf(stderr, "    name <volume> <name>\n");
79	fprintf(stderr, "    volume progress <volume>  - display status of active operations\n");
80	fprintf(stderr, "    clear                     - clear volume configuration\n");
81	fprintf(stderr, "    create <type> [-v] [-s stripe_size] <drive>[,<drive>[,...]] [<drive>[,<drive>[,...]]\n");
82	fprintf(stderr, "    delete <volume>\n");
83	fprintf(stderr, "    add <drive> [volume]      - add a hot spare\n");
84	fprintf(stderr, "    remove <drive>            - remove a hot spare\n");
85	fprintf(stderr, "    patrol <disable|auto|manual> [interval [start]]\n");
86	fprintf(stderr, "    start patrol              - start a patrol read\n");
87	fprintf(stderr, "    stop patrol               - stop a patrol read\n");
88	fprintf(stderr, "    foreign scan              - scan for foreign configurations\n");
89	fprintf(stderr, "    foreign clear [volume]    - clear foreign configurations (default all)\n");
90	fprintf(stderr, "    foreign diag [volume]     - diagnostic display foreign configurations (default all)\n");
91	fprintf(stderr, "    foreign preview [volume]  - preview foreign configurations (default all)\n");
92	fprintf(stderr, "    foreign import [volume]   - import foreign configurations (default all)\n");
93	fprintf(stderr, "    flash <firmware>\n");
94	fprintf(stderr, "    start learn               - start a BBU relearn\n");
95	fprintf(stderr, "    bbu <setting> <value>     - set BBU properties\n");
96	fprintf(stderr, "    ctrlprop rebuild [rate]   - get/set the volume rebuild rate\n");
97	fprintf(stderr, "    ctrlprop alarm [0/1]      - enable/disable controller alarms\n");
98#ifdef DEBUG
99	fprintf(stderr, "    debug                     - debug 'show config'\n");
100	fprintf(stderr, "    dump                      - display 'saved' config\n");
101#endif
102	exit(1);
103}
104
105static int
106version(int ac __unused, char **av __unused)
107{
108
109	printf("mfiutil version 1.0.15");
110#ifdef DEBUG
111	printf(" (DEBUG)");
112#endif
113	printf("\n");
114	return (0);
115}
116MFI_COMMAND(top, version, version);
117
118int
119main(int ac, char **av)
120{
121	struct mfiutil_command **cmd;
122	int ch;
123
124	while ((ch = getopt(ac, av, "deu:")) != -1) {
125		switch (ch) {
126		case 'd':
127			mfi_opts |= MFI_DNAME_DEVICE_ID;
128			break;
129		case 'e':
130			mfi_opts |= MFI_DNAME_ES;
131			break;
132		case 'u':
133			mfi_unit = atoi(optarg);
134			break;
135		case '?':
136			usage();
137		}
138	}
139
140	av += optind;
141	ac -= optind;
142
143	/* getopt() eats av[0], so we can't use mfi_table_handler() directly. */
144	if (ac == 0)
145		usage();
146
147	SET_FOREACH(cmd, MFI_DATASET(top)) {
148		if (strcmp((*cmd)->name, av[0]) == 0) {
149			if ((*cmd)->handler(ac, av))
150				return (1);
151			else
152				return (0);
153		}
154	}
155	warnx("Unknown command %s.", av[0]);
156	return (1);
157}
158
159void
160scan_firmware(struct mfi_info_component *comp)
161{
162	int len;
163
164	len = strlen(comp->name);
165	if (fw_name_width < len)
166		fw_name_width = len;
167	len = strlen(comp->version);
168	if (fw_version_width < len)
169		fw_version_width = len;
170	len = strlen(comp->build_date);
171	if (fw_date_width < len)
172		fw_date_width = len;
173	len = strlen(comp->build_time);
174	if (fw_time_width < len)
175		fw_time_width = len;
176}
177
178void
179display_firmware(struct mfi_info_component *comp, const char *tag)
180{
181
182	printf("%-*s  %-*s  %-*s  %-*s  %s\n", fw_name_width, comp->name,
183	    fw_version_width, comp->version, fw_date_width, comp->build_date,
184	    fw_time_width, comp->build_time, tag);
185}
186