blob: f1d60a5bf0f652cc339551a9e7dd44ec5284719f (
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
|
/* Copyright (c) 2013, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP buffer descriptor
*/
#ifndef ODP_BUFFER_H_
#define ODP_BUFFER_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/std_types.h>
#include <odp/platform_types.h>
#include <odp/event.h>
/** @defgroup odp_buffer ODP BUFFER
* Operations on a buffer.
* @{
*/
/**
* @typedef odp_buffer_t
* ODP buffer
*/
/**
* @def ODP_BUFFER_INVALID
* Invalid buffer
*/
/**
* @typedef odp_buffer_seg_t
* ODP buffer segment
*/
/**
* @def ODP_SEGMENT_INVALID
* Invalid segment
*/
/**
* Get buffer handle from event
*
* Converts an ODP_EVENT_BUFFER type event to a buffer.
*
* @param ev Event handle
*
* @return Buffer handle
*
* @see odp_event_type()
*/
odp_buffer_t odp_buffer_from_event(odp_event_t ev);
/**
* Convert buffer handle to event
*
* @param buf Buffer handle
*
* @return Event handle
*/
odp_event_t odp_buffer_to_event(odp_buffer_t buf);
/**
* Buffer start address
*
* @param buf Buffer handle
*
* @return Buffer start address
*/
void *odp_buffer_addr(odp_buffer_t buf);
/**
* Buffer maximum data size
*
* @param buf Buffer handle
*
* @return Buffer maximum data size
*/
uint32_t odp_buffer_size(odp_buffer_t buf);
/**
* Tests if buffer is valid
*
* @param buf Buffer handle
*
* @retval 1 Buffer handle represents a valid buffer.
* @retval 0 Buffer handle does not represent a valid buffer.
*/
int odp_buffer_is_valid(odp_buffer_t buf);
/**
* Buffer pool of the buffer
*
* @param buf Buffer handle
*
* @return Handle of buffer pool buffer belongs to
*/
odp_pool_t odp_buffer_pool(odp_buffer_t buf);
/**
* Print buffer metadata to STDOUT
*
* @param buf Buffer handle
*
*/
void odp_buffer_print(odp_buffer_t buf);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
