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 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2016 Cavium, Inc
*/
#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.
*/
#include <string.h>
#include <rte_common.h>
#include <rte_compat.h>
#include <rte_config.h>
#include <dev_driver.h>
#include <rte_log.h>
#include <rte_malloc.h>
#include <rte_mbuf.h>
#include <rte_mbuf_dyn.h>
#include "event_timer_adapter_pmd.h"
#include "rte_event_eth_rx_adapter.h"
#include "rte_event_vector_adapter.h"
#include "rte_eventdev.h"
#ifdef __cplusplus
extern "C" {
#endif
extern int rte_event_logtype;
#define RTE_LOGTYPE_EVENTDEV rte_event_logtype
/* Logging Macros */
#define RTE_EDEV_LOG_ERR(...) \
RTE_LOG_LINE_PREFIX(ERR, EVENTDEV, \
"%s() line %u: ", __func__ RTE_LOG_COMMA __LINE__, __VA_ARGS__)
#ifdef RTE_LIBRTE_EVENTDEV_DEBUG
#define RTE_EDEV_LOG_DEBUG(...) \
RTE_LOG_LINE_PREFIX(DEBUG, EVENTDEV, \
"%s() line %u: ", __func__ RTE_LOG_COMMA __LINE__, __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", 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", 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", 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) | \
(RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR))
#define RTE_EVENT_CRYPTO_ADAPTER_SW_CAP \
RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA
/**< Ethernet Rx adapter cap to return If the packet transfers from
* the ethdev to eventdev use a SW service function
*/
#define RTE_EVENT_TIMER_ADAPTER_SW_CAP \
RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC
#define RTE_EVENT_VECTOR_ADAPTER_SW_CAP RTE_EVENT_VECTOR_ADAPTER_CAP_SOV_EOV
#define RTE_EVENTDEV_DETACHED (0)
#define RTE_EVENTDEV_ATTACHED (1)
#define RTE_EVENTDEV_NAME_MAX_LEN (64)
/**< @internal Max length of name of event PMD */
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 */
};
/**
* @internal
* The data part, with no function pointers, associated with each device.
*
* This structure is safe to place in shared memory to be common among
* different processes in a multi-process configuration.
*/
struct __rte_cache_aligned rte_eventdev_data {
int socket_id;
/**< Socket ID where memory is allocated */
uint8_t dev_id;
/**< Device ID for this instance */
uint8_t nb_queues;
/**< Number of event queues. */
uint8_t nb_ports;
/**< Number of event ports. */
void *ports[RTE_EVENT_MAX_PORTS_PER_DEV];
/**< Array of pointers to ports. */
struct rte_event_port_conf ports_cfg[RTE_EVENT_MAX_PORTS_PER_DEV];
/**< Array of port configuration structures. */
struct rte_event_queue_conf queues_cfg[RTE_EVENT_MAX_QUEUES_PER_DEV];
/**< Array of queue configuration structures. */
uint16_t links_map[RTE_EVENT_MAX_PROFILES_PER_PORT]
[RTE_EVENT_MAX_PORTS_PER_DEV * RTE_EVENT_MAX_QUEUES_PER_DEV];
/**< Memory to store queues to port connections. */
void *dev_private;
/**< PMD-specific private data */
uint32_t event_dev_cap;
/**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
struct rte_event_dev_config dev_conf;
/**< Configuration applied to device. */
uint8_t service_inited;
/* Service initialization state */
uint32_t service_id;
/* Service ID*/
void *dev_stop_flush_arg;
/**< User-provided argument for event flush function */
uint8_t dev_started : 1;
/**< Device state: STARTED(1)/STOPPED(0) */
char name[RTE_EVENTDEV_NAME_MAX_LEN];
/**< Unique identifier name */
uint64_t reserved_64s[4]; /**< Reserved for future fields */
void *reserved_ptrs[4]; /**< Reserved for future fields */
};
/** @internal The data structure associated with each event device. */
struct __rte_cache_aligned rte_eventdev {
struct rte_eventdev_data *data;
/**< Pointer to device data */
struct eventdev_ops *dev_ops;
/**< Functions exported by PMD */
struct rte_device *dev;
/**< Device info. supplied by probing */
uint8_t attached : 1;
/**< Flag indicating the device is attached */
event_enqueue_burst_t enqueue_burst;
/**< Pointer to PMD enqueue burst function. */
event_enqueue_burst_t enqueue_new_burst;
/**< Pointer to PMD enqueue burst function(op new variant) */
event_enqueue_burst_t enqueue_forward_burst;
/**< Pointer to PMD enqueue burst function(op forward variant) */
event_dequeue_burst_t dequeue_burst;
/**< Pointer to PMD dequeue burst function. */
event_maintain_t maintain;
/**< Pointer to PMD port maintenance function. */
event_tx_adapter_enqueue_t txa_enqueue_same_dest;
/**< Pointer to PMD eth Tx adapter burst enqueue function with
* events destined to same Eth port & Tx queue.
*/
event_tx_adapter_enqueue_t txa_enqueue;
/**< Pointer to PMD eth Tx adapter enqueue function. */
event_crypto_adapter_enqueue_t ca_enqueue;
/**< Pointer to PMD crypto adapter enqueue function. */
event_dma_adapter_enqueue_t dma_enqueue;
/**< Pointer to PMD DMA adapter enqueue function. */
event_profile_switch_t profile_switch;
/**< Pointer to PMD Event switch profile function. */
event_preschedule_modify_t preschedule_modify;
/**< Pointer to PMD Event port pre-schedule type modify function. */
event_preschedule_t preschedule;
/**< Pointer to PMD Event port pre-schedule function. */
uint64_t reserved_64s[3]; /**< Reserved for future fields */
void *reserved_ptrs[3]; /**< Reserved for future fields */
};
extern struct rte_eventdev *rte_eventdevs;
/** @internal 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.
*/
__rte_internal
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).
*/
__rte_internal
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
* 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
*/
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);
/**
* Set an event queue attribute at runtime.
*
* @param dev
* Event device pointer
* @param queue_id
* Event queue index
* @param attr_id
* Event queue attribute id
* @param attr_value
* Event queue attribute value
*
* @return
* - 0: Success.
* - <0: Error code on failure.
*/
typedef int (*eventdev_queue_attr_set_t)(struct rte_eventdev *dev,
uint8_t queue_id, uint32_t attr_id,
uint64_t attr_value);
/**
* 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);
/**
* Quiesce any core specific resources consumed by the event port
*
* @param dev
* Event device pointer.
* @param port
* Event port pointer.
* @param flush_cb
* User-provided event flush function.
* @param args
* Arguments to be passed to the user-provided event flush function.
*/
typedef void (*eventdev_port_quiesce_t)(struct rte_eventdev *dev, void *port,
rte_eventdev_port_flush_t flush_cb,
void *args);
/**
* Link multiple source event queues to destination event port.
*
* @param dev
* Event device pointer
* @param port
* Event port pointer
* @param queues
* 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);
/**
* Link multiple source event queues associated with a link profile to a
* destination event port.
*
* @param dev
* Event device pointer
* @param port
* Event port pointer
* @param queues
* 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.
* @param profile_id
* The profile ID to associate the links.
*
* @return
* Returns 0 on success.
*/
typedef int (*eventdev_port_link_profile_t)(struct rte_eventdev *dev, void *port,
const uint8_t queues[], const uint8_t priorities[],
uint16_t nb_links, uint8_t profile_id);
/**
* 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);
/**
* Unlink multiple source event queues associated with a link profile 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
* @param profile_id
* The profile ID of the associated links.
*
* @return
* Returns 0 on success.
*/
typedef int (*eventdev_port_unlink_profile_t)(struct rte_eventdev *dev, void *port,
uint8_t queues[], uint16_t nb_unlinks,
uint8_t profile_id);
/**
* Unlinks in progress. Returns number of unlinks that the PMD is currently
* performing, but have not yet been completed.
*
* @param dev
* Event device pointer
*
* @param port
* Event port pointer
*
* @return
* Returns the number of in-progress unlinks. Zero is returned if none are
* in progress.
*/
typedef int (*eventdev_port_unlinks_in_progress_t)(struct rte_eventdev *dev,
void *port);
/**
* 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 mode
* Level (device, port or queue)
* @param queue_port_id
* Queue or port number depending on mode
* @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 uint64_t 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 uint64_t ids[],
uint32_t nb_ids);
/**
* Get names of extended stats of an event device
*
* @param dev
* Event device pointer
* @param mode
* Level (device, port or queue)
* @param queue_port_id
* Queue or port number depending on mode
* @param xstats_names
* Array of name values to be filled in
* @param ids
* The stat ids to retrieve
* @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,
uint64_t *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, uint64_t *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;
/**
* Retrieve the event device's timer adapter capabilities, as well as the ops
* structure that an event timer adapter should call through to enter the
* driver
*
* @param dev
* Event device pointer
*
* @param flags
* Flags that can be used to determine how to select an event timer
* adapter ops structure
*
* @param[out] caps
* A pointer to memory filled with Rx event adapter capabilities.
*
* @param[out] ops
* A pointer to the ops pointer to set with the address of the desired ops
* structure
*
* @return
* - 0: Success, driver provides Rx event adapter capabilities for the
* ethernet device.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_timer_adapter_caps_get_t)(
const struct rte_eventdev *dev, uint64_t flags, uint32_t *caps,
const struct event_timer_adapter_ops **ops);
/**
* 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);
/**
* Add ethernet Rx queues to event device in burst. 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 array
*
* @param queue_conf
* Additional configuration structure array
*
* @param nb_rx_queues
* Number of ethernet device receive queues
*
* @return
* - 0: Success, ethernet receive queues added successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_eth_rx_adapter_queues_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[],
uint16_t nb_rx_queues);
/**
* 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);
/**
* Retrieve Rx adapter queue config information for the specified
* rx queue ID.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param rx_queue_id
* Ethernet device receive queue index.
*
* @param[out] queue_conf
* Pointer to rte_event_eth_rx_adapter_queue_conf structure
*
* @return
* - 0: Success
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_rx_adapter_queue_conf_get_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
uint16_t rx_queue_id,
struct rte_event_eth_rx_adapter_queue_conf *queue_conf);
/**
* 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;
/**
* 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);
struct rte_event_eth_rx_adapter_queue_stats;
/**
* Retrieve ethernet Rx adapter queue statistics.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param rx_queue_id
* Ethernet device receive queue index.
*
* @param[out] q_stats
* Pointer to queue stats structure
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_eth_rx_adapter_q_stats_get)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
uint16_t rx_queue_id,
struct rte_event_eth_rx_adapter_queue_stats *q_stats);
/**
* Reset ethernet Rx adapter queue statistics.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param rx_queue_id
* Ethernet device receive queue index.
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_eth_rx_adapter_q_stats_reset)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
uint16_t rx_queue_id);
/**
* Start eventdev selftest.
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_selftest)(void);
struct rte_event_eth_rx_adapter_vector_limits;
/**
* Get event vector limits for a given event, ethernet device pair.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param[out] limits
* Pointer to the limits structure to be filled.
*
* @return
* - 0: Success.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_eth_rx_adapter_vector_limits_get_t)(
const struct rte_eventdev *dev, const struct rte_eth_dev *eth_dev,
struct rte_event_eth_rx_adapter_vector_limits *limits);
/**
* Get Rx adapter instance ID for Rx queue
*
* @param eth_dev_id
* Port identifier of ethernet device
*
* @param rx_queue_id
* Ethernet device Rx queue index
*
* @param[out] rxa_inst_id
* Pointer to Rx adapter instance identifier.
* Contains valid Rx adapter instance ID when return value is 0
*
* @return
* - 0: Success
* - <0: Error code on failure
*/
typedef int (*eventdev_eth_rx_adapter_instance_get_t)
(uint16_t eth_dev_id, uint16_t rx_queue_id, uint8_t *rxa_inst_id);
typedef uint32_t rte_event_pmd_selftest_seqn_t;
extern int rte_event_pmd_selftest_seqn_dynfield_offset;
/**
* Read test sequence number from mbuf.
*
* @param mbuf Structure to read from.
* @return pointer to test sequence number.
*/
__rte_internal
static inline rte_event_pmd_selftest_seqn_t *
rte_event_pmd_selftest_seqn(struct rte_mbuf *mbuf)
{
return RTE_MBUF_DYNFIELD(mbuf,
rte_event_pmd_selftest_seqn_dynfield_offset,
rte_event_pmd_selftest_seqn_t *);
}
struct rte_cryptodev;
struct rte_event_crypto_adapter_queue_conf;
/**
* This API may change without prior notice
*
* Retrieve the event device's crypto adapter capabilities for the
* specified cryptodev
*
* @param dev
* Event device pointer
*
* @param cdev
* cryptodev pointer
*
* @param[out] caps
* A pointer to memory filled with event adapter capabilities.
* It is expected to be pre-allocated & initialized by caller.
*
* @return
* - 0: Success, driver provides event adapter capabilities for the
* cryptodev.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_caps_get_t)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev,
uint32_t *caps);
/**
* This API may change without prior notice
*
* Add crypto queue pair to event device. This callback is invoked if
* the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id)
* has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.
*
* @param dev
* Event device pointer
*
* @param cdev
* cryptodev pointer
*
* @param queue_pair_id
* cryptodev queue pair identifier.
*
* @param event
* Event information required for binding cryptodev queue pair to event queue.
* This structure will have a valid value for only those HW PMDs supporting
* @see RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND capability.
*
* @return
* - 0: Success, cryptodev queue pair added successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_queue_pair_add_t)(
const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev,
int32_t queue_pair_id,
const struct rte_event_crypto_adapter_queue_conf *queue_conf);
/**
* This API may change without prior notice
*
* Delete crypto queue pair to event device. This callback is invoked if
* the caps returned from rte_event_crypto_adapter_caps_get(, cdev_id)
* has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set.
*
* @param dev
* Event device pointer
*
* @param cdev
* cryptodev pointer
*
* @param queue_pair_id
* cryptodev queue pair identifier.
*
* @return
* - 0: Success, cryptodev queue pair deleted successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_queue_pair_del_t)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev,
int32_t queue_pair_id);
/**
* Start crypto adapter. This callback is invoked if
* the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id)
* has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs
* from cdev_id have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param cdev
* Crypto device pointer
*
* @return
* - 0: Success, crypto adapter started successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_start_t)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev);
/**
* Stop crypto adapter. This callback is invoked if
* the caps returned from rte_event_crypto_adapter_caps_get(.., cdev_id)
* has RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_* set and queue pairs
* from cdev_id have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param cdev
* Crypto device pointer
*
* @return
* - 0: Success, crypto adapter stopped successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_stop_t)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev);
struct rte_event_crypto_adapter_stats;
/**
* Retrieve crypto adapter statistics.
*
* @param dev
* Event device pointer
*
* @param cdev
* Crypto device pointer
*
* @param[out] stats
* Pointer to stats structure
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_crypto_adapter_stats_get)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev,
struct rte_event_crypto_adapter_stats *stats);
/**
* Reset crypto adapter statistics.
*
* @param dev
* Event device pointer
*
* @param cdev
* Crypto device pointer
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_crypto_adapter_stats_reset)
(const struct rte_eventdev *dev,
const struct rte_cryptodev *cdev);
struct rte_event_crypto_adapter_vector_limits;
/**
* Get event vector limits for a given event, crypto device pair.
*
* @param dev
* Event device pointer
*
* @param cdev
* Crypto device pointer
*
* @param[out] limits
* Pointer to the limits structure to be filled.
*
* @return
* - 0: Success.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_crypto_adapter_vector_limits_get_t)(
const struct rte_eventdev *dev, const struct rte_cryptodev *cdev,
struct rte_event_crypto_adapter_vector_limits *limits);
/**
* Retrieve the event device's eth Tx adapter capabilities.
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param[out] caps
* A pointer to memory filled with eth Tx adapter capabilities.
*
* @return
* - 0: Success, driver provides eth Tx adapter capabilities
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_eth_tx_adapter_caps_get_t)
(const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
uint32_t *caps);
/**
* Create adapter callback.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @return
* - 0: Success.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_create_t)(uint8_t id,
const struct rte_eventdev *dev);
/**
* Free adapter callback.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @return
* - 0: Success.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_free_t)(uint8_t id,
const struct rte_eventdev *dev);
/**
* Add a Tx queue to the adapter.
* A queue value of -1 is used to indicate all
* queues within the device.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param tx_queue_id
* Transmit queue index
*
* @return
* - 0: Success.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_queue_add_t)(
uint8_t id,
const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
int32_t tx_queue_id);
/**
* Delete a Tx queue from the adapter.
* A queue value of -1 is used to indicate all
* queues within the device, that have been added to this
* adapter.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @param eth_dev
* Ethernet device pointer
*
* @param tx_queue_id
* Transmit queue index
*
* @return
* - 0: Success, Queues deleted successfully.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_queue_del_t)(
uint8_t id,
const struct rte_eventdev *dev,
const struct rte_eth_dev *eth_dev,
int32_t tx_queue_id);
/**
* Start the adapter.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @return
* - 0: Success, Adapter started correctly.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_start_t)(uint8_t id,
const struct rte_eventdev *dev);
/**
* Stop the adapter.
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @return
* - 0: Success.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_stop_t)(uint8_t id,
const struct rte_eventdev *dev);
struct rte_event_eth_tx_adapter_stats;
/**
* Retrieve statistics for an adapter
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @param [out] stats
* A pointer to structure used to retrieve statistics for an adapter
*
* @return
* - 0: Success, statistics retrieved successfully.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_stats_get_t)(
uint8_t id,
const struct rte_eventdev *dev,
struct rte_event_eth_tx_adapter_stats *stats);
/**
* Reset statistics for an adapter
*
* @param id
* Adapter identifier
*
* @param dev
* Event device pointer
*
* @return
* - 0: Success, statistics retrieved successfully.
* - <0: Error code on failure.
*/
typedef int (*eventdev_eth_tx_adapter_stats_reset_t)(uint8_t id,
const struct rte_eventdev *dev);
/**
* Get TX adapter instance ID for Tx queue
*
* @param eth_dev_id
* Port identifier of Ethernet device
*
* @param tx_queue_id
* Ethernet device Tx queue index
*
* @param[out] txa_inst_id
* Pointer to Tx adapter instance identifier
* Contains valid Tx adapter instance ID when return value is 0
*
* @return
* - 0: Success
* - <0: Error code on failure
*/
typedef int (*eventdev_eth_tx_adapter_instance_get_t)
(uint16_t eth_dev_id, uint16_t tx_queue_id, uint8_t *txa_inst_id);
/**
* Start a Tx queue that is assigned to Tx adapter instance
*
* @param id
* Adapter identifier
*
* @param eth_dev_id
* Port identifier of Ethernet device
*
* @param tx_queue_id
* Ethernet device Tx queue index
*
* @return
* - 0: Success
* - <0: Error code on failure
*/
typedef int (*eventdev_eth_tx_adapter_queue_start)
(uint8_t id, uint16_t eth_dev_id, uint16_t tx_queue_id);
/**
* Stop a Tx queue that is assigned to Tx adapter instance
*
* @param id
* Adapter identifier
*
* @param eth_dev_id
* Port identifier of Ethernet device
*
* @param tx_queue_id
* Ethernet device Tx queue index
*
* @return
* - 0: Success
* - <0: Error code on failure
*/
typedef int (*eventdev_eth_tx_adapter_queue_stop)
(uint8_t id, uint16_t eth_dev_id, uint16_t tx_queue_id);
#define eventdev_stop_flush_t rte_eventdev_stop_flush_t
/**
* Retrieve the event device's DMA adapter capabilities for the
* specified DMA device
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @param[out] caps
* A pointer to memory filled with event adapter capabilities.
* It is expected to be pre-allocated & initialized by caller.
*
* @return
* - 0: Success, driver provides event adapter capabilities for the
* dmadev.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_dma_adapter_caps_get_t)(const struct rte_eventdev *dev,
const int16_t dma_dev_id, uint32_t *caps);
/**
* Add DMA vchan queue to event device. This callback is invoked if
* the caps returned from rte_event_dma_adapter_caps_get(, dmadev_id)
* has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @param vchan_id
* dmadev vchan queue identifier.
*
* @param event
* Event information required for binding dmadev vchan to event queue.
* This structure will have a valid value for only those HW PMDs supporting
* @see RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_VCHAN_EV_BIND capability.
*
* @return
* - 0: Success, dmadev vchan added successfully.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_dma_adapter_vchan_add_t)(const struct rte_eventdev *dev,
const int16_t dma_dev_id,
uint16_t vchan_id,
const struct rte_event *event);
/**
* Delete DMA vhcan to event device. This callback is invoked if
* the caps returned from rte_event_dma_adapter_caps_get(, dmadev_id)
* has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @param vchan_id
* dmadev vchan identifier.
*
* @return
* - 0: Success, dmadev vchan deleted successfully.
* - <0: Error code returned by the driver function.
*
*/
typedef int (*eventdev_dma_adapter_vchan_del_t)(const struct rte_eventdev *dev,
const int16_t dma_dev_id,
uint16_t vchan_id);
/**
* Start DMA adapter. This callback is invoked if
* the caps returned from rte_event_dma_adapter_caps_get(.., dmadev_id)
* has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set and vchan for dmadev_id
* have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @return
* - 0: Success, DMA adapter started successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_dma_adapter_start_t)(const struct rte_eventdev *dev,
const int16_t dma_dev_id);
/**
* Stop DMA adapter. This callback is invoked if
* the caps returned from rte_event_dma_adapter_caps_get(.., dmadev_id)
* has RTE_EVENT_DMA_ADAPTER_CAP_INTERNAL_PORT_* set and vchan for dmadev_id
* have been added to the event device.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @return
* - 0: Success, DMA adapter stopped successfully.
* - <0: Error code returned by the driver function.
*/
typedef int (*eventdev_dma_adapter_stop_t)(const struct rte_eventdev *dev,
const int16_t dma_dev_id);
struct rte_event_dma_adapter_stats;
/**
* Retrieve DMA adapter statistics.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @param[out] stats
* Pointer to stats structure
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_dma_adapter_stats_get)(const struct rte_eventdev *dev,
const int16_t dma_dev_id,
struct rte_event_dma_adapter_stats *stats);
/**
* Reset DMA adapter statistics.
*
* @param dev
* Event device pointer
*
* @param dma_dev_id
* DMA device identifier
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_dma_adapter_stats_reset)(const struct rte_eventdev *dev,
const int16_t dma_dev_id);
/**
* Event device vector adapter capabilities.
*
* @param dev
* Event device pointer
* @param caps
* Vector adapter capabilities
* @param ops
* Vector adapter ops
*
* @return
* Return 0 on success.
*
*/
typedef int (*eventdev_vector_adapter_caps_get_t)(const struct rte_eventdev *dev, uint32_t *caps,
const struct event_vector_adapter_ops **ops);
/**
* Event device vector adapter info.
*
* @param dev
* Event device pointer
* @param info
* Vector adapter info
*
* @return
* Return 0 on success.
*/
typedef int (*eventdev_vector_adapter_info_get_t)(const struct rte_eventdev *dev,
struct rte_event_vector_adapter_info *info);
/** Event device operations function pointer table */
struct 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_queue_attr_set_t queue_attr_set;
/**< Set an event queue attribute. */
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_quiesce_t port_quiesce;
/**< Quiesce an event port. */
eventdev_port_link_t port_link;
/**< Link event queues to an event port. */
eventdev_port_link_profile_t port_link_profile;
/**< Link event queues associated with a profile to an event port. */
eventdev_port_unlink_t port_unlink;
/**< Unlink event queues from an event port. */
eventdev_port_unlink_profile_t port_unlink_profile;
/**< Unlink event queues associated with a profile from an event port. */
eventdev_port_unlinks_in_progress_t port_unlinks_in_progress;
/**< Unlinks in progress on 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_queues_add_t eth_rx_adapter_queues_add;
/**< Add Rx queues to ethernet Rx adapter in burst */
eventdev_eth_rx_adapter_queue_del_t eth_rx_adapter_queue_del;
/**< Delete Rx queues from ethernet Rx adapter */
eventdev_eth_rx_adapter_queue_conf_get_t eth_rx_adapter_queue_conf_get;
/**< Get Rx adapter queue info */
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 */
eventdev_eth_rx_adapter_vector_limits_get_t
eth_rx_adapter_vector_limits_get;
/**< Get event vector limits for the Rx adapter */
eventdev_eth_rx_adapter_instance_get_t eth_rx_adapter_instance_get;
/**< Get Rx adapter instance ID for Rx queue */
eventdev_timer_adapter_caps_get_t timer_adapter_caps_get;
/**< Get timer adapter capabilities */
eventdev_crypto_adapter_caps_get_t crypto_adapter_caps_get;
/**< Get crypto adapter capabilities */
eventdev_crypto_adapter_queue_pair_add_t crypto_adapter_queue_pair_add;
/**< Add queue pair to crypto adapter */
eventdev_crypto_adapter_queue_pair_del_t crypto_adapter_queue_pair_del;
/**< Delete queue pair from crypto adapter */
eventdev_crypto_adapter_start_t crypto_adapter_start;
/**< Start crypto adapter */
eventdev_crypto_adapter_stop_t crypto_adapter_stop;
/**< Stop crypto adapter */
eventdev_crypto_adapter_stats_get crypto_adapter_stats_get;
/**< Get crypto stats */
eventdev_crypto_adapter_stats_reset crypto_adapter_stats_reset;
/**< Reset crypto stats */
eventdev_crypto_adapter_vector_limits_get_t
crypto_adapter_vector_limits_get;
/**< Get event vector limits for the crypto adapter */
eventdev_eth_rx_adapter_q_stats_get eth_rx_adapter_queue_stats_get;
/**< Get ethernet Rx queue stats */
eventdev_eth_rx_adapter_q_stats_reset eth_rx_adapter_queue_stats_reset;
/**< Reset ethernet Rx queue stats */
eventdev_eth_tx_adapter_caps_get_t eth_tx_adapter_caps_get;
/**< Get ethernet Tx adapter capabilities */
eventdev_eth_tx_adapter_create_t eth_tx_adapter_create;
/**< Create adapter callback */
eventdev_eth_tx_adapter_free_t eth_tx_adapter_free;
/**< Free adapter callback */
eventdev_eth_tx_adapter_queue_add_t eth_tx_adapter_queue_add;
/**< Add Tx queues to the eth Tx adapter */
eventdev_eth_tx_adapter_queue_del_t eth_tx_adapter_queue_del;
/**< Delete Tx queues from the eth Tx adapter */
eventdev_eth_tx_adapter_start_t eth_tx_adapter_start;
/**< Start eth Tx adapter */
eventdev_eth_tx_adapter_stop_t eth_tx_adapter_stop;
/**< Stop eth Tx adapter */
eventdev_eth_tx_adapter_stats_get_t eth_tx_adapter_stats_get;
/**< Get eth Tx adapter statistics */
eventdev_eth_tx_adapter_stats_reset_t eth_tx_adapter_stats_reset;
/**< Reset eth Tx adapter statistics */
eventdev_eth_tx_adapter_instance_get_t eth_tx_adapter_instance_get;
/**< Get Tx adapter instance ID for Tx queue */
eventdev_eth_tx_adapter_queue_start eth_tx_adapter_queue_start;
/**< Start Tx queue assigned to Tx adapter instance */
eventdev_eth_tx_adapter_queue_stop eth_tx_adapter_queue_stop;
/**< Stop Tx queue assigned to Tx adapter instance */
eventdev_dma_adapter_caps_get_t dma_adapter_caps_get;
/**< Get DMA adapter capabilities */
eventdev_dma_adapter_vchan_add_t dma_adapter_vchan_add;
/**< Add vchan queue to DMA adapter */
eventdev_dma_adapter_vchan_del_t dma_adapter_vchan_del;
/**< Delete vchan queue from DMA adapter */
eventdev_dma_adapter_start_t dma_adapter_start;
/**< Start DMA adapter */
eventdev_dma_adapter_stop_t dma_adapter_stop;
/**< Stop DMA adapter */
eventdev_dma_adapter_stats_get dma_adapter_stats_get;
/**< Get DMA stats */
eventdev_dma_adapter_stats_reset dma_adapter_stats_reset;
/**< Reset DMA stats */
eventdev_vector_adapter_caps_get_t vector_adapter_caps_get;
/**< Get vector adapter capabilities */
eventdev_vector_adapter_info_get_t vector_adapter_info_get;
/**< Get vector adapter info */
eventdev_selftest dev_selftest;
/**< Start eventdev Selftest */
eventdev_stop_flush_t dev_stop_flush;
/**< User-provided event flush function */
};
/**
* 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;
*/
__rte_internal
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
*/
__rte_internal
int
rte_event_pmd_release(struct rte_eventdev *eventdev);
/**
*
* @internal
* This is the last step of device probing.
* It must be called after a port is allocated and initialized successfully.
*
* @param eventdev
* New event device.
*/
__rte_internal
void
event_dev_probing_finish(struct rte_eventdev *eventdev);
/**
* Reset eventdevice fastpath APIs to dummy values.
*
* @param fp_ops
* The *fp_ops* pointer to reset.
*/
__rte_internal
void
event_dev_fp_ops_reset(struct rte_event_fp_ops *fp_op);
/**
* Set eventdevice fastpath APIs to event device values.
*
* @param fp_ops
* The *fp_ops* pointer to set.
*/
__rte_internal
void
event_dev_fp_ops_set(struct rte_event_fp_ops *fp_ops,
const struct rte_eventdev *dev);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_EVENTDEV_PMD_H_ */
|