drivers/event/octeontx2/otx2_tim_evdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2019 Marvell International Ltd.
   3  */
   4
   5 #ifndef __OTX2_TIM_EVDEV_H__
   6 #define __OTX2_TIM_EVDEV_H__
   7
   8 #include <rte_event_timer_adapter.h>
   9 #include <rte_event_timer_adapter_pmd.h>
  10 #include <rte_reciprocal.h>
  11
  12 #include "otx2_dev.h"
  13
  14 #define OTX2_TIM_EVDEV_NAME otx2_tim_eventdev
  15
  16 #define otx2_tim_func_trace otx2_tim_dbg
  17
  18 #define TIM_LF_RING_AURA                (0x0)
  19 #define TIM_LF_RING_BASE                (0x130)
  20 #define TIM_LF_NRSPERR_INT              (0x200)
  21 #define TIM_LF_NRSPERR_INT_W1S          (0x208)
  22 #define TIM_LF_NRSPERR_INT_ENA_W1S      (0x210)
  23 #define TIM_LF_NRSPERR_INT_ENA_W1C      (0x218)
  24 #define TIM_LF_RAS_INT                  (0x300)
  25 #define TIM_LF_RAS_INT_W1S              (0x308)
  26 #define TIM_LF_RAS_INT_ENA_W1S          (0x310)
  27 #define TIM_LF_RAS_INT_ENA_W1C          (0x318)
  28
  29 #define TIM_BUCKET_W1_S_CHUNK_REMAINDER (48)
  30 #define TIM_BUCKET_W1_M_CHUNK_REMAINDER ((1ULL << (64 - \
  31                                          TIM_BUCKET_W1_S_CHUNK_REMAINDER)) - 1)
  32 #define TIM_BUCKET_W1_S_LOCK            (40)
  33 #define TIM_BUCKET_W1_M_LOCK            ((1ULL <<       \
  34                                          (TIM_BUCKET_W1_S_CHUNK_REMAINDER - \
  35                                           TIM_BUCKET_W1_S_LOCK)) - 1)
  36 #define TIM_BUCKET_W1_S_RSVD            (35)
  37 #define TIM_BUCKET_W1_S_BSK             (34)
  38 #define TIM_BUCKET_W1_M_BSK             ((1ULL <<       \
  39                                          (TIM_BUCKET_W1_S_RSVD -            \
  40                                           TIM_BUCKET_W1_S_BSK)) - 1)
  41 #define TIM_BUCKET_W1_S_HBT             (33)
  42 #define TIM_BUCKET_W1_M_HBT             ((1ULL <<       \
  43                                          (TIM_BUCKET_W1_S_BSK -             \
  44                                           TIM_BUCKET_W1_S_HBT)) - 1)
  45 #define TIM_BUCKET_W1_S_SBT             (32)
  46 #define TIM_BUCKET_W1_M_SBT             ((1ULL <<       \
  47                                          (TIM_BUCKET_W1_S_HBT -             \
  48                                           TIM_BUCKET_W1_S_SBT)) - 1)
  49 #define TIM_BUCKET_W1_S_NUM_ENTRIES     (0)
  50 #define TIM_BUCKET_W1_M_NUM_ENTRIES     ((1ULL <<       \
  51                                          (TIM_BUCKET_W1_S_SBT -             \
  52                                           TIM_BUCKET_W1_S_NUM_ENTRIES)) - 1)
  53
  54 #define TIM_BUCKET_SEMA                 (TIM_BUCKET_CHUNK_REMAIN)
  55
  56 #define TIM_BUCKET_CHUNK_REMAIN \
  57         (TIM_BUCKET_W1_M_CHUNK_REMAINDER << TIM_BUCKET_W1_S_CHUNK_REMAINDER)
  58
  59 #define TIM_BUCKET_LOCK \
  60         (TIM_BUCKET_W1_M_LOCK << TIM_BUCKET_W1_S_LOCK)
  61
  62 #define TIM_BUCKET_SEMA_WLOCK \
  63         (TIM_BUCKET_CHUNK_REMAIN | (1ull << TIM_BUCKET_W1_S_LOCK))
  64
  65 #define OTX2_MAX_TIM_RINGS              (256)
  66 #define OTX2_TIM_MAX_BUCKETS            (0xFFFFF)
  67 #define OTX2_TIM_RING_DEF_CHUNK_SZ      (4096)
  68 #define OTX2_TIM_CHUNK_ALIGNMENT        (16)
  69 #define OTX2_TIM_MAX_BURST              (RTE_CACHE_LINE_SIZE / \
  70                                                 OTX2_TIM_CHUNK_ALIGNMENT)
  71 #define OTX2_TIM_NB_CHUNK_SLOTS(sz)     (((sz) / OTX2_TIM_CHUNK_ALIGNMENT) - 1)
  72 #define OTX2_TIM_MIN_CHUNK_SLOTS        (0x1)
  73 #define OTX2_TIM_MAX_CHUNK_SLOTS        (0x1FFE)
  74 #define OTX2_TIM_MIN_TMO_TKS            (256)
  75
  76 #define OTX2_TIM_SP             0x1
  77 #define OTX2_TIM_MP             0x2
  78 #define OTX2_TIM_BKT_AND        0x4
  79 #define OTX2_TIM_BKT_MOD        0x8
  80 #define OTX2_TIM_ENA_FB         0x10
  81 #define OTX2_TIM_ENA_DFB        0x20
  82
  83 enum otx2_tim_clk_src {
  84         OTX2_TIM_CLK_SRC_10NS = RTE_EVENT_TIMER_ADAPTER_CPU_CLK,
  85         OTX2_TIM_CLK_SRC_GPIO = RTE_EVENT_TIMER_ADAPTER_EXT_CLK0,
  86         OTX2_TIM_CLK_SRC_GTI  = RTE_EVENT_TIMER_ADAPTER_EXT_CLK1,
  87         OTX2_TIM_CLK_SRC_PTP  = RTE_EVENT_TIMER_ADAPTER_EXT_CLK2,
  88 };
  89
  90 struct otx2_tim_bkt {
  91         uint64_t first_chunk;
  92         union {
  93                 uint64_t w1;
  94                 struct {
  95                         uint32_t nb_entry;
  96                         uint8_t sbt:1;
  97                         uint8_t hbt:1;
  98                         uint8_t bsk:1;
  99                         uint8_t rsvd:5;
 100                         uint8_t lock;
 101                         int16_t chunk_remainder;
 102                 };
 103         };
 104         uint64_t current_chunk;
 105         uint64_t pad;
 106 } __rte_packed __rte_aligned(32);
 107
 108 struct otx2_tim_ent {
 109         uint64_t w0;
 110         uint64_t wqe;
 111 } __rte_packed;
 112
 113 struct otx2_tim_evdev {
 114         struct rte_pci_device *pci_dev;
 115         struct rte_eventdev *event_dev;
 116         struct otx2_mbox *mbox;
 117         uint16_t nb_rings;
 118         uint32_t chunk_sz;
 119         uintptr_t bar2;
 120         /* Dev args */
 121         uint8_t disable_npa;
 122         uint16_t chunk_slots;
 123         /* MSIX offsets */
 124         uint16_t tim_msixoff[OTX2_MAX_TIM_RINGS];
 125 };
 126
 127 struct otx2_tim_ring {
 128         uintptr_t base;
 129         struct rte_reciprocal_u64 fast_div;
 130         uint16_t nb_chunk_slots;
 131         uint32_t nb_bkts;
 132         uint64_t ring_start_cyc;
 133         struct otx2_tim_bkt *bkt;
 134         struct rte_mempool *chunk_pool;
 135         uint64_t tck_int;
 136         uint8_t prod_type_sp;
 137         uint8_t disable_npa;
 138         uint8_t optimized;
 139         uint8_t ena_dfb;
 140         uint16_t ring_id;
 141         uint32_t aura;
 142         uint64_t tck_nsec;
 143         uint64_t max_tout;
 144         uint64_t nb_chunks;
 145         uint64_t chunk_sz;
 146         uint64_t tenns_clk_freq;
 147         enum otx2_tim_clk_src clk_src;
 148 } __rte_cache_aligned;
 149
 150 static inline struct otx2_tim_evdev *
 151 tim_priv_get(void)
 152 {
 153         const struct rte_memzone *mz;
 154
 155         mz = rte_memzone_lookup(RTE_STR(OTX2_TIM_EVDEV_NAME));
 156         if (mz == NULL)
 157                 return NULL;
 158
 159         return mz->addr;
 160 }
 161
 162 #define TIM_ARM_FASTPATH_MODES                                            \
 163 FP(mod_sp,    0, 0, 0, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_DFB | OTX2_TIM_SP) \
 164 FP(mod_mp,    0, 0, 1, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_DFB | OTX2_TIM_MP) \
 165 FP(mod_fb_sp, 0, 1, 0, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_FB  | OTX2_TIM_SP) \
 166 FP(mod_fb_mp, 0, 1, 1, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_FB  | OTX2_TIM_MP) \
 167 FP(and_sp,    1, 0, 0, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_DFB | OTX2_TIM_SP) \
 168 FP(and_mp,    1, 0, 1, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_DFB | OTX2_TIM_MP) \
 169 FP(and_fb_sp, 1, 1, 0, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_FB  | OTX2_TIM_SP) \
 170 FP(and_fb_mp, 1, 1, 1, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_FB  | OTX2_TIM_MP) \
 171
 172 #define FP(_name, _f3, _f2, _f1, flags)                                   \
 173 uint16_t otx2_tim_arm_burst_ ## _name(                                    \
 174                         const struct rte_event_timer_adapter *adptr,      \
 175                                       struct rte_event_timer **tim,       \
 176                                       const uint16_t nb_timers);
 177 TIM_ARM_FASTPATH_MODES
 178 #undef FP
 179
 180 #define TIM_ARM_TMO_FASTPATH_MODES                              \
 181 FP(mod,       0, 0, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_DFB)        \
 182 FP(mod_fb,    0, 1, OTX2_TIM_BKT_MOD | OTX2_TIM_ENA_FB)         \
 183 FP(and,       1, 0, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_DFB)        \
 184 FP(and_fb,    1, 1, OTX2_TIM_BKT_AND | OTX2_TIM_ENA_FB)         \
 185
 186 #define FP(_name, _f2, _f1, flags)                                      \
 187 uint16_t otx2_tim_arm_tmo_tick_burst_ ## _name(                         \
 188                 const struct rte_event_timer_adapter *adptr,            \
 189                 struct rte_event_timer **tim,                           \
 190                 const uint64_t timeout_tick, const uint16_t nb_timers);
 191 TIM_ARM_TMO_FASTPATH_MODES
 192 #undef FP
 193
 194 uint16_t otx2_tim_timer_cancel_burst(
 195                 const struct rte_event_timer_adapter *adptr,
 196                 struct rte_event_timer **tim, const uint16_t nb_timers);
 197
 198 int otx2_tim_caps_get(const struct rte_eventdev *dev, uint64_t flags,
 199                       uint32_t *caps,
 200                       const struct rte_event_timer_adapter_ops **ops);
 201
 202 void otx2_tim_init(struct rte_pci_device *pci_dev, struct otx2_dev *cmn_dev);
 203 void otx2_tim_fini(void);
 204
 205 /* TIM IRQ */
 206 int tim_register_irq(uint16_t ring_id);
 207 void tim_unregister_irq(uint16_t ring_id);
 208
 209 #endif /* __OTX2_TIM_EVDEV_H__ */