1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
3 * Copyright(c) 2010-2017 Intel Corporation
9 #define NGBE_ERR_MBX -100
11 /* If it's a NGBE_VF_* msg then it originates in the VF and is sent to the
12 * PF. The reverse is true if it is NGBE_PF_*.
13 * Message ACK's are the value or'd with 0xF0000000
15 /* Messages below or'd with this are the ACK */
16 #define NGBE_VT_MSGTYPE_ACK 0x80000000
17 /* Messages below or'd with this are the NACK */
18 #define NGBE_VT_MSGTYPE_NACK 0x40000000
19 /* Indicates that VF is still clear to send requests */
20 #define NGBE_VT_MSGTYPE_CTS 0x20000000
22 #define NGBE_VT_MSGINFO_SHIFT 16
23 /* bits 23:16 are used for extra info for certain messages */
24 #define NGBE_VT_MSGINFO_MASK (0xFF << NGBE_VT_MSGINFO_SHIFT)
27 * each element denotes a version of the API; existing numbers may not
28 * change; any additions must go at the end
30 enum ngbe_pfvf_api_rev {
32 ngbe_mbox_api_10, /* API version 1.0, linux/freebsd VF driver */
33 ngbe_mbox_api_11, /* API version 1.1, linux/freebsd VF driver */
34 ngbe_mbox_api_12, /* API version 1.2, linux/freebsd VF driver */
35 ngbe_mbox_api_13, /* API version 1.3, linux/freebsd VF driver */
36 ngbe_mbox_api_20, /* API version 2.0, solaris Phase1 VF driver */
37 /* This value should always be last */
38 ngbe_mbox_api_unknown, /* indicates that API version is not known */
41 /* mailbox API, legacy requests */
42 #define NGBE_VF_RESET 0x01 /* VF requests reset */
43 #define NGBE_VF_SET_MAC_ADDR 0x02 /* VF requests PF to set MAC addr */
44 #define NGBE_VF_SET_MULTICAST 0x03 /* VF requests PF to set MC addr */
45 #define NGBE_VF_SET_VLAN 0x04 /* VF requests PF to set VLAN */
47 /* mailbox API, version 1.0 VF requests */
48 #define NGBE_VF_SET_LPE 0x05 /* VF requests PF to set VMOLR.LPE */
49 #define NGBE_VF_SET_MACVLAN 0x06 /* VF requests PF for unicast filter */
50 #define NGBE_VF_API_NEGOTIATE 0x08 /* negotiate API version */
52 /* mailbox API, version 1.1 VF requests */
53 #define NGBE_VF_GET_QUEUES 0x09 /* get queue configuration */
55 /* mailbox API, version 1.2 VF requests */
56 #define NGBE_VF_GET_RETA 0x0a /* VF request for RETA */
57 #define NGBE_VF_GET_RSS_KEY 0x0b /* get RSS key */
58 #define NGBE_VF_UPDATE_XCAST_MODE 0x0c
60 /* mode choices for NGBE_VF_UPDATE_XCAST_MODE */
61 enum ngbevf_xcast_modes {
62 NGBEVF_XCAST_MODE_NONE = 0,
63 NGBEVF_XCAST_MODE_MULTI,
64 NGBEVF_XCAST_MODE_ALLMULTI,
65 NGBEVF_XCAST_MODE_PROMISC,
68 /* GET_QUEUES return data indices within the mailbox */
69 #define NGBE_VF_TX_QUEUES 1 /* number of Tx queues supported */
70 #define NGBE_VF_RX_QUEUES 2 /* number of Rx queues supported */
71 #define NGBE_VF_TRANS_VLAN 3 /* Indication of port vlan */
72 #define NGBE_VF_DEF_QUEUE 4 /* Default queue offset */
74 /* length of permanent address message returned from PF */
75 #define NGBE_VF_PERMADDR_MSG_LEN 4
76 s32 ngbe_read_mbx(struct ngbe_hw *hw, u32 *msg, u16 size, u16 mbx_id);
77 s32 ngbe_write_mbx(struct ngbe_hw *hw, u32 *msg, u16 size, u16 mbx_id);
78 s32 ngbe_check_for_msg(struct ngbe_hw *hw, u16 mbx_id);
79 s32 ngbe_check_for_ack(struct ngbe_hw *hw, u16 mbx_id);
80 s32 ngbe_check_for_rst(struct ngbe_hw *hw, u16 mbx_id);
81 void ngbe_init_mbx_params_pf(struct ngbe_hw *hw);
83 s32 ngbe_read_mbx_pf(struct ngbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
84 s32 ngbe_write_mbx_pf(struct ngbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
85 s32 ngbe_check_for_msg_pf(struct ngbe_hw *hw, u16 vf_number);
86 s32 ngbe_check_for_ack_pf(struct ngbe_hw *hw, u16 vf_number);
87 s32 ngbe_check_for_rst_pf(struct ngbe_hw *hw, u16 vf_number);
89 #endif /* _NGBE_MBX_H_ */