xref: /freebsd/usr.sbin/mfiutil/mfiutil.h (revision 10b3b54548f2290bbe8d8f88c59c28d12b7a635d)
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$
30  */
31 
32 #ifndef __MFIUTIL_H__
33 #define	__MFIUTIL_H__
34 
35 #include <sys/cdefs.h>
36 #include <sys/linker_set.h>
37 
38 #include <dev/mfi/mfireg.h>
39 
40 /* 4.x compat */
41 #ifndef SET_DECLARE
42 
43 /* <sys/cdefs.h> */
44 #define	__used
45 #define	__section(x)	__attribute__((__section__(x)))
46 
47 /* <sys/linker_set.h> */
48 #undef __MAKE_SET
49 #undef DATA_SET
50 
51 #define __MAKE_SET(set, sym)						\
52 	static void const * const __set_##set##_sym_##sym 		\
53 	__section("set_" #set) __used = &sym
54 
55 #define DATA_SET(set, sym)	__MAKE_SET(set, sym)
56 
57 #define SET_DECLARE(set, ptype)						\
58 	extern ptype *__CONCAT(__start_set_,set);			\
59 	extern ptype *__CONCAT(__stop_set_,set)
60 
61 #define SET_BEGIN(set)							\
62 	(&__CONCAT(__start_set_,set))
63 #define SET_LIMIT(set)							\
64 	(&__CONCAT(__stop_set_,set))
65 
66 #define	SET_FOREACH(pvar, set)						\
67 	for (pvar = SET_BEGIN(set); pvar < SET_LIMIT(set); pvar++)
68 
69 int	humanize_number(char *_buf, size_t _len, int64_t _number,
70 	    const char *_suffix, int _scale, int _flags);
71 
72 /* humanize_number(3) */
73 #define HN_DECIMAL		0x01
74 #define HN_NOSPACE		0x02
75 #define HN_B			0x04
76 #define HN_DIVISOR_1000		0x08
77 
78 #define HN_GETSCALE		0x10
79 #define HN_AUTOSCALE		0x20
80 
81 #endif
82 
83 /* Constants for DDF RAID levels. */
84 #define	DDF_RAID0		0x00
85 #define	DDF_RAID1		0x01
86 #define	DDF_RAID3		0x03
87 #define	DDF_RAID5		0x05
88 #define	DDF_RAID6		0x06
89 #define	DDF_RAID1E		0x11
90 #define	DDF_JBOD		0x0f
91 #define	DDF_CONCAT		0x1f
92 #define	DDF_RAID5E		0x15
93 #define	DDF_RAID5EE		0x25
94 
95 struct mfiutil_command {
96 	const char *name;
97 	int (*handler)(int ac, char **av);
98 };
99 
100 #define	MFI_DATASET(name)	mfiutil_ ## name ## _table
101 
102 #define	MFI_COMMAND(set, name, function)				\
103 	static struct mfiutil_command function ## _mfiutil_command =	\
104 	{ #name, function };						\
105 	DATA_SET(MFI_DATASET(set), function ## _mfiutil_command)
106 
107 #define	MFI_TABLE(set, name)						\
108 	SET_DECLARE(MFI_DATASET(name), struct mfiutil_command);		\
109 									\
110 	static int							\
111 	mfiutil_ ## name ## _table_handler(int ac, char **av)		\
112 	{								\
113 		return (mfi_table_handler(SET_BEGIN(MFI_DATASET(name)), \
114 		    SET_LIMIT(MFI_DATASET(name)), ac, av));		\
115 	}								\
116 	MFI_COMMAND(set, name, mfiutil_ ## name ## _table_handler)
117 
118 extern int mfi_unit;
119 
120 void	mbox_store_ldref(uint8_t *mbox, union mfi_ld_ref *ref);
121 void	mbox_store_pdref(uint8_t *mbox, union mfi_pd_ref *ref);
122 void	mfi_display_progress(const char *label, struct mfi_progress *prog);
123 int	mfi_table_handler(struct mfiutil_command **start,
124     struct mfiutil_command **end, int ac, char **av);
125 const char *mfi_raid_level(uint8_t primary_level, uint8_t secondary_level);
126 const char *mfi_ldstate(enum mfi_ld_state state);
127 const char *mfi_pdstate(enum mfi_pd_state state);
128 const char *mfi_pd_inq_string(struct mfi_pd_info *info);
129 const char *mfi_volume_name(int fd, uint8_t target_id);
130 int	mfi_volume_busy(int fd, uint8_t target_id);
131 int	mfi_config_read(int fd, struct mfi_config_data **configp);
132 int	mfi_lookup_drive(int fd, char *drive, uint16_t *device_id);
133 int	mfi_lookup_volume(int fd, const char *name, uint8_t *target_id);
134 int	mfi_dcmd_command(int fd, uint32_t opcode, void *buf, size_t bufsize,
135     uint8_t *mbox, size_t mboxlen, uint8_t *statusp);
136 int	mfi_open(int unit);
137 int	mfi_ctrl_get_info(int fd, struct mfi_ctrl_info *info, uint8_t *statusp);
138 int	mfi_ld_get_info(int fd, uint8_t target_id, struct mfi_ld_info *info,
139     uint8_t *statusp);
140 int	mfi_ld_get_list(int fd, struct mfi_ld_list *list, uint8_t *statusp);
141 int	mfi_pd_get_info(int fd, uint16_t device_id, struct mfi_pd_info *info,
142     uint8_t *statusp);
143 int	mfi_pd_get_list(int fd, struct mfi_pd_list **listp, uint8_t *statusp);
144 int	mfi_reconfig_supported(void);
145 const char *mfi_status(u_int status_code);
146 
147 #endif /* !__MFIUTIL_H__ */
148