// SPDX-License-Identifier: GPL-2.0
#include "qlge.h"

int qlge_unpause_mpi_risc(struct qlge_adapter *qdev)
{
        u32 tmp;

        /* Un-pause the RISC */
        tmp = qlge_read32(qdev, CSR);
        if (!(tmp & CSR_RP))
                return -EIO;

        qlge_write32(qdev, CSR, CSR_CMD_CLR_PAUSE);
        return 0;
}

int qlge_pause_mpi_risc(struct qlge_adapter *qdev)
{
        u32 tmp;
        int count;

        /* Pause the RISC */
        qlge_write32(qdev, CSR, CSR_CMD_SET_PAUSE);
        for (count = UDELAY_COUNT; count; count--) {
                tmp = qlge_read32(qdev, CSR);
                if (tmp & CSR_RP)
                        break;
                mdelay(UDELAY_DELAY);
        }
        return (count == 0) ? -ETIMEDOUT : 0;
}

int qlge_hard_reset_mpi_risc(struct qlge_adapter *qdev)
{
        u32 tmp;
        int count;

        /* Reset the RISC */
        qlge_write32(qdev, CSR, CSR_CMD_SET_RST);
        for (count = UDELAY_COUNT; count; count--) {
                tmp = qlge_read32(qdev, CSR);
                if (tmp & CSR_RR) {
                        qlge_write32(qdev, CSR, CSR_CMD_CLR_RST);
                        break;
                }
                mdelay(UDELAY_DELAY);
        }
        return (count == 0) ? -ETIMEDOUT : 0;
}

int qlge_read_mpi_reg(struct qlge_adapter *qdev, u32 reg, u32 *data)
{
        int status;
        /* wait for reg to come ready */
        status = qlge_wait_reg_rdy(qdev, PROC_ADDR, PROC_ADDR_RDY, PROC_ADDR_ERR);
        if (status)
                goto exit;
        /* set up for reg read */
        qlge_write32(qdev, PROC_ADDR, reg | PROC_ADDR_R);
        /* wait for reg to come ready */
        status = qlge_wait_reg_rdy(qdev, PROC_ADDR, PROC_ADDR_RDY, PROC_ADDR_ERR);
        if (status)
                goto exit;
        /* get the data */
        *data = qlge_read32(qdev, PROC_DATA);
exit:
        return status;
}

int qlge_write_mpi_reg(struct qlge_adapter *qdev, u32 reg, u32 data)
{
        int status = 0;
        /* wait for reg to come ready */
        status = qlge_wait_reg_rdy(qdev, PROC_ADDR, PROC_ADDR_RDY, PROC_ADDR_ERR);
        if (status)
                goto exit;
        /* write the data to the data reg */
        qlge_write32(qdev, PROC_DATA, data);
        /* trigger the write */
        qlge_write32(qdev, PROC_ADDR, reg);
        /* wait for reg to come ready */
        status = qlge_wait_reg_rdy(qdev, PROC_ADDR, PROC_ADDR_RDY, PROC_ADDR_ERR);
        if (status)
                goto exit;
exit:
        return status;
}

int qlge_soft_reset_mpi_risc(struct qlge_adapter *qdev)
{
        return qlge_write_mpi_reg(qdev, 0x00001010, 1);
}

/* Determine if we are in charge of the firmware. If
 * we are the lower of the 2 NIC pcie functions, or if
 * we are the higher function and the lower function
 * is not enabled.
 */
int qlge_own_firmware(struct qlge_adapter *qdev)
{
        u32 temp;

        /* If we are the lower of the 2 NIC functions
         * on the chip the we are responsible for
         * core dump and firmware reset after an error.
         */
        if (qdev->func < qdev->alt_func)
                return 1;

        /* If we are the higher of the 2 NIC functions
         * on the chip and the lower function is not
         * enabled, then we are responsible for
         * core dump and firmware reset after an error.
         */
        temp =  qlge_read32(qdev, STS);
        if (!(temp & (1 << (8 + qdev->alt_func))))
                return 1;

        return 0;
}

static int qlge_get_mb_sts(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int i, status;

        status = qlge_sem_spinlock(qdev, SEM_PROC_REG_MASK);
        if (status)
                return -EBUSY;
        for (i = 0; i < mbcp->out_count; i++) {
                status =
                    qlge_read_mpi_reg(qdev, qdev->mailbox_out + i,
                                      &mbcp->mbox_out[i]);
                if (status) {
                        netif_err(qdev, drv, qdev->ndev, "Failed mailbox read.\n");
                        break;
                }
        }
        qlge_sem_unlock(qdev, SEM_PROC_REG_MASK);       /* does flush too */
        return status;
}

