iPXE
igbvf_mbx.h
Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003   Intel(R) 82576 Virtual Function Linux driver
00004   Copyright(c) 1999 - 2008 Intel Corporation.
00005 
00006   This program is free software; you can redistribute it and/or modify it
00007   under the terms and conditions of the GNU General Public License,
00008   version 2, as published by the Free Software Foundation.
00009 
00010   This program is distributed in the hope it will be useful, but WITHOUT
00011   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
00013   more details.
00014 
00015   You should have received a copy of the GNU General Public License along with
00016   this program; if not, write to the Free Software Foundation, Inc.,
00017   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
00018 
00019   The full GNU General Public License is included in this distribution in
00020   the file called "COPYING".
00021 
00022   Contact Information:
00023   Linux NICS <linux.nics@intel.com>
00024   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
00025   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
00026 
00027 *******************************************************************************/
00028 
00029 FILE_LICENCE ( GPL2_ONLY );
00030 
00031 #ifndef _IGBVF_MBX_H_
00032 #define _IGBVF_MBX_H_
00033 
00034 #include "igbvf_vf.h"
00035 
00036 /* Define mailbox specific registers */
00037 #define E1000_V2PMAILBOX(_n)   (0x00C40 + (4 * (_n)))
00038 #define E1000_VMBMEM(_n)       (0x00800 + (64 * (_n)))
00039 
00040 /* Define mailbox register bits */
00041 #define E1000_V2PMAILBOX_REQ   0x00000001 /* Request for PF Ready bit */
00042 #define E1000_V2PMAILBOX_ACK   0x00000002 /* Ack PF message received */
00043 #define E1000_V2PMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
00044 #define E1000_V2PMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
00045 #define E1000_V2PMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */
00046 #define E1000_V2PMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */
00047 #define E1000_V2PMAILBOX_RSTI  0x00000040 /* PF has reset indication */
00048 #define E1000_V2PMAILBOX_RSTD  0x00000080 /* PF has indicated reset done */
00049 #define E1000_V2PMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */
00050 
00051 #define E1000_VFMAILBOX_SIZE   16 /* 16 32 bit words - 64 bytes */
00052 
00053 /* If it's a E1000_VF_* msg then it originates in the VF and is sent to the
00054  * PF.  The reverse is true if it is E1000_PF_*.
00055  * Message ACK's are the value or'd with 0xF0000000
00056  */
00057 #define E1000_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
00058                                                * this are the ACK */
00059 #define E1000_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
00060                                                * this are the NACK */
00061 #define E1000_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
00062                                                  clear to send requests */
00063 #define E1000_VT_MSGINFO_SHIFT    16
00064 /* bits 23:16 are used for exra info for certain messages */
00065 #define E1000_VT_MSGINFO_MASK     (0xFF << E1000_VT_MSGINFO_SHIFT)
00066 
00067 #define E1000_VF_RESET            0x01 /* VF requests reset */
00068 #define E1000_VF_SET_MAC_ADDR     0x02 /* VF requests to set MAC addr */
00069 #define E1000_VF_SET_MULTICAST    0x03 /* VF requests to set MC addr */
00070 #define E1000_VF_SET_MULTICAST_COUNT_MASK (0x1F << E1000_VT_MSGINFO_SHIFT)
00071 #define E1000_VF_SET_MULTICAST_OVERFLOW   (0x80 << E1000_VT_MSGINFO_SHIFT)
00072 #define E1000_VF_SET_VLAN         0x04 /* VF requests to set VLAN */
00073 #define E1000_VF_SET_VLAN_ADD             (0x01 << E1000_VT_MSGINFO_SHIFT)
00074 #define E1000_VF_SET_LPE          0x05 /* VF requests to set VMOLR.LPE */
00075 #define E1000_VF_SET_PROMISC      0x06 /*VF requests to clear VMOLR.ROPE/MPME*/
00076 #define E1000_VF_SET_PROMISC_UNICAST      (0x01 << E1000_VT_MSGINFO_SHIFT)
00077 #define E1000_VF_SET_PROMISC_MULTICAST    (0x02 << E1000_VT_MSGINFO_SHIFT)
00078 
00079 #define E1000_PF_CONTROL_MSG      0x0100 /* PF control message */
00080 
00081 #define E1000_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
00082 #define E1000_VF_MBX_INIT_DELAY   500  /* microseconds between retries */
00083 
00084 void igbvf_init_mbx_ops_generic(struct e1000_hw *hw);
00085 s32 igbvf_init_mbx_params_vf(struct e1000_hw *);
00086 
00087 #endif /* _IGBVF_MBX_H_ */