usr.sbin/mptutil/mptutil.h

   1 /*-
   2  * Copyright (c) 2008 Yahoo!, Inc.
   3  * All rights reserved.
   4  * Written by: John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Neither the name of the author nor the names of any co-contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD: src/usr.sbin/mptutil/mptutil.h,v 1.1 2009/08/14 13:13:12 scottl Exp $
  31  */
  32
  33 #ifndef __MPTUTIL_H__
  34 #define __MPTUTIL_H__
  35
  36 #include <sys/linker_set.h>
  37
  38 #include <dev/disk/mpt/mpilib/mpi_type.h>
  39 #include <dev/disk/mpt/mpilib/mpi.h>
  40 #include <dev/disk/mpt/mpilib/mpi_cnfg.h>
  41 #include <dev/disk/mpt/mpilib/mpi_raid.h>
  42
  43 #define SPECNAMELEN 15 /* XXX: hidden under _KERNEL in <sys/conf.h> */
  44
  45 #define IOC_STATUS_SUCCESS(status)                                      \
  46         (((status) & MPI_IOCSTATUS_MASK) == MPI_IOCSTATUS_SUCCESS)
  47
  48 struct mpt_query_disk {
  49         char    devname[SPECNAMELEN + 1];
  50 };
  51
  52 struct mpt_standalone_disk {
  53         uint64_t maxlba;
  54         char    inqstring[64];
  55         char    devname[SPECNAMELEN + 1];
  56         u_int   bus;
  57         u_int   target;
  58 };
  59
  60 struct mpt_drive_list {
  61         int     ndrives;
  62         CONFIG_PAGE_RAID_PHYS_DISK_0 *drives[0];
  63 };
  64
  65 struct mptutil_command {
  66         const char *name;
  67         int (*handler)(int ac, char **av);
  68 };
  69
  70 #define MPT_DATASET(name)       mptutil_ ## name ## _table
  71
  72 #define MPT_COMMAND(set, name, function)                                \
  73         static struct mptutil_command function ## _mptutil_command =    \
  74         { #name, function };                                            \
  75         DATA_SET(MPT_DATASET(set), function ## _mptutil_command)
  76
  77 #define MPT_TABLE(set, name)                                            \
  78         SET_DECLARE(MPT_DATASET(name), struct mptutil_command);         \
  79                                                                         \
  80         static int                                                      \
  81         mptutil_ ## name ## _table_handler(int ac, char **av)           \
  82         {                                                               \
  83                 return (mpt_table_handler(SET_BEGIN(MPT_DATASET(name)), \
  84                     SET_LIMIT(MPT_DATASET(name)), ac, av));             \
  85         }                                                               \
  86         MPT_COMMAND(set, name, mptutil_ ## name ## _table_handler)
  87
  88 extern int mpt_unit;
  89
  90 #ifdef DEBUG
  91 void    hexdump(const void *ptr, int length, const char *hdr, int flags);
  92 #define HD_COLUMN_MASK  0xff
  93 #define HD_DELIM_MASK   0xff00
  94 #define HD_OMIT_COUNT   (1 << 16)
  95 #define HD_OMIT_HEX     (1 << 17)
  96 #define HD_OMIT_CHARS   (1 << 18)
  97 #endif
  98
  99 int     mpt_table_handler(struct mptutil_command **start,
 100     struct mptutil_command **end, int ac, char **av);
 101 int     mpt_read_config_page_header(int fd, U8 PageType, U8 PageNumber,
 102     U32 PageAddress, CONFIG_PAGE_HEADER *header, U16 *IOCStatus);
 103 void    *mpt_read_config_page(int fd, U8 PageType, U8 PageNumber,
 104     U32 PageAddress, U16 *IOCStatus);
 105 void    *mpt_read_extended_config_page(int fd, U8 ExtPageType, U8 PageVersion,
 106     U8 PageNumber, U32 PageAddress, U16 *IOCStatus);
 107 int     mpt_write_config_page(int fd, void *buf, U16 *IOCStatus);
 108 const char *mpt_ioc_status(U16 IOCStatus);
 109 int     mpt_raid_action(int fd, U8 Action, U8 VolumeBus, U8 VolumeID,
 110     U8 PhysDiskNum, U32 ActionDataWord, void *buf, int len,
 111     RAID_VOL0_STATUS *VolumeStatus, U32 *ActionData, int datalen,
 112     U16 *IOCStatus, U16 *ActionStatus, int write);
 113 const char *mpt_raid_status(U16 ActionStatus);
 114 int     mpt_open(int unit);
 115 const char *mpt_raid_level(U8 VolumeType);
 116 const char *mpt_volstate(U8 State);
 117 const char *mpt_pdstate(CONFIG_PAGE_RAID_PHYS_DISK_0 *info);
 118 const char *mpt_pd_inq_string(CONFIG_PAGE_RAID_PHYS_DISK_0 *pd_info);
 119 struct mpt_drive_list *mpt_pd_list(int fd);
 120 void    mpt_free_pd_list(struct mpt_drive_list *list);
 121 int     mpt_query_disk(U8 VolumeBus, U8 VolumeID, struct mpt_query_disk *qd);
 122 const char *mpt_volume_name(U8 VolumeBus, U8 VolumeID);
 123 int     mpt_fetch_disks(int fd, int *ndisks,
 124     struct mpt_standalone_disk **disksp);
 125 int     mpt_lock_volume(U8 VolumeBus, U8 VolumeID);
 126 int     mpt_lookup_drive(struct mpt_drive_list *list, const char *drive,
 127     U8 *PhysDiskNum);
 128 int     mpt_lookup_volume(int fd, const char *name, U8 *VolumeBus,
 129     U8 *VolumeID);
 130 int     mpt_rescan_bus(int bus, int id);
 131
 132 static __inline void *
 133 mpt_read_man_page(int fd, U8 PageNumber, U16 *IOCStatus)
 134 {
 135
 136         return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_MANUFACTURING,
 137             PageNumber, 0, IOCStatus));
 138 }
 139
 140 static __inline void *
 141 mpt_read_ioc_page(int fd, U8 PageNumber, U16 *IOCStatus)
 142 {
 143
 144         return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_IOC, PageNumber,
 145             0, IOCStatus));
 146 }
 147
 148 static __inline U32
 149 mpt_vol_pageaddr(U8 VolumeBus, U8 VolumeID)
 150 {
 151
 152         return (VolumeBus << 8 | VolumeID);
 153 }
 154
 155 static __inline CONFIG_PAGE_RAID_VOL_0 *
 156 mpt_vol_info(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus)
 157 {
 158
 159         return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 0,
 160             mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus));
 161 }
 162
 163 static __inline CONFIG_PAGE_RAID_VOL_1 *
 164 mpt_vol_names(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus)
 165 {
 166
 167         return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 1,
 168             mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus));
 169 }
 170
 171 static __inline CONFIG_PAGE_RAID_PHYS_DISK_0 *
 172 mpt_pd_info(int fd, U8 PhysDiskNum, U16 *IOCStatus)
 173 {
 174
 175         return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_PHYSDISK, 0,
 176             PhysDiskNum, IOCStatus));
 177 }
 178
 179 #endif /* !__MPTUTIL_H__ */