blob: 2ad3ce84262f9fe6fbe50dac1791aa2274a77788 (
plain)
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
|
/* Copyright (c) 2015, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP event
*/
#ifndef ODP_API_EVENT_H_
#define ODP_API_EVENT_H_
#include <odp/visibility_begin.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @defgroup odp_event ODP EVENT
* Operations on an event.
* @{
*/
/**
* @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)
*/
/**
* @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_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.
*
* @param event Event handle
*
* @return Event type
*/
odp_event_type_t odp_event_type(odp_event_t event);
/**
* Event subtype of an event
*
* Event subtype expands event type specification by providing more detailed
* purpose and format of an event.
*
* @param event Event handle
*
* @return Event subtype
*/
odp_event_subtype_t odp_event_subtype(odp_event_t event);
/**
* Event type and subtype of an event
*
* Returns event type and outputs event subtype.
*
* @param event Event handle
* @param[out] subtype Pointer to event subtype for output
*
* @return Event type
*/
odp_event_type_t odp_event_types(odp_event_t event,
odp_event_subtype_t *subtype);
/**
* Get printable value for an odp_event_t
*
* @param hdl odp_event_t handle to be printed
* @return uint64_t value that can be used to print/display this
* handle
*
* @note This routine is intended to be used for diagnostic purposes
* to enable applications to generate a printable value that represents
* an odp_event_t handle.
*/
uint64_t odp_event_to_u64(odp_event_t hdl);
/**
* Free event
*
* Frees the event based on its type. Results are undefined if event
* type is unknown.
*
* @param event Event handle
*
*/
void odp_event_free(odp_event_t event);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <odp/visibility_end.h>
#endif
|
