1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2015-2020 3 */ 4 5 #ifndef _TXGBE_MBX_H_ 6 #define _TXGBE_MBX_H_ 7 8 #include "txgbe_type.h" 9 10 #define TXGBE_ERR_MBX -100 11 12 /* If it's a TXGBE_VF_* msg then it originates in the VF and is sent to the 13 * PF. The reverse is true if it is TXGBE_PF_*. 14 * Message ACK's are the value or'd with 0xF0000000 15 */ 16 /* Messages below or'd with this are the ACK */ 17 #define TXGBE_VT_MSGTYPE_ACK 0x80000000 18 /* Messages below or'd with this are the NACK */ 19 #define TXGBE_VT_MSGTYPE_NACK 0x40000000 20 /* Indicates that VF is still clear to send requests */ 21 #define TXGBE_VT_MSGTYPE_CTS 0x20000000 22 23 #define TXGBE_VT_MSGINFO_SHIFT 16 24 /* bits 23:16 are used for extra info for certain messages */ 25 #define TXGBE_VT_MSGINFO_MASK (0xFF << TXGBE_VT_MSGINFO_SHIFT) 26 27 /* definitions to support mailbox API version negotiation */ 28 29 /* 30 * each element denotes a version of the API; existing numbers may not 31 * change; any additions must go at the end 32 */ 33 enum txgbe_pfvf_api_rev { 34 txgbe_mbox_api_null, 35 txgbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */ 36 txgbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */ 37 txgbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */ 38 txgbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */ 39 txgbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */ 40 /* This value should always be last */ 41 txgbe_mbox_api_unknown, /* indicates that API version is not known */ 42 }; 43 44 /* mailbox API, legacy requests */ 45 #define TXGBE_VF_RESET 0x01 /* VF requests reset */ 46 #define TXGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */ 47 #define TXGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */ 48 #define TXGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */ 49 50 /* mailbox API, version 1.0 VF requests */ 51 #define TXGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */ 52 #define TXGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */ 53 #define TXGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */ 54 55 /* mailbox API, version 1.1 VF requests */ 56 #define TXGBE_VF_GET_QUEUES 0x09 /* get queue configuration */ 57 58 /* mailbox API, version 1.2 VF requests */ 59 #define TXGBE_VF_GET_RETA 0x0a /* VF request for RETA */ 60 #define TXGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */ 61 #define TXGBE_VF_UPDATE_XCAST_MODE 0x0c 62 63 /* mode choices for TXGBE_VF_UPDATE_XCAST_MODE */ 64 enum txgbevf_xcast_modes { 65 TXGBEVF_XCAST_MODE_NONE = 0, 66 TXGBEVF_XCAST_MODE_MULTI, 67 TXGBEVF_XCAST_MODE_ALLMULTI, 68 TXGBEVF_XCAST_MODE_PROMISC, 69 }; 70 71 /* GET_QUEUES return data indices within the mailbox */ 72 #define TXGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */ 73 #define TXGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */ 74 #define TXGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */ 75 #define TXGBE_VF_DEF_QUEUE 4 /* Default queue offset */ 76 77 /* length of permanent address message returned from PF */ 78 #define TXGBE_VF_PERMADDR_MSG_LEN 4 79 80 s32 txgbe_read_mbx(struct txgbe_hw *hw, u32 *msg, u16 size, u16 mbx_id); 81 s32 txgbe_write_mbx(struct txgbe_hw *hw, u32 *msg, u16 size, u16 mbx_id); 82 s32 txgbe_check_for_msg(struct txgbe_hw *hw, u16 mbx_id); 83 s32 txgbe_check_for_ack(struct txgbe_hw *hw, u16 mbx_id); 84 s32 txgbe_check_for_rst(struct txgbe_hw *hw, u16 mbx_id); 85 void txgbe_init_mbx_params_pf(struct txgbe_hw *hw); 86 87 s32 txgbe_read_mbx_pf(struct txgbe_hw *hw, u32 *msg, u16 size, u16 vf_number); 88 s32 txgbe_write_mbx_pf(struct txgbe_hw *hw, u32 *msg, u16 size, u16 vf_number); 89 s32 txgbe_check_for_msg_pf(struct txgbe_hw *hw, u16 vf_number); 90 s32 txgbe_check_for_ack_pf(struct txgbe_hw *hw, u16 vf_number); 91 s32 txgbe_check_for_rst_pf(struct txgbe_hw *hw, u16 vf_number); 92 93 #endif /* _TXGBE_MBX_H_ */ 94