/*      $NetBSD: mpt_debug.c,v 1.13 2024/02/09 22:08:34 andvar Exp $    */

/*
* Copyright (c) 2000, 2001 by Greg Ansley
*
* 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 immediately at the beginning of the file, without modification,
*    this list of conditions, and the following disclaimer.
* 2. The name of the author may not 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.
*/
/*
* Additional Copyright (c) 2002 by Matthew Jacob under same license.
*/

/*
* mpt_debug.c:
*
* Debug routines for LSI Fusion adapters.
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: mpt_debug.c,v 1.13 2024/02/09 22:08:34 andvar Exp $");

#include <dev/ic/mpt.h>

struct Error_Map {
       int      Error_Code;
       const char    *Error_String;
};

static const struct Error_Map IOC_Status[] = {
{ MPI_IOCSTATUS_SUCCESS,                  "Success" },
{ MPI_IOCSTATUS_INVALID_FUNCTION,         "IOC: Invalid Function" },
{ MPI_IOCSTATUS_BUSY,                     "IOC: Busy" },
{ MPI_IOCSTATUS_INVALID_SGL,              "IOC: Invalid SGL" },
{ MPI_IOCSTATUS_INTERNAL_ERROR,           "IOC: Internal Error" },
{ MPI_IOCSTATUS_RESERVED,                 "IOC: Reserved" },
{ MPI_IOCSTATUS_INSUFFICIENT_RESOURCES,   "IOC: Insufficient Resources" },
{ MPI_IOCSTATUS_INVALID_FIELD,            "IOC: Invalid Field" },
{ MPI_IOCSTATUS_INVALID_STATE,            "IOC: Invalid State" },
{ MPI_IOCSTATUS_CONFIG_INVALID_ACTION,    "Invalid Action" },
{ MPI_IOCSTATUS_CONFIG_INVALID_TYPE,      "Invalid Type" },
{ MPI_IOCSTATUS_CONFIG_INVALID_PAGE,      "Invalid Page" },
{ MPI_IOCSTATUS_CONFIG_INVALID_DATA,      "Invalid Data" },
{ MPI_IOCSTATUS_CONFIG_NO_DEFAULTS,       "No Defaults" },
{ MPI_IOCSTATUS_CONFIG_CANT_COMMIT,       "Can't Commit" },
{ MPI_IOCSTATUS_SCSI_RECOVERED_ERROR,     "SCSI: Recoverd Error" },
{ MPI_IOCSTATUS_SCSI_INVALID_BUS,         "SCSI: Invalid Bus" },
{ MPI_IOCSTATUS_SCSI_INVALID_TARGETID,    "SCSI: Invalid Target ID" },
{ MPI_IOCSTATUS_SCSI_DEVICE_NOT_THERE,    "SCSI: Device Not There" },
{ MPI_IOCSTATUS_SCSI_DATA_OVERRUN,        "SCSI: Data Overrun" },
{ MPI_IOCSTATUS_SCSI_DATA_UNDERRUN,       "SCSI: Data Underrun" },
{ MPI_IOCSTATUS_SCSI_IO_DATA_ERROR,       "SCSI: Data Error" },
{ MPI_IOCSTATUS_SCSI_PROTOCOL_ERROR,      "SCSI: Protocol Error" },
{ MPI_IOCSTATUS_SCSI_TASK_TERMINATED,     "SCSI: Task Terminated" },
{ MPI_IOCSTATUS_SCSI_RESIDUAL_MISMATCH,   "SCSI: Residual Mismatch" },
{ MPI_IOCSTATUS_SCSI_TASK_MGMT_FAILED,    "SCSI: Task Management Failed" },
{ MPI_IOCSTATUS_SCSI_IOC_TERMINATED,      "SCSI: IOC Bus Reset" },
{ MPI_IOCSTATUS_SCSI_EXT_TERMINATED,      "SCSI: External Bus Reset" },
{ MPI_IOCSTATUS_TARGET_PRIORITY_IO,       "SCSI Target: Priority I/O" },
{ MPI_IOCSTATUS_TARGET_INVALID_PORT,      "SCSI Target: Invalid Port" },
{ MPI_IOCSTATUS_TARGET_INVALID_IOCINDEX,  "SCSI Target: Invalid IOC Index" },
{ MPI_IOCSTATUS_TARGET_ABORTED,           "SCSI Target: Aborted" },
{ MPI_IOCSTATUS_TARGET_NO_CONN_RETRYABLE, "SCSI Target: No Connection (Retryable)" },
{ MPI_IOCSTATUS_TARGET_NO_CONNECTION,     "SCSI Target: No Connection" },
{ MPI_IOCSTATUS_TARGET_XFER_COUNT_MISMATCH,"SCSI Target: Transfer Count Mismatch" },
{ MPI_IOCSTATUS_TARGET_FC_ABORTED,        "FC: Aborted" },
{ MPI_IOCSTATUS_TARGET_FC_RX_ID_INVALID,  "FC: Receive ID Invalid" },
{ MPI_IOCSTATUS_TARGET_FC_DID_INVALID,    "FC: Receive DID Invalid" },
{ MPI_IOCSTATUS_TARGET_FC_NODE_LOGGED_OUT,"FC: Node Logged Out" },
{ MPI_IOCSTATUS_LAN_DEVICE_NOT_FOUND,     "LAN: Device Not Found" },
{ MPI_IOCSTATUS_LAN_DEVICE_FAILURE,       "LAN: Device Not Failure" },
{ MPI_IOCSTATUS_LAN_TRANSMIT_ERROR,       "LAN: Transmit Error" },
{ MPI_IOCSTATUS_LAN_TRANSMIT_ABORTED,     "LAN: Transmit Aborted" },
{ MPI_IOCSTATUS_LAN_RECEIVE_ERROR,        "LAN: Receive Error" },
{ MPI_IOCSTATUS_LAN_RECEIVE_ABORTED,      "LAN: Receive Aborted" },
{ MPI_IOCSTATUS_LAN_PARTIAL_PACKET,       "LAN: Partial Packet" },
{ MPI_IOCSTATUS_LAN_CANCELED,             "LAN: Canceled" },
{ -1, 0},
};

static const struct Error_Map IOC_Func[] = {
{ MPI_FUNCTION_SCSI_IO_REQUEST,              "SCSI IO Request" },
{ MPI_FUNCTION_SCSI_TASK_MGMT,               "SCSI Task Management" },
{ MPI_FUNCTION_IOC_INIT,                     "IOC Init" },
{ MPI_FUNCTION_IOC_FACTS,                    "IOC Facts" },
{ MPI_FUNCTION_CONFIG,                       "Config" },
{ MPI_FUNCTION_PORT_FACTS,                   "Port Facts" },
{ MPI_FUNCTION_PORT_ENABLE,                  "Port Enable" },
{ MPI_FUNCTION_EVENT_NOTIFICATION,           "Event Notification" },
{ MPI_FUNCTION_FW_DOWNLOAD,                  "FW Download" },
{ MPI_FUNCTION_TARGET_CMD_BUFFER_POST,       "SCSI Target Command Buffer" },
{ MPI_FUNCTION_TARGET_ASSIST,                "Target Assist" },
{ MPI_FUNCTION_TARGET_STATUS_SEND,           "Target Status Send" },
{ MPI_FUNCTION_TARGET_MODE_ABORT,            "Target Mode Abort" },
{ MPI_FUNCTION_TARGET_FC_BUF_POST_LINK_SRVC, "FC: Link Service Buffers" },
{ MPI_FUNCTION_TARGET_FC_RSP_LINK_SRVC,      "FC: Link Service Response" },
{ MPI_FUNCTION_TARGET_FC_EX_SEND_LINK_SRVC,  "FC: Send Extended Link Service" },
{ MPI_FUNCTION_TARGET_FC_ABORT,              "FC: Abort" },
{ MPI_FUNCTION_LAN_SEND,                     "LAN Send" },
{ MPI_FUNCTION_LAN_RECEIVE,                  "LAN Receive" },
{ MPI_FUNCTION_LAN_RESET,                    "LAN Reset" },
{ -1, 0},
};

static const struct Error_Map IOC_Event[] = {
{ MPI_EVENT_NONE,                       "None" },
{ MPI_EVENT_LOG_DATA,                   "LogData" },
{ MPI_EVENT_STATE_CHANGE,               "State Change" },
{ MPI_EVENT_UNIT_ATTENTION,             "Unit Attention" },
{ MPI_EVENT_IOC_BUS_RESET,              "IOC Bus Reset" },
{ MPI_EVENT_EXT_BUS_RESET,              "External Bus Reset" },
{ MPI_EVENT_RESCAN,                     "Rescan" },
{ MPI_EVENT_LINK_STATUS_CHANGE,         "Link Status Change" },
{ MPI_EVENT_LOOP_STATE_CHANGE,          "Loop State Change" },
{ MPI_EVENT_LOGOUT,                     "Logout" },
{ MPI_EVENT_EVENT_CHANGE,               "EventChange" },
{ MPI_EVENT_INTEGRATED_RAID,            "Integrated RAID" },
{ MPI_EVENT_SCSI_DEVICE_STATUS_CHANGE,  "SCSI Device Status Change" },
{ MPI_EVENT_ON_BUS_TIMER_EXPIRED,       "On Bus Timer Expired" },
{ MPI_EVENT_QUEUE_FULL,                 "Queue Full" },
{ MPI_EVENT_SAS_DEVICE_STATUS_CHANGE,   "SAS Device Status Change" },
{ MPI_EVENT_SAS_SES,                    "SAS Ses" },
{ MPI_EVENT_PERSISTENT_TABLE_FULL,      "Persistent Table Full" },
{ MPI_EVENT_SAS_PHY_LINK_STATUS,        "SAS Phy Link Status" },
{ MPI_EVENT_SAS_DISCOVERY_ERROR,        "SAS Discovery Error" },
{ MPI_EVENT_IR_RESYNC_UPDATE,           "IR Resync Update" },
{ MPI_EVENT_IR2,                        "IR2", },
{ MPI_EVENT_SAS_DISCOVERY,              "Sas Discovery" },
{ -1, 0},
};

static const struct Error_Map IOC_SCSIState[] = {
{ MPI_SCSI_STATE_AUTOSENSE_VALID,       "AutoSense_Valid" },
{ MPI_SCSI_STATE_AUTOSENSE_FAILED,      "AutoSense_Failed" },
{ MPI_SCSI_STATE_NO_SCSI_STATUS,        "No_SCSI_Status" },
{ MPI_SCSI_STATE_TERMINATED,            "State_Terminated" },
{ MPI_SCSI_STATE_RESPONSE_INFO_VALID,   "Response_Info_Valid" },
{ MPI_SCSI_STATE_QUEUE_TAG_REJECTED,    "Queue Tag Rejected" },
{ -1, 0},
};

static const struct Error_Map IOC_SCSIStatus[] = {
{ SCSI_OK,                              "OK" },
{ SCSI_CHECK,                   "Check Condition" },
#if 0
{ SCSI_STATUS_COND_MET,                 "Check Condition Met" },
#endif
{ SCSI_BUSY,                            "Busy" },
{ SCSI_INTERM,                          "Intermediate Condition" },
#if 0
{ SCSI_STATUS_INTERMED_COND_MET,        "Intermediate Condition Met" },
#endif
{ SCSI_RESV_CONFLICT,                   "Reservation Conflict" },
#if 0
{ SCSI_STATUS_CMD_TERMINATED,           "Command Terminated" },
#endif
{ SCSI_QUEUE_FULL,                      "Queue Full" },
{ -1, 0},
};

static const struct Error_Map IOC_Diag[] = {
{ MPT_DIAG_ENABLED,     "DWE" },
{ MPT_DIAG_FLASHBAD,    "FLASH_Bad" },
{ MPT_DIAG_TTLI,        "TTLI" },
{ MPT_DIAG_RESET_IOC,   "Reset" },
{ MPT_DIAG_ARM_DISABLE, "DisARM" },
{ MPT_DIAG_DME,         "DME" },
{ -1, 0 },
};


static void mpt_dump_sgl(SGE_IO_UNION *sgl);

static const char *
mpt_ioc_status(int code)
{
       const struct Error_Map *status = IOC_Status;
       static char tbuf[64];
       while (status->Error_Code >= 0) {
               if (status->Error_Code == (code & MPI_IOCSTATUS_MASK))
                       return status->Error_String;
               status++;
       }
       snprintf(tbuf, sizeof tbuf, "Unknown (0x%08x)", code);
       return tbuf;
}

char *
mpt_ioc_diag(u_int32_t code)
{
       const struct Error_Map *status = IOC_Diag;
       static char tbuf[128];
       size_t len;
       len = snprintf(tbuf, sizeof(tbuf), "(0x%08x)", code);
       if (len > sizeof(tbuf))
               return tbuf;
       while (status->Error_Code >= 0) {
               if ((status->Error_Code & code) != 0) {
                       if (len >= sizeof(tbuf))
                               return tbuf;
                       len += snprintf(tbuf + len, sizeof(tbuf) - len, "%s ",
                           status->Error_String);
               }
               status++;
       }
       return tbuf;
}

static const char *
mpt_ioc_function(int code)
{
       const struct Error_Map *status = IOC_Func;
       static char tbuf[64];
       while (status->Error_Code >= 0) {
               if (status->Error_Code == code)
                       return status->Error_String;
               status++;
       }
       snprintf(tbuf, sizeof tbuf, "Unknown (0x%08x)", code);
       return tbuf;
}
static const char *
mpt_ioc_event(int code)
{
       const struct Error_Map *status = IOC_Event;
       static char tbuf[64];
       while (status->Error_Code >= 0) {
               if (status->Error_Code == code)
                       return status->Error_String;
               status++;
       }
       snprintf(tbuf, sizeof tbuf, "Unknown (0x%08x)", code);
       return tbuf;
}
static char *
mpt_scsi_state(int code)
{
       const struct Error_Map *status = IOC_SCSIState;
       static char tbuf[128];
       size_t len;
       len = snprintf(tbuf, sizeof(tbuf), "(0x%08x)", code);
       if (len > sizeof(tbuf))
               return tbuf;
       while (status->Error_Code >= 0) {
               if ((status->Error_Code & code) != 0) {
                       if (len >= sizeof(tbuf))
                               return tbuf;
                       len += snprintf(tbuf + len, sizeof(tbuf) - len, "%s ",
                               status->Error_String);
               }
               status++;
       }
       return tbuf;
}
static const char *
mpt_scsi_status(int code)
{
       const struct Error_Map *status = IOC_SCSIStatus;
       static char tbuf[64];
       while (status->Error_Code >= 0) {
               if (status->Error_Code == code)
                       return status->Error_String;
               status++;
       }
       snprintf(tbuf, sizeof tbuf, "Unknown (0x%08x)", code);
       return tbuf;
}
static const char *
mpt_who(int who_init)
{
       const char *who;

       switch (who_init) {
       case MPT_DB_INIT_NOONE:       who = "No One";        break;
       case MPT_DB_INIT_BIOS:        who = "BIOS";          break;
       case MPT_DB_INIT_ROMBIOS:     who = "ROM BIOS";      break;
       case MPT_DB_INIT_PCIPEER:     who = "PCI Peer";      break;
       case MPT_DB_INIT_HOST:        who = "Host Driver";   break;
       case MPT_DB_INIT_MANUFACTURE: who = "Manufacturing"; break;
       default:                      who = "Unknown";       break;
       }
       return who;
}

static const char *
mpt_state(u_int32_t mb)
{
       const char *text;

       switch (MPT_STATE(mb)) {
               case MPT_DB_STATE_RESET:  text = "Reset";   break;
               case MPT_DB_STATE_READY:  text = "Ready";   break;
               case MPT_DB_STATE_RUNNING:text = "Running"; break;
               case MPT_DB_STATE_FAULT:  text = "Fault";   break;
               default:                  text = "Unknown"; break;
       }
       return text;
};

void
mpt_print_db(u_int32_t mb)
{
       printf("mpt mailbox: (0x%x) State %s  WhoInit %s\n",
           mb, mpt_state(mb), mpt_who(MPT_WHO(mb)));
}

/*****************************************************************************/
/*  Reply functions                                                          */
/*****************************************************************************/
static void
mpt_print_reply_hdr(MSG_DEFAULT_REPLY *msg)
{
       printf("%s Reply @ %p\n", mpt_ioc_function(msg->Function), msg);
       printf("\tIOC Status    %s\n", mpt_ioc_status(le16toh(msg->IOCStatus)));
       printf("\tIOCLogInfo    0x%08x\n", msg->IOCLogInfo);
       printf("\tMsgLength     0x%02x\n", msg->MsgLength);
       printf("\tMsgFlags      0x%02x\n", msg->MsgFlags);
       printf("\tMsgContext    0x%08x\n", le32toh(msg->MsgContext));
}

