net/liquidio: add API for PF VF handshake
[dpdk.git] / drivers / net / liquidio / base / lio_23xx_vf.c
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2017 Cavium, Inc.. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Cavium, Inc. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #include <rte_ethdev.h>
35 #include <rte_cycles.h>
36 #include <rte_malloc.h>
37
38 #include "lio_logs.h"
39 #include "lio_23xx_vf.h"
40 #include "lio_23xx_reg.h"
41 #include "lio_mbox.h"
42
43 static int
44 cn23xx_vf_reset_io_queues(struct lio_device *lio_dev, uint32_t num_queues)
45 {
46         uint32_t loop = CN23XX_VF_BUSY_READING_REG_LOOP_COUNT;
47         uint64_t d64, q_no;
48         int ret_val = 0;
49
50         PMD_INIT_FUNC_TRACE();
51
52         for (q_no = 0; q_no < num_queues; q_no++) {
53                 /* set RST bit to 1. This bit applies to both IQ and OQ */
54                 d64 = lio_read_csr64(lio_dev,
55                                      CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
56                 d64 = d64 | CN23XX_PKT_INPUT_CTL_RST;
57                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(q_no),
58                                 d64);
59         }
60
61         /* wait until the RST bit is clear or the RST and QUIET bits are set */
62         for (q_no = 0; q_no < num_queues; q_no++) {
63                 volatile uint64_t reg_val;
64
65                 reg_val = lio_read_csr64(lio_dev,
66                                          CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
67                 while ((reg_val & CN23XX_PKT_INPUT_CTL_RST) &&
68                                 !(reg_val & CN23XX_PKT_INPUT_CTL_QUIET) &&
69                                 loop) {
70                         reg_val = lio_read_csr64(
71                                         lio_dev,
72                                         CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
73                         loop = loop - 1;
74                 }
75
76                 if (loop == 0) {
77                         lio_dev_err(lio_dev,
78                                     "clearing the reset reg failed or setting the quiet reg failed for qno: %lu\n",
79                                     (unsigned long)q_no);
80                         return -1;
81                 }
82
83                 reg_val = reg_val & ~CN23XX_PKT_INPUT_CTL_RST;
84                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(q_no),
85                                 reg_val);
86
87                 reg_val = lio_read_csr64(
88                     lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
89                 if (reg_val & CN23XX_PKT_INPUT_CTL_RST) {
90                         lio_dev_err(lio_dev,
91                                     "clearing the reset failed for qno: %lu\n",
92                                     (unsigned long)q_no);
93                         ret_val = -1;
94                 }
95         }
96
97         return ret_val;
98 }
99
100 static int
101 cn23xx_vf_setup_global_input_regs(struct lio_device *lio_dev)
102 {
103         uint64_t q_no;
104         uint64_t d64;
105
106         PMD_INIT_FUNC_TRACE();
107
108         if (cn23xx_vf_reset_io_queues(lio_dev,
109                                       lio_dev->sriov_info.rings_per_vf))
110                 return -1;
111
112         for (q_no = 0; q_no < (lio_dev->sriov_info.rings_per_vf); q_no++) {
113                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_DOORBELL(q_no),
114                                 0xFFFFFFFF);
115
116                 d64 = lio_read_csr64(lio_dev,
117                                      CN23XX_SLI_IQ_INSTR_COUNT64(q_no));
118
119                 d64 &= 0xEFFFFFFFFFFFFFFFL;
120
121                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_INSTR_COUNT64(q_no),
122                                 d64);
123
124                 /* Select ES, RO, NS, RDSIZE,DPTR Fomat#0 for
125                  * the Input Queues
126                  */
127                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(q_no),
128                                 CN23XX_PKT_INPUT_CTL_MASK);
129         }
130
131         return 0;
132 }
133
134 static void
135 cn23xx_vf_setup_global_output_regs(struct lio_device *lio_dev)
136 {
137         uint32_t reg_val;
138         uint32_t q_no;
139
140         PMD_INIT_FUNC_TRACE();
141
142         for (q_no = 0; q_no < lio_dev->sriov_info.rings_per_vf; q_no++) {
143                 lio_write_csr(lio_dev, CN23XX_SLI_OQ_PKTS_CREDIT(q_no),
144                               0xFFFFFFFF);
145
146                 reg_val =
147                     lio_read_csr(lio_dev, CN23XX_SLI_OQ_PKTS_SENT(q_no));
148
149                 reg_val &= 0xEFFFFFFFFFFFFFFFL;
150
151                 reg_val =
152                     lio_read_csr(lio_dev, CN23XX_SLI_OQ_PKT_CONTROL(q_no));
153
154                 /* set IPTR & DPTR */
155                 reg_val |=
156                     (CN23XX_PKT_OUTPUT_CTL_IPTR | CN23XX_PKT_OUTPUT_CTL_DPTR);
157
158                 /* reset BMODE */
159                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_BMODE);
160
161                 /* No Relaxed Ordering, No Snoop, 64-bit Byte swap
162                  * for Output Queue Scatter List
163                  * reset ROR_P, NSR_P
164                  */
165                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_ROR_P);
166                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_NSR_P);
167
168 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
169                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_ES_P);
170 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
171                 reg_val |= (CN23XX_PKT_OUTPUT_CTL_ES_P);
172 #endif
173                 /* No Relaxed Ordering, No Snoop, 64-bit Byte swap
174                  * for Output Queue Data
175                  * reset ROR, NSR
176                  */
177                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_ROR);
178                 reg_val &= ~(CN23XX_PKT_OUTPUT_CTL_NSR);
179                 /* set the ES bit */
180                 reg_val |= (CN23XX_PKT_OUTPUT_CTL_ES);
181
182                 /* write all the selected settings */
183                 lio_write_csr(lio_dev, CN23XX_SLI_OQ_PKT_CONTROL(q_no),
184                               reg_val);
185         }
186 }
187
188 static int
189 cn23xx_vf_setup_device_regs(struct lio_device *lio_dev)
190 {
191         PMD_INIT_FUNC_TRACE();
192
193         if (cn23xx_vf_setup_global_input_regs(lio_dev))
194                 return -1;
195
196         cn23xx_vf_setup_global_output_regs(lio_dev);
197
198         return 0;
199 }
200
201 static void
202 cn23xx_vf_free_mbox(struct lio_device *lio_dev)
203 {
204         PMD_INIT_FUNC_TRACE();
205
206         rte_free(lio_dev->mbox[0]);
207         lio_dev->mbox[0] = NULL;
208
209         rte_free(lio_dev->mbox);
210         lio_dev->mbox = NULL;
211 }
212
213 static int
214 cn23xx_vf_setup_mbox(struct lio_device *lio_dev)
215 {
216         struct lio_mbox *mbox;
217
218         PMD_INIT_FUNC_TRACE();
219
220         if (lio_dev->mbox == NULL) {
221                 lio_dev->mbox = rte_zmalloc(NULL, sizeof(void *), 0);
222                 if (lio_dev->mbox == NULL)
223                         return -ENOMEM;
224         }
225
226         mbox = rte_zmalloc(NULL, sizeof(struct lio_mbox), 0);
227         if (mbox == NULL) {
228                 rte_free(lio_dev->mbox);
229                 lio_dev->mbox = NULL;
230                 return -ENOMEM;
231         }
232
233         rte_spinlock_init(&mbox->lock);
234
235         mbox->lio_dev = lio_dev;
236
237         mbox->q_no = 0;
238
239         mbox->state = LIO_MBOX_STATE_IDLE;
240
241         /* VF mbox interrupt reg */
242         mbox->mbox_int_reg = (uint8_t *)lio_dev->hw_addr +
243                                 CN23XX_VF_SLI_PKT_MBOX_INT(0);
244         /* VF reads from SIG0 reg */
245         mbox->mbox_read_reg = (uint8_t *)lio_dev->hw_addr +
246                                 CN23XX_SLI_PKT_PF_VF_MBOX_SIG(0, 0);
247         /* VF writes into SIG1 reg */
248         mbox->mbox_write_reg = (uint8_t *)lio_dev->hw_addr +
249                                 CN23XX_SLI_PKT_PF_VF_MBOX_SIG(0, 1);
250
251         lio_dev->mbox[0] = mbox;
252
253         rte_write64(LIO_PFVFSIG, mbox->mbox_read_reg);
254
255         return 0;
256 }
257
258 static void
259 cn23xx_pfvf_hs_callback(struct lio_device *lio_dev,
260                         struct lio_mbox_cmd *cmd, void *arg)
261 {
262         uint32_t major = 0;
263
264         PMD_INIT_FUNC_TRACE();
265
266         rte_memcpy((uint8_t *)&lio_dev->pfvf_hsword, cmd->msg.s.params, 6);
267         if (cmd->recv_len > 1) {
268                 struct lio_version *lio_ver = (struct lio_version *)cmd->data;
269
270                 major = lio_ver->major;
271                 major = major << 16;
272         }
273
274         rte_atomic64_set((rte_atomic64_t *)arg, major | 1);
275 }
276
277 int
278 cn23xx_pfvf_handshake(struct lio_device *lio_dev)
279 {
280         struct lio_mbox_cmd mbox_cmd;
281         struct lio_version *lio_ver = (struct lio_version *)&mbox_cmd.data[0];
282         rte_atomic64_t status;
283         uint32_t count = 0;
284         uint32_t pfmajor;
285         uint32_t vfmajor;
286         uint32_t ret;
287
288         PMD_INIT_FUNC_TRACE();
289
290         /* Sending VF_ACTIVE indication to the PF driver */
291         lio_dev_dbg(lio_dev, "requesting info from PF\n");
292
293         mbox_cmd.msg.mbox_msg64 = 0;
294         mbox_cmd.msg.s.type = LIO_MBOX_REQUEST;
295         mbox_cmd.msg.s.resp_needed = 1;
296         mbox_cmd.msg.s.cmd = LIO_VF_ACTIVE;
297         mbox_cmd.msg.s.len = 2;
298         mbox_cmd.data[0] = 0;
299         lio_ver->major = LIO_BASE_MAJOR_VERSION;
300         lio_ver->minor = LIO_BASE_MINOR_VERSION;
301         lio_ver->micro = LIO_BASE_MICRO_VERSION;
302         mbox_cmd.q_no = 0;
303         mbox_cmd.recv_len = 0;
304         mbox_cmd.recv_status = 0;
305         mbox_cmd.fn = (lio_mbox_callback)cn23xx_pfvf_hs_callback;
306         mbox_cmd.fn_arg = (void *)&status;
307
308         if (lio_mbox_write(lio_dev, &mbox_cmd)) {
309                 lio_dev_err(lio_dev, "Write to mailbox failed\n");
310                 return -1;
311         }
312
313         rte_atomic64_set(&status, 0);
314
315         do {
316                 rte_delay_ms(1);
317         } while ((rte_atomic64_read(&status) == 0) && (count++ < 10000));
318
319         ret = rte_atomic64_read(&status);
320         if (ret == 0) {
321                 lio_dev_err(lio_dev, "cn23xx_pfvf_handshake timeout\n");
322                 return -1;
323         }
324
325         vfmajor = LIO_BASE_MAJOR_VERSION;
326         pfmajor = ret >> 16;
327         if (pfmajor != vfmajor) {
328                 lio_dev_err(lio_dev,
329                             "VF LiquidIO driver (major version %d) is not compatible with LiquidIO PF driver (major version %d)\n",
330                             vfmajor, pfmajor);
331                 ret = -EPERM;
332         } else {
333                 lio_dev_dbg(lio_dev,
334                             "VF LiquidIO driver (major version %d), LiquidIO PF driver (major version %d)\n",
335                             vfmajor, pfmajor);
336                 ret = 0;
337         }
338
339         return ret;
340 }
341
342 void
343 cn23xx_vf_handle_mbox(struct lio_device *lio_dev)
344 {
345         uint64_t mbox_int_val;
346
347         /* read and clear by writing 1 */
348         mbox_int_val = rte_read64(lio_dev->mbox[0]->mbox_int_reg);
349         rte_write64(mbox_int_val, lio_dev->mbox[0]->mbox_int_reg);
350         if (lio_mbox_read(lio_dev->mbox[0]))
351                 lio_mbox_process_message(lio_dev->mbox[0]);
352 }
353
354 int
355 cn23xx_vf_setup_device(struct lio_device *lio_dev)
356 {
357         uint64_t reg_val;
358
359         PMD_INIT_FUNC_TRACE();
360
361         /* INPUT_CONTROL[RPVF] gives the VF IOq count */
362         reg_val = lio_read_csr64(lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(0));
363
364         lio_dev->pf_num = (reg_val >> CN23XX_PKT_INPUT_CTL_PF_NUM_POS) &
365                                 CN23XX_PKT_INPUT_CTL_PF_NUM_MASK;
366         lio_dev->vf_num = (reg_val >> CN23XX_PKT_INPUT_CTL_VF_NUM_POS) &
367                                 CN23XX_PKT_INPUT_CTL_VF_NUM_MASK;
368
369         reg_val = reg_val >> CN23XX_PKT_INPUT_CTL_RPVF_POS;
370
371         lio_dev->sriov_info.rings_per_vf =
372                                 reg_val & CN23XX_PKT_INPUT_CTL_RPVF_MASK;
373
374         lio_dev->default_config = lio_get_conf(lio_dev);
375         if (lio_dev->default_config == NULL)
376                 return -1;
377
378         lio_dev->fn_list.setup_mbox             = cn23xx_vf_setup_mbox;
379         lio_dev->fn_list.free_mbox              = cn23xx_vf_free_mbox;
380
381         lio_dev->fn_list.setup_device_regs      = cn23xx_vf_setup_device_regs;
382
383         return 0;
384 }
385
386 int
387 cn23xx_vf_set_io_queues_off(struct lio_device *lio_dev)
388 {
389         uint32_t loop = CN23XX_VF_BUSY_READING_REG_LOOP_COUNT;
390         uint64_t q_no;
391
392         /* Disable the i/p and o/p queues for this Octeon.
393          * IOQs will already be in reset.
394          * If RST bit is set, wait for Quiet bit to be set
395          * Once Quiet bit is set, clear the RST bit
396          */
397         PMD_INIT_FUNC_TRACE();
398
399         for (q_no = 0; q_no < lio_dev->sriov_info.rings_per_vf; q_no++) {
400                 volatile uint64_t reg_val;
401
402                 reg_val = lio_read_csr64(lio_dev,
403                                          CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
404                 while ((reg_val & CN23XX_PKT_INPUT_CTL_RST) && !(reg_val &
405                                          CN23XX_PKT_INPUT_CTL_QUIET) && loop) {
406                         reg_val = lio_read_csr64(
407                                         lio_dev,
408                                         CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
409                         loop = loop - 1;
410                 }
411
412                 if (loop == 0) {
413                         lio_dev_err(lio_dev,
414                                     "clearing the reset reg failed or setting the quiet reg failed for qno %lu\n",
415                                     (unsigned long)q_no);
416                         return -1;
417                 }
418
419                 reg_val = reg_val & ~CN23XX_PKT_INPUT_CTL_RST;
420                 lio_write_csr64(lio_dev, CN23XX_SLI_IQ_PKT_CONTROL64(q_no),
421                                 reg_val);
422
423                 reg_val = lio_read_csr64(lio_dev,
424                                          CN23XX_SLI_IQ_PKT_CONTROL64(q_no));
425                 if (reg_val & CN23XX_PKT_INPUT_CTL_RST) {
426                         lio_dev_err(lio_dev, "unable to reset qno %lu\n",
427                                     (unsigned long)q_no);
428                         return -1;
429                 }
430         }
431
432         return 0;
433 }