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