usr.sbin/mfiutil/mfiutil.h

   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: src/usr.sbin/mfiutil/mfiutil.h,v 1.2 2011/06/20 21:28:50 bz Exp $
  30  */
  31
  32 #ifndef __MFIUTIL_H__
  33 #define __MFIUTIL_H__
  34
  35 #include <sys/linker_set.h>
  36
  37 #include <dev/raid/mfi/mfireg.h>
  38
  39 /* Constants for DDF RAID levels. */
  40 #define DDF_RAID0               0x00
  41 #define DDF_RAID1               0x01
  42 #define DDF_RAID3               0x03
  43 #define DDF_RAID5               0x05
  44 #define DDF_RAID6               0x06
  45 #define DDF_RAID1E              0x11
  46 #define DDF_JBOD                0x0f
  47 #define DDF_CONCAT              0x1f
  48 #define DDF_RAID5E              0x15
  49 #define DDF_RAID5EE             0x25
  50
  51 struct mfiutil_command {
  52         const char *name;
  53         int (*handler)(int ac, char **av);
  54 };
  55
  56 #define MFI_DATASET(name)       mfiutil_ ## name ## _table
  57
  58 #define MFI_COMMAND(set, name, function)                                \
  59         static struct mfiutil_command function ## _mfiutil_command =    \
  60         { #name, function };                                            \
  61         DATA_SET(MFI_DATASET(set), function ## _mfiutil_command)
  62
  63 #define MFI_TABLE(set, name)                                            \
  64         SET_DECLARE(MFI_DATASET(name), struct mfiutil_command);         \
  65                                                                         \
  66         static int                                                      \
  67         mfiutil_ ## name ## _table_handler(int ac, char **av)           \
  68         {                                                               \
  69                 return (mfi_table_handler(SET_BEGIN(MFI_DATASET(name)), \
  70                     SET_LIMIT(MFI_DATASET(name)), ac, av));             \
  71         }                                                               \
  72         MFI_COMMAND(set, name, mfiutil_ ## name ## _table_handler)
  73
  74 /* Drive name printing options */
  75 #define MFI_DNAME_ES            0x0001  /* E%u:S%u */
  76 #define MFI_DNAME_DEVICE_ID     0x0002  /* %u */
  77 #define MFI_DNAME_HONOR_OPTS    0x8000  /* Allow cmd line to override default */
  78
  79 extern int mfi_unit;
  80 extern u_int mfi_opts;
  81
  82 void    mbox_store_ldref(uint8_t *mbox, union mfi_ld_ref *ref);
  83 void    mbox_store_pdref(uint8_t *mbox, union mfi_pd_ref *ref);
  84 void    mfi_display_progress(const char *label, struct mfi_progress *prog);
  85 int     mfi_table_handler(struct mfiutil_command **start,
  86     struct mfiutil_command **end, int ac, char **av);
  87 const char *mfi_raid_level(uint8_t primary_level, uint8_t secondary_level);
  88 const char *mfi_ldstate(enum mfi_ld_state state);
  89 const char *mfi_pdstate(enum mfi_pd_state state);
  90 const char *mfi_pd_inq_string(struct mfi_pd_info *info);
  91 const char *mfi_volume_name(int fd, uint8_t target_id);
  92 int     mfi_volume_busy(int fd, uint8_t target_id);
  93 int     mfi_config_read(int fd, struct mfi_config_data **configp);
  94 int     mfi_config_read_opcode(int fd, uint32_t opcode,
  95     struct mfi_config_data **configp, uint8_t *mbox, size_t mboxlen);
  96 int     mfi_lookup_drive(int fd, char *drive, uint16_t *device_id);
  97 int     mfi_lookup_volume(int fd, const char *name, uint8_t *target_id);
  98 int     mfi_dcmd_command(int fd, uint32_t opcode, void *buf, size_t bufsize,
  99     uint8_t *mbox, size_t mboxlen, uint8_t *statusp);
 100 int     mfi_open(int unit);
 101 int     mfi_ctrl_get_info(int fd, struct mfi_ctrl_info *info, uint8_t *statusp);
 102 int     mfi_ld_get_info(int fd, uint8_t target_id, struct mfi_ld_info *info,
 103     uint8_t *statusp);
 104 int     mfi_ld_get_list(int fd, struct mfi_ld_list *list, uint8_t *statusp);
 105 int     mfi_pd_get_info(int fd, uint16_t device_id, struct mfi_pd_info *info,
 106     uint8_t *statusp);
 107 int     mfi_pd_get_list(int fd, struct mfi_pd_list **listp, uint8_t *statusp);
 108 int     mfi_reconfig_supported(void);
 109 const char *mfi_status(u_int status_code);
 110 const char *mfi_drive_name(struct mfi_pd_info *pinfo, uint16_t device_id,
 111     uint32_t def);
 112 void    format_stripe(char *buf, size_t buflen, uint8_t stripe);
 113 void    print_ld(struct mfi_ld_info *info, int state_len);
 114 void    print_pd(struct mfi_pd_info *info, int state_len);
 115 void    dump_config(int fd, struct mfi_config_data *config, const char* msg_prefix);
 116
 117 #endif /* !__MFIUTIL_H__ */