1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2001-2020 Intel Corporation 3 */ 4 5 #ifndef _IXGBE_MBX_H_ 6 #define _IXGBE_MBX_H_ 7 8 #include "ixgbe_type.h" 9 10 #define IXGBE_VFMAILBOX_SIZE 16 /* 16 32 bit words - 64 bytes */ 11 #define IXGBE_ERR_MBX -100 12 13 #define IXGBE_VFMAILBOX 0x002FC 14 #define IXGBE_VFMBMEM 0x00200 15 16 /* Define mailbox register bits */ 17 #define IXGBE_VFMAILBOX_REQ 0x00000001 /* Request for PF Ready bit */ 18 #define IXGBE_VFMAILBOX_ACK 0x00000002 /* Ack PF message received */ 19 #define IXGBE_VFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 20 #define IXGBE_VFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 21 #define IXGBE_VFMAILBOX_PFSTS 0x00000010 /* PF wrote a message in the MB */ 22 #define IXGBE_VFMAILBOX_PFACK 0x00000020 /* PF ack the previous VF msg */ 23 #define IXGBE_VFMAILBOX_RSTI 0x00000040 /* PF has reset indication */ 24 #define IXGBE_VFMAILBOX_RSTD 0x00000080 /* PF has indicated reset done */ 25 #define IXGBE_VFMAILBOX_R2C_BITS 0x000000B0 /* All read to clear bits */ 26 27 #define IXGBE_PFMAILBOX_STS 0x00000001 /* Initiate message send to VF */ 28 #define IXGBE_PFMAILBOX_ACK 0x00000002 /* Ack message recv'd from VF */ 29 #define IXGBE_PFMAILBOX_VFU 0x00000004 /* VF owns the mailbox buffer */ 30 #define IXGBE_PFMAILBOX_PFU 0x00000008 /* PF owns the mailbox buffer */ 31 #define IXGBE_PFMAILBOX_RVFU 0x00000010 /* Reset VFU - used when VF stuck */ 32 33 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */ 34 #define IXGBE_MBVFICR_VFREQ_VF1 0x00000001 /* bit for VF 1 message */ 35 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */ 36 #define IXGBE_MBVFICR_VFACK_VF1 0x00010000 /* bit for VF 1 ack */ 37 38 39 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the 40 * PF. The reverse is true if it is IXGBE_PF_*. 41 * Message ACK's are the value or'd with 0xF0000000 42 */ 43 #define IXGBE_VT_MSGTYPE_ACK 0x80000000 /* Messages below or'd with 44 * this are the ACK */ 45 #define IXGBE_VT_MSGTYPE_NACK 0x40000000 /* Messages below or'd with 46 * this are the NACK */ 47 #define IXGBE_VT_MSGTYPE_CTS 0x20000000 /* Indicates that VF is still 48 * clear to send requests */ 49 #define IXGBE_VT_MSGINFO_SHIFT 16 50 /* bits 23:16 are used for extra info for certain messages */ 51 #define IXGBE_VT_MSGINFO_MASK (0xFF << IXGBE_VT_MSGINFO_SHIFT) 52 53 /* definitions to support mailbox API version negotiation */ 54 55 /* 56 * each element denotes a version of the API; existing numbers may not 57 * change; any additions must go at the end 58 */ 59 enum ixgbe_pfvf_api_rev { 60 ixgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */ 61 ixgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */ 62 ixgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */ 63 ixgbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */ 64 ixgbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */ 65 /* This value should always be last */ 66 ixgbe_mbox_api_unknown, /* indicates that API version is not known */ 67 }; 68 69 /* mailbox API, legacy requests */ 70 #define IXGBE_VF_RESET 0x01 /* VF requests reset */ 71 #define IXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ 72 #define IXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ 73 #define IXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ 74 75 /* mailbox API, version 1.0 VF requests */ 76 #define IXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ 77 #define IXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ 78 #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 79 80 /* mailbox API, version 1.1 VF requests */ 81 #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 82 83 /* mailbox API, version 1.2 VF requests */ 84 #define IXGBE_VF_GET_RETA 0x0a /* VF request for RETA */ 85 #define IXGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */ 86 #define IXGBE_VF_UPDATE_XCAST_MODE 0x0c 87 88 /* mode choices for IXGBE_VF_UPDATE_XCAST_MODE */ 89 enum ixgbevf_xcast_modes { 90 IXGBEVF_XCAST_MODE_NONE = 0, 91 IXGBEVF_XCAST_MODE_MULTI, 92 IXGBEVF_XCAST_MODE_ALLMULTI, 93 IXGBEVF_XCAST_MODE_PROMISC, 94 }; 95 96 /* GET_QUEUES return data indices within the mailbox */ 97 #define IXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ 98 #define IXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ 99 #define IXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ 100 #define IXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ 101 102 /* length of permanent address message returned from PF */ 103 #define IXGBE_VF_PERMADDR_MSG_LEN 4 104 /* word in permanent address message with the current multicast type */ 105 #define IXGBE_VF_MC_TYPE_WORD 3 106 107 #define IXGBE_PF_CONTROL_MSG 0x0100 /* PF control message */ 108 109 /* mailbox API, version 2.0 VF requests */ 110 #define IXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 111 #define IXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 112 #define IXGBE_VF_ENABLE_MACADDR 0x0A /* enable MAC address */ 113 #define IXGBE_VF_DISABLE_MACADDR 0x0B /* disable MAC address */ 114 #define IXGBE_VF_GET_MACADDRS 0x0C /* get all configured MAC addrs */ 115 #define IXGBE_VF_SET_MCAST_PROMISC 0x0D /* enable multicast promiscuous */ 116 #define IXGBE_VF_GET_MTU 0x0E /* get bounds on MTU */ 117 #define IXGBE_VF_SET_MTU 0x0F /* set a specific MTU */ 118 119 /* mailbox API, version 2.0 PF requests */ 120 #define IXGBE_PF_TRANSPARENT_VLAN 0x0101 /* enable transparent vlan */ 121 122 #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */ 123 #define IXGBE_VF_MBX_INIT_DELAY 500 /* microseconds between retries */ 124 125 s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16); 126 s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16); 127 s32 ixgbe_read_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16); 128 s32 ixgbe_write_posted_mbx(struct ixgbe_hw *, u32 *, u16, u16); 129 s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16); 130 s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16); 131 s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16); 132 void ixgbe_init_mbx_ops_generic(struct ixgbe_hw *hw); 133 void ixgbe_init_mbx_params_vf(struct ixgbe_hw *); 134 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *); 135 136 #endif /* _IXGBE_MBX_H_ */ 137