1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /* Copyright (c) 2016-2017 Hisilicon Limited. */
3 
4 #ifndef __HCLGE_MBX_H
5 #define __HCLGE_MBX_H
6 #include <linux/init.h>
7 #include <linux/mutex.h>
8 #include <linux/types.h>
9 
10 enum HCLGE_MBX_OPCODE {
11 	HCLGE_MBX_RESET = 0x01,		/* (VF -> PF) assert reset */
12 	HCLGE_MBX_ASSERTING_RESET,	/* (PF -> VF) PF is asserting reset */
13 	HCLGE_MBX_SET_UNICAST,		/* (VF -> PF) set UC addr */
14 	HCLGE_MBX_SET_MULTICAST,	/* (VF -> PF) set MC addr */
15 	HCLGE_MBX_SET_VLAN,		/* (VF -> PF) set VLAN */
16 	HCLGE_MBX_MAP_RING_TO_VECTOR,	/* (VF -> PF) map ring-to-vector */
17 	HCLGE_MBX_UNMAP_RING_TO_VECTOR,	/* (VF -> PF) unamp ring-to-vector */
18 	HCLGE_MBX_SET_PROMISC_MODE,	/* (VF -> PF) set promiscuous mode */
19 	HCLGE_MBX_SET_MACVLAN,		/* (VF -> PF) set unicast filter */
20 	HCLGE_MBX_API_NEGOTIATE,	/* (VF -> PF) negotiate API version */
21 	HCLGE_MBX_GET_QINFO,		/* (VF -> PF) get queue config */
22 	HCLGE_MBX_GET_QDEPTH,		/* (VF -> PF) get queue depth */
23 	HCLGE_MBX_GET_BASIC_INFO,	/* (VF -> PF) get basic info */
24 	HCLGE_MBX_GET_RETA,		/* (VF -> PF) get RETA */
25 	HCLGE_MBX_GET_RSS_KEY,		/* (VF -> PF) get RSS key */
26 	HCLGE_MBX_GET_MAC_ADDR,		/* (VF -> PF) get MAC addr */
27 	HCLGE_MBX_PF_VF_RESP,		/* (PF -> VF) generate response to VF */
28 	HCLGE_MBX_GET_BDNUM,		/* (VF -> PF) get BD num */
29 	HCLGE_MBX_GET_BUFSIZE,		/* (VF -> PF) get buffer size */
30 	HCLGE_MBX_GET_STREAMID,		/* (VF -> PF) get stream id */
31 	HCLGE_MBX_SET_AESTART,		/* (VF -> PF) start ae */
32 	HCLGE_MBX_SET_TSOSTATS,		/* (VF -> PF) get tso stats */
33 	HCLGE_MBX_LINK_STAT_CHANGE,	/* (PF -> VF) link status has changed */
34 	HCLGE_MBX_GET_BASE_CONFIG,	/* (VF -> PF) get config */
35 	HCLGE_MBX_BIND_FUNC_QUEUE,	/* (VF -> PF) bind function and queue */
36 	HCLGE_MBX_GET_LINK_STATUS,	/* (VF -> PF) get link status */
37 	HCLGE_MBX_QUEUE_RESET,		/* (VF -> PF) reset queue */
38 	HCLGE_MBX_KEEP_ALIVE,		/* (VF -> PF) send keep alive cmd */
39 	HCLGE_MBX_SET_ALIVE,		/* (VF -> PF) set alive state */
40 	HCLGE_MBX_SET_MTU,		/* (VF -> PF) set mtu */
41 	HCLGE_MBX_GET_QID_IN_PF,	/* (VF -> PF) get queue id in pf */
42 	HCLGE_MBX_LINK_STAT_MODE,	/* (PF -> VF) link mode has changed */
43 	HCLGE_MBX_GET_LINK_MODE,	/* (VF -> PF) get the link mode of pf */
44 	HCLGE_MBX_PUSH_VLAN_INFO,	/* (PF -> VF) push port base vlan */
45 	HCLGE_MBX_GET_MEDIA_TYPE,       /* (VF -> PF) get media type */
46 	HCLGE_MBX_PUSH_PROMISC_INFO,	/* (PF -> VF) push vf promisc info */
47 	HCLGE_MBX_VF_UNINIT,            /* (VF -> PF) vf is unintializing */
48 	HCLGE_MBX_HANDLE_VF_TBL,	/* (VF -> PF) store/clear hw table */
49 
50 	HCLGE_MBX_GET_VF_FLR_STATUS = 200, /* (M7 -> PF) get vf flr status */
51 	HCLGE_MBX_PUSH_LINK_STATUS,	/* (M7 -> PF) get port link status */
52 	HCLGE_MBX_NCSI_ERROR,		/* (M7 -> PF) receive a NCSI error */
53 };
54 
55 /* below are per-VF mac-vlan subcodes */
56 enum hclge_mbx_mac_vlan_subcode {
57 	HCLGE_MBX_MAC_VLAN_UC_MODIFY = 0,	/* modify UC mac addr */
58 	HCLGE_MBX_MAC_VLAN_UC_ADD,		/* add a new UC mac addr */
59 	HCLGE_MBX_MAC_VLAN_UC_REMOVE,		/* remove a new UC mac addr */
60 	HCLGE_MBX_MAC_VLAN_MC_MODIFY,		/* modify MC mac addr */
61 	HCLGE_MBX_MAC_VLAN_MC_ADD,		/* add new MC mac addr */
62 	HCLGE_MBX_MAC_VLAN_MC_REMOVE,		/* remove MC mac addr */
63 };
64 
65 /* below are per-VF vlan cfg subcodes */
66 enum hclge_mbx_vlan_cfg_subcode {
67 	HCLGE_MBX_VLAN_FILTER = 0,	/* set vlan filter */
68 	HCLGE_MBX_VLAN_TX_OFF_CFG,	/* set tx side vlan offload */
69 	HCLGE_MBX_VLAN_RX_OFF_CFG,	/* set rx side vlan offload */
70 	HCLGE_MBX_PORT_BASE_VLAN_CFG,	/* set port based vlan configuration */
71 	HCLGE_MBX_GET_PORT_BASE_VLAN_STATE,	/* get port based vlan state */
72 	HCLGE_MBX_ENABLE_VLAN_FILTER,
73 };
74 
75 enum hclge_mbx_tbl_cfg_subcode {
76 	HCLGE_MBX_VPORT_LIST_CLEAR,
77 };
78 
79 #define HCLGE_MBX_MAX_MSG_SIZE	14
80 #define HCLGE_MBX_MAX_RESP_DATA_SIZE	8U
81 #define HCLGE_MBX_MAX_RING_CHAIN_PARAM_NUM	4
82 
83 #define HCLGE_RESET_SCHED_TIMEOUT	(3 * HZ)
84 #define HCLGE_MBX_SCHED_TIMEOUT	(HZ / 2)
85 
86 struct hclge_ring_chain_param {
87 	u8 ring_type;
88 	u8 tqp_index;
89 	u8 int_gl_index;
90 };
91 
92 struct hclge_basic_info {
93 	u8 hw_tc_map;
94 	u8 rsv;
95 	u16 mbx_api_version;
96 	u32 pf_caps;
97 };
98 
99 struct hclgevf_mbx_resp_status {
100 	struct mutex mbx_mutex; /* protects against contending sync cmd resp */
101 	u32 origin_mbx_msg;
102 	bool received_resp;
103 	int resp_status;
104 	u16 match_id;
105 	u8 additional_info[HCLGE_MBX_MAX_RESP_DATA_SIZE];
106 };
107 
108 struct hclge_respond_to_vf_msg {
109 	int status;
110 	u8 data[HCLGE_MBX_MAX_RESP_DATA_SIZE];
111 	u16 len;
112 };
113 
114 struct hclge_vf_to_pf_msg {
115 	u8 code;
116 	union {
117 		struct {
118 			u8 subcode;
119 			u8 data[HCLGE_MBX_MAX_MSG_SIZE];
120 		};
121 		struct {
122 			u8 en_bc;
123 			u8 en_uc;
124 			u8 en_mc;
125 			u8 en_limit_promisc;
126 		};
127 		struct {
128 			u8 vector_id;
129 			u8 ring_num;
130 			struct hclge_ring_chain_param
131 				param[HCLGE_MBX_MAX_RING_CHAIN_PARAM_NUM];
132 		};
133 	};
134 };
135 
136 struct hclge_pf_to_vf_msg {
137 	u16 code;
138 	u16 vf_mbx_msg_code;
139 	u16 vf_mbx_msg_subcode;
140 	u16 resp_status;
141 	u8 resp_data[HCLGE_MBX_MAX_RESP_DATA_SIZE];
142 };
143 
144 struct hclge_mbx_vf_to_pf_cmd {
145 	u8 rsv;
146 	u8 mbx_src_vfid; /* Auto filled by IMP */
147 	u8 mbx_need_resp;
148 	u8 rsv1[1];
149 	u8 msg_len;
150 	u8 rsv2;
151 	u16 match_id;
152 	struct hclge_vf_to_pf_msg msg;
153 };
154 
155 #define HCLGE_MBX_NEED_RESP_B		0
156 
157 struct hclge_mbx_pf_to_vf_cmd {
158 	u8 dest_vfid;
159 	u8 rsv[3];
160 	u8 msg_len;
161 	u8 rsv1;
162 	u16 match_id;
163 	struct hclge_pf_to_vf_msg msg;
164 };
165 
166 struct hclge_vf_rst_cmd {
167 	u8 dest_vfid;
168 	u8 vf_rst;
169 	u8 rsv[22];
170 };
171 
172 /* used by VF to store the received Async responses from PF */
173 struct hclgevf_mbx_arq_ring {
174 #define HCLGE_MBX_MAX_ARQ_MSG_SIZE	8
175 #define HCLGE_MBX_MAX_ARQ_MSG_NUM	1024
176 	struct hclgevf_dev *hdev;
177 	u32 head;
178 	u32 tail;
179 	atomic_t count;
180 	u16 msg_q[HCLGE_MBX_MAX_ARQ_MSG_NUM][HCLGE_MBX_MAX_ARQ_MSG_SIZE];
181 };
182 
183 #define hclge_mbx_ring_ptr_move_crq(crq) \
184 	(crq->next_to_use = (crq->next_to_use + 1) % crq->desc_num)
185 #define hclge_mbx_tail_ptr_move_arq(arq) \
186 		(arq.tail = (arq.tail + 1) % HCLGE_MBX_MAX_ARQ_MSG_NUM)
187 #define hclge_mbx_head_ptr_move_arq(arq) \
188 		(arq.head = (arq.head + 1) % HCLGE_MBX_MAX_ARQ_MSG_NUM)
189 
190 /* PF immediately push link status to VFs when link status changed */
191 #define HCLGE_MBX_PUSH_LINK_STATUS_EN			BIT(0)
192 #endif
193