drivers/event/octeontx2/otx2_evdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2019 Marvell International Ltd.
   3  */
   4
   5 #ifndef __OTX2_EVDEV_H__
   6 #define __OTX2_EVDEV_H__
   7
   8 #include <rte_eventdev.h>
   9
  10 #include "otx2_common.h"
  11 #include "otx2_dev.h"
  12 #include "otx2_mempool.h"
  13
  14 #define EVENTDEV_NAME_OCTEONTX2_PMD otx2_eventdev
  15
  16 #define sso_func_trace otx2_sso_dbg
  17
  18 #define OTX2_SSO_MAX_VHGRP                  RTE_EVENT_MAX_QUEUES_PER_DEV
  19 #define OTX2_SSO_MAX_VHWS                   (UINT8_MAX)
  20 #define OTX2_SSO_FC_NAME                    "otx2_evdev_xaq_fc"
  21 #define OTX2_SSO_XAQ_SLACK                  (8)
  22 #define OTX2_SSO_XAQ_CACHE_CNT              (0x7)
  23
  24 /* SSO LF register offsets (BAR2) */
  25 #define SSO_LF_GGRP_OP_ADD_WORK0            (0x0ull)
  26 #define SSO_LF_GGRP_OP_ADD_WORK1            (0x8ull)
  27
  28 #define SSO_LF_GGRP_QCTL                    (0x20ull)
  29 #define SSO_LF_GGRP_EXE_DIS                 (0x80ull)
  30 #define SSO_LF_GGRP_INT                     (0x100ull)
  31 #define SSO_LF_GGRP_INT_W1S                 (0x108ull)
  32 #define SSO_LF_GGRP_INT_ENA_W1S             (0x110ull)
  33 #define SSO_LF_GGRP_INT_ENA_W1C             (0x118ull)
  34 #define SSO_LF_GGRP_INT_THR                 (0x140ull)
  35 #define SSO_LF_GGRP_INT_CNT                 (0x180ull)
  36 #define SSO_LF_GGRP_XAQ_CNT                 (0x1b0ull)
  37 #define SSO_LF_GGRP_AQ_CNT                  (0x1c0ull)
  38 #define SSO_LF_GGRP_AQ_THR                  (0x1e0ull)
  39 #define SSO_LF_GGRP_MISC_CNT                (0x200ull)
  40
  41 /* SSOW LF register offsets (BAR2) */
  42 #define SSOW_LF_GWS_LINKS                   (0x10ull)
  43 #define SSOW_LF_GWS_PENDWQP                 (0x40ull)
  44 #define SSOW_LF_GWS_PENDSTATE               (0x50ull)
  45 #define SSOW_LF_GWS_NW_TIM                  (0x70ull)
  46 #define SSOW_LF_GWS_GRPMSK_CHG              (0x80ull)
  47 #define SSOW_LF_GWS_INT                     (0x100ull)
  48 #define SSOW_LF_GWS_INT_W1S                 (0x108ull)
  49 #define SSOW_LF_GWS_INT_ENA_W1S             (0x110ull)
  50 #define SSOW_LF_GWS_INT_ENA_W1C             (0x118ull)
  51 #define SSOW_LF_GWS_TAG                     (0x200ull)
  52 #define SSOW_LF_GWS_WQP                     (0x210ull)
  53 #define SSOW_LF_GWS_SWTP                    (0x220ull)
  54 #define SSOW_LF_GWS_PENDTAG                 (0x230ull)
  55 #define SSOW_LF_GWS_OP_ALLOC_WE             (0x400ull)
  56 #define SSOW_LF_GWS_OP_GET_WORK             (0x600ull)
  57 #define SSOW_LF_GWS_OP_SWTAG_FLUSH          (0x800ull)
  58 #define SSOW_LF_GWS_OP_SWTAG_UNTAG          (0x810ull)
  59 #define SSOW_LF_GWS_OP_SWTP_CLR             (0x820ull)
  60 #define SSOW_LF_GWS_OP_UPD_WQP_GRP0         (0x830ull)
  61 #define SSOW_LF_GWS_OP_UPD_WQP_GRP1         (0x838ull)
  62 #define SSOW_LF_GWS_OP_DESCHED              (0x880ull)
  63 #define SSOW_LF_GWS_OP_DESCHED_NOSCH        (0x8c0ull)
  64 #define SSOW_LF_GWS_OP_SWTAG_DESCHED        (0x980ull)
  65 #define SSOW_LF_GWS_OP_SWTAG_NOSCHED        (0x9c0ull)
  66 #define SSOW_LF_GWS_OP_CLR_NSCHED0          (0xa00ull)
  67 #define SSOW_LF_GWS_OP_CLR_NSCHED1          (0xa08ull)
  68 #define SSOW_LF_GWS_OP_SWTP_SET             (0xc00ull)
  69 #define SSOW_LF_GWS_OP_SWTAG_NORM           (0xc10ull)
  70 #define SSOW_LF_GWS_OP_SWTAG_FULL0          (0xc20ull)
  71 #define SSOW_LF_GWS_OP_SWTAG_FULL1          (0xc28ull)
  72 #define SSOW_LF_GWS_OP_GWC_INVAL            (0xe00ull)
  73
  74 #define OTX2_SSOW_GET_BASE_ADDR(_GW)        ((_GW) - SSOW_LF_GWS_OP_GET_WORK)
  75
  76 #define NSEC2USEC(__ns)                 ((__ns) / 1E3)
  77 #define USEC2NSEC(__us)                 ((__us) * 1E3)
  78 #define NSEC2TICK(__ns, __freq)         (((__ns) * (__freq)) / 1E9)
  79
  80 enum otx2_sso_lf_type {
  81         SSO_LF_GGRP,
  82         SSO_LF_GWS
  83 };
  84
  85 union otx2_sso_event {
  86         uint64_t get_work0;
  87         struct {
  88                 uint32_t flow_id:20;
  89                 uint32_t sub_event_type:8;
  90                 uint32_t event_type:4;
  91                 uint8_t op:2;
  92                 uint8_t rsvd:4;
  93                 uint8_t sched_type:2;
  94                 uint8_t queue_id;
  95                 uint8_t priority;
  96                 uint8_t impl_opaque;
  97         };
  98 } __rte_aligned(64);
  99
 100 enum {
 101         SSO_SYNC_ORDERED,
 102         SSO_SYNC_ATOMIC,
 103         SSO_SYNC_UNTAGGED,
 104         SSO_SYNC_EMPTY
 105 };
 106
 107 struct otx2_sso_qos {
 108         uint8_t queue;
 109         uint8_t xaq_prcnt;
 110         uint8_t taq_prcnt;
 111         uint8_t iaq_prcnt;
 112 };
 113
 114 struct otx2_sso_evdev {
 115         OTX2_DEV; /* Base class */
 116         uint8_t max_event_queues;
 117         uint8_t max_event_ports;
 118         uint8_t is_timeout_deq;
 119         uint8_t nb_event_queues;
 120         uint8_t nb_event_ports;
 121         uint8_t configured;
 122         uint32_t deq_tmo_ns;
 123         uint32_t min_dequeue_timeout_ns;
 124         uint32_t max_dequeue_timeout_ns;
 125         int32_t max_num_events;
 126         uint64_t *fc_mem;
 127         uint64_t xaq_lmt;
 128         uint64_t nb_xaq_cfg;
 129         rte_iova_t fc_iova;
 130         struct rte_mempool *xaq_pool;
 131         /* Dev args */
 132         uint8_t dual_ws;
 133         uint8_t selftest;
 134         uint32_t xae_cnt;
 135         uint8_t qos_queue_cnt;
 136         struct otx2_sso_qos *qos_parse_data;
 137         /* HW const */
 138         uint32_t xae_waes;
 139         uint32_t xaq_buf_size;
 140         uint32_t iue;
 141         /* MSIX offsets */
 142         uint16_t sso_msixoff[OTX2_SSO_MAX_VHGRP];
 143         uint16_t ssow_msixoff[OTX2_SSO_MAX_VHWS];
 144 } __rte_cache_aligned;
 145
 146 #define OTX2_SSOGWS_OPS \
 147         /* WS ops */                    \
 148         uintptr_t getwrk_op;            \
 149         uintptr_t tag_op;               \
 150         uintptr_t wqp_op;               \
 151         uintptr_t swtp_op;              \
 152         uintptr_t swtag_norm_op;        \
 153         uintptr_t swtag_desched_op;     \
 154         uint8_t cur_tt;                 \
 155         uint8_t cur_grp
 156
 157 /* Event port aka GWS */
 158 struct otx2_ssogws {
 159         /* Get Work Fastpath data */
 160         OTX2_SSOGWS_OPS;
 161         uint8_t swtag_req;
 162         uint8_t port;
 163         /* Add Work Fastpath data */
 164         uint64_t xaq_lmt __rte_cache_aligned;
 165         uint64_t *fc_mem;
 166         uintptr_t grps_base[OTX2_SSO_MAX_VHGRP];
 167 } __rte_cache_aligned;
 168
 169 struct otx2_ssogws_state {
 170         OTX2_SSOGWS_OPS;
 171 };
 172
 173 struct otx2_ssogws_dual {
 174         /* Get Work Fastpath data */
 175         struct otx2_ssogws_state ws_state[2]; /* Ping and Pong */
 176         uint8_t swtag_req;
 177         uint8_t vws; /* Ping pong bit */
 178         uint8_t port;
 179         /* Add Work Fastpath data */
 180         uint64_t xaq_lmt __rte_cache_aligned;
 181         uint64_t *fc_mem;
 182         uintptr_t grps_base[OTX2_SSO_MAX_VHGRP];
 183 } __rte_cache_aligned;
 184
 185 static inline struct otx2_sso_evdev *
 186 sso_pmd_priv(const struct rte_eventdev *event_dev)
 187 {
 188         return event_dev->data->dev_private;
 189 }
 190
 191 static inline int
 192 parse_kvargs_flag(const char *key, const char *value, void *opaque)
 193 {
 194         RTE_SET_USED(key);
 195
 196         *(uint8_t *)opaque = !!atoi(value);
 197         return 0;
 198 }
 199
 200 static inline int
 201 parse_kvargs_value(const char *key, const char *value, void *opaque)
 202 {
 203         RTE_SET_USED(key);
 204
 205         *(uint32_t *)opaque = (uint32_t)atoi(value);
 206         return 0;
 207 }
 208
 209 /* Single WS API's */
 210 uint16_t otx2_ssogws_enq(void *port, const struct rte_event *ev);
 211 uint16_t otx2_ssogws_enq_burst(void *port, const struct rte_event ev[],
 212                                uint16_t nb_events);
 213 uint16_t otx2_ssogws_enq_new_burst(void *port, const struct rte_event ev[],
 214                                    uint16_t nb_events);
 215 uint16_t otx2_ssogws_enq_fwd_burst(void *port, const struct rte_event ev[],
 216                                    uint16_t nb_events);
 217
 218 uint16_t otx2_ssogws_deq(void *port, struct rte_event *ev,
 219                          uint64_t timeout_ticks);
 220 uint16_t otx2_ssogws_deq_burst(void *port, struct rte_event ev[],
 221                                uint16_t nb_events, uint64_t timeout_ticks);
 222 uint16_t otx2_ssogws_deq_timeout(void *port, struct rte_event *ev,
 223                                  uint64_t timeout_ticks);
 224 uint16_t otx2_ssogws_deq_timeout_burst(void *port, struct rte_event ev[],
 225                                        uint16_t nb_events,
 226                                        uint64_t timeout_ticks);
 227 /* Dual WS API's */
 228 uint16_t otx2_ssogws_dual_enq(void *port, const struct rte_event *ev);
 229 uint16_t otx2_ssogws_dual_enq_burst(void *port, const struct rte_event ev[],
 230                                     uint16_t nb_events);
 231 uint16_t otx2_ssogws_dual_enq_new_burst(void *port, const struct rte_event ev[],
 232                                         uint16_t nb_events);
 233 uint16_t otx2_ssogws_dual_enq_fwd_burst(void *port, const struct rte_event ev[],
 234                                         uint16_t nb_events);
 235
 236 uint16_t otx2_ssogws_dual_deq(void *port, struct rte_event *ev,
 237                               uint64_t timeout_ticks);
 238 uint16_t otx2_ssogws_dual_deq_burst(void *port, struct rte_event ev[],
 239                                     uint16_t nb_events, uint64_t timeout_ticks);
 240 uint16_t otx2_ssogws_dual_deq_timeout(void *port, struct rte_event *ev,
 241                                       uint64_t timeout_ticks);
 242 uint16_t otx2_ssogws_dual_deq_timeout_burst(void *port, struct rte_event ev[],
 243                                             uint16_t nb_events,
 244                                             uint64_t timeout_ticks);
 245 void sso_fastpath_fns_set(struct rte_eventdev *event_dev);
 246 /* Clean up API's */
 247 typedef void (*otx2_handle_event_t)(void *arg, struct rte_event ev);
 248 void ssogws_flush_events(struct otx2_ssogws *ws, uint8_t queue_id,
 249                          uintptr_t base, otx2_handle_event_t fn, void *arg);
 250 void ssogws_reset(struct otx2_ssogws *ws);
 251 /* Selftest */
 252 int otx2_sso_selftest(void);
 253 /* Init and Fini API's */
 254 int otx2_sso_init(struct rte_eventdev *event_dev);
 255 int otx2_sso_fini(struct rte_eventdev *event_dev);
 256 /* IRQ handlers */
 257 int sso_register_irqs(const struct rte_eventdev *event_dev);
 258 void sso_unregister_irqs(const struct rte_eventdev *event_dev);
 259
 260 #endif /* __OTX2_EVDEV_H__ */