75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi/******************************************************************************
49b7860084dbba18bc00b29413d6182197f9fe93Robert Mustacchi Copyright (c) 2001-2015, Intel Corporation
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi All rights reserved.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi Redistribution and use in source and binary forms, with or without
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi modification, are permitted provided that the following conditions are met:
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi 1. Redistributions of source code must retain the above copyright notice,
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi this list of conditions and the following disclaimer.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi 2. Redistributions in binary form must reproduce the above copyright
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi notice, this list of conditions and the following disclaimer in the
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi documentation and/or other materials provided with the distribution.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi 3. Neither the name of the Intel Corporation nor the names of its
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi contributors may be used to endorse or promote products derived from
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi this software without specific prior written permission.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi POSSIBILITY OF SUCH DAMAGE.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi******************************************************************************/
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi/* Define mailbox register bits */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_ACK 0x00000002 /* Ack PF message received */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_RSTI 0x00000040 /* PF has reset indication */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_V2PMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi#define E1000_V2PMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_P2VMAILBOX_STS 0x00000001 /* Initiate message send to VF */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_P2VMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_P2VMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_P2VMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_P2VMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi#define E1000_MBVFICR_VFREQ_MASK 0x000000FF /* bits for VF messages */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi#define E1000_MBVFICR_VFACK_MASK 0x00FF0000 /* bits for VF acks */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi/* If it's a E1000_VF_* msg then it originates in the VF and is sent to the
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi * PF. The reverse is TRUE if it is E1000_PF_*.
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi * Message ACK's are the value or'd with 0xF0000000
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi/* Msgs below or'd with this are the ACK */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi/* Msgs below or'd with this are the NACK */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi/* Indicates that VF is still clear to send requests */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi/* bits 23:16 are used for extra info for certain messages */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VT_MSGINFO_MASK (0xFF << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_RESET 0x01 /* VF requests reset */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_MAC_ADDR 0x02 /* VF requests to set MAC addr */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_MULTICAST 0x03 /* VF requests to set MC addr */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi#define E1000_VF_SET_MULTICAST_COUNT_MASK (0x1F << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_MULTICAST_OVERFLOW (0x80 << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_VLAN 0x04 /* VF requests to set VLAN */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_VLAN_ADD (0x01 << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_LPE 0x05 /* reqs to set VMOLR.LPE */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_PROMISC 0x06 /* reqs to clear VMOLR.ROPE/MPME*/
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_PROMISC_UNICAST (0x01 << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_SET_PROMISC_MULTICAST (0x02 << E1000_VT_MSGINFO_SHIFT)
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_PF_CONTROL_MSG 0x0100 /* PF control message */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
c124a83e09115de88ecccd4f689983f42a1d53bdRobert Mustacchi#define E1000_VF_MBX_INIT_DELAY 500 /* microseconds between retries */
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_read_mbx(struct e1000_hw *, u32 *, u16, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_write_mbx(struct e1000_hw *, u32 *, u16, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_read_posted_mbx(struct e1000_hw *, u32 *, u16, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_write_posted_mbx(struct e1000_hw *, u32 *, u16, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_check_for_msg(struct e1000_hw *, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_check_for_ack(struct e1000_hw *, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_check_for_rst(struct e1000_hw *, u16);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchivoid e1000_init_mbx_ops_generic(struct e1000_hw *hw);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_init_mbx_params_vf(struct e1000_hw *);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchis32 e1000_init_mbx_params_pf(struct e1000_hw *);
75eba5b6d79ed4d2ce3daf7b2806306b6b69a938Robert Mustacchi#endif /* _E1000_MBX_H_ */