static void
mpt_print_init_reply(MSG_IOC_INIT_REPLY *msg)
{
       mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
       printf("\tWhoInit       %s\n", mpt_who(msg->WhoInit));
       printf("\tMaxDevices    0x%02x\n", msg->MaxDevices);
       printf("\tMaxBuses     0x%02x\n", msg->MaxBuses);
}

static void
mpt_print_ioc_facts(MSG_IOC_FACTS_REPLY *msg)
{
       mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
       printf("\tIOCNumber     %d\n",          msg->IOCNumber);
       printf("\tMaxChainDepth %d\n",          msg->MaxChainDepth);
       printf("\tWhoInit       %s\n",          mpt_who(msg->WhoInit));
       printf("\tBlockSize     %d\n",          msg->BlockSize);
       printf("\tFlags         %d\n",          msg->Flags);
       printf("\tReplyQueueDepth %d\n",        le16toh(msg->ReplyQueueDepth));
       printf("\tReqFrameSize  0x%04x\n",      le16toh(msg->RequestFrameSize));
       printf("\tFW Version    0x%08x\n",      msg->FWVersion.Word);
       printf("\tProduct ID    0x%04x\n",      le16toh(msg->ProductID));
       printf("\tCredits       0x%04x\n",      le16toh(msg->GlobalCredits));
       printf("\tPorts         %d\n",          msg->NumberOfPorts);
       printf("\tEventState    0x%02x\n",      msg->EventState);
       printf("\tHostMFA_HA    0x%08x\n",
           le32toh(msg->CurrentHostMfaHighAddr));
       printf("\tSenseBuf_HA   0x%08x\n",
           le32toh(msg->CurrentSenseBufferHighAddr));
       printf("\tRepFrameSize  0x%04x\n",
           le16toh(msg->CurReplyFrameSize));
       printf("\tMaxDevices    0x%02x\n",      msg->MaxDevices);
       printf("\tMaxBuses      0x%02x\n",      msg->MaxBuses);
       printf("\tFWImageSize   0x%04x\n",      le32toh(msg->FWImageSize));
}

