e1000_mbx.c

Go to the documentation of this file.

/******************************************************************************
  SPDX-License-Identifier: BSD-3-Clause
 
  Copyright (c) 2001-2020, Intel Corporation
  All rights reserved.
 
  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 Intel Corporation nor the names of its
      contributors may be used to endorse or promote products derived from
      this software without specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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$*/
 
#include "e1000_mbx.h"
 
static s32 e1000_null_mbx_check_for_flag(struct e1000_hw E1000_UNUSEDARG *hw,
                                         u16 E1000_UNUSEDARG mbx_id)
{
        DEBUGFUNC("e1000_null_mbx_check_flag");
 
        return E1000_SUCCESS;
}
 
static s32 e1000_null_mbx_transact(struct e1000_hw E1000_UNUSEDARG *hw,
                                   u32 E1000_UNUSEDARG *msg,
                                   u16 E1000_UNUSEDARG size,
                                   u16 E1000_UNUSEDARG mbx_id)
{
        DEBUGFUNC("e1000_null_mbx_rw_msg");
 
        return E1000_SUCCESS;
}
 
s32 e1000_read_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_read_mbx");
 
        /* limit read to size of mailbox */
        if (size > mbx->size)
                size = mbx->size;
 
        if (mbx->ops.read)
                ret_val = mbx->ops.read(hw, msg, size, mbx_id);
 
        return ret_val;
}
 
s32 e1000_write_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = E1000_SUCCESS;
 
        DEBUGFUNC("e1000_write_mbx");
 
        if (size > mbx->size)
                ret_val = -E1000_ERR_MBX;
 
        else if (mbx->ops.write)
                ret_val = mbx->ops.write(hw, msg, size, mbx_id);
 
        return ret_val;
}
 
s32 e1000_check_for_msg(struct e1000_hw *hw, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_msg");
 
        if (mbx->ops.check_for_msg)
                ret_val = mbx->ops.check_for_msg(hw, mbx_id);
 
        return ret_val;
}
 
s32 e1000_check_for_ack(struct e1000_hw *hw, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_ack");
 
        if (mbx->ops.check_for_ack)
                ret_val = mbx->ops.check_for_ack(hw, mbx_id);
 
        return ret_val;
}
 
s32 e1000_check_for_rst(struct e1000_hw *hw, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_rst");
 
        if (mbx->ops.check_for_rst)
                ret_val = mbx->ops.check_for_rst(hw, mbx_id);
 
        return ret_val;
}
 
static s32 e1000_poll_for_msg(struct e1000_hw *hw, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        int countdown = mbx->timeout;
 
        DEBUGFUNC("e1000_poll_for_msg");
 
        if (!countdown || !mbx->ops.check_for_msg)
                goto out;
 
        while (countdown && mbx->ops.check_for_msg(hw, mbx_id)) {
                countdown--;
                if (!countdown)
                        break;
                usec_delay(mbx->usec_delay);
        }
 
        /* if we failed, all future posted messages fail until reset */
        if (!countdown)
                mbx->timeout = 0;
out:
        return countdown ? E1000_SUCCESS : -E1000_ERR_MBX;
}
 
static s32 e1000_poll_for_ack(struct e1000_hw *hw, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        int countdown = mbx->timeout;
 
        DEBUGFUNC("e1000_poll_for_ack");
 
        if (!countdown || !mbx->ops.check_for_ack)
                goto out;
 
        while (countdown && mbx->ops.check_for_ack(hw, mbx_id)) {
                countdown--;
                if (!countdown)
                        break;
                usec_delay(mbx->usec_delay);
        }
 
        /* if we failed, all future posted messages fail until reset */
        if (!countdown)
                mbx->timeout = 0;
out:
        return countdown ? E1000_SUCCESS : -E1000_ERR_MBX;
}
 
s32 e1000_read_posted_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_read_posted_mbx");
 
        if (!mbx->ops.read)
                goto out;
 
        ret_val = e1000_poll_for_msg(hw, mbx_id);
 
        /* if ack received read message, otherwise we timed out */
        if (!ret_val)
                ret_val = mbx->ops.read(hw, msg, size, mbx_id);
out:
        return ret_val;
}
 
