freebsd-nq/usr.sbin/mptutil/mptutil.h

/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2008 Yahoo!, Inc.
 * All rights reserved.
 * Written by: John Baldwin <jhb@FreeBSD.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef __MPTUTIL_H__
#define	__MPTUTIL_H__

#include <sys/cdefs.h>
#include <sys/linker_set.h>

#include <dev/mpt/mpilib/mpi_type.h>
#include <dev/mpt/mpilib/mpi.h>
#include <dev/mpt/mpilib/mpi_cnfg.h>
#include <dev/mpt/mpilib/mpi_raid.h>

#define	IOC_STATUS_SUCCESS(status)					\
	(((status) & MPI_IOCSTATUS_MASK) == MPI_IOCSTATUS_SUCCESS)

struct mpt_query_disk {
	char	devname[SPECNAMELEN + 1];
};

struct mpt_standalone_disk {
	uint64_t maxlba;
	char	inqstring[64];
	char	devname[SPECNAMELEN + 1];
	u_int	bus;
	u_int	target;
};

struct mpt_drive_list {
	int	ndrives;
	CONFIG_PAGE_RAID_PHYS_DISK_0 *drives[0];
};

struct mptutil_command {
	const char *name;
	int (*handler)(int ac, char **av);
};

#define	MPT_DATASET(name)	mptutil_ ## name ## _table

#define	MPT_COMMAND(set, name, function)				\
	static struct mptutil_command function ## _mptutil_command =	\
	{ #name, function };						\
	DATA_SET(MPT_DATASET(set), function ## _mptutil_command)

#define	MPT_TABLE(set, name)						\
	SET_DECLARE(MPT_DATASET(name), struct mptutil_command);		\
									\
	static int							\
	mptutil_ ## name ## _table_handler(int ac, char **av)		\
	{								\
		return (mpt_table_handler(SET_BEGIN(MPT_DATASET(name)), \
		    SET_LIMIT(MPT_DATASET(name)), ac, av));		\
	}								\
	MPT_COMMAND(set, name, mptutil_ ## name ## _table_handler)

extern int mpt_unit;

#ifdef DEBUG
void	hexdump(const void *ptr, int length, const char *hdr, int flags);
#define	HD_COLUMN_MASK	0xff
#define	HD_DELIM_MASK	0xff00
#define	HD_OMIT_COUNT	(1 << 16)
#define	HD_OMIT_HEX	(1 << 17)
#define	HD_OMIT_CHARS	(1 << 18)
#endif

int	mpt_table_handler(struct mptutil_command **start,
    struct mptutil_command **end, int ac, char **av);
int	mpt_read_config_page_header(int fd, U8 PageType, U8 PageNumber,
    U32 PageAddress, CONFIG_PAGE_HEADER *header, U16 *IOCStatus);
void	*mpt_read_config_page(int fd, U8 PageType, U8 PageNumber,
    U32 PageAddress, U16 *IOCStatus);
void	*mpt_read_extended_config_page(int fd, U8 ExtPageType, U8 PageVersion,
    U8 PageNumber, U32 PageAddress, U16 *IOCStatus);
int	mpt_write_config_page(int fd, void *buf, U16 *IOCStatus);
const char *mpt_ioc_status(U16 IOCStatus);
int	mpt_raid_action(int fd, U8 Action, U8 VolumeBus, U8 VolumeID,
    U8 PhysDiskNum, U32 ActionDataWord, void *buf, int len,
    RAID_VOL0_STATUS *VolumeStatus, U32 *ActionData, int datalen,
    U16 *IOCStatus, U16 *ActionStatus, int write);
const char *mpt_raid_status(U16 ActionStatus);
int	mpt_open(int unit);
const char *mpt_raid_level(U8 VolumeType);
const char *mpt_volstate(U8 State);
const char *mpt_pdstate(CONFIG_PAGE_RAID_PHYS_DISK_0 *info);
const char *mpt_pd_inq_string(CONFIG_PAGE_RAID_PHYS_DISK_0 *pd_info);
struct mpt_drive_list *mpt_pd_list(int fd);
void	mpt_free_pd_list(struct mpt_drive_list *list);
int	mpt_query_disk(U8 VolumeBus, U8 VolumeID, struct mpt_query_disk *qd);
const char *mpt_volume_name(U8 VolumeBus, U8 VolumeID);
int	mpt_fetch_disks(int fd, int *ndisks,
    struct mpt_standalone_disk **disksp);
int	mpt_lock_volume(U8 VolumeBus, U8 VolumeID);
int	mpt_lookup_drive(struct mpt_drive_list *list, const char *drive,
    U8 *PhysDiskNum);
int	mpt_lookup_volume(int fd, const char *name, U8 *VolumeBus,
    U8 *VolumeID);
int	mpt_rescan_bus(int bus, int id);

static __inline void *
mpt_read_man_page(int fd, U8 PageNumber, U16 *IOCStatus)
{

	return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_MANUFACTURING,
	    PageNumber, 0, IOCStatus));
}

static __inline void *
mpt_read_ioc_page(int fd, U8 PageNumber, U16 *IOCStatus)
{

	return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_IOC, PageNumber,
	    0, IOCStatus));
}

static __inline U32
mpt_vol_pageaddr(U8 VolumeBus, U8 VolumeID)
{

	return (VolumeBus << 8 | VolumeID);
}

static __inline CONFIG_PAGE_RAID_VOL_0 *
mpt_vol_info(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus)
{

	return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 0,
	    mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus));
}

static __inline CONFIG_PAGE_RAID_VOL_1 *
mpt_vol_names(int fd, U8 VolumeBus, U8 VolumeID, U16 *IOCStatus)
{

	return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_VOLUME, 1,
	    mpt_vol_pageaddr(VolumeBus, VolumeID), IOCStatus));
}

static __inline CONFIG_PAGE_RAID_PHYS_DISK_0 *
mpt_pd_info(int fd, U8 PhysDiskNum, U16 *IOCStatus)
{

	return (mpt_read_config_page(fd, MPI_CONFIG_PAGETYPE_RAID_PHYSDISK, 0,
	    PhysDiskNum, IOCStatus));
}

#endif /* !__MPTUTIL_H__ */