/* Wait for a single mailbox command to complete.
 * Returns zero on success.
 */
static int qlge_wait_mbx_cmd_cmplt(struct qlge_adapter *qdev)
{
        int count;
        u32 value;

        for (count = 100; count; count--) {
                value = qlge_read32(qdev, STS);
                if (value & STS_PI)
                        return 0;
                mdelay(UDELAY_DELAY); /* 100ms */
        }
        return -ETIMEDOUT;
}

/* Execute a single mailbox command.
 * Caller must hold PROC_ADDR semaphore.
 */
static int qlge_exec_mb_cmd(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int i, status;

        /*
         * Make sure there's nothing pending.
         * This shouldn't happen.
         */
        if (qlge_read32(qdev, CSR) & CSR_HRI)
                return -EIO;

        status = qlge_sem_spinlock(qdev, SEM_PROC_REG_MASK);
        if (status)
                return status;

        /*
         * Fill the outbound mailboxes.
         */
        for (i = 0; i < mbcp->in_count; i++) {
                status = qlge_write_mpi_reg(qdev, qdev->mailbox_in + i,
                                            mbcp->mbox_in[i]);
                if (status)
                        goto end;
        }
        /*
         * Wake up the MPI firmware.
         */
        qlge_write32(qdev, CSR, CSR_CMD_SET_H2R_INT);
end:
        qlge_sem_unlock(qdev, SEM_PROC_REG_MASK);
        return status;
}

/* We are being asked by firmware to accept
 * a change to the port.  This is only
 * a change to max frame sizes (Tx/Rx), pause
 * parameters, or loopback mode. We wake up a worker
 * to handler processing this since a mailbox command
 * will need to be sent to ACK the request.
 */
static int qlge_idc_req_aen(struct qlge_adapter *qdev)
{
        int status;
        struct mbox_params *mbcp = &qdev->idc_mbc;

        netif_err(qdev, drv, qdev->ndev, "Enter!\n");
        /* Get the status data and start up a thread to
         * handle the request.
         */
        mbcp->out_count = 4;
        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "Could not read MPI, resetting ASIC!\n");
                qlge_queue_asic_error(qdev);
        } else  {
                /* Begin polled mode early so
                 * we don't get another interrupt
                 * when we leave mpi_worker.
                 */
                qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16));
                queue_delayed_work(qdev->workqueue, &qdev->mpi_idc_work, 0);
        }
        return status;
}

/* Process an inter-device event completion.
 * If good, signal the caller's completion.
 */
static int qlge_idc_cmplt_aen(struct qlge_adapter *qdev)
{
        int status;
        struct mbox_params *mbcp = &qdev->idc_mbc;

        mbcp->out_count = 4;
        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "Could not read MPI, resetting RISC!\n");
                qlge_queue_fw_error(qdev);
        } else {
                /* Wake up the sleeping mpi_idc_work thread that is
                 * waiting for this event.
                 */
                complete(&qdev->ide_completion);
        }
        return status;
}

static void qlge_link_up(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 2;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "%s: Could not get mailbox status.\n", __func__);
                return;
        }

        qdev->link_status = mbcp->mbox_out[1];
        netif_err(qdev, drv, qdev->ndev, "Link Up.\n");

        /* If we're coming back from an IDC event
         * then set up the CAM and frame routing.
         */
        if (test_bit(QL_CAM_RT_SET, &qdev->flags)) {
                status = qlge_cam_route_initialize(qdev);
                if (status) {
                        netif_err(qdev, ifup, qdev->ndev,
                                  "Failed to init CAM/Routing tables.\n");
                        return;
                }
                clear_bit(QL_CAM_RT_SET, &qdev->flags);
        }

        /* Queue up a worker to check the frame
         * size information, and fix it if it's not
         * to our liking.
         */
        if (!test_bit(QL_PORT_CFG, &qdev->flags)) {
                netif_err(qdev, drv, qdev->ndev, "Queue Port Config Worker!\n");
                set_bit(QL_PORT_CFG, &qdev->flags);
                /* Begin polled mode early so
                 * we don't get another interrupt
                 * when we leave mpi_worker dpc.
                 */
                qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16));
                queue_delayed_work(qdev->workqueue,
                                   &qdev->mpi_port_cfg_work, 0);
        }

        qlge_link_on(qdev);
}

