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 IOC_STATUS_SUCCESS(status) \ 44 (((status) & MPI_IOCSTATUS_MASK) == MPI_IOCSTATUS_SUCCESS) 45 46 struct mpt_query_disk { 47 char devname[SPECNAMELEN + 1]; 48 }; 49 50 struct mpt_standalone_disk { 51 uint64_t maxlba; 52 char inqstring[64]; 53 char devname[SPECNAMELEN + 1]; 54 u_int bus; 55 u_int target; 56 }; 57 58 struct mpt_drive_list { 59 int ndrives; 60 CONFIG_PAGE_RAID_PHYS_DISK_0 *drives[0]; 61 }; 62 63 struct mptutil_command { 64 const char *name; 65 int (*handler)(int ac, char **av); 66 }; 67 68 #define MPT_DATASET(name) mptutil_ ## name ## _table 69 70 #define MPT_COMMAND(set, name, function) \ 71 static struct mptutil_command function ## _mptutil_command = \ 72 { #name, function }; \ 73 DATA_SET(MPT_DATASET(set), function ## _mptutil_command) 74 75 #define MPT_TABLE(set, name) \ 76 SET_DECLARE(MPT_DATASET(name), struct mptutil_command); \ 77 \ 78 static int \ 79 mptutil_ ## name ## _table_handler(int ac, char **av) \ 80 { \ 81 return (mpt_table_handler(SET_BEGIN(MPT_DATASET(name)), \ 82 SET_LIMIT(MPT_DATASET(name)), ac, av)); \ 83 } \ 84 MPT_COMMAND(set, name, mptutil_ ## name ## _table_handler) 85 86 extern int mpt_unit; 87 88 #ifdef DEBUG 89 void hexdump(const void *ptr, int length, const char *hdr, int flags); 90 #define HD_COLUMN_MASK 0xff 91 #define HD_DELIM_MASK 0xff00 92 #define HD_OMIT_COUNT (1 << 16) 93 #define HD_OMIT_HEX (1 << 17) 94 #define HD_OMIT_CHARS (1 << 18) 95 #endif 96 97 int mpt_table_handler(struct mptutil_command **start, 98 struct mptutil_command **end, int ac, char **av); 99 int mpt_read_config_page_header(int fd, U8 PageType, U8 PageNumber, 100 U32 PageAddress, CONFIG_PAGE_HEADER *header, U16 *IOCStatus); 101 void *mpt_read_config_page(int fd, U8 PageType, U8 PageNumber, 102 U32 PageAddress, U16 *IOCStatus); 103 void *mpt_read_extended_config_page(int fd, U8 ExtPageType, U8 PageVersion, 104 U8 PageNumber, U32 PageAddress, U16 *IOCStatus); 105 int mpt_write_config_page(int fd, void *buf, U16 *IOCStatus); 106 const char *mpt_ioc_status(U16 IOCStatus); 107 int mpt_raid_action(int fd, U8 Action, U8 VolumeBus, U8 VolumeID, 108 U8 PhysDiskNum, U32 ActionDataWord, void *buf, int len, 109 RAID_VOL0_STATUS *VolumeStatus, U32 *ActionData, int datalen, 110 U16 *IOCStatus, U16 *ActionStatus, int write); 111 const char *mpt_raid_status(U16 ActionStatus); 112 int mpt_open(int unit); 113 const char *mpt_raid_level(U8 VolumeType); 114 const char *mpt_volstate(U8 State); 115 const char *mpt_pdstate(CONFIG_PAGE_RAID_PHYS_DISK_0 *info); 116 const char *mpt_pd_inq_string(CONFIG_PAGE_RAID_PHYS_DISK_0 *pd_info); 117 struct mpt_drive_list *mpt_pd_list(int fd); 118 void mpt_free_pd_list(struct mpt_drive_list *list); 119 int mpt_query_disk(U8 VolumeBus, U8 VolumeID, struct mpt_query_disk *qd); 120 const char *mpt_volume_name(U8 VolumeBus, U8 VolumeID); 121 int mpt_fetch_disks(int fd, int *ndisks, 122 struct mpt_standalone_disk **disksp); 123 int mpt_lock_volume(U8 VolumeBus, U8 VolumeID); 124 int mpt_lookup_drive(struct mpt_drive_list *list, const char *drive, 125 U8 *PhysDiskNum); 126 int mpt_lookup_volume(int fd, const char *name, U8 *VolumeBus, 127 U8 *VolumeID); 128 int mpt_rescan_bus(int bus, int id); 129 130 static __inline void * 131 mpt_read_man_page(int fd, U8 PageNumber, U16 *IOCStatus) 132 { 133 134 return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_MANUFACTURING, 135 PageNumber, 0, IOCStatus)); 136 } 137 138 static __inline void * 139 mpt_read_ioc_page(int fd, U8 PageNumber, U16 *IOCStatus) 140 { 141 142 return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_IOC, PageNumber, 143 0, IOCStatus)); 144 } 145 146 static __inline U32 147 mpt_vol_pageaddr(U8 VolumeBus, U8 VolumeID) 148 { 149 150 return (VolumeBus << 8 | VolumeID); 151 } 152 153 static __inline CONFIG_PAGE_RAID_VOL_0 * 154 mpt_vol_info(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus) 155 { 156 157 return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 0, 158 mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus)); 159 } 160 161 static __inline CONFIG_PAGE_RAID_VOL_1 * 162 mpt_vol_names(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus) 163 { 164 165 return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 1, 166 mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus)); 167 } 168 169 static __inline CONFIG_PAGE_RAID_PHYS_DISK_0 * 170 mpt_pd_info(int fd, U8 PhysDiskNum, U16 *IOCStatus) 171 { 172 173 return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_PHYSDISK, 0, 174 PhysDiskNum, IOCStatus)); 175 } 176 177 #endif /* !__MPTUTIL_H__ */ 178