static void
mpt_print_enable_reply(MSG_PORT_ENABLE_REPLY *msg)
{
       mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
       printf("\tPort:         %d\n", msg->PortNumber);
}

static void
mpt_print_scsi_io_reply(MSG_SCSI_IO_REPLY *msg)
{
       mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
       printf("\tBus:          %d\n", msg->Bus);
       printf("\tTargetID      %d\n", msg->TargetID);
       printf("\tCDBLength     %d\n", msg->CDBLength);
       printf("\tSCSI Status:  %s\n", mpt_scsi_status(msg->SCSIStatus));
       printf("\tSCSI State:   %s\n", mpt_scsi_state(msg->SCSIState));
       printf("\tTransferCnt   0x%04x\n", le32toh(msg->TransferCount));
       printf("\tSenseCnt      0x%04x\n", le32toh(msg->SenseCount));
       printf("\tResponseInfo  0x%08x\n", le32toh(msg->ResponseInfo));
}



static void
mpt_print_event_notice(MSG_EVENT_NOTIFY_REPLY *msg)
{
       mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
       printf("\tEvent:        %s\n", mpt_ioc_event(le32toh(msg->Event)));
       printf("\tEventContext  0x%04x\n", le32toh(msg->EventContext));
       printf("\tAckRequired     %d\n", msg->AckRequired);
       printf("\tEventDataLength %d\n", le16toh(msg->EventDataLength));
       printf("\tContinuation    %d\n", msg->MsgFlags & 0x80);
       switch(msg->Event) {
       case MPI_EVENT_LOG_DATA:
               printf("\tEvtLogData:   0x%04x\n", le32toh(msg->Data[0]));
               break;

       case MPI_EVENT_UNIT_ATTENTION:
               printf("\tTargetID:     0x%04x\n",
                       msg->Data[0] & 0xff);
               printf("\tBus:          0x%04x\n",
                       (msg->Data[0] >> 8) & 0xff);
               break;

       case MPI_EVENT_IOC_BUS_RESET:
       case MPI_EVENT_EXT_BUS_RESET:
       case MPI_EVENT_RESCAN:
               printf("\tPort:           %d\n",
                       (msg->Data[0] >> 8) & 0xff);
               break;

       case MPI_EVENT_LINK_STATUS_CHANGE:
               printf("\tLinkState:    %d\n",
                       msg->Data[0] & 0xff);
               printf("\tPort:         %d\n",
                       (msg->Data[1] >> 8) & 0xff);
               break;

       case MPI_EVENT_LOOP_STATE_CHANGE:
               printf("\tType:         %d\n",
                       (msg->Data[0] >> 16) & 0xff);
               printf("\tChar3:      0x%02x\n",
                       (msg->Data[0] >> 8) & 0xff);
               printf("\tChar4:      0x%02x\n",
                       (msg->Data[0]     ) & 0xff);
               printf("\tPort:         %d\n",
                       (msg->Data[1] >> 8) & 0xff);
               break;

       case MPI_EVENT_LOGOUT:
               printf("\tN_PortId:   0x%04x\n", msg->Data[0]);
               printf("\tPort:         %d\n",
                       (msg->Data[1] >> 8) & 0xff);
               break;
       }

}

