xref: /linux/drivers/net/ethernet/wangxun/libwx/wx_mbx.h (revision b803c4a4f78834b31ebfbbcea350473333760559)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2015 - 2025 Beijing WangXun Technology Co., Ltd. */
3 #ifndef _WX_MBX_H_
4 #define _WX_MBX_H_
5 
6 #define WX_VXMAILBOX_SIZE    15
7 
8 /* PF Registers */
9 #define WX_PXMAILBOX(i)      (0x600 + (4 * (i))) /* i=[0,63] */
10 #define WX_PXMAILBOX_STS     BIT(0) /* Initiate message send to VF */
11 #define WX_PXMAILBOX_ACK     BIT(1) /* Ack message recv'd from VF */
12 #define WX_PXMAILBOX_PFU     BIT(3) /* PF owns the mailbox buffer */
13 
14 #define WX_PXMBMEM(i)        (0x5000 + (64 * (i))) /* i=[0,63] */
15 
16 #define WX_VFLRE(i)          (0x4A0 + (4 * (i))) /* i=[0,1] */
17 #define WX_VFLREC(i)         (0x4A8 + (4 * (i))) /* i=[0,1] */
18 
19 /* SR-IOV specific macros */
20 #define WX_MBVFICR(i)         (0x480 + (4 * (i))) /* i=[0,3] */
21 #define WX_MBVFICR_VFREQ_MASK GENMASK(15, 0)
22 #define WX_MBVFICR_VFACK_MASK GENMASK(31, 16)
23 
24 #define WX_VT_MSGTYPE_ACK     BIT(31)
25 #define WX_VT_MSGTYPE_NACK    BIT(30)
26 #define WX_VT_MSGTYPE_CTS     BIT(29)
27 #define WX_VT_MSGINFO_SHIFT   16
28 #define WX_VT_MSGINFO_MASK    GENMASK(23, 16)
29 
30 enum wx_pfvf_api_rev {
31 	wx_mbox_api_null,
32 	wx_mbox_api_13 = 4,      /* API version 1.3 */
33 	wx_mbox_api_unknown, /* indicates that API version is not known */
34 };
35 
36 /* mailbox API */
37 #define WX_VF_RESET                  0x01 /* VF requests reset */
38 #define WX_VF_SET_MAC_ADDR           0x02 /* VF requests PF to set MAC addr */
39 #define WX_VF_SET_MULTICAST          0x03 /* VF requests PF to set MC addr */
40 #define WX_VF_SET_VLAN               0x04 /* VF requests PF to set VLAN */
41 #define WX_VF_SET_LPE                0x05 /* VF requests PF to set VMOLR.LPE */
42 #define WX_VF_SET_MACVLAN            0x06 /* VF requests PF unicast filter */
43 #define WX_VF_API_NEGOTIATE          0x08 /* negotiate API version */
44 #define WX_VF_GET_QUEUES             0x09 /* get queue configuration */
45 #define WX_VF_GET_RETA               0x0a /* VF request for RETA */
46 #define WX_VF_GET_RSS_KEY            0x0b /* get RSS key */
47 #define WX_VF_UPDATE_XCAST_MODE      0x0c
48 #define WX_VF_GET_LINK_STATE         0x10 /* get vf link state */
49 #define WX_VF_GET_FW_VERSION         0x11 /* get fw version */
50 
51 #define WX_VF_BACKUP                 0x8001 /* VF requests backup */
52 
53 #define WX_PF_CONTROL_MSG            BIT(8) /* PF control message */
54 #define WX_PF_NOFITY_VF_LINK_STATUS  0x1
55 #define WX_PF_NOFITY_VF_NET_NOT_RUNNING BIT(31)
56 
57 #define WX_VF_TX_QUEUES              1 /* number of Tx queues supported */
58 #define WX_VF_RX_QUEUES              2 /* number of Rx queues supported */
59 #define WX_VF_TRANS_VLAN             3 /* Indication of port vlan */
60 #define WX_VF_DEF_QUEUE              4 /* Default queue offset */
61 
62 #define WX_VF_PERMADDR_MSG_LEN       4
63 
64 enum wxvf_xcast_modes {
65 	WXVF_XCAST_MODE_NONE = 0,
66 	WXVF_XCAST_MODE_MULTI,
67 	WXVF_XCAST_MODE_ALLMULTI,
68 	WXVF_XCAST_MODE_PROMISC,
69 };
70 
71 int wx_write_mbx_pf(struct wx *wx, u32 *msg, u16 size, u16 vf);
72 int wx_read_mbx_pf(struct wx *wx, u32 *msg, u16 size, u16 vf);
73 int wx_check_for_rst_pf(struct wx *wx, u16 mbx_id);
74 int wx_check_for_msg_pf(struct wx *wx, u16 mbx_id);
75 int wx_check_for_ack_pf(struct wx *wx, u16 mbx_id);
76 
77 #endif /* _WX_MBX_H_ */
78