2010-01-09 02:25:10 +00:00
/*******************************************************************************
Intel 10 Gigabit PCI Express Linux driver
2013-01-08 05:02:28 +00:00
Copyright ( c ) 1999 - 2013 Intel Corporation .
2010-01-09 02:25:10 +00:00
This program is free software ; you can redistribute it and / or modify it
under the terms and conditions of the GNU General Public License ,
version 2 , as published by the Free Software Foundation .
This program is distributed in the hope it will be useful , but WITHOUT
ANY WARRANTY ; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE . See the GNU General Public License for
more details .
You should have received a copy of the GNU General Public License along with
this program ; if not , write to the Free Software Foundation , Inc . ,
51 Franklin St - Fifth Floor , Boston , MA 02110 - 1301 USA .
The full GNU General Public License is included in this distribution in
the file called " COPYING " .
Contact Information :
e1000 - devel Mailing List < e1000 - devel @ lists . sourceforge . net >
Intel Corporation , 5200 N . E . Elam Young Parkway , Hillsboro , OR 97124 - 6497
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# ifndef _IXGBE_MBX_H_
# define _IXGBE_MBX_H_
# include "ixgbe_type.h"
# define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */
# define IXGBE_ERR_MBX -100
# define IXGBE_VFMAILBOX 0x002FC
# define IXGBE_VFMBMEM 0x00200
# define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */
# define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */
# define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */
# define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */
# define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */
# define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
# define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */
# define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
# define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */
/* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
* PF . The reverse is true if it is IXGBE_PF_ * .
* Message ACK ' s are the value or ' d with 0xF0000000
*/
# define IXGBE_VT_MSGTYPE_ACK 0x80000000 / * Messages below or'd with
* this are the ACK */
# define IXGBE_VT_MSGTYPE_NACK 0x40000000 / * Messages below or'd with
* this are the NACK */
# define IXGBE_VT_MSGTYPE_CTS 0x20000000 / * Indicates that VF is still
clear to send requests */
# define IXGBE_VT_MSGINFO_SHIFT 16
/* bits 23:16 are used for exra info for certain messages */
# define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT)
2012-07-20 08:09:22 +00:00
/* definitions to support mailbox API version negotiation */
/*
* Each element denotes a version of the API ; existing numbers may not
* change ; any additions must go at the end
*/
enum ixgbe_pfvf_api_rev {
ixgbe_mbox_api_10 , /* API version 1.0, linux/freebsd VF driver */
ixgbe_mbox_api_20 , /* API version 2.0, solaris Phase1 VF driver */
2012-07-20 08:09:32 +00:00
ixgbe_mbox_api_11 , /* API version 1.1, linux/freebsd VF driver */
2012-07-20 08:09:22 +00:00
/* This value should always be last */
ixgbe_mbox_api_unknown , /* indicates that API version is not known */
} ;
/* mailbox API, legacy requests */
2010-01-09 02:25:10 +00:00
# define IXGBE_VF_RESET 0x01 /* VF requests reset */
# define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */
# define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */
# define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */
2012-07-20 08:09:22 +00:00
/* mailbox API, version 1.0 VF requests */
# define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */
# define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */
# define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */
2010-01-09 02:25:10 +00:00
2012-07-20 08:09:32 +00:00
/* mailbox API, version 1.1 VF requests */
# define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */
/* GET_QUEUES return data indices within the mailbox */
# define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */
# define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */
# define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */
# define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */
2010-01-09 02:25:10 +00:00
/* length of permanent address message returned from PF */
# define IXGBE_VF_PERMADDR_MSG_LEN 4
/* word in permanent address message with the current multicast type */
# define IXGBE_VF_MC_TYPE_WORD 3
# define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */
# define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
# define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */
s32 ixgbe_read_mbx ( struct ixgbe_hw * , u32 * , u16 , u16 ) ;
s32 ixgbe_write_mbx ( struct ixgbe_hw * , u32 * , u16 , u16 ) ;
s32 ixgbe_check_for_msg ( struct ixgbe_hw * , u16 ) ;
s32 ixgbe_check_for_ack ( struct ixgbe_hw * , u16 ) ;
s32 ixgbe_check_for_rst ( struct ixgbe_hw * , u16 ) ;
2011-01-28 02:28:36 +00:00
# ifdef CONFIG_PCI_IOV
2010-01-09 02:25:10 +00:00
void ixgbe_init_mbx_params_pf ( struct ixgbe_hw * ) ;
2011-01-28 02:28:36 +00:00
# endif /* CONFIG_PCI_IOV */
2010-01-09 02:25:10 +00:00
2010-11-16 19:27:15 -08:00
extern struct ixgbe_mbx_operations mbx_ops_generic ;
2010-01-09 02:25:10 +00:00
# endif /* _IXGBE_MBX_H_ */
