xref: /dpdk/drivers/net/hns3/hns3_mbx.h (revision 7be78d02)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018-2021 HiSilicon Limited.
3  */
4 
5 #ifndef _HNS3_MBX_H_
6 #define _HNS3_MBX_H_
7 
8 enum HNS3_MBX_OPCODE {
9 	HNS3_MBX_RESET = 0x01,          /* (VF -> PF) assert reset */
10 	HNS3_MBX_ASSERTING_RESET,       /* (PF -> VF) PF is asserting reset */
11 	HNS3_MBX_SET_UNICAST,           /* (VF -> PF) set UC addr */
12 	HNS3_MBX_SET_MULTICAST,         /* (VF -> PF) set MC addr */
13 	HNS3_MBX_SET_VLAN,              /* (VF -> PF) set VLAN */
14 	HNS3_MBX_MAP_RING_TO_VECTOR,    /* (VF -> PF) map ring-to-vector */
15 	HNS3_MBX_UNMAP_RING_TO_VECTOR,  /* (VF -> PF) unamp ring-to-vector */
16 	HNS3_MBX_SET_PROMISC_MODE,      /* (VF -> PF) set promiscuous mode */
17 	HNS3_MBX_SET_MACVLAN,           /* (VF -> PF) set unicast filter */
18 	HNS3_MBX_API_NEGOTIATE,         /* (VF -> PF) negotiate API version */
19 	HNS3_MBX_GET_QINFO,             /* (VF -> PF) get queue config */
20 	HNS3_MBX_GET_QDEPTH,            /* (VF -> PF) get queue depth */
21 	HNS3_MBX_GET_BASIC_INFO,        /* (VF -> PF) get basic info */
22 	HNS3_MBX_GET_RETA,              /* (VF -> PF) get RETA */
23 	HNS3_MBX_GET_RSS_KEY,           /* (VF -> PF) get RSS key */
24 	HNS3_MBX_GET_MAC_ADDR,          /* (VF -> PF) get MAC addr */
25 	HNS3_MBX_PF_VF_RESP,            /* (PF -> VF) generate response to VF */
26 	HNS3_MBX_GET_BDNUM,             /* (VF -> PF) get BD num */
27 	HNS3_MBX_GET_BUFSIZE,           /* (VF -> PF) get buffer size */
28 	HNS3_MBX_GET_STREAMID,          /* (VF -> PF) get stream id */
29 	HNS3_MBX_SET_AESTART,           /* (VF -> PF) start ae */
30 	HNS3_MBX_SET_TSOSTATS,          /* (VF -> PF) get tso stats */
31 	HNS3_MBX_LINK_STAT_CHANGE,      /* (PF -> VF) link status has changed */
32 	HNS3_MBX_GET_BASE_CONFIG,       /* (VF -> PF) get config */
33 	HNS3_MBX_BIND_FUNC_QUEUE,       /* (VF -> PF) bind function and queue */
34 	HNS3_MBX_GET_LINK_STATUS,       /* (VF -> PF) get link status */
35 	HNS3_MBX_QUEUE_RESET,           /* (VF -> PF) reset queue */
36 	HNS3_MBX_KEEP_ALIVE,            /* (VF -> PF) send keep alive cmd */
37 	HNS3_MBX_SET_ALIVE,             /* (VF -> PF) set alive state */
38 	HNS3_MBX_SET_MTU,               /* (VF -> PF) set mtu */
39 	HNS3_MBX_GET_QID_IN_PF,         /* (VF -> PF) get queue id in pf */
40 
41 	HNS3_MBX_PUSH_VLAN_INFO = 34,   /* (PF -> VF) push port base vlan */
42 
43 	HNS3_MBX_PUSH_PROMISC_INFO = 36, /* (PF -> VF) push vf promisc info */
44 
45 	HNS3_MBX_HANDLE_VF_TBL = 38,    /* (VF -> PF) store/clear hw cfg tbl */
46 	HNS3_MBX_GET_RING_VECTOR_MAP,   /* (VF -> PF) get ring-to-vector map */
47 	HNS3_MBX_PUSH_LINK_STATUS = 201, /* (IMP -> PF) get port link status */
48 };
49 
50 struct hns3_basic_info {
51 	uint8_t hw_tc_map;
52 	uint8_t rsv;
53 	uint16_t pf_vf_if_version;
54 	/* capabilities of VF dependent on PF */
55 	uint32_t caps;
56 };
57 
58 /* below are per-VF mac-vlan subcodes */
59 enum hns3_mbx_mac_vlan_subcode {
60 	HNS3_MBX_MAC_VLAN_UC_MODIFY = 0,        /* modify UC mac addr */
61 	HNS3_MBX_MAC_VLAN_UC_ADD,               /* add a new UC mac addr */
62 	HNS3_MBX_MAC_VLAN_UC_REMOVE,            /* remove a new UC mac addr */
63 	HNS3_MBX_MAC_VLAN_MC_MODIFY,            /* modify MC mac addr */
64 	HNS3_MBX_MAC_VLAN_MC_ADD,               /* add new MC mac addr */
65 	HNS3_MBX_MAC_VLAN_MC_REMOVE,            /* remove MC mac addr */
66 };
67 
68 /* below are per-VF vlan cfg subcodes */
69 enum hns3_mbx_vlan_cfg_subcode {
70 	HNS3_MBX_VLAN_FILTER = 0,               /* set vlan filter */
71 	HNS3_MBX_VLAN_TX_OFF_CFG,               /* set tx side vlan offload */
72 	HNS3_MBX_VLAN_RX_OFF_CFG,               /* set rx side vlan offload */
73 	HNS3_MBX_GET_PORT_BASE_VLAN_STATE = 4,  /* get port based vlan state */
74 	HNS3_MBX_ENABLE_VLAN_FILTER,            /* set vlan filter state */
75 };
76 
77 enum hns3_mbx_tbl_cfg_subcode {
78 	HNS3_MBX_VPORT_LIST_CLEAR = 0,
79 };
80 
81 enum hns3_mbx_link_fail_subcode {
82 	HNS3_MBX_LF_NORMAL = 0,
83 	HNS3_MBX_LF_REF_CLOCK_LOST,
84 	HNS3_MBX_LF_XSFP_TX_DISABLE,
85 	HNS3_MBX_LF_XSFP_ABSENT,
86 };
87 
88 #define HNS3_MBX_MAX_MSG_SIZE	16
89 #define HNS3_MBX_MAX_RESP_DATA_SIZE	8
90 #define HNS3_MBX_DEF_TIME_LIMIT_MS	500
91 
92 enum {
93 	HNS3_MBX_RESP_MATCHING_SCHEME_OF_ORIGINAL = 0,
94 	HNS3_MBX_RESP_MATCHING_SCHEME_OF_MATCH_ID
95 };
96 
97 struct hns3_mbx_resp_status {
98 	rte_spinlock_t lock; /* protects against contending sync cmd resp */
99 
100 	uint8_t matching_scheme;
101 
102 	/* The following fields used in the matching scheme for original */
103 	uint32_t req_msg_data;
104 	uint32_t head;
105 	uint32_t tail;
106 	uint32_t lost;
107 
108 	/* The following fields used in the matching scheme for match_id */
109 	uint16_t match_id;
110 	bool received_match_resp;
111 
112 	int resp_status;
113 	uint8_t additional_info[HNS3_MBX_MAX_RESP_DATA_SIZE];
114 };
115 
116 struct errno_respcode_map {
117 	uint16_t resp_code;
118 	int err_no;
119 };
120 
121 #define HNS3_MBX_NEED_RESP_BIT                BIT(0)
122 
123 struct hns3_mbx_vf_to_pf_cmd {
124 	uint8_t rsv;
125 	uint8_t mbx_src_vfid;                   /* Auto filled by IMP */
126 	uint8_t mbx_need_resp;
127 	uint8_t rsv1;
128 	uint8_t msg_len;
129 	uint8_t rsv2;
130 	uint16_t match_id;
131 	uint8_t msg[HNS3_MBX_MAX_MSG_SIZE];
132 };
133 
134 struct hns3_mbx_pf_to_vf_cmd {
135 	uint8_t dest_vfid;
136 	uint8_t rsv[3];
137 	uint8_t msg_len;
138 	uint8_t rsv1;
139 	uint16_t match_id;
140 	uint16_t msg[8];
141 };
142 
143 struct hns3_ring_chain_param {
144 	uint8_t ring_type;
145 	uint8_t tqp_index;
146 	uint8_t int_gl_index;
147 };
148 
149 #define HNS3_MBX_MAX_RING_CHAIN_PARAM_NUM	4
150 struct hns3_vf_bind_vector_msg {
151 	uint8_t vector_id;
152 	uint8_t ring_num;
153 	struct hns3_ring_chain_param param[HNS3_MBX_MAX_RING_CHAIN_PARAM_NUM];
154 };
155 
156 struct hns3_pf_rst_done_cmd {
157 	uint8_t pf_rst_done;
158 	uint8_t rsv[23];
159 };
160 
161 #define HNS3_PF_RESET_DONE_BIT		BIT(0)
162 
163 #define hns3_mbx_ring_ptr_move_crq(crq) \
164 	((crq)->next_to_use = ((crq)->next_to_use + 1) % (crq)->desc_num)
165 
166 struct hns3_hw;
167 void hns3_dev_handle_mbx_msg(struct hns3_hw *hw);
168 int hns3_send_mbx_msg(struct hns3_hw *hw, uint16_t code, uint16_t subcode,
169 		      const uint8_t *msg_data, uint8_t msg_len, bool need_resp,
170 		      uint8_t *resp_data, uint16_t resp_len);
171 #endif /* _HNS3_MBX_H_ */
172