static void qlge_link_down(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 3;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status)
                netif_err(qdev, drv, qdev->ndev, "Link down AEN broken!\n");

        qlge_link_off(qdev);
}

static int qlge_sfp_in(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 5;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status)
                netif_err(qdev, drv, qdev->ndev, "SFP in AEN broken!\n");
        else
                netif_err(qdev, drv, qdev->ndev, "SFP insertion detected.\n");

        return status;
}

static int qlge_sfp_out(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 1;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status)
                netif_err(qdev, drv, qdev->ndev, "SFP out AEN broken!\n");
        else
                netif_err(qdev, drv, qdev->ndev, "SFP removal detected.\n");

        return status;
}

static int qlge_aen_lost(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 6;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev, "Lost AEN broken!\n");
        } else {
                int i;

                netif_err(qdev, drv, qdev->ndev, "Lost AEN detected.\n");
                for (i = 0; i < mbcp->out_count; i++)
                        netif_err(qdev, drv, qdev->ndev, "mbox_out[%d] = 0x%.08x.\n",
                                  i, mbcp->mbox_out[i]);
        }

        return status;
}

static void qlge_init_fw_done(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;

        mbcp->out_count = 2;

        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev, "Firmware did not initialize!\n");
        } else {
                netif_err(qdev, drv, qdev->ndev, "Firmware Revision  = 0x%.08x.\n",
                          mbcp->mbox_out[1]);
                qdev->fw_rev_id = mbcp->mbox_out[1];
                status = qlge_cam_route_initialize(qdev);
                if (status)
                        netif_err(qdev, ifup, qdev->ndev,
                                  "Failed to init CAM/Routing tables.\n");
        }
}

/* Process an async event and clear it unless it's an
 * error condition.
 *  This can get called iteratively from the mpi_work thread
 *  when events arrive via an interrupt.
 *  It also gets called when a mailbox command is polling for
 *  it's completion.
 */
static int qlge_mpi_handler(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;
        int orig_count = mbcp->out_count;

        /* Just get mailbox zero for now. */
        mbcp->out_count = 1;
        status = qlge_get_mb_sts(qdev, mbcp);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "Could not read MPI, resetting ASIC!\n");
                qlge_queue_asic_error(qdev);
                goto end;
        }

        switch (mbcp->mbox_out[0]) {
                /* This case is only active when we arrive here
                 * as a result of issuing a mailbox command to
                 * the firmware.
                 */
        case MB_CMD_STS_INTRMDT:
        case MB_CMD_STS_GOOD:
        case MB_CMD_STS_INVLD_CMD:
        case MB_CMD_STS_XFC_ERR:
        case MB_CMD_STS_CSUM_ERR:
        case MB_CMD_STS_ERR:
        case MB_CMD_STS_PARAM_ERR:
                /* We can only get mailbox status if we're polling from an
                 * unfinished command.  Get the rest of the status data and
                 * return back to the caller.
                 * We only end up here when we're polling for a mailbox
                 * command completion.
                 */
                mbcp->out_count = orig_count;
                status = qlge_get_mb_sts(qdev, mbcp);
                return status;

                /* We are being asked by firmware to accept
                 * a change to the port.  This is only
                 * a change to max frame sizes (Tx/Rx), pause
                 * parameters, or loopback mode.
                 */
        case AEN_IDC_REQ:
                status = qlge_idc_req_aen(qdev);
                break;

                /* Process and inbound IDC event.
                 * This will happen when we're trying to
                 * change tx/rx max frame size, change pause
                 * parameters or loopback mode.
                 */
        case AEN_IDC_CMPLT:
        case AEN_IDC_EXT:
                status = qlge_idc_cmplt_aen(qdev);
                break;

        case AEN_LINK_UP:
                qlge_link_up(qdev, mbcp);
                break;

        case AEN_LINK_DOWN:
                qlge_link_down(qdev, mbcp);
                break;

        case AEN_FW_INIT_DONE:
                /* If we're in process on executing the firmware,
                 * then convert the status to normal mailbox status.
                 */
                if (mbcp->mbox_in[0] == MB_CMD_EX_FW) {
                        mbcp->out_count = orig_count;
                        status = qlge_get_mb_sts(qdev, mbcp);
                        mbcp->mbox_out[0] = MB_CMD_STS_GOOD;
                        return status;
                }
                qlge_init_fw_done(qdev, mbcp);
                break;

        case AEN_AEN_SFP_IN:
                qlge_sfp_in(qdev, mbcp);
                break;

        case AEN_AEN_SFP_OUT:
                qlge_sfp_out(qdev, mbcp);
                break;

                /* This event can arrive at boot time or after an
                 * MPI reset if the firmware failed to initialize.
                 */
        case AEN_FW_INIT_FAIL:
                /* If we're in process on executing the firmware,
                 * then convert the status to normal mailbox status.
                 */
                if (mbcp->mbox_in[0] == MB_CMD_EX_FW) {
                        mbcp->out_count = orig_count;
                        status = qlge_get_mb_sts(qdev, mbcp);
                        mbcp->mbox_out[0] = MB_CMD_STS_ERR;
                        return status;
                }
                netif_err(qdev, drv, qdev->ndev,
                          "Firmware initialization failed.\n");
                status = -EIO;
                qlge_queue_fw_error(qdev);
                break;

        case AEN_SYS_ERR:
                netif_err(qdev, drv, qdev->ndev, "System Error.\n");
                qlge_queue_fw_error(qdev);
                status = -EIO;
                break;

        case AEN_AEN_LOST:
                qlge_aen_lost(qdev, mbcp);
                break;

        case AEN_DCBX_CHG:
                /* Need to support AEN 8110 */
                break;
        default:
                netif_err(qdev, drv, qdev->ndev,
                          "Unsupported AE %.08x.\n", mbcp->mbox_out[0]);
                /* Clear the MPI firmware status. */
        }
