aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api/spec/event.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/odp/api/spec/event.h')
-rw-r--r--include/odp/api/spec/event.h79
1 files changed, 3 insertions, 76 deletions
diff --git a/include/odp/api/spec/event.h b/include/odp/api/spec/event.h
index dc99f35c7..c36d9cef1 100644
--- a/include/odp/api/spec/event.h
+++ b/include/odp/api/spec/event.h
@@ -1,4 +1,5 @@
/* Copyright (c) 2015-2018, Linaro Limited
+ * Copyright (c) 2022, Nokia
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
@@ -18,7 +19,8 @@
extern "C" {
#endif
-#include <odp/api/packet.h>
+#include <odp/api/event_types.h>
+#include <odp/api/packet_types.h>
/** @defgroup odp_event ODP EVENT
* Generic event metadata and operations.
@@ -26,81 +28,6 @@ extern "C" {
*/
/**
- * @typedef odp_event_t
- * ODP event
- */
-
-/**
- * @def ODP_EVENT_INVALID
- * Invalid event
- */
-
-/**
- * @typedef odp_event_type_t
- * Event type
- *
- * Event type specifies purpose and general format of an event. It can be
- * checked with odp_event_type() or odp_event_types(). Each event type has
- * functions (e.g. odp_buffer_from_event()) to convert between the generic event
- * handle (odp_event_t) and the type specific handle (e.g. odp_buffer_t).
- * Results are undefined, if conversion function of a wrong event type is used.
- * Application cannot change event type by chaining conversion functions.
- *
- * List of event types:
- * - ODP_EVENT_BUFFER
- * - Buffer event (odp_buffer_t) for simple data storage and message passing
- * - ODP_EVENT_PACKET
- * - Packet event (odp_packet_t) containing packet data and plenty of
- * packet processing related metadata
- * - ODP_EVENT_TIMEOUT
- * - Timeout event (odp_timeout_t) from a timer
- * - ODP_EVENT_CRYPTO_COMPL
- * - Crypto completion event (odp_crypto_compl_t)
- * - ODP_EVENT_IPSEC_STATUS
- * - IPSEC status update event (odp_ipsec_status_t)
- * - ODP_EVENT_PACKET_VECTOR
- * - Vector of packet events (odp_packet_t) as odp_packet_vector_t
- * - ODP_EVENT_PACKET_TX_COMPL
- * - Packet Tx completion event (odp_packet_tx_compl_t) generated as a result of a Packet Tx
- * completion.
- * - ODP_EVENT_DMA_COMPL
- * - DMA completion event (odp_dma_compl_t) indicates that a DMA transfer has finished
- */
-
-/**
- * @typedef odp_event_subtype_t
- * Event subtype
- *
- * Event subtype expands event type specification by providing more detailed
- * purpose and format of an event. It can be checked with odp_event_subtype() or
- * odp_event_types(). Each event subtype may define specific functions
- * (e.g. odp_ipsec_packet_from_event()) to convert between the generic event
- * handle (odp_event_t) and event type specific handle (e.g. odp_packet_t). When
- * subtype is known, these subtype specific functions should be preferred over
- * the event type general function (e.g. odp_packet_from_event()). Results are
- * undefined, if conversion function of a wrong event subtype is used.
- * Application cannot change event subtype by chaining conversion functions.
- *
- * List of event subtypes:
- * - ODP_EVENT_PACKET_BASIC
- * - Packet event (odp_packet_t) with basic packet metadata
- * - ODP_EVENT_PACKET_COMP
- * - Packet event (odp_packet_t) generated as a result of a compression/
- * decompression operation. It contains compression specific metadata in
- * addition to the basic packet metadata.
- * - ODP_EVENT_PACKET_CRYPTO
- * - Packet event (odp_packet_t) generated as a result of a Crypto
- * operation. It contains crypto specific metadata in addition to the
- * basic packet metadata.
- * - ODP_EVENT_PACKET_IPSEC
- * - Packet event (odp_packet_t) generated as a result of an IPsec
- * operation. It contains IPSEC specific metadata in addition to the basic
- * packet metadata.
- * - ODP_EVENT_NO_SUBTYPE
- * - An event type does not have any subtypes defined
- */
-
-/**
* Event type of an event
*
* Event type specifies purpose and general format of an event.