void
mpt_print_reply(void *vmsg)
{
       MSG_DEFAULT_REPLY *msg = vmsg;

       switch (msg->Function) {
       case MPI_FUNCTION_EVENT_NOTIFICATION:
               mpt_print_event_notice((MSG_EVENT_NOTIFY_REPLY *)msg);
               break;
       case MPI_FUNCTION_PORT_ENABLE:
               mpt_print_enable_reply((MSG_PORT_ENABLE_REPLY *)msg);
               break;
       case MPI_FUNCTION_IOC_FACTS:
               mpt_print_ioc_facts((MSG_IOC_FACTS_REPLY *)msg);
               break;
       case MPI_FUNCTION_IOC_INIT:
               mpt_print_init_reply((MSG_IOC_INIT_REPLY *)msg);
               break;
       case MPI_FUNCTION_SCSI_IO_REQUEST:
               mpt_print_scsi_io_reply((MSG_SCSI_IO_REPLY *)msg);
               break;
       default:
               mpt_print_reply_hdr((MSG_DEFAULT_REPLY *)msg);
               break;
       }
}

/*****************************************************************************/
/*  Request functions                                                        */
/*****************************************************************************/
static void
mpt_print_request_hdr(MSG_REQUEST_HEADER *req)
{
       printf("%s @ %p\n", mpt_ioc_function(req->Function), req);
       printf("\tChain Offset  0x%02x\n", req->ChainOffset);
       printf("\tMsgFlags      0x%02x\n", req->MsgFlags);
       printf("\tMsgContext    0x%08x\n", le32toh(req->MsgContext));
}