end:
        qlge_write32(qdev, CSR, CSR_CMD_CLR_R2PCI_INT);
        /* Restore the original mailbox count to
         * what the caller asked for.  This can get
         * changed when a mailbox command is waiting
         * for a response and an AEN arrives and
         * is handled.
         */
        mbcp->out_count = orig_count;
        return status;
}

/* Execute a single mailbox command.
 * mbcp is a pointer to an array of u32.  Each
 * element in the array contains the value for it's
 * respective mailbox register.
 */
static int qlge_mailbox_command(struct qlge_adapter *qdev, struct mbox_params *mbcp)
{
        int status;
        unsigned long count;

        mutex_lock(&qdev->mpi_mutex);

        /* Begin polled mode for MPI */
        qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16));

        /* Load the mailbox registers and wake up MPI RISC. */
        status = qlge_exec_mb_cmd(qdev, mbcp);
        if (status)
                goto end;

        /* If we're generating a system error, then there's nothing
         * to wait for.
         */
        if (mbcp->mbox_in[0] == MB_CMD_MAKE_SYS_ERR)
                goto end;

        /* Wait for the command to complete. We loop
         * here because some AEN might arrive while
         * we're waiting for the mailbox command to
         * complete. If more than 5 seconds expire we can
         * assume something is wrong.
         */
        count = jiffies + HZ * MAILBOX_TIMEOUT;
        do {
                /* Wait for the interrupt to come in. */
                status = qlge_wait_mbx_cmd_cmplt(qdev);
                if (status)
                        continue;

                /* Process the event.  If it's an AEN, it
                 * will be handled in-line or a worker
                 * will be spawned. If it's our completion
                 * we will catch it below.
                 */
                status = qlge_mpi_handler(qdev, mbcp);
                if (status)
                        goto end;

                /* It's either the completion for our mailbox
                 * command complete or an AEN.  If it's our
                 * completion then get out.
                 */
                if (((mbcp->mbox_out[0] & 0x0000f000) ==
                     MB_CMD_STS_GOOD) ||
                    ((mbcp->mbox_out[0] & 0x0000f000) ==
                     MB_CMD_STS_INTRMDT))
                        goto done;
        } while (time_before(jiffies, count));

        netif_err(qdev, drv, qdev->ndev,
                  "Timed out waiting for mailbox complete.\n");
        status = -ETIMEDOUT;
        goto end;

done:

        /* Now we can clear the interrupt condition
         * and look at our status.
         */
        qlge_write32(qdev, CSR, CSR_CMD_CLR_R2PCI_INT);

        if (((mbcp->mbox_out[0] & 0x0000f000) !=
             MB_CMD_STS_GOOD) &&
            ((mbcp->mbox_out[0] & 0x0000f000) !=
             MB_CMD_STS_INTRMDT)) {
                status = -EIO;
        }
