lib/eventdev/rte_event_timer_adapter.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Cavium, Inc.
   3  * Copyright(c) 2017-2018 Intel Corporation.
   4  * All rights reserved.
   5  */
   6
   7 #ifndef __RTE_EVENT_TIMER_ADAPTER_H__
   8 #define __RTE_EVENT_TIMER_ADAPTER_H__
   9
  10 /**
  11  * @file
  12  *
  13  * RTE Event Timer Adapter
  14  *
  15  * An event timer adapter has the following abstract working model:
  16  *
  17  *                               timer_tick_ns
  18  *                                   +
  19  *                      +-------+    |
  20  *                      |       |    |
  21  *              +-------+ bkt 0 +----v---+
  22  *              |       |       |        |
  23  *              |       +-------+        |
  24  *          +---+---+                +---+---+  +---+---+---+---+
  25  *          |       |                |       |  |   |   |   |   |
  26  *          | bkt n |                | bkt 1 |<-> t0| t1| t2| tn|
  27  *          |       |                |       |  |   |   |   |   |
  28  *          +---+---+                +---+---+  +---+---+---+---+
  29  *              |     Timer adapter      |
  30  *          +---+---+                +---+---+
  31  *          |       |                |       |
  32  *          | bkt 4 |                | bkt 2 |<--- Current bucket
  33  *          |       |                |       |
  34  *          +---+---+                +---+---+
  35  *               |      +-------+       |
  36  *               |      |       |       |
  37  *               +------+ bkt 3 +-------+
  38  *                      |       |
  39  *                      +-------+
  40  *
  41  * - It has a virtual monotonically increasing 64-bit timer adapter clock based
  42  *   on *enum rte_event_timer_adapter_clk_src* clock source. The clock source
  43  *   could be a CPU clock, or a platform dependent external clock.
  44  *
  45  * - The application creates a timer adapter instance with given the clock
  46  *   source, the total number of event timers, and a resolution(expressed in ns)
  47  *   to traverse between the buckets.
  48  *
  49  * - Each timer adapter may have 0 to n buckets based on the configured
  50  *   max timeout(max_tmo_ns) and resolution(timer_tick_ns). Upon starting the
  51  *   timer adapter, the adapter starts ticking at *timer_tick_ns* resolution.
  52  *
  53  * - The application arms an event timer that will expire *timer_tick_ns*
  54  *   from now.
  55  *
  56  * - The application can cancel an armed timer and no timer expiry event will be
  57  *   generated.
  58  *
  59  * - If a timer expires then the library injects the timer expiry event in
  60  *   the designated event queue.
  61  *
  62  * - The timer expiry event will be received through *rte_event_dequeue_burst*.
  63  *
  64  * - The application frees the timer adapter instance.
  65  *
  66  * Multiple timer adapters can be created with a varying level of resolution
  67  * for various expiry use cases that run in parallel.
  68  *
  69  * Before using the timer adapter, the application has to create and configure
  70  * an event device along with the event port. Based on the event device
  71  * capability it might require creating an additional event port to be used
  72  * by the timer adapter.
  73  *
  74  * The application creates the event timer adapter using the
  75  * ``rte_event_timer_adapter_create()``. The event device id is passed to this
  76  * function, inside this function the event device capability is checked,
  77  * and if an in-built port is absent the application uses the default
  78  * function to create a new producer port.
  79  *
  80  * The application may also use the function
  81  * ``rte_event_timer_adapter_create_ext()`` to have granular control over
  82  * producer port creation in a case where the in-built port is absent.
  83  *
  84  * After creating the timer adapter, the application has to start it
  85  * using ``rte_event_timer_adapter_start()``. The buckets are traversed from
  86  * 0 to n; when the adapter ticks, the next bucket is visited. Each time,
  87  * the list per bucket is processed, and timer expiry events are sent to the
  88  * designated event queue.
  89  *
  90  * The application can arm one or more event timers using the
  91  * ``rte_event_timer_arm_burst()``. The *timeout_ticks* represents the number
  92  * of *timer_tick_ns* after which the timer has to expire. The timeout at
  93  * which the timers expire can be grouped or be independent of each
  94  * event timer instance. ``rte_event_timer_arm_tmo_tick_burst()`` addresses the
  95  * former case and ``rte_event_timer_arm_burst()`` addresses the latter case.
  96  *
  97  * The application can cancel the timers from expiring using the
  98  * ``rte_event_timer_cancel_burst()``.
  99  *
 100  * On the secondary process, ``rte_event_timer_adapter_lookup()`` can be used
 101  * to get the timer adapter pointer from its id and use it to invoke fastpath
 102  * operations such as arm and cancel.
 103  *
 104  * Some of the use cases of event timer adapter are Beacon Timers,
 105  * Generic SW Timeout, Wireless MAC Scheduling, 3G Frame Protocols,
 106  * Packet Scheduling, Protocol Retransmission Timers, Supervision Timers.
 107  * All these use cases require high resolution and low time drift.
 108  */
 109
 110 #ifdef __cplusplus
 111 extern "C" {
 112 #endif
 113
 114 #include <rte_spinlock.h>
 115 #include <rte_memory.h>
 116
 117 #include "rte_eventdev.h"
 118 #include "rte_eventdev_trace_fp.h"
 119
 120 /**
 121  * Timer adapter clock source
 122  */
 123 enum rte_event_timer_adapter_clk_src {
 124         RTE_EVENT_TIMER_ADAPTER_CPU_CLK,
 125         /**< Use CPU clock as the clock source. */
 126         RTE_EVENT_TIMER_ADAPTER_EXT_CLK0,
 127         /**< Platform dependent external clock source 0. */
 128         RTE_EVENT_TIMER_ADAPTER_EXT_CLK1,
 129         /**< Platform dependent external clock source 1. */
 130         RTE_EVENT_TIMER_ADAPTER_EXT_CLK2,
 131         /**< Platform dependent external clock source 2. */
 132         RTE_EVENT_TIMER_ADAPTER_EXT_CLK3,
 133         /**< Platform dependent external clock source 3. */
 134 };
 135
 136 #define RTE_EVENT_TIMER_ADAPTER_F_ADJUST_RES    (1ULL << 0)
 137 /**< The event timer adapter implementation may have constraints on the
 138  * resolution (timer_tick_ns) and maximum timer expiry timeout(max_tmo_ns)
 139  * based on the given timer adapter or system. If this flag is set, the
 140  * implementation adjusts the resolution and maximum timeout to the best
 141  * possible configuration. On successful timer adapter creation, the
 142  * application can get the configured resolution and max timeout with
 143  * ``rte_event_timer_adapter_get_info()``.
 144  *
 145  * @see struct rte_event_timer_adapter_info::min_resolution_ns
 146  * @see struct rte_event_timer_adapter_info::max_tmo_ns
 147  */
 148 #define RTE_EVENT_TIMER_ADAPTER_F_SP_PUT        (1ULL << 1)
 149 /**< ``rte_event_timer_arm_burst()`` API to be used in single producer mode.
 150  *
 151  * @see struct rte_event_timer_adapter_conf::flags
 152  */
 153
 154 #define RTE_EVENT_TIMER_ADAPTER_F_PERIODIC      (1ULL << 2)
 155 /**< Flag to configure an event timer adapter in periodic mode; non-periodic
 156  * mode is the default. A timer will fire once or periodically until the timer
 157  * is cancelled based on the adapter mode.
 158  *
 159  * @see struct rte_event_timer_adapter_conf::flags
 160  */
 161
 162 /**
 163  * Timer adapter configuration structure
 164  */
 165 struct rte_event_timer_adapter_conf {
 166         uint8_t event_dev_id;
 167         /**< Event device identifier */
 168         uint16_t timer_adapter_id;
 169         /**< Event timer adapter identifier */
 170         uint32_t socket_id;
 171         /**< Identifier of socket from which to allocate memory for adapter */
 172         enum rte_event_timer_adapter_clk_src clk_src;
 173         /**< Clock source for timer adapter */
 174         uint64_t timer_tick_ns;
 175         /**< Timer adapter resolution in ns */
 176         uint64_t max_tmo_ns;
 177         /**< Maximum timer timeout(expiry) in ns */
 178         uint64_t nb_timers;
 179         /**< Total number of timers per adapter */
 180         uint64_t flags;
 181         /**< Timer adapter config flags (RTE_EVENT_TIMER_ADAPTER_F_*) */
 182 };
 183
 184 /**
 185  * Event timer adapter stats structure
 186  */
 187 struct rte_event_timer_adapter_stats {
 188         uint64_t evtim_exp_count;
 189         /**< Number of event timers that have expired. */
 190         uint64_t ev_enq_count;
 191         /**< Eventdev enqueue count */
 192         uint64_t ev_inv_count;
 193         /**< Invalid expiry event count */
 194         uint64_t evtim_retry_count;
 195         /**< Event timer retry count */
 196         uint64_t adapter_tick_count;
 197         /**< Tick count for the adapter, at its resolution */
 198 };
 199
 200 struct rte_event_timer_adapter;
 201
 202 /**
 203  * Callback function type for producer port creation.
 204  */
 205 typedef int (*rte_event_timer_adapter_port_conf_cb_t)(uint16_t id,
 206                                                       uint8_t event_dev_id,
 207                                                       uint8_t *event_port_id,
 208                                                       void *conf_arg);
 209
 210 /**
 211  * Create an event timer adapter.
 212  *
 213  * This function must be invoked first before any other function in the API.
 214  *
 215  * @param conf
 216  *   The event timer adapter configuration structure.
 217  *
 218  * @return
 219  *   A pointer to the new allocated event timer adapter on success.
 220  *   NULL on error with rte_errno set appropriately.
 221  *   Possible rte_errno values include:
 222  *   - ERANGE: timer_tick_ns is not in supported range.
 223  *   - ENOMEM: unable to allocate sufficient memory for adapter instances
 224  *   - EINVAL: invalid event device identifier specified in config
 225  *   - ENOSPC: maximum number of adapters already created
 226  *   - EIO: event device reconfiguration and restart error.  The adapter
 227  *   reconfigures the event device with an additional port by default if it is
 228  *   required to use a service to manage timers. If the device had been started
 229  *   before this call, this error code indicates an error in restart following
 230  *   an error in reconfiguration, i.e., a combination of the two error codes.
 231  */
 232 struct rte_event_timer_adapter *
 233 rte_event_timer_adapter_create(const struct rte_event_timer_adapter_conf *conf);
 234
 235 /**
 236  * Create a timer adapter with the supplied callback.
 237  *
 238  * This function can be used to have a more granular control over the timer
 239  * adapter creation.  If a built-in port is absent, then the function uses the
 240  * callback provided to create and get the port id to be used as a producer
 241  * port.
 242  *
 243  * @param conf
 244  *   The timer adapter configuration structure
 245  * @param conf_cb
 246  *   The port config callback function.
 247  * @param conf_arg
 248  *   Opaque pointer to the argument for the callback function
 249  *
 250  * @return
 251  *   A pointer to the new allocated event timer adapter on success.
 252  *   NULL on error with rte_errno set appropriately.
 253  *   Possible rte_errno values include:
 254  *   - ERANGE: timer_tick_ns is not in supported range.
 255  *   - ENOMEM: unable to allocate sufficient memory for adapter instances
 256  *   - EINVAL: invalid event device identifier specified in config
 257  *   - ENOSPC: maximum number of adapters already created
 258  */
 259 struct rte_event_timer_adapter *
 260 rte_event_timer_adapter_create_ext(
 261                 const struct rte_event_timer_adapter_conf *conf,
 262                 rte_event_timer_adapter_port_conf_cb_t conf_cb,
 263                 void *conf_arg);
 264
 265 /**
 266  * Timer adapter info structure.
 267  */
 268 struct rte_event_timer_adapter_info {
 269         uint64_t min_resolution_ns;
 270         /**< Minimum timer adapter resolution in ns */
 271         uint64_t max_tmo_ns;
 272         /**< Maximum timer timeout(expire) in ns */
 273         struct rte_event_timer_adapter_conf conf;
 274         /**< Configured timer adapter attributes */
 275         uint32_t caps;
 276         /**< Event timer adapter capabilities */
 277         int16_t event_dev_port_id;
 278         /**< Event device port ID, if applicable */
 279 };
 280
 281 /**
 282  * Retrieve the contextual information of an event timer adapter.
 283  *
 284  * @param adapter
 285  *   A pointer to the event timer adapter structure.
 286  *
 287  * @param[out] adapter_info
 288  *   A pointer to a structure of type *rte_event_timer_adapter_info* to be
 289  *   filled with the contextual information of the adapter.
 290  *
 291  * @return
 292  *   - 0: Success, driver updates the contextual information of the
 293  *   timer adapter
 294  *   - <0: Error code returned by the driver info get function.
 295  *   - -EINVAL: adapter identifier invalid
 296  *
 297  * @see RTE_EVENT_TIMER_ADAPTER_F_ADJUST_RES,
 298  *   struct rte_event_timer_adapter_info
 299  *
 300  */
 301 int
 302 rte_event_timer_adapter_get_info(
 303                 const struct rte_event_timer_adapter *adapter,
 304                 struct rte_event_timer_adapter_info *adapter_info);
 305
 306 /**
 307  * Start a timer adapter.
 308  *
 309  * The adapter start step is the last one and consists of setting the timer
 310  * adapter to start accepting the timers and schedules to event queues.
 311  *
 312  * On success, all basic functions exported by the API (timer arm,
 313  * timer cancel and so on) can be invoked.
 314  *
 315  * @param adapter
 316  *   A pointer to the event timer adapter structure.
 317  *
 318  * @return
 319  *   - 0: Success, adapter started.
 320  *   - <0: Error code returned by the driver start function.
 321  *   - -EINVAL if adapter identifier invalid
 322  *   - -ENOENT if software adapter but no service core mapped
 323  *   - -ENOTSUP if software adapter and more than one service core mapped
 324  *   - -EALREADY if adapter has already been started
 325  *
 326  * @note
 327  *  The eventdev to which the event_timer_adapter is connected needs to
 328  *  be started before calling rte_event_timer_adapter_start().
 329  */
 330 int
 331 rte_event_timer_adapter_start(
 332                 const struct rte_event_timer_adapter *adapter);
 333
 334 /**
 335  * Stop an event timer adapter.
 336  *
 337  * The adapter can be restarted with a call to
 338  * ``rte_event_timer_adapter_start()``.
 339  *
 340  * @param adapter
 341  *   A pointer to the event timer adapter structure.
 342  *
 343  * @return
 344  *   - 0: Success, adapter stopped.
 345  *   - <0: Error code returned by the driver stop function.
 346  *   - -EINVAL if adapter identifier invalid
 347  */
 348 int
 349 rte_event_timer_adapter_stop(const struct rte_event_timer_adapter *adapter);
 350
 351 /**
 352  * Lookup an event timer adapter using its identifier.
 353  *
 354  * If an event timer adapter was created in another process with the same
 355  * identifier, this function will locate its state and set up access to it
 356  * so that it can be used in this process.
 357  *
 358  * @param adapter_id
 359  *  The event timer adapter identifier.
 360  *
 361  * @return
 362  *  A pointer to the event timer adapter matching the identifier on success.
 363  *  NULL on error with rte_errno set appropriately.
 364  *  Possible rte_errno values include:
 365  *   - ENOENT - requested entry not available to return.
 366  */
 367 struct rte_event_timer_adapter *
 368 rte_event_timer_adapter_lookup(uint16_t adapter_id);
 369
 370 /**
 371  * Free an event timer adapter.
 372  *
 373  * Destroy an event timer adapter, freeing all resources.
 374  *
 375  * Before invoking this function, the application must wait for all the
 376  * armed timers to expire or cancel the outstanding armed timers.
 377  *
 378  * @param adapter
 379  *   A pointer to an event timer adapter structure.
 380  *
 381  * @return
 382  *   - 0: Successfully freed the event timer adapter resources.
 383  *   - <0: Failed to free the event timer adapter resources.
 384  *   - -EAGAIN:  adapter is busy; timers outstanding
 385  *   - -EBUSY: stop hasn't been called for this adapter yet
 386  *   - -EINVAL: adapter id invalid, or adapter invalid
 387  */
 388 int
 389 rte_event_timer_adapter_free(struct rte_event_timer_adapter *adapter);
 390
 391 /**
 392  * Retrieve the service ID of the event timer adapter. If the adapter doesn't
 393  * use an rte_service function, this function returns -ESRCH.
 394  *
 395  * @param adapter
 396  *   A pointer to an event timer adapter.
 397  *
 398  * @param [out] service_id
 399  *   A pointer to a uint32_t, to be filled in with the service id.
 400  *
 401  * @return
 402  *   - 0: Success
 403  *   - <0: Error code on failure
 404  *   - -ESRCH: the adapter does not require a service to operate
 405  */
 406 int
 407 rte_event_timer_adapter_service_id_get(struct rte_event_timer_adapter *adapter,
 408                                        uint32_t *service_id);
 409
 410 /**
 411  * Retrieve statistics for an event timer adapter instance.
 412  *
 413  * @param adapter
 414  *   A pointer to an event timer adapter structure.
 415  * @param[out] stats
 416  *   A pointer to a structure to fill with statistics.
 417  *
 418  * @return
 419  *   - 0: Successfully retrieved.
 420  *   - <0: Failure; error code returned.
 421  */
 422 int
 423 rte_event_timer_adapter_stats_get(struct rte_event_timer_adapter *adapter,
 424                 struct rte_event_timer_adapter_stats *stats);
 425
 426 /**
 427  * Reset statistics for an event timer adapter instance.
 428  *
 429  * @param adapter
 430  *   A pointer to an event timer adapter structure.
 431  *
 432  * @return
 433  *   - 0: Successfully reset;
 434  *   - <0: Failure; error code returned.
 435  */
 436 int
 437 rte_event_timer_adapter_stats_reset(struct rte_event_timer_adapter *adapter);
 438
 439 /**
 440  * Event timer state.
 441  */
 442 enum rte_event_timer_state {
 443         RTE_EVENT_TIMER_NOT_ARMED       = 0,
 444         /**< Event timer not armed. */
 445         RTE_EVENT_TIMER_ARMED           = 1,
 446         /**< Event timer successfully armed. */
 447         RTE_EVENT_TIMER_CANCELED        = 2,
 448         /**< Event timer successfully canceled. */
 449         RTE_EVENT_TIMER_ERROR           = -1,
 450         /**< Generic event timer error. */
 451         RTE_EVENT_TIMER_ERROR_TOOEARLY  = -2,
 452         /**< Event timer timeout tick value is too small for the adapter to
 453          * handle, given its configured resolution.
 454          */
 455         RTE_EVENT_TIMER_ERROR_TOOLATE   = -3,
 456         /**< Event timer timeout tick is greater than the maximum timeout.*/
 457 };
 458
 459 /**
 460  * The generic *rte_event_timer* structure to hold the event timer attributes
 461  * for arm and cancel operations.
 462  */
 463 RTE_STD_C11
 464 struct rte_event_timer {
 465         struct rte_event ev;
 466         /**<
 467          * Expiry event attributes.  On successful event timer timeout,
 468          * the following attributes will be used to inject the expiry event to
 469          * the eventdev:
 470          *  - event_queue_id: Targeted event queue id for expiry events.
 471          *  - event_priority: Event priority of the event expiry event in the
 472          *  event queue relative to other events.
 473          *  - sched_type: Scheduling type of the expiry event.
 474          *  - flow_id: Flow id of the expiry event.
 475          *  - op: RTE_EVENT_OP_NEW
 476          *  - event_type: RTE_EVENT_TYPE_TIMER
 477          */
 478         volatile enum rte_event_timer_state state;
 479         /**< State of the event timer. */
 480         uint64_t timeout_ticks;
 481         /**< Expiry timer ticks expressed in number of *timer_ticks_ns* from
 482          * now.
 483          * @see struct rte_event_timer_adapter_info::adapter_conf::timer_tick_ns
 484          */
 485         uint64_t impl_opaque[2];
 486         /**< Implementation-specific opaque data.
 487          * An event timer adapter implementation use this field to hold
 488          * implementation specific values to share between the arm and cancel
 489          * operations.  The application should not modify this field.
 490          */
 491         uint8_t user_meta[0];
 492         /**< Memory to store user specific metadata.
 493          * The event timer adapter implementation should not modify this area.
 494          */
 495 } __rte_cache_aligned;
 496
 497 typedef uint16_t (*rte_event_timer_arm_burst_t)(
 498                 const struct rte_event_timer_adapter *adapter,
 499                 struct rte_event_timer **tims,
 500                 uint16_t nb_tims);
 501 /**< @internal Enable event timers to enqueue timer events upon expiry */
 502 typedef uint16_t (*rte_event_timer_arm_tmo_tick_burst_t)(
 503                 const struct rte_event_timer_adapter *adapter,
 504                 struct rte_event_timer **tims,
 505                 uint64_t timeout_tick,
 506                 uint16_t nb_tims);
 507 /**< @internal Enable event timers with common expiration time */
 508 typedef uint16_t (*rte_event_timer_cancel_burst_t)(
 509                 const struct rte_event_timer_adapter *adapter,
 510                 struct rte_event_timer **tims,
 511                 uint16_t nb_tims);
 512 /**< @internal Prevent event timers from enqueuing timer events */
 513
 514 /**
 515  * @internal Data structure associated with each event timer adapter.
 516  */
 517 struct rte_event_timer_adapter {
 518         rte_event_timer_arm_burst_t arm_burst;
 519         /**< Pointer to driver arm_burst function. */
 520         rte_event_timer_arm_tmo_tick_burst_t arm_tmo_tick_burst;
 521         /**< Pointer to driver arm_tmo_tick_burst function. */
 522         rte_event_timer_cancel_burst_t cancel_burst;
 523         /**< Pointer to driver cancel function. */
 524         struct rte_event_timer_adapter_data *data;
 525         /**< Pointer to shared adapter data */
 526         const struct rte_event_timer_adapter_ops *ops;
 527         /**< Functions exported by adapter driver */
 528
 529         RTE_STD_C11
 530         uint8_t allocated : 1;
 531         /**< Flag to indicate that this adapter has been allocated */
 532 } __rte_cache_aligned;
 533
 534 #define ADAPTER_VALID_OR_ERR_RET(adapter, retval) do {          \
 535         if (adapter == NULL || !adapter->allocated)             \
 536                 return retval;                                  \
 537 } while (0)
 538
 539 #define FUNC_PTR_OR_ERR_RET(func, errval) do {                  \
 540         if ((func) == NULL)                                     \
 541                 return errval;                                  \
 542 } while (0)
 543
 544 #define FUNC_PTR_OR_NULL_RET_WITH_ERRNO(func, errval) do {      \
 545         if ((func) == NULL) {                                   \
 546                 rte_errno = errval;                             \
 547                 return NULL;                                    \
 548         }                                                       \
 549 } while (0)
 550
 551 /**
 552  * Arm a burst of event timers with separate expiration timeout tick for each
 553  * event timer.
 554  *
 555  * Before calling this function, the application allocates
 556  * ``struct rte_event_timer`` objects from mempool or huge page backed
 557  * application buffers of desired size. On successful allocation,
 558  * application updates the `struct rte_event_timer`` attributes such as
 559  * expiry event attributes, timeout ticks from now.
 560  * This function submits the event timer arm requests to the event timer adapter
 561  * and on expiry, the events will be injected to designated event queue.
 562  * Timer expiry events will be generated once or periodically until cancellation
 563  * based on the adapter mode.
 564  *
 565  * @param adapter
 566  *   A pointer to an event timer adapter structure.
 567  * @param evtims
 568  *   Pointer to an array of objects of type *rte_event_timer* structure.
 569  * @param nb_evtims
 570  *   Number of event timers in the supplied array.
 571  *
 572  * @return
 573  *   The number of successfully armed event timers. The return value can be less
 574  *   than the value of the *nb_evtims* parameter. If the return value is less
 575  *   than *nb_evtims*, the remaining event timers at the end of *evtims*
 576  *   are not consumed, and the caller has to take care of them, and rte_errno
 577  *   is set accordingly. Possible errno values include:
 578  *   - EINVAL Invalid timer adapter, expiry event queue ID is invalid, or an
 579  *   expiry event's sched type doesn't match the capabilities of the
 580  *   destination event queue.
 581  *   - EAGAIN Specified timer adapter is not running
 582  *   - EALREADY A timer was encountered that was already armed
 583  *
 584  * @see RTE_EVENT_TIMER_ADAPTER_F_PERIODIC
 585  *
 586  */
 587 static inline uint16_t
 588 rte_event_timer_arm_burst(const struct rte_event_timer_adapter *adapter,
 589                           struct rte_event_timer **evtims,
 590                           uint16_t nb_evtims)
 591 {
 592 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
 593         ADAPTER_VALID_OR_ERR_RET(adapter, -EINVAL);
 594         FUNC_PTR_OR_ERR_RET(adapter->arm_burst, -EINVAL);
 595 #endif
 596         rte_eventdev_trace_timer_arm_burst(adapter, (void **)evtims,
 597                 nb_evtims);
 598         return adapter->arm_burst(adapter, evtims, nb_evtims);
 599 }
 600
 601 /**
 602  * Arm a burst of event timers with same expiration timeout tick.
 603  *
 604  * Provides the same functionality as ``rte_event_timer_arm_burst()``, except
 605  * that application can use this API when all the event timers have the
 606  * same timeout expiration tick. This specialized function can provide the
 607  * additional hint to the adapter implementation and optimize if possible.
 608  *
 609  * @param adapter
 610  *   A pointer to an event timer adapter structure.
 611  * @param evtims
 612  *   Points to an array of objects of type *rte_event_timer* structure.
 613  * @param timeout_ticks
 614  *   The number of ticks in which the timers should expire.
 615  * @param nb_evtims
 616  *   Number of event timers in the supplied array.
 617  *
 618  * @return
 619  *   The number of successfully armed event timers. The return value can be less
 620  *   than the value of the *nb_evtims* parameter. If the return value is less
 621  *   than *nb_evtims*, the remaining event timers at the end of *evtims*
 622  *   are not consumed, and the caller has to take care of them, and rte_errno
 623  *   is set accordingly. Possible errno values include:
 624  *   - EINVAL Invalid timer adapter, expiry event queue ID is invalid, or an
 625  *   expiry event's sched type doesn't match the capabilities of the
 626  *   destination event queue.
 627  *   - EAGAIN Specified event timer adapter is not running
 628  *   - EALREADY A timer was encountered that was already armed
 629  */
 630 static inline uint16_t
 631 rte_event_timer_arm_tmo_tick_burst(
 632                         const struct rte_event_timer_adapter *adapter,
 633                         struct rte_event_timer **evtims,
 634                         const uint64_t timeout_ticks,
 635                         const uint16_t nb_evtims)
 636 {
 637 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
 638         ADAPTER_VALID_OR_ERR_RET(adapter, -EINVAL);
 639         FUNC_PTR_OR_ERR_RET(adapter->arm_tmo_tick_burst, -EINVAL);
 640 #endif
 641         rte_eventdev_trace_timer_arm_tmo_tick_burst(adapter, timeout_ticks,
 642                 (void **)evtims, nb_evtims);
 643         return adapter->arm_tmo_tick_burst(adapter, evtims, timeout_ticks,
 644                                            nb_evtims);
 645 }
 646
 647 /**
 648  * Cancel a burst of event timers from being scheduled to the event device.
 649  *
 650  * @param adapter
 651  *   A pointer to an event timer adapter structure.
 652  * @param evtims
 653  *   Points to an array of objects of type *rte_event_timer* structure
 654  * @param nb_evtims
 655  *   Number of event timer instances in the supplied array.
 656  *
 657  * @return
 658  *   The number of successfully canceled event timers. The return value can be
 659  *   less than the value of the *nb_evtims* parameter. If the return value is
 660  *   less than *nb_evtims*, the remaining event timers at the end of *evtims*
 661  *   are not consumed, and the caller has to take care of them, and rte_errno
 662  *   is set accordingly. Possible errno values include:
 663  *   - EINVAL Invalid timer adapter identifier
 664  *   - EAGAIN Specified timer adapter is not running
 665  *   - EALREADY  A timer was encountered that was already canceled
 666  */
 667 static inline uint16_t
 668 rte_event_timer_cancel_burst(const struct rte_event_timer_adapter *adapter,
 669                              struct rte_event_timer **evtims,
 670                              uint16_t nb_evtims)
 671 {
 672 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
 673         ADAPTER_VALID_OR_ERR_RET(adapter, -EINVAL);
 674         FUNC_PTR_OR_ERR_RET(adapter->cancel_burst, -EINVAL);
 675 #endif
 676         rte_eventdev_trace_timer_cancel_burst(adapter, (void **)evtims,
 677                 nb_evtims);
 678         return adapter->cancel_burst(adapter, evtims, nb_evtims);
 679 }
 680
 681 #endif /* __RTE_EVENT_TIMER_ADAPTER_H__ */