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 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 #define MRSAS_TYPE "mrsas" 41 #define MFI_TYPE "mfi" 42 43 /* 4.x compat */ 44 #ifndef SET_DECLARE 45 46 /* <sys/cdefs.h> */ 47 #define __used 48 #define __section(x) __attribute__((__section__(x))) 49 50 /* <sys/linker_set.h> */ 51 #undef __MAKE_SET 52 #undef DATA_SET 53 54 #define __MAKE_SET(set, sym) \ 55 static void const * const __set_##set##_sym_##sym \ 56 __section("set_" #set) __used = &sym 57 58 #define DATA_SET(set, sym) __MAKE_SET(set, sym) 59 60 #define SET_DECLARE(set, ptype) \ 61 extern ptype *__CONCAT(__start_set_,set); \ 62 extern ptype *__CONCAT(__stop_set_,set) 63 64 #define SET_BEGIN(set) \ 65 (&__CONCAT(__start_set_,set)) 66 #define SET_LIMIT(set) \ 67 (&__CONCAT(__stop_set_,set)) 68 69 #define SET_FOREACH(pvar, set) \ 70 for (pvar = SET_BEGIN(set); pvar < SET_LIMIT(set); pvar++) 71 72 int humanize_number(char *_buf, size_t _len, int64_t _number, 73 const char *_suffix, int _scale, int _flags); 74 75 /* humanize_number(3) */ 76 #define HN_DECIMAL 0x01 77 #define HN_NOSPACE 0x02 78 #define HN_B 0x04 79 #define HN_DIVISOR_1000 0x08 80 81 #define HN_GETSCALE 0x10 82 #define HN_AUTOSCALE 0x20 83 84 #endif 85 86 /* Constants for DDF RAID levels. */ 87 #define DDF_RAID0 0x00 88 #define DDF_RAID1 0x01 89 #define DDF_RAID3 0x03 90 #define DDF_RAID5 0x05 91 #define DDF_RAID6 0x06 92 #define DDF_RAID1E 0x11 93 #define DDF_JBOD 0x0f 94 #define DDF_CONCAT 0x1f 95 #define DDF_RAID5E 0x15 96 #define DDF_RAID5EE 0x25 97 98 struct mfiutil_command { 99 const char *name; 100 int (*handler)(int ac, char **av); 101 }; 102 103 #define MFI_DATASET(name) mfiutil_ ## name ## _table 104 105 #define MFI_COMMAND(set, name, function) \ 106 static struct mfiutil_command function ## _mfiutil_command = \ 107 { #name, function }; \ 108 DATA_SET(MFI_DATASET(set), function ## _mfiutil_command) 109 110 #define MFI_TABLE(set, name) \ 111 SET_DECLARE(MFI_DATASET(name), struct mfiutil_command); \ 112 \ 113 static int \ 114 mfiutil_ ## name ## _table_handler(int ac, char **av) \ 115 { \ 116 return (mfi_table_handler(SET_BEGIN(MFI_DATASET(name)), \ 117 SET_LIMIT(MFI_DATASET(name)), ac, av)); \ 118 } \ 119 MFI_COMMAND(set, name, mfiutil_ ## name ## _table_handler) 120 121 /* Drive name printing options */ 122 #define MFI_DNAME_ES 0x0001 /* E%u:S%u */ 123 #define MFI_DNAME_DEVICE_ID 0x0002 /* %u */ 124 #define MFI_DNAME_HONOR_OPTS 0x8000 /* Allow cmd line to override default */ 125 126 extern char *mfi_device; 127 128 extern u_int mfi_opts; 129 130 /* We currently don't know the full details of the following struct */ 131 struct mfi_foreign_scan_cfg { 132 char data[24]; 133 }; 134 135 struct mfi_foreign_scan_info { 136 uint32_t count; /* Number of foreign configs found */ 137 struct mfi_foreign_scan_cfg cfgs[8]; 138 }; 139 140 void mbox_store_ldref(uint8_t *mbox, union mfi_ld_ref *ref); 141 void mbox_store_pdref(uint8_t *mbox, union mfi_pd_ref *ref); 142 void mfi_display_progress(const char *label, struct mfi_progress *prog); 143 int mfi_table_handler(struct mfiutil_command **start, 144 struct mfiutil_command **end, int ac, char **av); 145 const char *mfi_raid_level(uint8_t primary_level, uint8_t secondary_level); 146 const char *mfi_ldstate(enum mfi_ld_state state); 147 const char *mfi_pdstate(enum mfi_pd_state state); 148 const char *mfi_pd_inq_string(struct mfi_pd_info *info); 149 const char *mfi_volume_name(int fd, uint8_t target_id); 150 int mfi_volume_busy(int fd, uint8_t target_id); 151 int mfi_config_read(int fd, struct mfi_config_data **configp); 152 int mfi_config_read_opcode(int fd, uint32_t opcode, 153 struct mfi_config_data **configp, uint8_t *mbox, size_t mboxlen); 154 int mfi_lookup_drive(int fd, char *drive, uint16_t *device_id); 155 int mfi_lookup_volume(int fd, const char *name, uint8_t *target_id); 156 int mfi_dcmd_command(int fd, uint32_t opcode, void *buf, size_t bufsize, 157 uint8_t *mbox, size_t mboxlen, uint8_t *statusp); 158 int mfi_open(char *dev, int acs); 159 int mfi_ctrl_get_info(int fd, struct mfi_ctrl_info *info, uint8_t *statusp); 160 int mfi_ld_get_info(int fd, uint8_t target_id, struct mfi_ld_info *info, 161 uint8_t *statusp); 162 int mfi_ld_get_list(int fd, struct mfi_ld_list *list, uint8_t *statusp); 163 int mfi_pd_get_info(int fd, uint16_t device_id, struct mfi_pd_info *info, 164 uint8_t *statusp); 165 int mfi_pd_get_list(int fd, struct mfi_pd_list **listp, uint8_t *statusp); 166 int mfi_reconfig_supported(const char *mfi_device); 167 const char *mfi_status(u_int status_code); 168 const char *mfi_drive_name(struct mfi_pd_info *pinfo, uint16_t device_id, 169 uint32_t def); 170 void format_stripe(char *buf, size_t buflen, uint8_t stripe); 171 void print_ld(struct mfi_ld_info *info, int state_len); 172 void print_pd(struct mfi_pd_info *info, int state_len); 173 void dump_config(int fd, struct mfi_config_data *config, const char *msg_prefix); 174 int mfi_bbu_get_props(int fd, struct mfi_bbu_properties *props, 175 uint8_t *statusp); 176 int mfi_bbu_set_props(int fd, struct mfi_bbu_properties *props, 177 uint8_t *statusp); 178 void mfi_autolearn_period(uint32_t, char *, size_t); 179 void mfi_next_learn_time(uint32_t, char *, size_t); 180 void mfi_autolearn_mode(uint8_t, char *, size_t); 181 int get_mfi_unit(const char *dev); 182 char *get_mfi_type(const char *dev); 183 184 void scan_firmware(struct mfi_info_component *comp); 185 void display_firmware(struct mfi_info_component *comp, const char *tag); 186 187 int display_format(int ac, char **av, int diagnostic, mfi_dcmd_t display_cmd); 188 #endif /* !__MFIUTIL_H__ */ 189