drivers/event/octeontx2/otx2_tim_evdev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2019 Marvell International Ltd.
   3  */
   4
   5 #include <rte_kvargs.h>
   6 #include <rte_malloc.h>
   7 #include <rte_mbuf_pool_ops.h>
   8
   9 #include "otx2_evdev.h"
  10 #include "otx2_tim_evdev.h"
  11
  12 static struct rte_event_timer_adapter_ops otx2_tim_ops;
  13
  14 static inline int
  15 tim_get_msix_offsets(void)
  16 {
  17         struct otx2_tim_evdev *dev = tim_priv_get();
  18         struct otx2_mbox *mbox = dev->mbox;
  19         struct msix_offset_rsp *msix_rsp;
  20         int i, rc;
  21
  22         /* Get TIM MSIX vector offsets */
  23         otx2_mbox_alloc_msg_msix_offset(mbox);
  24         rc = otx2_mbox_process_msg(mbox, (void *)&msix_rsp);
  25
  26         for (i = 0; i < dev->nb_rings; i++)
  27                 dev->tim_msixoff[i] = msix_rsp->timlf_msixoff[i];
  28
  29         return rc;
  30 }
  31
  32 static void
  33 tim_set_fp_ops(struct otx2_tim_ring *tim_ring)
  34 {
  35         uint8_t prod_flag = !tim_ring->prod_type_sp;
  36
  37         /* [MOD/AND] [DFB/FB] [SP][MP]*/
  38         const rte_event_timer_arm_burst_t arm_burst[2][2][2] = {
  39 #define FP(_name,  _f3, _f2, _f1, flags) \
  40                 [_f3][_f2][_f1] = otx2_tim_arm_burst_ ## _name,
  41 TIM_ARM_FASTPATH_MODES
  42 #undef FP
  43         };
  44
  45         const rte_event_timer_arm_tmo_tick_burst_t arm_tmo_burst[2][2] = {
  46 #define FP(_name, _f2, _f1, flags) \
  47                 [_f2][_f1] = otx2_tim_arm_tmo_tick_burst_ ## _name,
  48 TIM_ARM_TMO_FASTPATH_MODES
  49 #undef FP
  50         };
  51
  52         otx2_tim_ops.arm_burst = arm_burst[tim_ring->optimized]
  53                                 [tim_ring->ena_dfb][prod_flag];
  54         otx2_tim_ops.arm_tmo_tick_burst = arm_tmo_burst[tim_ring->optimized]
  55                                 [tim_ring->ena_dfb];
  56         otx2_tim_ops.cancel_burst = otx2_tim_timer_cancel_burst;
  57 }
  58
  59 static void
  60 otx2_tim_ring_info_get(const struct rte_event_timer_adapter *adptr,
  61                        struct rte_event_timer_adapter_info *adptr_info)
  62 {
  63         struct otx2_tim_ring *tim_ring = adptr->data->adapter_priv;
  64
  65         adptr_info->max_tmo_ns = tim_ring->max_tout;
  66         adptr_info->min_resolution_ns = tim_ring->tck_nsec;
  67         rte_memcpy(&adptr_info->conf, &adptr->data->conf,
  68                    sizeof(struct rte_event_timer_adapter_conf));
  69 }
  70
  71 static void
  72 tim_optimze_bkt_param(struct otx2_tim_ring *tim_ring)
  73 {
  74         uint64_t tck_nsec;
  75         uint32_t hbkts;
  76         uint32_t lbkts;
  77
  78         hbkts = rte_align32pow2(tim_ring->nb_bkts);
  79         tck_nsec = RTE_ALIGN_MUL_CEIL(tim_ring->max_tout / (hbkts - 1), 10);
  80
  81         if ((tck_nsec < TICK2NSEC(OTX2_TIM_MIN_TMO_TKS,
  82                                   tim_ring->tenns_clk_freq) ||
  83             hbkts > OTX2_TIM_MAX_BUCKETS))
  84                 hbkts = 0;
  85
  86         lbkts = rte_align32prevpow2(tim_ring->nb_bkts);
  87         tck_nsec = RTE_ALIGN_MUL_CEIL((tim_ring->max_tout / (lbkts - 1)), 10);
  88
  89         if ((tck_nsec < TICK2NSEC(OTX2_TIM_MIN_TMO_TKS,
  90                                   tim_ring->tenns_clk_freq) ||
  91             lbkts > OTX2_TIM_MAX_BUCKETS))
  92                 lbkts = 0;
  93
  94         if (!hbkts && !lbkts)
  95                 return;
  96
  97         if (!hbkts) {
  98                 tim_ring->nb_bkts = lbkts;
  99                 goto end;
 100         } else if (!lbkts) {
 101                 tim_ring->nb_bkts = hbkts;
 102                 goto end;
 103         }
 104
 105         tim_ring->nb_bkts = (hbkts - tim_ring->nb_bkts) <
 106                 (tim_ring->nb_bkts - lbkts) ? hbkts : lbkts;
 107 end:
 108         tim_ring->optimized = true;
 109         tim_ring->tck_nsec = RTE_ALIGN_MUL_CEIL((tim_ring->max_tout /
 110                                                 (tim_ring->nb_bkts - 1)), 10);
 111         otx2_tim_dbg("Optimized configured values");
 112         otx2_tim_dbg("Nb_bkts  : %" PRIu32 "", tim_ring->nb_bkts);
 113         otx2_tim_dbg("Tck_nsec : %" PRIu64 "", tim_ring->tck_nsec);
 114 }
 115
 116 static int
 117 tim_chnk_pool_create(struct otx2_tim_ring *tim_ring,
 118                      struct rte_event_timer_adapter_conf *rcfg)
 119 {
 120         unsigned int cache_sz = (tim_ring->nb_chunks / 1.5);
 121         unsigned int mp_flags = 0;
 122         char pool_name[25];
 123         int rc;
 124
 125         /* Create chunk pool. */
 126         if (rcfg->flags & RTE_EVENT_TIMER_ADAPTER_F_SP_PUT) {
 127                 mp_flags = MEMPOOL_F_SP_PUT | MEMPOOL_F_SC_GET;
 128                 otx2_tim_dbg("Using single producer mode");
 129                 tim_ring->prod_type_sp = true;
 130         }
 131
 132         snprintf(pool_name, sizeof(pool_name), "otx2_tim_chunk_pool%d",
 133                  tim_ring->ring_id);
 134
 135         if (cache_sz > RTE_MEMPOOL_CACHE_MAX_SIZE)
 136                 cache_sz = RTE_MEMPOOL_CACHE_MAX_SIZE;
 137
 138         if (!tim_ring->disable_npa) {
 139                 /* NPA need not have cache as free is not visible to SW */
 140                 tim_ring->chunk_pool = rte_mempool_create_empty(pool_name,
 141                                 tim_ring->nb_chunks, tim_ring->chunk_sz,
 142                                 0, 0, rte_socket_id(), mp_flags);
 143
 144                 if (tim_ring->chunk_pool == NULL) {
 145                         otx2_err("Unable to create chunkpool.");
 146                         return -ENOMEM;
 147                 }
 148
 149                 rc = rte_mempool_set_ops_byname(tim_ring->chunk_pool,
 150                                                 rte_mbuf_platform_mempool_ops(),
 151                                                 NULL);
 152                 if (rc < 0) {
 153                         otx2_err("Unable to set chunkpool ops");
 154                         goto free;
 155                 }
 156
 157                 rc = rte_mempool_populate_default(tim_ring->chunk_pool);
 158                 if (rc < 0) {
 159                         otx2_err("Unable to set populate chunkpool.");
 160                         goto free;
 161                 }
 162                 tim_ring->aura = npa_lf_aura_handle_to_aura(
 163                                 tim_ring->chunk_pool->pool_id);
 164                 tim_ring->ena_dfb = 0;
 165         } else {
 166                 tim_ring->chunk_pool = rte_mempool_create(pool_name,
 167                                 tim_ring->nb_chunks, tim_ring->chunk_sz,
 168                                 cache_sz, 0, NULL, NULL, NULL, NULL,
 169                                 rte_socket_id(),
 170                                 mp_flags);
 171                 if (tim_ring->chunk_pool == NULL) {
 172                         otx2_err("Unable to create chunkpool.");
 173                         return -ENOMEM;
 174                 }
 175                 tim_ring->ena_dfb = 1;
 176         }
 177
 178         return 0;
 179
 180 free:
 181         rte_mempool_free(tim_ring->chunk_pool);
 182         return rc;
 183 }
 184
 185 static void
 186 tim_err_desc(int rc)
 187 {
 188         switch (rc) {
 189         case TIM_AF_NO_RINGS_LEFT:
 190                 otx2_err("Unable to allocat new TIM ring.");
 191                 break;
 192         case TIM_AF_INVALID_NPA_PF_FUNC:
 193                 otx2_err("Invalid NPA pf func.");
 194                 break;
 195         case TIM_AF_INVALID_SSO_PF_FUNC:
 196                 otx2_err("Invalid SSO pf func.");
 197                 break;
 198         case TIM_AF_RING_STILL_RUNNING:
 199                 otx2_tim_dbg("Ring busy.");
 200                 break;
 201         case TIM_AF_LF_INVALID:
 202                 otx2_err("Invalid Ring id.");
 203                 break;
 204         case TIM_AF_CSIZE_NOT_ALIGNED:
 205                 otx2_err("Chunk size specified needs to be multiple of 16.");
 206                 break;
 207         case TIM_AF_CSIZE_TOO_SMALL:
 208                 otx2_err("Chunk size too small.");
 209                 break;
 210         case TIM_AF_CSIZE_TOO_BIG:
 211                 otx2_err("Chunk size too big.");
 212                 break;
 213         case TIM_AF_INTERVAL_TOO_SMALL:
 214                 otx2_err("Bucket traversal interval too small.");
 215                 break;
 216         case TIM_AF_INVALID_BIG_ENDIAN_VALUE:
 217                 otx2_err("Invalid Big endian value.");
 218                 break;
 219         case TIM_AF_INVALID_CLOCK_SOURCE:
 220                 otx2_err("Invalid Clock source specified.");
 221                 break;
 222         case TIM_AF_GPIO_CLK_SRC_NOT_ENABLED:
 223                 otx2_err("GPIO clock source not enabled.");
 224                 break;
 225         case TIM_AF_INVALID_BSIZE:
 226                 otx2_err("Invalid bucket size.");
 227                 break;
 228         case TIM_AF_INVALID_ENABLE_PERIODIC:
 229                 otx2_err("Invalid bucket size.");
 230                 break;
 231         case TIM_AF_INVALID_ENABLE_DONTFREE:
 232                 otx2_err("Invalid Don't free value.");
 233                 break;
 234         case TIM_AF_ENA_DONTFRE_NSET_PERIODIC:
 235                 otx2_err("Don't free bit not set when periodic is enabled.");
 236                 break;
 237         case TIM_AF_RING_ALREADY_DISABLED:
 238                 otx2_err("Ring already stopped");
 239                 break;
 240         default:
 241                 otx2_err("Unknown Error.");
 242         }
 243 }
 244
 245 static int
 246 otx2_tim_ring_create(struct rte_event_timer_adapter *adptr)
 247 {
 248         struct rte_event_timer_adapter_conf *rcfg = &adptr->data->conf;
 249         struct otx2_tim_evdev *dev = tim_priv_get();
 250         struct otx2_tim_ring *tim_ring;
 251         struct tim_config_req *cfg_req;
 252         struct tim_ring_req *free_req;
 253         struct tim_lf_alloc_req *req;
 254         struct tim_lf_alloc_rsp *rsp;
 255         uint64_t nb_timers;
 256         int rc;
 257
 258         if (dev == NULL)
 259                 return -ENODEV;
 260
 261         if (adptr->data->id >= dev->nb_rings)
 262                 return -ENODEV;
 263
 264         req = otx2_mbox_alloc_msg_tim_lf_alloc(dev->mbox);
 265         req->npa_pf_func = otx2_npa_pf_func_get();
 266         req->sso_pf_func = otx2_sso_pf_func_get();
 267         req->ring = adptr->data->id;
 268
 269         rc = otx2_mbox_process_msg(dev->mbox, (void **)&rsp);
 270         if (rc < 0) {
 271                 tim_err_desc(rc);
 272                 return -ENODEV;
 273         }
 274
 275         if (NSEC2TICK(RTE_ALIGN_MUL_CEIL(rcfg->timer_tick_ns, 10),
 276                       rsp->tenns_clk) < OTX2_TIM_MIN_TMO_TKS) {
 277                 if (rcfg->flags & RTE_EVENT_TIMER_ADAPTER_F_ADJUST_RES)
 278                         rcfg->timer_tick_ns = TICK2NSEC(OTX2_TIM_MIN_TMO_TKS,
 279                                         rsp->tenns_clk);
 280                 else {
 281                         rc = -ERANGE;
 282                         goto rng_mem_err;
 283                 }
 284         }
 285
 286         tim_ring = rte_zmalloc("otx2_tim_prv", sizeof(struct otx2_tim_ring), 0);
 287         if (tim_ring == NULL) {
 288                 rc =  -ENOMEM;
 289                 goto rng_mem_err;
 290         }
 291
 292         adptr->data->adapter_priv = tim_ring;
 293
 294         tim_ring->tenns_clk_freq = rsp->tenns_clk;
 295         tim_ring->clk_src = (int)rcfg->clk_src;
 296         tim_ring->ring_id = adptr->data->id;
 297         tim_ring->tck_nsec = RTE_ALIGN_MUL_CEIL(rcfg->timer_tick_ns, 10);
 298         tim_ring->max_tout = rcfg->max_tmo_ns;
 299         tim_ring->nb_bkts = (tim_ring->max_tout / tim_ring->tck_nsec);
 300         tim_ring->chunk_sz = dev->chunk_sz;
 301         nb_timers = rcfg->nb_timers;
 302         tim_ring->disable_npa = dev->disable_npa;
 303
 304         tim_ring->nb_chunks = nb_timers / OTX2_TIM_NB_CHUNK_SLOTS(
 305                                                         tim_ring->chunk_sz);
 306         tim_ring->nb_chunk_slots = OTX2_TIM_NB_CHUNK_SLOTS(tim_ring->chunk_sz);
 307
 308         /* Try to optimize the bucket parameters. */
 309         if ((rcfg->flags & RTE_EVENT_TIMER_ADAPTER_F_ADJUST_RES)) {
 310                 if (rte_is_power_of_2(tim_ring->nb_bkts))
 311                         tim_ring->optimized = true;
 312                 else
 313                         tim_optimze_bkt_param(tim_ring);
 314         }
 315
 316         tim_ring->nb_chunks = tim_ring->nb_chunks * tim_ring->nb_bkts;
 317         /* Create buckets. */
 318         tim_ring->bkt = rte_zmalloc("otx2_tim_bucket", (tim_ring->nb_bkts) *
 319                                     sizeof(struct otx2_tim_bkt),
 320                                     RTE_CACHE_LINE_SIZE);
 321         if (tim_ring->bkt == NULL)
 322                 goto bkt_mem_err;
 323
 324         rc = tim_chnk_pool_create(tim_ring, rcfg);
 325         if (rc < 0)
 326                 goto chnk_mem_err;
 327
 328         cfg_req = otx2_mbox_alloc_msg_tim_config_ring(dev->mbox);
 329
 330         cfg_req->ring = tim_ring->ring_id;
 331         cfg_req->bigendian = false;
 332         cfg_req->clocksource = tim_ring->clk_src;
 333         cfg_req->enableperiodic = false;
 334         cfg_req->enabledontfreebuffer = tim_ring->ena_dfb;
 335         cfg_req->bucketsize = tim_ring->nb_bkts;
 336         cfg_req->chunksize = tim_ring->chunk_sz;
 337         cfg_req->interval = NSEC2TICK(tim_ring->tck_nsec,
 338                                       tim_ring->tenns_clk_freq);
 339
 340         rc = otx2_mbox_process(dev->mbox);
 341         if (rc < 0) {
 342                 tim_err_desc(rc);
 343                 goto chnk_mem_err;
 344         }
 345
 346         tim_ring->base = dev->bar2 +
 347                 (RVU_BLOCK_ADDR_TIM << 20 | tim_ring->ring_id << 12);
 348
 349         rc = tim_register_irq(tim_ring->ring_id);
 350         if (rc < 0)
 351                 goto chnk_mem_err;
 352
 353         otx2_write64((uint64_t)tim_ring->bkt,
 354                      tim_ring->base + TIM_LF_RING_BASE);
 355         otx2_write64(tim_ring->aura, tim_ring->base + TIM_LF_RING_AURA);
 356
 357         /* Set fastpath ops. */
 358         tim_set_fp_ops(tim_ring);
 359
 360         /* Update SSO xae count. */
 361         sso_updt_xae_cnt(sso_pmd_priv(dev->event_dev), (void *)&nb_timers,
 362                          RTE_EVENT_TYPE_TIMER);
 363         sso_xae_reconfigure(dev->event_dev);
 364
 365         return rc;
 366
 367 chnk_mem_err:
 368         rte_free(tim_ring->bkt);
 369 bkt_mem_err:
 370         rte_free(tim_ring);
 371 rng_mem_err:
 372         free_req = otx2_mbox_alloc_msg_tim_lf_free(dev->mbox);
 373         free_req->ring = adptr->data->id;
 374         otx2_mbox_process(dev->mbox);
 375         return rc;
 376 }
 377
 378 static int
 379 otx2_tim_ring_free(struct rte_event_timer_adapter *adptr)
 380 {
 381         struct otx2_tim_ring *tim_ring = adptr->data->adapter_priv;
 382         struct otx2_tim_evdev *dev = tim_priv_get();
 383         struct tim_ring_req *req;
 384         int rc;
 385
 386         if (dev == NULL)
 387                 return -ENODEV;
 388
 389         tim_unregister_irq(tim_ring->ring_id);
 390
 391         req = otx2_mbox_alloc_msg_tim_lf_free(dev->mbox);
 392         req->ring = tim_ring->ring_id;
 393
 394         rc = otx2_mbox_process(dev->mbox);
 395         if (rc < 0) {
 396                 tim_err_desc(rc);
 397                 return -EBUSY;
 398         }
 399
 400         rte_free(tim_ring->bkt);
 401         rte_mempool_free(tim_ring->chunk_pool);
 402         rte_free(adptr->data->adapter_priv);
 403
 404         return 0;
 405 }
 406
 407 int
 408 otx2_tim_caps_get(const struct rte_eventdev *evdev, uint64_t flags,
 409                   uint32_t *caps,
 410                   const struct rte_event_timer_adapter_ops **ops)
 411 {
 412         struct otx2_tim_evdev *dev = tim_priv_get();
 413
 414         RTE_SET_USED(flags);
 415         if (dev == NULL)
 416                 return -ENODEV;
 417
 418         otx2_tim_ops.init = otx2_tim_ring_create;
 419         otx2_tim_ops.uninit = otx2_tim_ring_free;
 420         otx2_tim_ops.get_info   = otx2_tim_ring_info_get;
 421
 422         /* Store evdev pointer for later use. */
 423         dev->event_dev = (struct rte_eventdev *)(uintptr_t)evdev;
 424         *caps = RTE_EVENT_TIMER_ADAPTER_CAP_INTERNAL_PORT;
 425         *ops = &otx2_tim_ops;
 426
 427         return 0;
 428 }
 429
 430 #define OTX2_TIM_DISABLE_NPA    "tim_disable_npa"
 431 #define OTX2_TIM_CHNK_SLOTS     "tim_chnk_slots"
 432
 433 static void
 434 tim_parse_devargs(struct rte_devargs *devargs, struct otx2_tim_evdev *dev)
 435 {
 436         struct rte_kvargs *kvlist;
 437
 438         if (devargs == NULL)
 439                 return;
 440
 441         kvlist = rte_kvargs_parse(devargs->args, NULL);
 442         if (kvlist == NULL)
 443                 return;
 444
 445         rte_kvargs_process(kvlist, OTX2_TIM_DISABLE_NPA,
 446                            &parse_kvargs_flag, &dev->disable_npa);
 447         rte_kvargs_process(kvlist, OTX2_TIM_CHNK_SLOTS,
 448                            &parse_kvargs_value, &dev->chunk_slots);
 449 }
 450
 451 void
 452 otx2_tim_init(struct rte_pci_device *pci_dev, struct otx2_dev *cmn_dev)
 453 {
 454         struct rsrc_attach_req *atch_req;
 455         struct rsrc_detach_req *dtch_req;
 456         struct free_rsrcs_rsp *rsrc_cnt;
 457         const struct rte_memzone *mz;
 458         struct otx2_tim_evdev *dev;
 459         int rc;
 460
 461         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 462                 return;
 463
 464         mz = rte_memzone_reserve(RTE_STR(OTX2_TIM_EVDEV_NAME),
 465                                  sizeof(struct otx2_tim_evdev),
 466                                  rte_socket_id(), 0);
 467         if (mz == NULL) {
 468                 otx2_tim_dbg("Unable to allocate memory for TIM Event device");
 469                 return;
 470         }
 471
 472         dev = mz->addr;
 473         dev->pci_dev = pci_dev;
 474         dev->mbox = cmn_dev->mbox;
 475         dev->bar2 = cmn_dev->bar2;
 476
 477         tim_parse_devargs(pci_dev->device.devargs, dev);
 478
 479         otx2_mbox_alloc_msg_free_rsrc_cnt(dev->mbox);
 480         rc = otx2_mbox_process_msg(dev->mbox, (void *)&rsrc_cnt);
 481         if (rc < 0) {
 482                 otx2_err("Unable to get free rsrc count.");
 483                 goto mz_free;
 484         }
 485
 486         dev->nb_rings = rsrc_cnt->tim;
 487
 488         if (!dev->nb_rings) {
 489                 otx2_tim_dbg("No TIM Logical functions provisioned.");
 490                 goto mz_free;
 491         }
 492
 493         atch_req = otx2_mbox_alloc_msg_attach_resources(dev->mbox);
 494         atch_req->modify = true;
 495         atch_req->timlfs = dev->nb_rings;
 496
 497         rc = otx2_mbox_process(dev->mbox);
 498         if (rc < 0) {
 499                 otx2_err("Unable to attach TIM rings.");
 500                 goto mz_free;
 501         }
 502
 503         rc = tim_get_msix_offsets();
 504         if (rc < 0) {
 505                 otx2_err("Unable to get MSIX offsets for TIM.");
 506                 goto detach;
 507         }
 508
 509         if (dev->chunk_slots &&
 510             dev->chunk_slots <= OTX2_TIM_MAX_CHUNK_SLOTS &&
 511             dev->chunk_slots >= OTX2_TIM_MIN_CHUNK_SLOTS) {
 512                 dev->chunk_sz = (dev->chunk_slots + 1) *
 513                         OTX2_TIM_CHUNK_ALIGNMENT;
 514         } else {
 515                 dev->chunk_sz = OTX2_TIM_RING_DEF_CHUNK_SZ;
 516         }
 517
 518         return;
 519
 520 detach:
 521         dtch_req = otx2_mbox_alloc_msg_detach_resources(dev->mbox);
 522         dtch_req->partial = true;
 523         dtch_req->timlfs = true;
 524
 525         otx2_mbox_process(dev->mbox);
 526 mz_free:
 527         rte_memzone_free(mz);
 528 }
 529
 530 void
 531 otx2_tim_fini(void)
 532 {
 533         struct otx2_tim_evdev *dev = tim_priv_get();
 534         struct rsrc_detach_req *dtch_req;
 535
 536         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 537                 return;
 538
 539         dtch_req = otx2_mbox_alloc_msg_detach_resources(dev->mbox);
 540         dtch_req->partial = true;
 541         dtch_req->timlfs = true;
 542
 543         otx2_mbox_process(dev->mbox);
 544         rte_memzone_free(rte_memzone_lookup(RTE_STR(OTX2_TIM_EVDEV_NAME)));
 545 }