/usr/share/dpdk/x86_64-default-linuxapp-gcc/include/rte_eventdev_pmd.h is in dpdk-dev 17.11.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | /*
*
* Copyright(c) 2016 Cavium, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Cavium, Inc nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTE_EVENTDEV_PMD_H_
#define _RTE_EVENTDEV_PMD_H_
/** @file
* RTE Event PMD APIs
*
* @note
* These API are from event PMD only and user applications should not call
* them directly.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <string.h>
#include <rte_common.h>
#include <rte_config.h>
#include <rte_dev.h>
#include <rte_log.h>
#include <rte_malloc.h>
#include "rte_eventdev.h"
/* Logging Macros */
#define RTE_EDEV_LOG_ERR(...) \
RTE_LOG(ERR, EVENTDEV, \
RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
#ifdef RTE_LIBRTE_EVENTDEV_DEBUG
#define RTE_EDEV_LOG_DEBUG(...) \
RTE_LOG(DEBUG, EVENTDEV, \
RTE_FMT("%s() line %u: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
__func__, __LINE__, RTE_FMT_TAIL(__VA_ARGS__,)))
#else
#define RTE_EDEV_LOG_DEBUG(...) (void)0
#endif
/* Macros to check for valid device */
#define RTE_EVENTDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
if (!rte_event_pmd_is_valid_dev((dev_id))) { \
RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
return retval; \
} \
} while (0)
#define RTE_EVENTDEV_VALID_DEVID_OR_ERRNO_RET(dev_id, errno, retval) do { \
if (!rte_event_pmd_is_valid_dev((dev_id))) { \
RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
rte_errno = errno; \
return retval; \
} \
} while (0)
#define RTE_EVENTDEV_VALID_DEVID_OR_RET(dev_id) do { \
if (!rte_event_pmd_is_valid_dev((dev_id))) { \
RTE_EDEV_LOG_ERR("Invalid dev_id=%d\n", dev_id); \
return; \
} \
} while (0)
#define RTE_EVENT_ETH_RX_ADAPTER_SW_CAP \
((RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID) | \
(RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ))
/**< Ethernet Rx adapter cap to return If the packet transfers from
* the ethdev to eventdev use a SW service function
*/
#define RTE_EVENTDEV_DETACHED (0)
#define RTE_EVENTDEV_ATTACHED (1)
struct rte_eth_dev;
/** Global structure used for maintaining state of allocated event devices */
struct rte_eventdev_global {
uint8_t nb_devs; /**< Number of devices found */
};
extern struct rte_eventdev_global *rte_eventdev_globals;
/** Pointer to global event devices data structure. */
extern struct rte_eventdev *rte_eventdevs;
/** The pool of rte_eventdev structures. */
/**
* Get the rte_eventdev structure device pointer for the named device.
*
* @param name
* device name to select the device structure.
*
* @return
* - The rte_eventdev structure pointer for the given device ID.
*/
static inline struct rte_eventdev *
rte_event_pmd_get_named_dev(const char *name)
{
struct rte_eventdev *dev;
unsigned int i;
if (name == NULL)
return NULL;
for (i = 0; i < RTE_EVENT_MAX_DEVS; i++) {
dev = &rte_eventdevs[i];
if ((dev->attached == RTE_EVENTDEV_ATTACHED) &&
(strcmp(dev->data->name, name) == 0))
return dev;
}
return NULL;
}
/**
* Validate if the event device index is valid attached event device.
*
* @param dev_id
* Event device index.
*
* @return
* - If the device index is valid (1) or not (0).
*/
static inline unsigned
rte_event_pmd_is_valid_dev(uint8_t dev_id)
{
struct rte_eventdev *dev;
if (dev_id >= RTE_EVENT_MAX_DEVS)
return 0;
dev = &rte_eventdevs[dev_id];
if (dev->attached != RTE_EVENTDEV_ATTACHED)
return 0;
else
return 1;
}
/**
* Definitions of all functions exported by a driver through the
* the generic structure of type *event_dev_ops* supplied in the
* *rte_eventdev* structure associated with a device.
*/
/**
* Get device information of a device.
*
* @param dev
* Event device pointer
* @param dev_info
* Event device information structure
*
* @return
* Returns 0 on success
*/
typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
struct rte_event_dev_info *dev_info);
/**
* Configure a device.
*
* @param dev
* Event device pointer
*
* @return
* Returns 0 on success
*/
typedef int (*eventdev_configure_t)(const struct rte_eventdev *dev);
/**
* Start a configured device.
*
* @param dev
* Event device pointer
*
* @return
* Returns 0 on success
*/
typedef int (*eventdev_start_t)(struct rte_eventdev *dev);
/**
* Stop a configured device.
*
* @param dev
* Event device pointer
*/
typedef void (*eventdev_stop_t)(struct rte_eventdev *dev);
/**
* Close a configured device.
*
* @param dev
* Event device pointer
*
* @return
* - 0 on success
* - (-EAGAIN) if can't close as device is busy
*/
typedef int (*eventdev_close_t)(struct rte_eventdev *dev);
/**
* Retrieve the default event queue configuration.
*
* @param dev
* Event device pointer
* @param queue_id
* Event queue index
* @param[out] queue_conf
* Event queue configuration structure
*
*/
typedef void (*eventdev_queue_default_conf_get_t)(struct rte_eventdev *dev,
uint8_t queue_id, struct rte_event_queue_conf *queue_conf);
/**
* Setup an event queue.
*
* @param dev
* Event device pointer
* @param queue_id
* Event queue index
* @param queue_conf
* Event queue configuration structure
*
* @return
* Returns 0 on success.
*/
typedef int (*eventdev_queue_setup_t)(struct rte_eventdev *dev,
uint8_t queue_id,
const struct rte_event_queue_conf *queue_conf);
/**
* Release resources allocated by given event queue.
*
* @param dev
* Event device pointer
* @param queue_id
* Event queue index
*
*/
typedef void (*eventdev_queue_release_t)(struct rte_eventdev *dev,
uint8_t queue_id);
/**
* Retrieve the default event port configuration.
*
* @param dev
* Event device pointer
* @param port_id
* Event port index
* @param[out] port_conf
* Event port configuration structure
*
*/
typedef void (*eventdev_port_default_conf_get_t)(struct rte_eventdev *dev,
uint8_t port_id, struct rte_event_port_conf *port_conf);
/**
* Setup an event port.
*
* @param dev
* Event device pointer
* @param port_id
* Event port index
* @param port_conf
* Event port configuration structure
*
* @return
* Returns 0 on success.
*/
typedef int (*eventdev_port_setup_t)(struct rte_eventdev *dev,
uint8_t port_id,
const struct rte_event_port_conf *port_conf);
/**
* Release memory resources allocated by given event port.
*
* @param port
* Event port pointer
*
*/
typedef void (*eventdev_port_release_t)(void *port);
/**
* Link multiple source event queues to destination event port.
*
* @param dev
* Event device pointer
* @param port
* Event port pointer
* @param link
* Points to an array of *nb_links* event queues to be linked
* to the event port.
* @param priorities
* Points to an array of *nb_links* service priorities associated with each
* event queue link to event port.
* @param nb_links
* The number of links to establish
*
* @return
* Returns 0 on success.
*
*/
typedef int (*eventdev_port_link_t)(struct rte_eventdev *dev, void *port,
const uint8_t queues[], const uint8_t priorities[],
uint16_t nb_links);
/**
* Unlink multiple source event queues from destination event port.
*
* @param dev
* Event device pointer
* @param port
* Event port pointer
* @param queues
* An array of *nb_unlinks* event queues to be unlinked from the event port.
* @param nb_unlinks
* The number of unlinks to establish
*
* @return
* Returns 0 on success.
*
*/
typedef int (*eventdev_port_unlink_t)(struct rte_eventdev *dev, void *port,
uint8_t queues[], uint16_t nb_unlinks);
/**
* Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue()
*
* @param dev
* Event device pointer
* @param ns
* Wait time in nanosecond
* @param[out] timeout_ticks
* Value for the *timeout_ticks* parameter in rte_event_dequeue() function
*
* @return
* Returns 0 on success.
*
*/
typedef int (*eventdev_dequeue_timeout_ticks_t)(struct rte_eventdev *dev,
uint64_t ns, uint64_t *timeout_ticks);
/**
* Dump internal information
*
* @param dev
* Event device pointer
* @param f
* A pointer to a file for output
*
*/
typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);
/**
* Retrieve a set of statistics from device
*
* @param dev
* Event device pointer
* @param ids
* The stat ids to retrieve
* @param values
* The returned stat values
* @param n
* The number of id values and entries in the values array
* @return
* The number of stat values successfully filled into the values array
*/
typedef int (*eventdev_xstats_get_t)(const struct rte_eventdev *dev,
enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
const unsigned int ids[], uint64_t values[], unsigned int n);
/**
* Resets the statistic values in xstats for the device, based on mode.
*/
typedef int (*eventdev_xstats_reset_t)(struct rte_eventdev *dev,
enum rte_event_dev_xstats_mode mode,
int16_t queue_port_id,
const uint32_t ids[],
uint32_t nb_ids);
/**
* Get names of extended stats of an event device
*
* @param dev
* Event device pointer
* @param xstats_names
* Array of name values to be filled in
* @param size
* Number of values in the xstats_names array
* @return
* When size >= the number of stats, return the number of stat values filled
* into the array.
* When size < the number of available stats, return the number of stats
* values, and do not fill in any data into xstats_names.
*/
typedef int (*eventdev_xstats_get_names_t)(const struct rte_eventdev *dev,
enum rte_event_dev_xstats_mode mode, uint8_t queue_port_id,
struct rte_event_dev_xstats_name *xstats_names,
unsigned int *ids, unsigned int size);
/**
* Get value of one stats and optionally return its id
*
* @param dev
* Event device pointer
* @param name
* The name of the stat to retrieve
* @param id
* Pointer to an unsigned int where we store the stat-id for future reference.
* This pointer may be null if the id is not required.
* @return
* The value of the stat, or (uint64_t)-1 if the stat is not found.
* If the stat is not found, the id value will be returned as (unsigned)-1,
* if id pointer is non-NULL
*/
typedef uint64_t (*eventdev_xstats_get_by_name)(const struct rte_eventdev *dev,
const char *name, unsigned int *id);
/**
* Retrieve the event device's ethdev Rx adapter capabilities for the
* specified ethernet port
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param[out] caps
* A pointer to memory filled with Rx event adapter capabilities.
*
* @return
* - 0: Success, driver provides Rx event adapter capabilities for the
* ethernet device.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_eth_rx_adapter_caps_get_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
uint32_t *caps);
struct rte_event_eth_rx_adapter_queue_conf *queue_conf;
/**
* Add ethernet Rx queues to event device. This callback is invoked if
* the caps returned from rte_eventdev_eth_rx_adapter_caps_get(, eth_port_id)
* has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param rx_queue_id
* Ethernet device receive queue index
*
* @param queue_conf
* Additional configuration structure
* @return
* - 0: Success, ethernet receive queue added successfully.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_eth_rx_adapter_queue_add_t)(
const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
int32_t rx_queue_id,
const struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
/**
* Delete ethernet Rx queues from event device. This callback is invoked if
* the caps returned from eventdev_eth_rx_adapter_caps_get(, eth_port_id)
* has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param rx_queue_id
* Ethernet device receive queue index
*
* @return
* - 0: Success, ethernet receive queue deleted successfully.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_eth_rx_adapter_queue_del_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
int32_t rx_queue_id);
/**
* Start ethernet Rx adapter. This callback is invoked if
* the caps returned from eventdev_eth_rx_adapter_caps_get(.., eth_port_id)
* has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
* from eth_port_id have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @return
* - 0: Success, ethernet Rx adapter started successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_eth_rx_adapter_start_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev);
/**
* Stop ethernet Rx adapter. This callback is invoked if
* the caps returned from eventdev_eth_rx_adapter_caps_get(..,eth_port_id)
* has RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT set and Rx queues
* from eth_port_id have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @return
* - 0: Success, ethernet Rx adapter stopped successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_eth_rx_adapter_stop_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev);
struct rte_event_eth_rx_adapter_stats *stats;
/**
* Retrieve ethernet Rx adapter statistics.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param[out] stats
* Pointer to stats structure
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_eth_rx_adapter_stats_get)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
struct rte_event_eth_rx_adapter_stats *stats);
/**
* Reset ethernet Rx adapter statistics.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_eth_rx_adapter_stats_reset)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev);
/** Event device operations function pointer table */
struct rte_eventdev_ops {
eventdev_info_get_t dev_infos_get; /**< Get device info. */
eventdev_configure_t dev_configure; /**< Configure device. */
eventdev_start_t dev_start; /**< Start device. */
eventdev_stop_t dev_stop; /**< Stop device. */
eventdev_close_t dev_close; /**< Close device. */
eventdev_queue_default_conf_get_t queue_def_conf;
/**< Get default queue configuration. */
eventdev_queue_setup_t queue_setup;
/**< Set up an event queue. */
eventdev_queue_release_t queue_release;
/**< Release an event queue. */
eventdev_port_default_conf_get_t port_def_conf;
/**< Get default port configuration. */
eventdev_port_setup_t port_setup;
/**< Set up an event port. */
eventdev_port_release_t port_release;
/**< Release an event port. */
eventdev_port_link_t port_link;
/**< Link event queues to an event port. */
eventdev_port_unlink_t port_unlink;
/**< Unlink event queues from an event port. */
eventdev_dequeue_timeout_ticks_t timeout_ticks;
/**< Converts ns to *timeout_ticks* value for rte_event_dequeue() */
eventdev_dump_t dump;
/* Dump internal information */
eventdev_xstats_get_t xstats_get;
/**< Get extended device statistics. */
eventdev_xstats_get_names_t xstats_get_names;
/**< Get names of extended stats. */
eventdev_xstats_get_by_name xstats_get_by_name;
/**< Get one value by name. */
eventdev_xstats_reset_t xstats_reset;
/**< Reset the statistics values in xstats. */
eventdev_eth_rx_adapter_caps_get_t eth_rx_adapter_caps_get;
/**< Get ethernet Rx adapter capabilities */
eventdev_eth_rx_adapter_queue_add_t eth_rx_adapter_queue_add;
/**< Add Rx queues to ethernet Rx adapter */
eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
/**< Delete Rx queues from ethernet Rx adapter */
eventdev_eth_rx_adapter_start_t eth_rx_adapter_start;
/**< Start ethernet Rx adapter */
eventdev_eth_rx_adapter_stop_t eth_rx_adapter_stop;
/**< Stop ethernet Rx adapter */
eventdev_eth_rx_adapter_stats_get eth_rx_adapter_stats_get;
/**< Get ethernet Rx stats */
eventdev_eth_rx_adapter_stats_reset eth_rx_adapter_stats_reset;
/**< Reset ethernet Rx stats */
};
/**
* Allocates a new eventdev slot for an event device and returns the pointer
* to that slot for the driver to use.
*
* @param name
* Unique identifier name for each device
* @param socket_id
* Socket to allocate resources on.
* @return
* - Slot in the rte_dev_devices array for a new device;
*/
struct rte_eventdev *
rte_event_pmd_allocate(const char *name, int socket_id);
/**
* Release the specified eventdev device.
*
* @param eventdev
* The *eventdev* pointer is the address of the *rte_eventdev* structure.
* @return
* - 0 on success, negative on error
*/
int
rte_event_pmd_release(struct rte_eventdev *eventdev);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_EVENTDEV_PMD_H_ */
|