1 /****************************************************************************** 2 SPDX-License-Identifier: BSD-3-Clause 3 4 Copyright (c) 2001-2020, Intel Corporation 5 All rights reserved. 6 7 Redistribution and use in source and binary forms, with or without 8 modification, are permitted provided that the following conditions are met: 9 10 1. Redistributions of source code must retain the above copyright notice, 11 this list of conditions and the following disclaimer. 12 13 2. Redistributions in binary form must reproduce the above copyright 14 notice, this list of conditions and the following disclaimer in the 15 documentation and/or other materials provided with the distribution. 16 17 3. Neither the name of the Intel Corporation nor the names of its 18 contributors may be used to endorse or promote products derived from 19 this software without specific prior written permission. 20 21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 POSSIBILITY OF SUCH DAMAGE. 32 33 ******************************************************************************/ 34 /*$FreeBSD$*/ 35 36 #ifndef _E1000_MBX_H_ 37 #define _E1000_MBX_H_ 38 39 #include "e1000_api.h" 40 41 /* Define mailbox register bits */ 42 #define E1000_V2PMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ 43 #define E1000_V2PMAILBOX_ACK 0x00000002 /* Ack PF message received */ 44 #define E1000_V2PMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 45 #define E1000_V2PMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 46 #define E1000_V2PMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ 47 #define E1000_V2PMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ 48 #define E1000_V2PMAILBOX_RSTI 0x00000040 /* PF has reset indication */ 49 #define E1000_V2PMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ 50 #define E1000_V2PMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ 51 52 #define E1000_P2VMAILBOX_STS 0x00000001 /* Initiate message send to VF */ 53 #define E1000_P2VMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ 54 #define E1000_P2VMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 55 #define E1000_P2VMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 56 #define E1000_P2VMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ 57 58 #define E1000_MBVFICR_VFREQ_MASK 0x000000FF /* bits for VF messages */ 59 #define E1000_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ 60 #define E1000_MBVFICR_VFACK_MASK 0x00FF0000 /* bits for VF acks */ 61 #define E1000_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ 62 63 #define E1000_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ 64 65 /* If it's a E1000_VF_* msg then it originates in the VF and is sent to the 66 * PF. The reverse is true if it is E1000_PF_*. 67 * Message ACK's are the value or'd with 0xF0000000 68 */ 69 /* Msgs below or'd with this are the ACK */ 70 #define E1000_VT_MSGTYPE_ACK 0x80000000 71 /* Msgs below or'd with this are the NACK */ 72 #define E1000_VT_MSGTYPE_NACK 0x40000000 73 /* Indicates that VF is still clear to send requests */ 74 #define E1000_VT_MSGTYPE_CTS 0x20000000 75 #define E1000_VT_MSGINFO_SHIFT 16 76 /* bits 23:16 are used for extra info for certain messages */ 77 #define E1000_VT_MSGINFO_MASK (0xFF << E1000_VT_MSGINFO_SHIFT) 78 79 #define E1000_VF_RESET 0x01 /* VF requests reset */ 80 #define E1000_VF_SET_MAC_ADDR 0x02 /* VF requests to set MAC addr */ 81 #define E1000_VF_SET_MULTICAST 0x03 /* VF requests to set MC addr */ 82 #define E1000_VF_SET_MULTICAST_COUNT_MASK (0x1F << E1000_VT_MSGINFO_SHIFT) 83 #define E1000_VF_SET_MULTICAST_OVERFLOW (0x80 << E1000_VT_MSGINFO_SHIFT) 84 #define E1000_VF_SET_VLAN 0x04 /* VF requests to set VLAN */ 85 #define E1000_VF_SET_VLAN_ADD (0x01 << E1000_VT_MSGINFO_SHIFT) 86 #define E1000_VF_SET_LPE 0x05 /* reqs to set VMOLR.LPE */ 87 #define E1000_VF_SET_PROMISC 0x06 /* reqs to clear VMOLR.ROPE/MPME*/ 88 #define E1000_VF_SET_PROMISC_UNICAST (0x01 << E1000_VT_MSGINFO_SHIFT) 89 #define E1000_VF_SET_PROMISC_MULTICAST (0x02 << E1000_VT_MSGINFO_SHIFT) 90 91 #define E1000_PF_CONTROL_MSG 0x0100 /* PF control message */ 92 93 #define E1000_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ 94 #define E1000_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ 95 96 s32 e1000_read_mbx(struct e1000_hw *, u32 *, u16, u16); 97 s32 e1000_write_mbx(struct e1000_hw *, u32 *, u16, u16); 98 s32 e1000_read_posted_mbx(struct e1000_hw *, u32 *, u16, u16); 99 s32 e1000_write_posted_mbx(struct e1000_hw *, u32 *, u16, u16); 100 s32 e1000_check_for_msg(struct e1000_hw *, u16); 101 s32 e1000_check_for_ack(struct e1000_hw *, u16); 102 s32 e1000_check_for_rst(struct e1000_hw *, u16); 103 void e1000_init_mbx_ops_generic(struct e1000_hw *hw); 104 s32 e1000_init_mbx_params_vf(struct e1000_hw *); 105 s32 e1000_init_mbx_params_pf(struct e1000_hw *); 106 107 #endif /* _E1000_MBX_H_ */ 108