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