end:
        /* End polled mode for MPI */
        qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16) | INTR_MASK_PI);
        mutex_unlock(&qdev->mpi_mutex);
        return status;
}

/* Get MPI firmware version. This will be used for
 * driver banner and for ethtool info.
 * Returns zero on success.
 */
int qlge_mb_about_fw(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status = 0;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 1;
        mbcp->out_count = 3;

        mbcp->mbox_in[0] = MB_CMD_ABOUT_FW;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed about firmware command\n");
                status = -EIO;
        }

        /* Store the firmware version */
        qdev->fw_rev_id = mbcp->mbox_out[1];

        return status;
}

/* Get functional state for MPI firmware.
 * Returns zero on success.
 */
int qlge_mb_get_fw_state(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status = 0;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 1;
        mbcp->out_count = 2;

        mbcp->mbox_in[0] = MB_CMD_GET_FW_STATE;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed Get Firmware State.\n");
                status = -EIO;
        }

        /* If bit zero is set in mbx 1 then the firmware is
         * running, but not initialized.  This should never
         * happen.
         */
        if (mbcp->mbox_out[1] & 1) {
                netif_err(qdev, drv, qdev->ndev,
                          "Firmware waiting for initialization.\n");
                status = -EIO;
        }

        return status;
}

/* Send and ACK mailbox command to the firmware to
 * let it continue with the change.
 */
static int qlge_mb_idc_ack(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status = 0;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 5;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_IDC_ACK;
        mbcp->mbox_in[1] = qdev->idc_mbc.mbox_out[1];
        mbcp->mbox_in[2] = qdev->idc_mbc.mbox_out[2];
        mbcp->mbox_in[3] = qdev->idc_mbc.mbox_out[3];
        mbcp->mbox_in[4] = qdev->idc_mbc.mbox_out[4];

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev, "Failed IDC ACK send.\n");
                status = -EIO;
        }
        return status;
}

/* Get link settings and maximum frame size settings
 * for the current port.
 * Most likely will block.
 */
int qlge_mb_set_port_cfg(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status = 0;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 3;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_SET_PORT_CFG;
        mbcp->mbox_in[1] = qdev->link_config;
        mbcp->mbox_in[2] = qdev->max_frame_size;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] == MB_CMD_STS_INTRMDT) {
                netif_err(qdev, drv, qdev->ndev,
                          "Port Config sent, wait for IDC.\n");
        } else  if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed Set Port Configuration.\n");
                status = -EIO;
        }
        return status;
}

static int qlge_mb_dump_ram(struct qlge_adapter *qdev, u64 req_dma, u32 addr,
                            u32 size)
{
        int status = 0;
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 9;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_DUMP_RISC_RAM;
        mbcp->mbox_in[1] = LSW(addr);
        mbcp->mbox_in[2] = MSW(req_dma);
        mbcp->mbox_in[3] = LSW(req_dma);
        mbcp->mbox_in[4] = MSW(size);
        mbcp->mbox_in[5] = LSW(size);
        mbcp->mbox_in[6] = MSW(MSD(req_dma));
        mbcp->mbox_in[7] = LSW(MSD(req_dma));
        mbcp->mbox_in[8] = MSW(addr);

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev, "Failed to dump risc RAM.\n");
                status = -EIO;
        }
        return status;
}

/* Issue a mailbox command to dump RISC RAM. */
int qlge_dump_risc_ram_area(struct qlge_adapter *qdev, void *buf,
                            u32 ram_addr, int word_count)
{
        int status;
        char *my_buf;
        dma_addr_t buf_dma;

        my_buf = dma_alloc_coherent(&qdev->pdev->dev,
                                    word_count * sizeof(u32), &buf_dma,
                                    GFP_ATOMIC);
        if (!my_buf)
                return -EIO;

        status = qlge_mb_dump_ram(qdev, buf_dma, ram_addr, word_count);
        if (!status)
                memcpy(buf, my_buf, word_count * sizeof(u32));

        dma_free_coherent(&qdev->pdev->dev, word_count * sizeof(u32), my_buf,
                          buf_dma);
        return status;
}

/* Get link settings and maximum frame size settings
 * for the current port.
 * Most likely will block.
 */