s32 e1000_write_posted_mbx(struct e1000_hw *hw, u32 *msg, u16 size, u16 mbx_id)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_write_posted_mbx");
 
        /* exit if either we can't write or there isn't a defined timeout */
        if (!mbx->ops.write || !mbx->timeout)
                goto out;
 
        /* send msg */
        ret_val = mbx->ops.write(hw, msg, size, mbx_id);
 
        /* if msg sent wait until we receive an ack */
        if (!ret_val)
                ret_val = e1000_poll_for_ack(hw, mbx_id);
out:
        return ret_val;
}
 
void e1000_init_mbx_ops_generic(struct e1000_hw *hw)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
        mbx->ops.init_params = e1000_null_ops_generic;
        mbx->ops.read = e1000_null_mbx_transact;
        mbx->ops.write = e1000_null_mbx_transact;
        mbx->ops.check_for_msg = e1000_null_mbx_check_for_flag;
        mbx->ops.check_for_ack = e1000_null_mbx_check_for_flag;
        mbx->ops.check_for_rst = e1000_null_mbx_check_for_flag;
        mbx->ops.read_posted = e1000_read_posted_mbx;
        mbx->ops.write_posted = e1000_write_posted_mbx;
}
 
static u32 e1000_read_v2p_mailbox(struct e1000_hw *hw)
{
        u32 v2p_mailbox = E1000_READ_REG(hw, E1000_V2PMAILBOX(0));
 
        v2p_mailbox |= hw->dev_spec.vf.v2p_mailbox;
        hw->dev_spec.vf.v2p_mailbox |= v2p_mailbox & E1000_V2PMAILBOX_R2C_BITS;
 
        return v2p_mailbox;
}
 
static s32 e1000_check_for_bit_vf(struct e1000_hw *hw, u32 mask)
{
        u32 v2p_mailbox = e1000_read_v2p_mailbox(hw);
        s32 ret_val = -E1000_ERR_MBX;
 
        if (v2p_mailbox & mask)
                ret_val = E1000_SUCCESS;
 
        hw->dev_spec.vf.v2p_mailbox &= ~mask;
 
        return ret_val;
}
 
static s32 e1000_check_for_msg_vf(struct e1000_hw *hw,
                                  u16 E1000_UNUSEDARG mbx_id)
{
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_msg_vf");
 
        if (!e1000_check_for_bit_vf(hw, E1000_V2PMAILBOX_PFSTS)) {
                ret_val = E1000_SUCCESS;
                hw->mbx.stats.reqs++;
        }
 
        return ret_val;
}
 
static s32 e1000_check_for_ack_vf(struct e1000_hw *hw,
                                  u16 E1000_UNUSEDARG mbx_id)
{
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_ack_vf");
 
        if (!e1000_check_for_bit_vf(hw, E1000_V2PMAILBOX_PFACK)) {
                ret_val = E1000_SUCCESS;
                hw->mbx.stats.acks++;
        }
 
        return ret_val;
}
 
static s32 e1000_check_for_rst_vf(struct e1000_hw *hw,
                                  u16 E1000_UNUSEDARG mbx_id)
{
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_rst_vf");
 
        if (!e1000_check_for_bit_vf(hw, (E1000_V2PMAILBOX_RSTD |
                                         E1000_V2PMAILBOX_RSTI))) {
                ret_val = E1000_SUCCESS;
                hw->mbx.stats.rsts++;
        }
 
        return ret_val;
}
 
static s32 e1000_obtain_mbx_lock_vf(struct e1000_hw *hw)
{
        s32 ret_val = -E1000_ERR_MBX;
        int count = 10;
 
        DEBUGFUNC("e1000_obtain_mbx_lock_vf");
 
        do {
                /* Take ownership of the buffer */
                E1000_WRITE_REG(hw, E1000_V2PMAILBOX(0), E1000_V2PMAILBOX_VFU);
 
                /* reserve mailbox for vf use */
                if (e1000_read_v2p_mailbox(hw) & E1000_V2PMAILBOX_VFU) {
                        ret_val = E1000_SUCCESS;
                        break;
                }
                usec_delay(1000);
        } while (count-- > 0);
 
        return ret_val;
}
 