void
mpt_print_scsi_io_request(MSG_SCSI_IO_REQUEST *orig_msg)
{
       MSG_SCSI_IO_REQUEST local, *msg = &local;
       int i;

       memcpy(msg, orig_msg, sizeof (MSG_SCSI_IO_REQUEST));
       mpt_print_request_hdr((MSG_REQUEST_HEADER *)msg);
       printf("\tBus:                %d\n", msg->Bus);
       printf("\tTargetID            %d\n", msg->TargetID);
       printf("\tSenseBufferLength   %d\n", msg->SenseBufferLength);
       printf("\tLUN:              0x%0x\n", msg->LUN[1]);
       printf("\tControl           0x%08x ", le32toh(msg->Control));
#define MPI_PRINT_FIELD(x)                                              \
       case MPI_SCSIIO_CONTROL_ ## x :                                 \
               printf(" " #x " ");                                     \
               break

       switch (le32toh(msg->Control) & MPI_SCSIIO_CONTROL_DATADIRECTION_MASK) {
       MPI_PRINT_FIELD(NODATATRANSFER);
       MPI_PRINT_FIELD(WRITE);
       MPI_PRINT_FIELD(READ);
       default:
               printf(" Invalid DIR! ");
               break;
       }
       switch (le32toh(msg->Control) & MPI_SCSIIO_CONTROL_TASKATTRIBUTE_MASK) {
       MPI_PRINT_FIELD(SIMPLEQ);
       MPI_PRINT_FIELD(HEADOFQ);
       MPI_PRINT_FIELD(ORDEREDQ);
       MPI_PRINT_FIELD(ACAQ);
       MPI_PRINT_FIELD(UNTAGGED);
       MPI_PRINT_FIELD(NO_DISCONNECT);
       default:
               printf(" Unknown attribute! ");
               break;
       }

       printf("\n");
#undef MPI_PRINT_FIELD

       printf("\tDataLength\t0x%08x\n", le32toh(msg->DataLength));
       printf("\tSenseBufAddr\t0x%08x\n", le32toh(msg->SenseBufferLowAddr));
       printf("\tCDB[0:%d]\t", msg->CDBLength);
       for (i = 0; i < msg->CDBLength; i++)
               printf("%02x ", msg->CDB[i]);
       printf("\n");
       mpt_dump_sgl(&orig_msg->SGL);
}

void
mpt_print_request(void *vreq)
{
       MSG_REQUEST_HEADER *req = vreq;

       switch (req->Function) {
       case MPI_FUNCTION_SCSI_IO_REQUEST:
               mpt_print_scsi_io_request((MSG_SCSI_IO_REQUEST *)req);
               break;
       default:
               mpt_print_request_hdr(req);
               break;
       }
}

const char *
mpt_req_state(enum mpt_req_state state)
{
       const char *text;

       switch (state) {
       case REQ_FREE:         text = "Free";         break;
       case REQ_IN_PROGRESS:  text = "In Progress";  break;
       case REQ_ON_CHIP:      text = "On Chip";      break;
       case REQ_TIMEOUT:      text = "Timeout";      break;
       default:               text = "Unknown";      break;
       }
       return text;
};

static void
mpt_dump_sgl(SGE_IO_UNION *su)
{
       SGE_SIMPLE32 *se = (SGE_SIMPLE32 *) su;
       int iCount, flags;

       iCount = MPT_SGL_MAX;
       do {
               int iprt;

               printf("\t");
               flags = MPI_SGE_GET_FLAGS(le32toh(se->FlagsLength));
               switch (flags & MPI_SGE_FLAGS_ELEMENT_MASK) {
               case MPI_SGE_FLAGS_SIMPLE_ELEMENT:
               {
                       printf("SE32 %p: Addr=0x%0x FlagsLength=0x%0x\n",
                           se, le32toh(se->Address), le32toh(se->FlagsLength));
                       printf(" ");
                       break;
               }
               case MPI_SGE_FLAGS_CHAIN_ELEMENT:
               {
                       SGE_CHAIN32 *ce = (SGE_CHAIN32 *) se;
                       printf("CE32 %p: Addr=0x%0x NxtChnO=0x%x Flgs=0x%x "
                           "Len=0x%0x\n", ce, le32toh(ce->Address),
                           ce->NextChainOffset, ce->Flags,
                           le16toh(ce->Length));
                       flags = 0;
                       break;
               }
               case MPI_SGE_FLAGS_TRANSACTION_ELEMENT:
                       printf("TE32 @ %p\n", se);
                       flags = 0;
                       break;
               }
               iprt = 0;
#define MPT_PRINT_FLAG(x)                                               \
               if (flags & MPI_SGE_FLAGS_ ## x ) {                     \
                       if (iprt == 0) {                                \
                               printf("\t");                           \
                       }                                               \
                       printf(" ");                                    \
                       printf( #x );                                   \
                       iprt++;                                         \
               }
               MPT_PRINT_FLAG(LOCAL_ADDRESS);
               MPT_PRINT_FLAG(HOST_TO_IOC);
               MPT_PRINT_FLAG(64_BIT_ADDRESSING);
               MPT_PRINT_FLAG(LAST_ELEMENT);
               MPT_PRINT_FLAG(END_OF_BUFFER);
               MPT_PRINT_FLAG(END_OF_LIST);
#undef MPT_PRINT_FLAG
               if (iprt)
                       printf("\n");
               se++;
               iCount -= 1;
       } while ((flags & MPI_SGE_FLAGS_END_OF_LIST) == 0 && iCount != 0);
}