int qlge_mb_get_port_cfg(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status = 0;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 1;
        mbcp->out_count = 3;

        mbcp->mbox_in[0] = MB_CMD_GET_PORT_CFG;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed Get Port Configuration.\n");
                status = -EIO;
        } else  {
                netif_printk(qdev, drv, KERN_DEBUG, qdev->ndev,
                             "Passed Get Port Configuration.\n");
                qdev->link_config = mbcp->mbox_out[1];
                qdev->max_frame_size = mbcp->mbox_out[2];
        }
        return status;
}

int qlge_mb_wol_mode(struct qlge_adapter *qdev, u32 wol)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 2;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_SET_WOL_MODE;
        mbcp->mbox_in[1] = wol;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev, "Failed to set WOL mode.\n");
                status = -EIO;
        }
        return status;
}

int qlge_mb_wol_set_magic(struct qlge_adapter *qdev, u32 enable_wol)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;
        u8 *addr = qdev->ndev->dev_addr;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 8;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_SET_WOL_MAGIC;
        if (enable_wol) {
                mbcp->mbox_in[1] = (u32)addr[0];
                mbcp->mbox_in[2] = (u32)addr[1];
                mbcp->mbox_in[3] = (u32)addr[2];
                mbcp->mbox_in[4] = (u32)addr[3];
                mbcp->mbox_in[5] = (u32)addr[4];
                mbcp->mbox_in[6] = (u32)addr[5];
                mbcp->mbox_in[7] = 0;
        } else {
                mbcp->mbox_in[1] = 0;
                mbcp->mbox_in[2] = 1;
                mbcp->mbox_in[3] = 1;
                mbcp->mbox_in[4] = 1;
                mbcp->mbox_in[5] = 1;
                mbcp->mbox_in[6] = 1;
                mbcp->mbox_in[7] = 0;
        }

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev, "Failed to set WOL mode.\n");
                status = -EIO;
        }
        return status;
}

/* IDC - Inter Device Communication...
 * Some firmware commands require consent of adjacent FCOE
 * function.  This function waits for the OK, or a
 * counter-request for a little more time.i
 * The firmware will complete the request if the other
 * function doesn't respond.
 */
static int qlge_idc_wait(struct qlge_adapter *qdev)
{
        int status = -ETIMEDOUT;
        struct mbox_params *mbcp = &qdev->idc_mbc;
        long wait_time;

        for (wait_time = 1 * HZ; wait_time;) {
                /* Wait here for the command to complete
                 * via the IDC process.
                 */
                wait_time =
                        wait_for_completion_timeout(&qdev->ide_completion,
                                                    wait_time);
                if (!wait_time) {
                        netif_err(qdev, drv, qdev->ndev, "IDC Timeout.\n");
                        break;
                }
                /* Now examine the response from the IDC process.
                 * We might have a good completion or a request for
                 * more wait time.
                 */
                if (mbcp->mbox_out[0] == AEN_IDC_EXT) {
                        netif_err(qdev, drv, qdev->ndev,
                                  "IDC Time Extension from function.\n");
                        wait_time += (mbcp->mbox_out[1] >> 8) & 0x0000000f;
                } else if (mbcp->mbox_out[0] == AEN_IDC_CMPLT) {
                        netif_err(qdev, drv, qdev->ndev, "IDC Success.\n");
                        status = 0;
                        break;
                } else {
                        netif_err(qdev, drv, qdev->ndev,
                                  "IDC: Invalid State 0x%.04x.\n",
                                  mbcp->mbox_out[0]);
                        status = -EIO;
                        break;
                }
        }

        return status;
}

int qlge_mb_set_led_cfg(struct qlge_adapter *qdev, u32 led_config)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 2;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_SET_LED_CFG;
        mbcp->mbox_in[1] = led_config;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed to set LED Configuration.\n");
                status = -EIO;
        }

        return status;
}

int qlge_mb_get_led_cfg(struct qlge_adapter *qdev)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 1;
        mbcp->out_count = 2;

        mbcp->mbox_in[0] = MB_CMD_GET_LED_CFG;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] != MB_CMD_STS_GOOD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed to get LED Configuration.\n");
                status = -EIO;
        } else {
                qdev->led_config = mbcp->mbox_out[1];
        }

        return status;
}