static s32 e1000_write_mbx_vf(struct e1000_hw *hw, u32 *msg, u16 size,
                              u16 E1000_UNUSEDARG mbx_id)
{
        s32 ret_val;
        u16 i;
 
 
        DEBUGFUNC("e1000_write_mbx_vf");
 
        /* lock the mailbox to prevent pf/vf race condition */
        ret_val = e1000_obtain_mbx_lock_vf(hw);
        if (ret_val)
                goto out_no_write;
 
        /* flush msg and acks as we are overwriting the message buffer */
        e1000_check_for_msg_vf(hw, 0);
        e1000_check_for_ack_vf(hw, 0);
 
        /* copy the caller specified message to the mailbox memory buffer */
        for (i = 0; i < size; i++)
                E1000_WRITE_REG_ARRAY(hw, E1000_VMBMEM(0), i, msg[i]);
 
        /* update stats */
        hw->mbx.stats.msgs_tx++;
 
        /* Drop VFU and interrupt the PF to tell it a message has been sent */
        E1000_WRITE_REG(hw, E1000_V2PMAILBOX(0), E1000_V2PMAILBOX_REQ);
 
out_no_write:
        return ret_val;
}
 
static s32 e1000_read_mbx_vf(struct e1000_hw *hw, u32 *msg, u16 size,
                             u16 E1000_UNUSEDARG mbx_id)
{
        s32 ret_val = E1000_SUCCESS;
        u16 i;
 
        DEBUGFUNC("e1000_read_mbx_vf");
 
        /* lock the mailbox to prevent pf/vf race condition */
        ret_val = e1000_obtain_mbx_lock_vf(hw);
        if (ret_val)
                goto out_no_read;
 
        /* copy the message from the mailbox memory buffer */
        for (i = 0; i < size; i++)
                msg[i] = E1000_READ_REG_ARRAY(hw, E1000_VMBMEM(0), i);
 
        /* Acknowledge receipt and release mailbox, then we're done */
        E1000_WRITE_REG(hw, E1000_V2PMAILBOX(0), E1000_V2PMAILBOX_ACK);
 
        /* update stats */
        hw->mbx.stats.msgs_rx++;
 
out_no_read:
        return ret_val;
}
 
s32 e1000_init_mbx_params_vf(struct e1000_hw *hw)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
 
        /* start mailbox as timed out and let the reset_hw call set the timeout
         * value to begin communications */
        mbx->timeout = 0;
        mbx->usec_delay = E1000_VF_MBX_INIT_DELAY;
 
        mbx->size = E1000_VFMAILBOX_SIZE;
 
        mbx->ops.read = e1000_read_mbx_vf;
        mbx->ops.write = e1000_write_mbx_vf;
        mbx->ops.read_posted = e1000_read_posted_mbx;
        mbx->ops.write_posted = e1000_write_posted_mbx;
        mbx->ops.check_for_msg = e1000_check_for_msg_vf;
        mbx->ops.check_for_ack = e1000_check_for_ack_vf;
        mbx->ops.check_for_rst = e1000_check_for_rst_vf;
 
        mbx->stats.msgs_tx = 0;
        mbx->stats.msgs_rx = 0;
        mbx->stats.reqs = 0;
        mbx->stats.acks = 0;
        mbx->stats.rsts = 0;
 
        return E1000_SUCCESS;
}
 
static s32 e1000_check_for_bit_pf(struct e1000_hw *hw, u32 mask)
{
        u32 mbvficr = E1000_READ_REG(hw, E1000_MBVFICR);
        s32 ret_val = -E1000_ERR_MBX;
 
        if (mbvficr & mask) {
                ret_val = E1000_SUCCESS;
                E1000_WRITE_REG(hw, E1000_MBVFICR, mask);
        }
 
        return ret_val;
}
 
static s32 e1000_check_for_msg_pf(struct e1000_hw *hw, u16 vf_number)
{
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_msg_pf");
 
        if (!e1000_check_for_bit_pf(hw, E1000_MBVFICR_VFREQ_VF1 << vf_number)) {
                ret_val = E1000_SUCCESS;
                hw->mbx.stats.reqs++;
        }
 
        return ret_val;
}
 
static s32 e1000_check_for_ack_pf(struct e1000_hw *hw, u16 vf_number)
{
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_ack_pf");
 
        if (!e1000_check_for_bit_pf(hw, E1000_MBVFICR_VFACK_VF1 << vf_number)) {
                ret_val = E1000_SUCCESS;
                hw->mbx.stats.acks++;
        }
 
        return ret_val;
}
 
static s32 e1000_check_for_rst_pf(struct e1000_hw *hw, u16 vf_number)
{
        u32 vflre = E1000_READ_REG(hw, E1000_VFLRE);
        s32 ret_val = -E1000_ERR_MBX;
 
        DEBUGFUNC("e1000_check_for_rst_pf");
 
        if (vflre & (1 << vf_number)) {
                ret_val = E1000_SUCCESS;
                E1000_WRITE_REG(hw, E1000_VFLRE, (1 << vf_number));
                hw->mbx.stats.rsts++;
        }
 
        return ret_val;
}
 
