diff mbox

[API-NEXT/PATCHv3,1/4] api: classification: add odp_cls_cos_pool_set() api

Message ID 1449130627-1234-1-git-send-email-bala.manoharan@linaro.org
State New
Headers show

Commit Message

Balasubramanian Manoharan Dec. 3, 2015, 8:17 a.m. UTC
odp_cls_cos_pool_set() api is used to configure packet pool to CoS.
The packets arriving at the CoS is allocated from the configured pool

Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org>
---
v3: Test Cases added to test pools associated with CoS

v2: Incorporates review comments from Stuart
 include/odp/api/classification.h | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

Comments

Balasubramanian Manoharan Dec. 3, 2015, 10:46 a.m. UTC | #1
I have sent V4 correcting the issues pointed above.

Regards,
Bala

On 3 December 2015 at 14:49, Savolainen, Petri (Nokia - FI/Espoo)
<petri.savolainen@nokia.com> wrote:
>
>
>> -----Original Message-----
>> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of EXT
>> Balasubramanian Manoharan
>> Sent: Thursday, December 03, 2015 10:17 AM
>> To: lng-odp@lists.linaro.org
>> Subject: [lng-odp] [API-NEXT/PATCHv3 1/4] api: classification: add
>> odp_cls_cos_pool_set() api
>>
>> odp_cls_cos_pool_set() api is used to configure packet pool to CoS.
>> The packets arriving at the CoS is allocated from the configured pool
>>
>> Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org>
>> ---
>> v3: Test Cases added to test pools associated with CoS
>>
>> v2: Incorporates review comments from Stuart
>>  include/odp/api/classification.h | 28 ++++++++++++++++++++++++++++
>>  1 file changed, 28 insertions(+)
>>
>> diff --git a/include/odp/api/classification.h
>> b/include/odp/api/classification.h
>> index 380d91b..137ac21 100644
>> --- a/include/odp/api/classification.h
>> +++ b/include/odp/api/classification.h
>> @@ -379,6 +379,34 @@ int odp_pktio_pmr_match_set_cos(odp_pmr_set_t
>> pmr_set_id, odp_pktio_t src_pktio,
>>                               odp_cos_t dst_cos);
>>
>>  /**
>> +* Assigns a packet buffer pool for a specific Class of service.
>
>
> Use term "packet pool", instead of "packet buffer pool".
>
> Also it would be nice to use only one format of CoS: Class of service, class of service, class-of-service
>
> Preferably: Class of Service == CoS.
>
>
>
>> +* All the packets belonging to the given class of service will
>> +* be allocated from the assigned packet pool.
>> +*
>> +* @param     cos_id  class-of-service handle
>> +* @param     pool_id Packet buffer pool handle
>
> Packet pool...
>
>
>> +*
>> +* @return    0 on success
>> +* @return    <0 on failure
>
> Both @return should be @retval
>
>
>> +*
>> +* @note              The packet pool associated with CoS will supersede
>> +*            the packet pool associated with the pktio interface
>
> This is the main functionality of the API call. @note tag is not needed and the sentence should be moved to the main part of the documentation.
>
>
>
>> +*/
>> +int odp_cls_cos_pool_set(odp_cos_t cos_id, odp_pool_t pool_id);
>> +
>> +/**
>> +* Get the pool associated with the given class of service
>> +*
>> +* @param     cos_id  class-of-service handle
>> +*
>> +* @retval    pool handle of the associated pool
>> +* @retval    ODP_POO_INVALID if no associated pool found or
>
> Typo: ODP_POOL_INVALID
>
>
> -Petri
>
>
>> +             incase of an error
>> +*
>> +*/
>> +odp_pool_t odp_cls_cos_pool(odp_cos_t cos_id);
>> +
>> +/**
>>   * Get printable value for an odp_cos_t
>>   *
>>   * @param hdl  odp_cos_t handle to be printed
>> --
>> 1.9.1
>>
>> _______________________________________________
>> lng-odp mailing list
>> lng-odp@lists.linaro.org
>> https://lists.linaro.org/mailman/listinfo/lng-odp
diff mbox

Patch

diff --git a/include/odp/api/classification.h b/include/odp/api/classification.h
index 380d91b..137ac21 100644
--- a/include/odp/api/classification.h
+++ b/include/odp/api/classification.h
@@ -379,6 +379,34 @@  int odp_pktio_pmr_match_set_cos(odp_pmr_set_t pmr_set_id, odp_pktio_t src_pktio,
 				odp_cos_t dst_cos);
 
 /**
+* Assigns a packet buffer pool for a specific Class of service.
+* All the packets belonging to the given class of service will
+* be allocated from the assigned packet pool.
+*
+* @param	cos_id	class-of-service handle
+* @param	pool_id	Packet buffer pool handle
+*
+* @return	0 on success
+* @return	<0 on failure
+*
+* @note		The packet pool associated with CoS will supersede
+*		the packet pool associated with the pktio interface
+*/
+int odp_cls_cos_pool_set(odp_cos_t cos_id, odp_pool_t pool_id);
+
+/**
+* Get the pool associated with the given class of service
+*
+* @param	cos_id	class-of-service handle
+*
+* @retval	pool handle of the associated pool
+* @retval	ODP_POO_INVALID if no associated pool found or
+		incase of an error
+*
+*/
+odp_pool_t odp_cls_cos_pool(odp_cos_t cos_id);
+
+/**
  * Get printable value for an odp_cos_t
  *
  * @param hdl  odp_cos_t handle to be printed