int qlge_mb_set_mgmnt_traffic_ctl(struct qlge_adapter *qdev, u32 control)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;

        memset(mbcp, 0, sizeof(struct mbox_params));

        mbcp->in_count = 1;
        mbcp->out_count = 2;

        mbcp->mbox_in[0] = MB_CMD_SET_MGMNT_TFK_CTL;
        mbcp->mbox_in[1] = control;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] == MB_CMD_STS_GOOD)
                return status;

        if (mbcp->mbox_out[0] == MB_CMD_STS_INVLD_CMD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Command not supported by firmware.\n");
                status = -EINVAL;
        } else if (mbcp->mbox_out[0] == MB_CMD_STS_ERR) {
                /* This indicates that the firmware is
                 * already in the state we are trying to
                 * change it to.
                 */
                netif_err(qdev, drv, qdev->ndev,
                          "Command parameters make no change.\n");
        }
        return status;
}

/* Returns a negative error code or the mailbox command status. */
static int qlge_mb_get_mgmnt_traffic_ctl(struct qlge_adapter *qdev, u32 *control)
{
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int status;

        memset(mbcp, 0, sizeof(struct mbox_params));
        *control = 0;

        mbcp->in_count = 1;
        mbcp->out_count = 1;

        mbcp->mbox_in[0] = MB_CMD_GET_MGMNT_TFK_CTL;

        status = qlge_mailbox_command(qdev, mbcp);
        if (status)
                return status;

        if (mbcp->mbox_out[0] == MB_CMD_STS_GOOD) {
                *control = mbcp->mbox_in[1];
                return status;
        }

        if (mbcp->mbox_out[0] == MB_CMD_STS_INVLD_CMD) {
                netif_err(qdev, drv, qdev->ndev,
                          "Command not supported by firmware.\n");
                status = -EINVAL;
        } else if (mbcp->mbox_out[0] == MB_CMD_STS_ERR) {
                netif_err(qdev, drv, qdev->ndev,
                          "Failed to get MPI traffic control.\n");
                status = -EIO;
        }
        return status;
}

int qlge_wait_fifo_empty(struct qlge_adapter *qdev)
{
        int count;
        u32 mgmnt_fifo_empty;
        u32 nic_fifo_empty;

        for (count = 6; count; count--) {
                nic_fifo_empty = qlge_read32(qdev, STS) & STS_NFE;
                qlge_mb_get_mgmnt_traffic_ctl(qdev, &mgmnt_fifo_empty);
                mgmnt_fifo_empty &= MB_GET_MPI_TFK_FIFO_EMPTY;
                if (nic_fifo_empty && mgmnt_fifo_empty)
                        return 0;
                msleep(100);
        }
        return -ETIMEDOUT;
}

/* API called in work thread context to set new TX/RX
 * maximum frame size values to match MTU.
 */
static int qlge_set_port_cfg(struct qlge_adapter *qdev)
{
        int status;

        status = qlge_mb_set_port_cfg(qdev);
        if (status)
                return status;
        status = qlge_idc_wait(qdev);
        return status;
}

/* The following routines are worker threads that process
 * events that may sleep waiting for completion.
 */

/* This thread gets the maximum TX and RX frame size values
 * from the firmware and, if necessary, changes them to match
 * the MTU setting.
 */
void qlge_mpi_port_cfg_work(struct work_struct *work)
{
        struct qlge_adapter *qdev =
                container_of(work, struct qlge_adapter, mpi_port_cfg_work.work);
        int status;

        status = qlge_mb_get_port_cfg(qdev);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "Bug: Failed to get port config data.\n");
                goto err;
        }

        if (qdev->link_config & CFG_JUMBO_FRAME_SIZE &&
            qdev->max_frame_size == CFG_DEFAULT_MAX_FRAME_SIZE)
                goto end;

        qdev->link_config |=    CFG_JUMBO_FRAME_SIZE;
        qdev->max_frame_size = CFG_DEFAULT_MAX_FRAME_SIZE;
        status = qlge_set_port_cfg(qdev);
        if (status) {
                netif_err(qdev, drv, qdev->ndev,
                          "Bug: Failed to set port config data.\n");
                goto err;
        }
end:
        clear_bit(QL_PORT_CFG, &qdev->flags);
        return;
err:
        qlge_queue_fw_error(qdev);
        goto end;
}

/* Process an inter-device request.  This is issues by
 * the firmware in response to another function requesting
 * a change to the port. We set a flag to indicate a change
 * has been made and then send a mailbox command ACKing
 * the change request.
 */