static s32 e1000_obtain_mbx_lock_pf(struct e1000_hw *hw, u16 vf_number)
{
        s32 ret_val = -E1000_ERR_MBX;
        u32 p2v_mailbox;
        int count = 10;
 
        DEBUGFUNC("e1000_obtain_mbx_lock_pf");
 
        do {
                /* Take ownership of the buffer */
                E1000_WRITE_REG(hw, E1000_P2VMAILBOX(vf_number),
                                E1000_P2VMAILBOX_PFU);
 
                /* reserve mailbox for pf use */
                p2v_mailbox = E1000_READ_REG(hw, E1000_P2VMAILBOX(vf_number));
                if (p2v_mailbox & E1000_P2VMAILBOX_PFU) {
                        ret_val = E1000_SUCCESS;
                        break;
                }
                usec_delay(1000);
        } while (count-- > 0);
 
        return ret_val;
 
}
 
static s32 e1000_write_mbx_pf(struct e1000_hw *hw, u32 *msg, u16 size,
                              u16 vf_number)
{
        s32 ret_val;
        u16 i;
 
        DEBUGFUNC("e1000_write_mbx_pf");
 
        /* lock the mailbox to prevent pf/vf race condition */
        ret_val = e1000_obtain_mbx_lock_pf(hw, vf_number);
        if (ret_val)
                goto out_no_write;
 
        /* flush msg and acks as we are overwriting the message buffer */
        e1000_check_for_msg_pf(hw, vf_number);
        e1000_check_for_ack_pf(hw, vf_number);
 
        /* copy the caller specified message to the mailbox memory buffer */
        for (i = 0; i < size; i++)
                E1000_WRITE_REG_ARRAY(hw, E1000_VMBMEM(vf_number), i, msg[i]);
 
        /* Interrupt VF to tell it a message has been sent and release buffer*/
        E1000_WRITE_REG(hw, E1000_P2VMAILBOX(vf_number), E1000_P2VMAILBOX_STS);
 
        /* update stats */
        hw->mbx.stats.msgs_tx++;
 
out_no_write:
        return ret_val;
 
}
 
static s32 e1000_read_mbx_pf(struct e1000_hw *hw, u32 *msg, u16 size,
                             u16 vf_number)
{
        s32 ret_val;
        u16 i;
 
        DEBUGFUNC("e1000_read_mbx_pf");
 
        /* lock the mailbox to prevent pf/vf race condition */
        ret_val = e1000_obtain_mbx_lock_pf(hw, vf_number);
        if (ret_val)
                goto out_no_read;
 
        /* copy the message to the mailbox memory buffer */
        for (i = 0; i < size; i++)
                msg[i] = E1000_READ_REG_ARRAY(hw, E1000_VMBMEM(vf_number), i);
 
        /* Acknowledge the message and release buffer */
        E1000_WRITE_REG(hw, E1000_P2VMAILBOX(vf_number), E1000_P2VMAILBOX_ACK);
 
        /* update stats */
        hw->mbx.stats.msgs_rx++;
 
out_no_read:
        return ret_val;
}
 
s32 e1000_init_mbx_params_pf(struct e1000_hw *hw)
{
        struct e1000_mbx_info *mbx = &hw->mbx;
 
        switch (hw->mac.type) {
        case e1000_82576:
        case e1000_i350:
        case e1000_i354:
                mbx->timeout = 0;
                mbx->usec_delay = 0;
 
                mbx->size = E1000_VFMAILBOX_SIZE;
 
                mbx->ops.read = e1000_read_mbx_pf;
                mbx->ops.write = e1000_write_mbx_pf;
                mbx->ops.read_posted = e1000_read_posted_mbx;
                mbx->ops.write_posted = e1000_write_posted_mbx;
                mbx->ops.check_for_msg = e1000_check_for_msg_pf;
                mbx->ops.check_for_ack = e1000_check_for_ack_pf;
                mbx->ops.check_for_rst = e1000_check_for_rst_pf;
 
                mbx->stats.msgs_tx = 0;
                mbx->stats.msgs_rx = 0;
                mbx->stats.reqs = 0;
                mbx->stats.acks = 0;
                mbx->stats.rsts = 0;
                /* FALLTHROUGH */
        default:
                return E1000_SUCCESS;
        }
}