diff options
author | Christophe Milard <christophe.milard@linaro.org> | 2016-02-11 15:21:41 +0100 |
---|---|---|
committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-03-04 11:15:23 +0300 |
commit | 98e20f0a78da6bf680ffbf473abc99b88d8576d9 (patch) | |
tree | 6715608e902d887a5070040eac8f62c8edc6b8a7 /include/odp/api/buffer.h | |
parent | 307ad1208bc59e03425468eebe8cffdf09ccb669 (diff) |
api and linux-generic: make room for new api
This is about making the current structure clearer so that other
interfaces can be added to ODP:
The ODP API specification (platform agnostic) is moved from
include/odp/api to include/odp/api/spec.
The ODP API platform definition (for linux generic) is moved from
platform/linux-generic/include/odp to
platform/linux-generic/include/odp/api
Include statements are adjusted accordinaly.
This patch has been done by a script which is given with the cover-letter
of this patch series.
Signed-off-by: Christophe Milard <christophe.milard@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api/buffer.h')
-rw-r--r-- | include/odp/api/buffer.h | 170 |
1 files changed, 0 insertions, 170 deletions
diff --git a/include/odp/api/buffer.h b/include/odp/api/buffer.h deleted file mode 100644 index 6631f478c..000000000 --- a/include/odp/api/buffer.h +++ /dev/null @@ -1,170 +0,0 @@ -/* Copyright (c) 2013, Linaro Limited - * All rights reserved. - * - * SPDX-License-Identifier: BSD-3-Clause - */ - - -/** - * @file - * - * ODP buffer descriptor - */ - -#ifndef ODP_API_BUFFER_H_ -#define ODP_API_BUFFER_H_ - -#ifdef __cplusplus -extern "C" { -#endif - - -/** @defgroup odp_buffer ODP BUFFER - * Operations on a buffer. - * @{ - */ - -/** - * @typedef odp_buffer_t - * ODP buffer - */ - -/** - * @def ODP_BUFFER_INVALID - * Invalid buffer - */ - -/** - * 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); - -/** - * Buffer alloc - * - * The validity of a buffer can be cheked at any time with odp_buffer_is_valid() - * @param pool Pool handle - * - * @return Handle of allocated buffer - * @retval ODP_BUFFER_INVALID Buffer could not be allocated - */ -odp_buffer_t odp_buffer_alloc(odp_pool_t pool); - -/** - * Allocate multiple buffers - - * Otherwise like odp_buffer_alloc(), but allocates multiple buffers from a pool - * - * @param pool Pool handle - * @param[out] buf Array of buffer handles for output - * @param num Maximum number of buffers to allocate - * - * @return Number of buffers actually allocated (0 ... num) - * @retval <0 on failure - */ -int odp_buffer_alloc_multi(odp_pool_t pool, odp_buffer_t buf[], int num); - -/** - * Buffer free - * - * @param buf Buffer handle - * - */ -void odp_buffer_free(odp_buffer_t buf); - -/** - * Free multiple buffers - * - * Otherwise like odp_buffer_free(), but frees multiple buffers - * to their originating pools. - * - * @param buf Array of buffer handles - * @param num Number of buffer handles to free - * - */ -void odp_buffer_free_multi(const odp_buffer_t buf[], int num); - -/** - * Print buffer metadata to STDOUT - * - * @param buf Buffer handle - * - */ -void odp_buffer_print(odp_buffer_t buf); - -/** - * Get printable value for an odp_buffer_t - * - * @param hdl odp_buffer_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_buffer_t handle. - */ -uint64_t odp_buffer_to_u64(odp_buffer_t hdl); - -/** - * @} - */ - -#ifdef __cplusplus -} -#endif - -#endif |