1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2008, 2009 Yahoo!, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. The names of the authors may not be used to endorse or promote 16 * products derived from this software without specific prior written 17 * permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 */ 33 34 #ifndef __MFIUTIL_H__ 35 #define __MFIUTIL_H__ 36 37 #include <sys/cdefs.h> 38 #include <sys/linker_set.h> 39 40 #include <dev/mfi/mfireg.h> 41 42 /* 4.x compat */ 43 #ifndef SET_DECLARE 44 45 /* <sys/cdefs.h> */ 46 #define __used 47 #define __section(x) __attribute__((__section__(x))) 48 49 /* <sys/linker_set.h> */ 50 #undef __MAKE_SET 51 #undef DATA_SET 52 53 #define __MAKE_SET(set, sym) \ 54 static void const * const __set_##set##_sym_##sym \ 55 __section("set_" #set) __used = &sym 56 57 #define DATA_SET(set, sym) __MAKE_SET(set, sym) 58 59 #define SET_DECLARE(set, ptype) \ 60 extern ptype *__CONCAT(__start_set_,set); \ 61 extern ptype *__CONCAT(__stop_set_,set) 62 63 #define SET_BEGIN(set) \ 64 (&__CONCAT(__start_set_,set)) 65 #define SET_LIMIT(set) \ 66 (&__CONCAT(__stop_set_,set)) 67 68 #define SET_FOREACH(pvar, set) \ 69 for (pvar = SET_BEGIN(set); pvar < SET_LIMIT(set); pvar++) 70 71 int humanize_number(char *_buf, size_t _len, int64_t _number, 72 const char *_suffix, int _scale, int _flags); 73 74 /* humanize_number(3) */ 75 #define HN_DECIMAL 0x01 76 #define HN_NOSPACE 0x02 77 #define HN_B 0x04 78 #define HN_DIVISOR_1000 0x08 79 80 #define HN_GETSCALE 0x10 81 #define HN_AUTOSCALE 0x20 82 83 #endif 84 85 /* Constants for DDF RAID levels. */ 86 #define DDF_RAID0 0x00 87 #define DDF_RAID1 0x01 88 #define DDF_RAID3 0x03 89 #define DDF_RAID5 0x05 90 #define DDF_RAID6 0x06 91 #define DDF_RAID1E 0x11 92 #define DDF_JBOD 0x0f 93 #define DDF_CONCAT 0x1f 94 #define DDF_RAID5E 0x15 95 #define DDF_RAID5EE 0x25 96 97 struct mfiutil_command { 98 const char *name; 99 int (*handler)(int ac, char **av); 100 }; 101 102 #define MFI_DATASET(name) mfiutil_ ## name ## _table 103 104 #define MFI_COMMAND(set, name, function) \ 105 static struct mfiutil_command function ## _mfiutil_command = \ 106 { #name, function }; \ 107 DATA_SET(MFI_DATASET(set), function ## _mfiutil_command) 108 109 #define MFI_TABLE(set, name) \ 110 SET_DECLARE(MFI_DATASET(name), struct mfiutil_command); \ 111 \ 112 static int \ 113 mfiutil_ ## name ## _table_handler(int ac, char **av) \ 114 { \ 115 return (mfi_table_handler(SET_BEGIN(MFI_DATASET(name)), \ 116 SET_LIMIT(MFI_DATASET(name)), ac, av)); \ 117 } \ 118 MFI_COMMAND(set, name, mfiutil_ ## name ## _table_handler) 119 120 /* Drive name printing options */ 121 #define MFI_DNAME_ES 0x0001 /* E%u:S%u */ 122 #define MFI_DNAME_DEVICE_ID 0x0002 /* %u */ 123 #define MFI_DNAME_HONOR_OPTS 0x8000 /* Allow cmd line to override default */ 124 125 extern int mfi_unit; 126 127 extern u_int mfi_opts; 128 129 /* We currently don't know the full details of the following struct */ 130 struct mfi_foreign_scan_cfg { 131 char data[24]; 132 }; 133 134 struct mfi_foreign_scan_info { 135 uint32_t count; /* Number of foreign configs found */ 136 struct mfi_foreign_scan_cfg cfgs[8]; 137 }; 138 139 void mbox_store_ldref(uint8_t *mbox, union mfi_ld_ref *ref); 140 void mbox_store_pdref(uint8_t *mbox, union mfi_pd_ref *ref); 141 void mfi_display_progress(const char *label, struct mfi_progress *prog); 142 int mfi_table_handler(struct mfiutil_command **start, 143 struct mfiutil_command **end, int ac, char **av); 144 const char *mfi_raid_level(uint8_t primary_level, uint8_t secondary_level); 145 const char *mfi_ldstate(enum mfi_ld_state state); 146 const char *mfi_pdstate(enum mfi_pd_state state); 147 const char *mfi_pd_inq_string(struct mfi_pd_info *info); 148 const char *mfi_volume_name(int fd, uint8_t target_id); 149 int mfi_volume_busy(int fd, uint8_t target_id); 150 int mfi_config_read(int fd, struct mfi_config_data **configp); 151 int mfi_config_read_opcode(int fd, uint32_t opcode, 152 struct mfi_config_data **configp, uint8_t *mbox, size_t mboxlen); 153 int mfi_lookup_drive(int fd, char *drive, uint16_t *device_id); 154 int mfi_lookup_volume(int fd, const char *name, uint8_t *target_id); 155 int mfi_dcmd_command(int fd, uint32_t opcode, void *buf, size_t bufsize, 156 uint8_t *mbox, size_t mboxlen, uint8_t *statusp); 157 int mfi_open(int unit, int acs); 158 int mfi_ctrl_get_info(int fd, struct mfi_ctrl_info *info, uint8_t *statusp); 159 int mfi_ld_get_info(int fd, uint8_t target_id, struct mfi_ld_info *info, 160 uint8_t *statusp); 161 int mfi_ld_get_list(int fd, struct mfi_ld_list *list, uint8_t *statusp); 162 int mfi_pd_get_info(int fd, uint16_t device_id, struct mfi_pd_info *info, 163 uint8_t *statusp); 164 int mfi_pd_get_list(int fd, struct mfi_pd_list **listp, uint8_t *statusp); 165 int mfi_reconfig_supported(void); 166 const char *mfi_status(u_int status_code); 167 const char *mfi_drive_name(struct mfi_pd_info *pinfo, uint16_t device_id, 168 uint32_t def); 169 void format_stripe(char *buf, size_t buflen, uint8_t stripe); 170 void print_ld(struct mfi_ld_info *info, int state_len); 171 void print_pd(struct mfi_pd_info *info, int state_len); 172 void dump_config(int fd, struct mfi_config_data *config, const char *msg_prefix); 173 int mfi_bbu_get_props(int fd, struct mfi_bbu_properties *props, 174 uint8_t *statusp); 175 int mfi_bbu_set_props(int fd, struct mfi_bbu_properties *props, 176 uint8_t *statusp); 177 void mfi_autolearn_period(uint32_t, char *, size_t); 178 void mfi_next_learn_time(uint32_t, char *, size_t); 179 void mfi_autolearn_mode(uint8_t, char *, size_t); 180 181 void scan_firmware(struct mfi_info_component *comp); 182 void display_firmware(struct mfi_info_component *comp, const char *tag); 183 184 int display_format(int ac, char **av, int diagnostic, mfi_dcmd_t display_cmd); 185 #endif /* !__MFIUTIL_H__ */ 186