[API-NEXT,v6,1/2] api: pool: add min and max headroom in capability

Message ID 1504702829-13921-2-git-send-email-odpbot@yandex.ru
State Superseded
Headers show
Series
  • [API-NEXT,v6,1/2] api: pool: add min and max headroom in capability
Related show

Commit Message

Github ODP bot Sept. 6, 2017, 1 p.m.
From: Balasubramanian Manoharan <bala.manoharan@linaro.org>


Adds pool minimum and maximum headroom in pool capability

Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org>

---
/** Email created from pull request 152 (bala-manoharan:pool_headroom)
 ** https://github.com/Linaro/odp/pull/152
 ** Patch: https://github.com/Linaro/odp/pull/152.patch
 ** Base sha: 4eae04e80a634c17ac276bb06bce468cbe28cde0
 ** Merge commit sha: 998193a656d35d26c49f1c5b6254d75f5eab0974
 **/
 include/odp/api/spec/pool.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Patch

diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h
index 6fc5b6b4..164ae25e 100644
--- a/include/odp/api/spec/pool.h
+++ b/include/odp/api/spec/pool.h
@@ -97,6 +97,13 @@  typedef struct odp_pool_capability_t {
 		 * packet input and user allocated packets.*/
 		uint32_t min_headroom;
 
+		/** Maximum packet level headroom length in bytes
+		 *
+		 * The maximum value of packet pool 'min_headroom' parameter
+		 * that can be configured. This value applies to both ODP
+		 * packet input and user allocated packets.*/
+		uint32_t max_headroom;
+
 		/** Minimum packet level tailroom length in bytes
 		 *
 		 * The minimum number of tailroom bytes that newly created
@@ -214,6 +221,17 @@  typedef struct odp_pool_param_t {
 			    defined by pool capability pkt.max_uarea_size.
 			    Specify as 0 if no user area is needed. */
 			uint32_t uarea_size;
+
+			/** Minimum Headroom size in bytes. Minimum number of
+			    bytes of space preceding packet data to reserve for
+			    use as headroom. Each newly allocated packet from
+			    the pool must have at least this much headroom.
+			    Must not exceed the implementation defined
+			    'max_headroom' in odp_pool_capability().
+			    @note If application does not require headroom it
+			    can configure 'min_headroom' as zero and
+			    implementation may or may not allocate headroom. */
+			uint32_t min_headroom;
 		} pkt;
 
 		/** Parameters for timeout pools */