eventdev: introduce specialized enqueue new op variant
[dpdk.git] / drivers / event / octeontx / ssovf_evdev.c
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright (C) Cavium networks Ltd. 2017.
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 #include <inttypes.h>
34
35 #include <rte_common.h>
36 #include <rte_debug.h>
37 #include <rte_dev.h>
38 #include <rte_eal.h>
39 #include <rte_lcore.h>
40 #include <rte_log.h>
41 #include <rte_malloc.h>
42 #include <rte_memory.h>
43 #include <rte_memzone.h>
44 #include <rte_vdev.h>
45
46 #include "ssovf_evdev.h"
47
48 /* SSOPF Mailbox messages */
49
50 struct ssovf_mbox_dev_info {
51         uint64_t min_deq_timeout_ns;
52         uint64_t max_deq_timeout_ns;
53         uint32_t max_num_events;
54 };
55
56 static int
57 ssovf_mbox_dev_info(struct ssovf_mbox_dev_info *info)
58 {
59         struct octeontx_mbox_hdr hdr = {0};
60         uint16_t len = sizeof(struct ssovf_mbox_dev_info);
61
62         hdr.coproc = SSO_COPROC;
63         hdr.msg = SSO_GET_DEV_INFO;
64         hdr.vfid = 0;
65
66         memset(info, 0, len);
67         return octeontx_ssovf_mbox_send(&hdr, NULL, 0, info, len);
68 }
69
70 struct ssovf_mbox_getwork_wait {
71         uint64_t wait_ns;
72 };
73
74 static int
75 ssovf_mbox_getwork_tmo_set(uint32_t timeout_ns)
76 {
77         struct octeontx_mbox_hdr hdr = {0};
78         struct ssovf_mbox_getwork_wait tmo_set;
79         uint16_t len = sizeof(struct ssovf_mbox_getwork_wait);
80         int ret;
81
82         hdr.coproc = SSO_COPROC;
83         hdr.msg = SSO_SET_GETWORK_WAIT;
84         hdr.vfid = 0;
85
86         tmo_set.wait_ns = timeout_ns;
87         ret = octeontx_ssovf_mbox_send(&hdr, &tmo_set, len, NULL, 0);
88         if (ret)
89                 ssovf_log_err("Failed to set getwork timeout(%d)", ret);
90
91         return ret;
92 }
93
94 struct ssovf_mbox_grp_pri {
95         uint8_t wgt_left; /* Read only */
96         uint8_t weight;
97         uint8_t affinity;
98         uint8_t priority;
99 };
100
101 static int
102 ssovf_mbox_priority_set(uint8_t queue, uint8_t prio)
103 {
104         struct octeontx_mbox_hdr hdr = {0};
105         struct ssovf_mbox_grp_pri grp;
106         uint16_t len = sizeof(struct ssovf_mbox_grp_pri);
107         int ret;
108
109         hdr.coproc = SSO_COPROC;
110         hdr.msg = SSO_GRP_SET_PRIORITY;
111         hdr.vfid = queue;
112
113         grp.weight = 0xff;
114         grp.affinity = 0xff;
115         grp.priority = prio / 32; /* Normalize to 0 to 7 */
116
117         ret = octeontx_ssovf_mbox_send(&hdr, &grp, len, NULL, 0);
118         if (ret)
119                 ssovf_log_err("Failed to set grp=%d prio=%d", queue, prio);
120
121         return ret;
122 }
123
124 struct ssovf_mbox_convert_ns_getworks_iter {
125         uint64_t wait_ns;
126         uint32_t getwork_iter;/* Get_work iterations for the given wait_ns */
127 };
128
129 static int
130 ssovf_mbox_timeout_ticks(uint64_t ns, uint64_t *tmo_ticks)
131 {
132         struct octeontx_mbox_hdr hdr = {0};
133         struct ssovf_mbox_convert_ns_getworks_iter ns2iter;
134         uint16_t len = sizeof(ns2iter);
135         int ret;
136
137         hdr.coproc = SSO_COPROC;
138         hdr.msg = SSO_CONVERT_NS_GETWORK_ITER;
139         hdr.vfid = 0;
140
141         memset(&ns2iter, 0, len);
142         ns2iter.wait_ns = ns;
143         ret = octeontx_ssovf_mbox_send(&hdr, &ns2iter, len, &ns2iter, len);
144         if (ret < 0 || (ret != len)) {
145                 ssovf_log_err("Failed to get tmo ticks ns=%"PRId64"", ns);
146                 return -EIO;
147         }
148
149         *tmo_ticks = ns2iter.getwork_iter;
150         return 0;
151 }
152
153 static void
154 ssovf_fastpath_fns_set(struct rte_eventdev *dev)
155 {
156         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
157
158         dev->schedule      = NULL;
159         dev->enqueue       = ssows_enq;
160         dev->enqueue_burst = ssows_enq_burst;
161         dev->enqueue_new_burst = ssows_enq_burst;
162         dev->dequeue       = ssows_deq;
163         dev->dequeue_burst = ssows_deq_burst;
164
165         if (edev->is_timeout_deq) {
166                 dev->dequeue       = ssows_deq_timeout;
167                 dev->dequeue_burst = ssows_deq_timeout_burst;
168         }
169 }
170
171 static void
172 ssovf_info_get(struct rte_eventdev *dev, struct rte_event_dev_info *dev_info)
173 {
174         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
175
176         dev_info->driver_name = RTE_STR(EVENTDEV_NAME_OCTEONTX_PMD);
177         dev_info->min_dequeue_timeout_ns = edev->min_deq_timeout_ns;
178         dev_info->max_dequeue_timeout_ns = edev->max_deq_timeout_ns;
179         dev_info->max_event_queues = edev->max_event_queues;
180         dev_info->max_event_queue_flows = (1ULL << 20);
181         dev_info->max_event_queue_priority_levels = 8;
182         dev_info->max_event_priority_levels = 1;
183         dev_info->max_event_ports = edev->max_event_ports;
184         dev_info->max_event_port_dequeue_depth = 1;
185         dev_info->max_event_port_enqueue_depth = 1;
186         dev_info->max_num_events =  edev->max_num_events;
187         dev_info->event_dev_cap = RTE_EVENT_DEV_CAP_QUEUE_QOS |
188                                         RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED |
189                                         RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES;
190 }
191
192 static int
193 ssovf_configure(const struct rte_eventdev *dev)
194 {
195         struct rte_event_dev_config *conf = &dev->data->dev_conf;
196         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
197         uint64_t deq_tmo_ns;
198
199         ssovf_func_trace();
200         deq_tmo_ns = conf->dequeue_timeout_ns;
201         if (deq_tmo_ns == 0)
202                 deq_tmo_ns = edev->min_deq_timeout_ns;
203
204         if (conf->event_dev_cfg & RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT) {
205                 edev->is_timeout_deq = 1;
206                 deq_tmo_ns = edev->min_deq_timeout_ns;
207         }
208         edev->nb_event_queues = conf->nb_event_queues;
209         edev->nb_event_ports = conf->nb_event_ports;
210
211         return ssovf_mbox_getwork_tmo_set(deq_tmo_ns);
212 }
213
214 static void
215 ssovf_queue_def_conf(struct rte_eventdev *dev, uint8_t queue_id,
216                                  struct rte_event_queue_conf *queue_conf)
217 {
218         RTE_SET_USED(dev);
219         RTE_SET_USED(queue_id);
220
221         queue_conf->nb_atomic_flows = (1ULL << 20);
222         queue_conf->nb_atomic_order_sequences = (1ULL << 20);
223         queue_conf->event_queue_cfg = RTE_EVENT_QUEUE_CFG_ALL_TYPES;
224         queue_conf->priority = RTE_EVENT_DEV_PRIORITY_NORMAL;
225 }
226
227 static void
228 ssovf_queue_release(struct rte_eventdev *dev, uint8_t queue_id)
229 {
230         RTE_SET_USED(dev);
231         RTE_SET_USED(queue_id);
232 }
233
234 static int
235 ssovf_queue_setup(struct rte_eventdev *dev, uint8_t queue_id,
236                               const struct rte_event_queue_conf *queue_conf)
237 {
238         RTE_SET_USED(dev);
239         ssovf_func_trace("queue=%d prio=%d", queue_id, queue_conf->priority);
240
241         return ssovf_mbox_priority_set(queue_id, queue_conf->priority);
242 }
243
244 static void
245 ssovf_port_def_conf(struct rte_eventdev *dev, uint8_t port_id,
246                                  struct rte_event_port_conf *port_conf)
247 {
248         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
249
250         RTE_SET_USED(port_id);
251         port_conf->new_event_threshold = edev->max_num_events;
252         port_conf->dequeue_depth = 1;
253         port_conf->enqueue_depth = 1;
254 }
255
256 static void
257 ssovf_port_release(void *port)
258 {
259         rte_free(port);
260 }
261
262 static int
263 ssovf_port_setup(struct rte_eventdev *dev, uint8_t port_id,
264                                 const struct rte_event_port_conf *port_conf)
265 {
266         struct ssows *ws;
267         uint32_t reg_off;
268         uint8_t q;
269         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
270
271         ssovf_func_trace("port=%d", port_id);
272         RTE_SET_USED(port_conf);
273
274         /* Free memory prior to re-allocation if needed */
275         if (dev->data->ports[port_id] != NULL) {
276                 ssovf_port_release(dev->data->ports[port_id]);
277                 dev->data->ports[port_id] = NULL;
278         }
279
280         /* Allocate event port memory */
281         ws = rte_zmalloc_socket("eventdev ssows",
282                         sizeof(struct ssows), RTE_CACHE_LINE_SIZE,
283                         dev->data->socket_id);
284         if (ws == NULL) {
285                 ssovf_log_err("Failed to alloc memory for port=%d", port_id);
286                 return -ENOMEM;
287         }
288
289         ws->base = octeontx_ssovf_bar(OCTEONTX_SSO_HWS, port_id, 0);
290         if (ws->base == NULL) {
291                 rte_free(ws);
292                 ssovf_log_err("Failed to get hws base addr port=%d", port_id);
293                 return -EINVAL;
294         }
295
296         reg_off = SSOW_VHWS_OP_GET_WORK0;
297         reg_off |= 1 << 4; /* Index_ggrp_mask (Use maskset zero) */
298         reg_off |= 1 << 16; /* Wait */
299         ws->getwork = ws->base + reg_off;
300         ws->port = port_id;
301
302         for (q = 0; q < edev->nb_event_queues; q++) {
303                 ws->grps[q] = octeontx_ssovf_bar(OCTEONTX_SSO_GROUP, q, 2);
304                 if (ws->grps[q] == NULL) {
305                         rte_free(ws);
306                         ssovf_log_err("Failed to get grp%d base addr", q);
307                         return -EINVAL;
308                 }
309         }
310
311         dev->data->ports[port_id] = ws;
312         ssovf_log_dbg("port=%d ws=%p", port_id, ws);
313         return 0;
314 }
315
316 static int
317 ssovf_port_link(struct rte_eventdev *dev, void *port, const uint8_t queues[],
318                 const uint8_t priorities[], uint16_t nb_links)
319 {
320         uint16_t link;
321         uint64_t val;
322         struct ssows *ws = port;
323
324         ssovf_func_trace("port=%d nb_links=%d", ws->port, nb_links);
325         RTE_SET_USED(dev);
326         RTE_SET_USED(priorities);
327
328         for (link = 0; link < nb_links; link++) {
329                 val = queues[link];
330                 val |= (1ULL << 24); /* Set membership */
331                 ssovf_write64(val, ws->base + SSOW_VHWS_GRPMSK_CHGX(0));
332         }
333         return (int)nb_links;
334 }
335
336 static int
337 ssovf_port_unlink(struct rte_eventdev *dev, void *port, uint8_t queues[],
338                         uint16_t nb_unlinks)
339 {
340         uint16_t unlink;
341         uint64_t val;
342         struct ssows *ws = port;
343
344         ssovf_func_trace("port=%d nb_links=%d", ws->port, nb_unlinks);
345         RTE_SET_USED(dev);
346
347         for (unlink = 0; unlink < nb_unlinks; unlink++) {
348                 val = queues[unlink];
349                 val &= ~(1ULL << 24); /* Clear membership */
350                 ssovf_write64(val, ws->base + SSOW_VHWS_GRPMSK_CHGX(0));
351         }
352         return (int)nb_unlinks;
353 }
354
355 static int
356 ssovf_timeout_ticks(struct rte_eventdev *dev, uint64_t ns, uint64_t *tmo_ticks)
357 {
358         RTE_SET_USED(dev);
359
360         return ssovf_mbox_timeout_ticks(ns, tmo_ticks);
361 }
362
363 static void
364 ssows_dump(struct ssows *ws, FILE *f)
365 {
366         uint8_t *base = ws->base;
367         uint64_t val;
368
369         fprintf(f, "\t---------------port%d---------------\n", ws->port);
370         val = ssovf_read64(base + SSOW_VHWS_TAG);
371         fprintf(f, "\ttag=0x%x tt=%d head=%d tail=%d grp=%d index=%d tail=%d\n",
372                 (uint32_t)(val & 0xffffffff), (int)(val >> 32) & 0x3,
373                 (int)(val >> 34) & 0x1, (int)(val >> 35) & 0x1,
374                 (int)(val >> 36) & 0x3ff, (int)(val >> 48) & 0x3ff,
375                 (int)(val >> 63) & 0x1);
376
377         val = ssovf_read64(base + SSOW_VHWS_WQP);
378         fprintf(f, "\twqp=0x%"PRIx64"\n", val);
379
380         val = ssovf_read64(base + SSOW_VHWS_LINKS);
381         fprintf(f, "\tindex=%d valid=%d revlink=%d tail=%d head=%d grp=%d\n",
382                 (int)(val & 0x3ff), (int)(val >> 10) & 0x1,
383                 (int)(val >> 11) & 0x3ff, (int)(val >> 26) & 0x1,
384                 (int)(val >> 27) & 0x1, (int)(val >> 28) & 0x3ff);
385
386         val = ssovf_read64(base + SSOW_VHWS_PENDTAG);
387         fprintf(f, "\tptag=0x%x ptt=%d pgwi=%d pdesc=%d pgw=%d pgww=%d ps=%d\n",
388                 (uint32_t)(val & 0xffffffff), (int)(val >> 32) & 0x3,
389                 (int)(val >> 56) & 0x1, (int)(val >> 58) & 0x1,
390                 (int)(val >> 61) & 0x1, (int)(val >> 62) & 0x1,
391                 (int)(val >> 63) & 0x1);
392
393         val = ssovf_read64(base + SSOW_VHWS_PENDWQP);
394         fprintf(f, "\tpwqp=0x%"PRIx64"\n", val);
395 }
396
397 static void
398 ssovf_dump(struct rte_eventdev *dev, FILE *f)
399 {
400         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
401         uint8_t port;
402
403         /* Dump SSOWVF debug registers */
404         for (port = 0; port < edev->nb_event_ports; port++)
405                 ssows_dump(dev->data->ports[port], f);
406 }
407
408 static int
409 ssovf_start(struct rte_eventdev *dev)
410 {
411         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
412         struct ssows *ws;
413         uint8_t *base;
414         uint8_t i;
415
416         ssovf_func_trace();
417         for (i = 0; i < edev->nb_event_ports; i++) {
418                 ws = dev->data->ports[i];
419                 ssows_reset(ws);
420                 ws->swtag_req = 0;
421         }
422
423         for (i = 0; i < edev->nb_event_queues; i++) {
424                 /* Consume all the events through HWS0 */
425                 ssows_flush_events(dev->data->ports[0], i);
426
427                 base = octeontx_ssovf_bar(OCTEONTX_SSO_GROUP, i, 0);
428                 base += SSO_VHGRP_QCTL;
429                 ssovf_write64(1, base); /* Enable SSO group */
430         }
431
432         ssovf_fastpath_fns_set(dev);
433         return 0;
434 }
435
436 static void
437 ssovf_stop(struct rte_eventdev *dev)
438 {
439         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
440         struct ssows *ws;
441         uint8_t *base;
442         uint8_t i;
443
444         ssovf_func_trace();
445         for (i = 0; i < edev->nb_event_ports; i++) {
446                 ws = dev->data->ports[i];
447                 ssows_reset(ws);
448                 ws->swtag_req = 0;
449         }
450
451         for (i = 0; i < edev->nb_event_queues; i++) {
452                 /* Consume all the events through HWS0 */
453                 ssows_flush_events(dev->data->ports[0], i);
454
455                 base = octeontx_ssovf_bar(OCTEONTX_SSO_GROUP, i, 0);
456                 base += SSO_VHGRP_QCTL;
457                 ssovf_write64(0, base); /* Disable SSO group */
458         }
459 }
460
461 static int
462 ssovf_close(struct rte_eventdev *dev)
463 {
464         struct ssovf_evdev *edev = ssovf_pmd_priv(dev);
465         uint8_t all_queues[RTE_EVENT_MAX_QUEUES_PER_DEV];
466         uint8_t i;
467
468         for (i = 0; i < edev->nb_event_queues; i++)
469                 all_queues[i] = i;
470
471         for (i = 0; i < edev->nb_event_ports; i++)
472                 ssovf_port_unlink(dev, dev->data->ports[i], all_queues,
473                         edev->nb_event_queues);
474         return 0;
475 }
476
477 /* Initialize and register event driver with DPDK Application */
478 static const struct rte_eventdev_ops ssovf_ops = {
479         .dev_infos_get    = ssovf_info_get,
480         .dev_configure    = ssovf_configure,
481         .queue_def_conf   = ssovf_queue_def_conf,
482         .queue_setup      = ssovf_queue_setup,
483         .queue_release    = ssovf_queue_release,
484         .port_def_conf    = ssovf_port_def_conf,
485         .port_setup       = ssovf_port_setup,
486         .port_release     = ssovf_port_release,
487         .port_link        = ssovf_port_link,
488         .port_unlink      = ssovf_port_unlink,
489         .timeout_ticks    = ssovf_timeout_ticks,
490         .dump             = ssovf_dump,
491         .dev_start        = ssovf_start,
492         .dev_stop         = ssovf_stop,
493         .dev_close        = ssovf_close
494 };
495
496 static int
497 ssovf_vdev_probe(struct rte_vdev_device *vdev)
498 {
499         struct octeontx_ssovf_info oinfo;
500         struct ssovf_mbox_dev_info info;
501         struct ssovf_evdev *edev;
502         struct rte_eventdev *eventdev;
503         static int ssovf_init_once;
504         const char *name;
505         int ret;
506
507         name = rte_vdev_device_name(vdev);
508         /* More than one instance is not supported */
509         if (ssovf_init_once) {
510                 ssovf_log_err("Request to create >1 %s instance", name);
511                 return -EINVAL;
512         }
513
514         eventdev = rte_event_pmd_vdev_init(name, sizeof(struct ssovf_evdev),
515                                 rte_socket_id());
516         if (eventdev == NULL) {
517                 ssovf_log_err("Failed to create eventdev vdev %s", name);
518                 return -ENOMEM;
519         }
520         eventdev->dev_ops = &ssovf_ops;
521
522         /* For secondary processes, the primary has done all the work */
523         if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
524                 ssovf_fastpath_fns_set(eventdev);
525                 return 0;
526         }
527
528         ret = octeontx_ssovf_info(&oinfo);
529         if (ret) {
530                 ssovf_log_err("Failed to probe and validate ssovfs %d", ret);
531                 goto error;
532         }
533
534         edev = ssovf_pmd_priv(eventdev);
535         edev->max_event_ports = oinfo.total_ssowvfs;
536         edev->max_event_queues = oinfo.total_ssovfs;
537         edev->is_timeout_deq = 0;
538
539         ret = ssovf_mbox_dev_info(&info);
540         if (ret < 0 || ret != sizeof(struct ssovf_mbox_dev_info)) {
541                 ssovf_log_err("Failed to get mbox devinfo %d", ret);
542                 goto error;
543         }
544
545         edev->min_deq_timeout_ns = info.min_deq_timeout_ns;
546         edev->max_deq_timeout_ns = info.max_deq_timeout_ns;
547         edev->max_num_events =  info.max_num_events;
548         ssovf_log_dbg("min_deq_tmo=%"PRId64" max_deq_tmo=%"PRId64" max_evts=%d",
549                         info.min_deq_timeout_ns, info.max_deq_timeout_ns,
550                         info.max_num_events);
551
552         if (!edev->max_event_ports || !edev->max_event_queues) {
553                 ssovf_log_err("Not enough eventdev resource queues=%d ports=%d",
554                         edev->max_event_queues, edev->max_event_ports);
555                 ret = -ENODEV;
556                 goto error;
557         }
558
559         ssovf_log_info("Initializing %s domain=%d max_queues=%d max_ports=%d",
560                         name, oinfo.domain, edev->max_event_queues,
561                         edev->max_event_ports);
562
563         ssovf_init_once = 1;
564         return 0;
565
566 error:
567         rte_event_pmd_vdev_uninit(name);
568         return ret;
569 }
570
571 static int
572 ssovf_vdev_remove(struct rte_vdev_device *vdev)
573 {
574         const char *name;
575
576         name = rte_vdev_device_name(vdev);
577         ssovf_log_info("Closing %s", name);
578         return rte_event_pmd_vdev_uninit(name);
579 }
580
581 static struct rte_vdev_driver vdev_ssovf_pmd = {
582         .probe = ssovf_vdev_probe,
583         .remove = ssovf_vdev_remove
584 };
585
586 RTE_PMD_REGISTER_VDEV(EVENTDEV_NAME_OCTEONTX_PMD, vdev_ssovf_pmd);