net/thunderx/base: add functions to store qsets
[dpdk.git] / drivers / net / thunderx / base / nicvf_mbox.h
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright (C) Cavium networks Ltd. 2016.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of Cavium networks nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef __THUNDERX_NICVF_MBOX__
34 #define __THUNDERX_NICVF_MBOX__
35
36 #include <stdint.h>
37
38 #include "nicvf_plat.h"
39
40 /* PF <--> VF Mailbox communication
41  * Two 64bit registers are shared between PF and VF for each VF
42  * Writing into second register means end of message.
43  */
44
45 /* PF <--> VF mailbox communication */
46 #define NIC_PF_VF_MAILBOX_SIZE          2
47 #define NIC_MBOX_MSG_TIMEOUT            2000    /* ms */
48
49 /* Mailbox message types */
50 #define NIC_MBOX_MSG_INVALID            0x00    /* Invalid message */
51 #define NIC_MBOX_MSG_READY              0x01    /* Is PF ready to rcv msgs */
52 #define NIC_MBOX_MSG_ACK                0x02    /* ACK the message received */
53 #define NIC_MBOX_MSG_NACK               0x03    /* NACK the message received */
54 #define NIC_MBOX_MSG_QS_CFG             0x04    /* Configure Qset */
55 #define NIC_MBOX_MSG_RQ_CFG             0x05    /* Configure receive queue */
56 #define NIC_MBOX_MSG_SQ_CFG             0x06    /* Configure Send queue */
57 #define NIC_MBOX_MSG_RQ_DROP_CFG        0x07    /* Configure receive queue */
58 #define NIC_MBOX_MSG_SET_MAC            0x08    /* Add MAC ID to DMAC filter */
59 #define NIC_MBOX_MSG_SET_MAX_FRS        0x09    /* Set max frame size */
60 #define NIC_MBOX_MSG_CPI_CFG            0x0A    /* Config CPI, RSSI */
61 #define NIC_MBOX_MSG_RSS_SIZE           0x0B    /* Get RSS indir_tbl size */
62 #define NIC_MBOX_MSG_RSS_CFG            0x0C    /* Config RSS table */
63 #define NIC_MBOX_MSG_RSS_CFG_CONT       0x0D    /* RSS config continuation */
64 #define NIC_MBOX_MSG_RQ_BP_CFG          0x0E    /* RQ backpressure config */
65 #define NIC_MBOX_MSG_RQ_SW_SYNC         0x0F    /* Flush inflight pkts to RQ */
66 #define NIC_MBOX_MSG_BGX_LINK_CHANGE    0x11    /* BGX:LMAC link status */
67 #define NIC_MBOX_MSG_ALLOC_SQS          0x12    /* Allocate secondary Qset */
68 #define NIC_MBOX_MSG_LOOPBACK           0x16    /* Set interface in loopback */
69 #define NIC_MBOX_MSG_RESET_STAT_COUNTER 0x17    /* Reset statistics counters */
70 #define NIC_MBOX_MSG_CFG_DONE           0xF0    /* VF configuration done */
71 #define NIC_MBOX_MSG_SHUTDOWN           0xF1    /* VF is being shutdown */
72 #define NIC_MBOX_MSG_MAX                0x100   /* Maximum number of messages */
73
74 /* Get vNIC VF configuration */
75 struct nic_cfg_msg {
76         uint8_t    msg;
77         uint8_t    vf_id;
78         uint8_t    node_id;
79         bool       tns_mode:1;
80         bool       sqs_mode:1;
81         bool       loopback_supported:1;
82         uint8_t    mac_addr[NICVF_MAC_ADDR_SIZE];
83 };
84
85 /* Qset configuration */
86 struct qs_cfg_msg {
87         uint8_t    msg;
88         uint8_t    num;
89         uint8_t    sqs_count;
90         uint64_t   cfg;
91 };
92
93 /* Receive queue configuration */
94 struct rq_cfg_msg {
95         uint8_t    msg;
96         uint8_t    qs_num;
97         uint8_t    rq_num;
98         uint64_t   cfg;
99 };
100
101 /* Send queue configuration */
102 struct sq_cfg_msg {
103         uint8_t    msg;
104         uint8_t    qs_num;
105         uint8_t    sq_num;
106         bool       sqs_mode;
107         uint64_t   cfg;
108 };
109
110 /* Set VF's MAC address */
111 struct set_mac_msg {
112         uint8_t    msg;
113         uint8_t    vf_id;
114         uint8_t    mac_addr[NICVF_MAC_ADDR_SIZE];
115 };
116
117 /* Set Maximum frame size */
118 struct set_frs_msg {
119         uint8_t    msg;
120         uint8_t    vf_id;
121         uint16_t   max_frs;
122 };
123
124 /* Set CPI algorithm type */
125 struct cpi_cfg_msg {
126         uint8_t    msg;
127         uint8_t    vf_id;
128         uint8_t    rq_cnt;
129         uint8_t    cpi_alg;
130 };
131
132 /* Get RSS table size */
133 struct rss_sz_msg {
134         uint8_t    msg;
135         uint8_t    vf_id;
136         uint16_t   ind_tbl_size;
137 };
138
139 /* Set RSS configuration */
140 struct rss_cfg_msg {
141         uint8_t    msg;
142         uint8_t    vf_id;
143         uint8_t    hash_bits;
144         uint8_t    tbl_len;
145         uint8_t    tbl_offset;
146 #define RSS_IND_TBL_LEN_PER_MBX_MSG     8
147         uint8_t    ind_tbl[RSS_IND_TBL_LEN_PER_MBX_MSG];
148 };
149
150 /* Physical interface link status */
151 struct bgx_link_status {
152         uint8_t    msg;
153         uint8_t    link_up;
154         uint8_t    duplex;
155         uint32_t   speed;
156 };
157
158 /* Set interface in loopback mode */
159 struct set_loopback {
160         uint8_t    msg;
161         uint8_t    vf_id;
162         bool       enable;
163 };
164
165 /* Reset statistics counters */
166 struct reset_stat_cfg {
167         uint8_t    msg;
168         /* Bitmap to select NIC_PF_VNIC(vf_id)_RX_STAT(0..13) */
169         uint16_t   rx_stat_mask;
170         /* Bitmap to select NIC_PF_VNIC(vf_id)_TX_STAT(0..4) */
171         uint8_t    tx_stat_mask;
172         /* Bitmap to select NIC_PF_QS(0..127)_RQ(0..7)_STAT(0..1)
173          * bit14, bit15 NIC_PF_QS(vf_id)_RQ7_STAT(0..1)
174          * bit12, bit13 NIC_PF_QS(vf_id)_RQ6_STAT(0..1)
175          * ..
176          * bit2, bit3 NIC_PF_QS(vf_id)_RQ1_STAT(0..1)
177          * bit0, bit1 NIC_PF_QS(vf_id)_RQ0_STAT(0..1)
178          */
179         uint16_t   rq_stat_mask;
180         /* Bitmap to select NIC_PF_QS(0..127)_SQ(0..7)_STAT(0..1)
181          * bit14, bit15 NIC_PF_QS(vf_id)_SQ7_STAT(0..1)
182          * bit12, bit13 NIC_PF_QS(vf_id)_SQ6_STAT(0..1)
183          * ..
184          * bit2, bit3 NIC_PF_QS(vf_id)_SQ1_STAT(0..1)
185          * bit0, bit1 NIC_PF_QS(vf_id)_SQ0_STAT(0..1)
186          */
187         uint16_t   sq_stat_mask;
188 };
189
190 struct nic_mbx {
191 /* 128 bit shared memory between PF and each VF */
192 union {
193         struct { uint8_t msg; } msg;
194         struct nic_cfg_msg      nic_cfg;
195         struct qs_cfg_msg       qs;
196         struct rq_cfg_msg       rq;
197         struct sq_cfg_msg       sq;
198         struct set_mac_msg      mac;
199         struct set_frs_msg      frs;
200         struct cpi_cfg_msg      cpi_cfg;
201         struct rss_sz_msg       rss_size;
202         struct rss_cfg_msg      rss_cfg;
203         struct bgx_link_status  link_status;
204         struct set_loopback     lbk;
205         struct reset_stat_cfg   reset_stat;
206 };
207 };
208
209 NICVF_STATIC_ASSERT(sizeof(struct nic_mbx) <= 16);
210
211 int nicvf_handle_mbx_intr(struct nicvf *nic);
212 int nicvf_mbox_check_pf_ready(struct nicvf *nic);
213 int nicvf_mbox_qset_config(struct nicvf *nic, struct pf_qs_cfg *qs_cfg);
214 int nicvf_mbox_rq_config(struct nicvf *nic, uint16_t qidx,
215                          struct pf_rq_cfg *pf_rq_cfg);
216 int nicvf_mbox_sq_config(struct nicvf *nic, uint16_t qidx);
217 int nicvf_mbox_rq_drop_config(struct nicvf *nic, uint16_t qidx, bool enable);
218 int nicvf_mbox_rq_bp_config(struct nicvf *nic, uint16_t qidx, bool enable);
219 int nicvf_mbox_set_mac_addr(struct nicvf *nic,
220                             const uint8_t mac[NICVF_MAC_ADDR_SIZE]);
221 int nicvf_mbox_config_cpi(struct nicvf *nic, uint32_t qcnt);
222 int nicvf_mbox_get_rss_size(struct nicvf *nic);
223 int nicvf_mbox_config_rss(struct nicvf *nic);
224 int nicvf_mbox_update_hw_max_frs(struct nicvf *nic, uint16_t mtu);
225 int nicvf_mbox_rq_sync(struct nicvf *nic);
226 int nicvf_mbox_loopback_config(struct nicvf *nic, bool enable);
227 int nicvf_mbox_reset_stat_counters(struct nicvf *nic, uint16_t rx_stat_mask,
228         uint8_t tx_stat_mask, uint16_t rq_stat_mask, uint16_t sq_stat_mask);
229 void nicvf_mbox_shutdown(struct nicvf *nic);
230 void nicvf_mbox_cfg_done(struct nicvf *nic);
231
232 #endif /* __THUNDERX_NICVF_MBOX__ */