void qlge_mpi_idc_work(struct work_struct *work)
{
        struct qlge_adapter *qdev =
                container_of(work, struct qlge_adapter, mpi_idc_work.work);
        int status;
        struct mbox_params *mbcp = &qdev->idc_mbc;
        u32 aen;
        int timeout;

        aen = mbcp->mbox_out[1] >> 16;
        timeout = (mbcp->mbox_out[1] >> 8) & 0xf;

        switch (aen) {
        default:
                netif_err(qdev, drv, qdev->ndev,
                          "Bug: Unhandled IDC action.\n");
                break;
        case MB_CMD_PORT_RESET:
        case MB_CMD_STOP_FW:
                qlge_link_off(qdev);
                fallthrough;
        case MB_CMD_SET_PORT_CFG:
                /* Signal the resulting link up AEN
                 * that the frame routing and mac addr
                 * needs to be set.
                 */
                set_bit(QL_CAM_RT_SET, &qdev->flags);
                /* Do ACK if required */
                if (timeout) {
                        status = qlge_mb_idc_ack(qdev);
                        if (status)
                                netif_err(qdev, drv, qdev->ndev,
                                          "Bug: No pending IDC!\n");
                } else {
                        netif_printk(qdev, drv, KERN_DEBUG, qdev->ndev,
                                     "IDC ACK not required\n");
                        status = 0; /* success */
                }
                break;

                /* These sub-commands issued by another (FCoE)
                 * function are requesting to do an operation
                 * on the shared resource (MPI environment).
                 * We currently don't issue these so we just
                 * ACK the request.
                 */
        case MB_CMD_IOP_RESTART_MPI:
        case MB_CMD_IOP_PREP_LINK_DOWN:
                /* Drop the link, reload the routing
                 * table when link comes up.
                 */
                qlge_link_off(qdev);
                set_bit(QL_CAM_RT_SET, &qdev->flags);
                fallthrough;
        case MB_CMD_IOP_DVR_START:
        case MB_CMD_IOP_FLASH_ACC:
        case MB_CMD_IOP_CORE_DUMP_MPI:
        case MB_CMD_IOP_PREP_UPDATE_MPI:
        case MB_CMD_IOP_COMP_UPDATE_MPI:
        case MB_CMD_IOP_NONE:   /*  an IDC without params */
                /* Do ACK if required */
                if (timeout) {
                        status = qlge_mb_idc_ack(qdev);
                        if (status)
                                netif_err(qdev, drv, qdev->ndev,
                                          "Bug: No pending IDC!\n");
                } else {
                        netif_printk(qdev, drv, KERN_DEBUG, qdev->ndev,
                                     "IDC ACK not required\n");
                        status = 0; /* success */
                }
                break;
        }
}

void qlge_mpi_work(struct work_struct *work)
{
        struct qlge_adapter *qdev =
                container_of(work, struct qlge_adapter, mpi_work.work);
        struct mbox_params mbc;
        struct mbox_params *mbcp = &mbc;
        int err = 0;

        mutex_lock(&qdev->mpi_mutex);
        /* Begin polled mode for MPI */
        qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16));

        while (qlge_read32(qdev, STS) & STS_PI) {
                memset(mbcp, 0, sizeof(struct mbox_params));
                mbcp->out_count = 1;
                /* Don't continue if an async event
                 * did not complete properly.
                 */
                err = qlge_mpi_handler(qdev, mbcp);
                if (err)
                        break;
        }

        /* End polled mode for MPI */
        qlge_write32(qdev, INTR_MASK, (INTR_MASK_PI << 16) | INTR_MASK_PI);
        mutex_unlock(&qdev->mpi_mutex);
}

void qlge_mpi_reset_work(struct work_struct *work)
{
        struct qlge_adapter *qdev =
                container_of(work, struct qlge_adapter, mpi_reset_work.work);
        cancel_delayed_work_sync(&qdev->mpi_work);
        cancel_delayed_work_sync(&qdev->mpi_port_cfg_work);
        cancel_delayed_work_sync(&qdev->mpi_idc_work);
        /* If we're not the dominant NIC function,
         * then there is nothing to do.
         */
        if (!qlge_own_firmware(qdev)) {
                netif_err(qdev, drv, qdev->ndev, "Don't own firmware!\n");
                return;
        }

        qlge_soft_reset_mpi_risc(qdev);
}