This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "".

The branch, api-next has been updated via 0980001e33b4190133d478a0aa2e718fd1e3c164 (commit) via 297df8bbdd88a2104c6dd0f6c2e506eb5140dd1c (commit) via 32bd7464a8d86b0d83daf1760202dbdc5eabccec (commit) from cf7d38c194f1a9183a524790511de8bfd74a36a9 (commit)

Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below.

- Log ----------------------------------------------------------------- commit 0980001e33b4190133d478a0aa2e718fd1e3c164 Author: Petri Savolainen petri.savolainen@linaro.org Date: Mon Dec 4 14:45:55 2017 +0200

api: tm: remove param-in doxygen tag

All parameters are input only (tag [in]) by default. Output parameters are better highlighted, when only those are tagged.

Signed-off-by: Petri Savolainen petri.savolainen@linaro.org Reviewed-by: Bill Fischofer bill.fischofer@linaro.org Signed-off-by: Maxim Uvarov maxim.uvarov@linaro.org

diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h index c9134e8e..b956f002 100644 --- a/include/odp/api/spec/traffic_mngr.h +++ b/include/odp/api/spec/traffic_mngr.h @@ -484,8 +484,8 @@ typedef struct { * odp_tm_requirements_t record before it is first used or assigned to. * This is done to allow for vendor specific additions to this record. * - * @param[in] requirements A pointer to an odp_tm_requirements_t record which - * is to be initialized. + * @param requirements A pointer to an odp_tm_requirements_t record which + * is to be initialized. */ void odp_tm_requirements_init(odp_tm_requirements_t *requirements);

@@ -495,8 +495,8 @@ void odp_tm_requirements_init(odp_tm_requirements_t *requirements); * record before it is first used or assigned to. * This is done to allow for vendor specific additions to this record. * - * @param[in] egress A pointer to an odp_tm_egress_t record which - * is to be initialized. + * @param egress A pointer to an odp_tm_egress_t record which + * is to be initialized. */ void odp_tm_egress_init(odp_tm_egress_t *egress);

@@ -518,7 +518,7 @@ void odp_tm_egress_init(odp_tm_egress_t *egress); * * @param[out] capabilities An array of odp_tm_capabilities_t records to * be filled in. - * @param[in] capabilities_size The number of odp_tm_capabilities_t records + * @param capabilities_size The number of odp_tm_capabilities_t records * in the capabilities array. * @return Returns < 0 upon failure. Returns N > 0, * where N is the maximum number of different @@ -531,16 +531,16 @@ int odp_tm_capabilities(odp_tm_capabilities_t capabilities[],

/** Create/instantiate a TM Packet Scheduling system. * - * @param[in] name The name to be assigned to this TM system. Cannot - * be NULL, and also must be unique amongst all other - * TM system names. - * @param[in] requirements The minimum required feature set and limits needed - * by the ODP application. - * @param[in] egress Describes the single egress "spigot" of this - * TM system. - * @return Returns ODP_TM_INVALID upon failure, otherwise the - * newly created TM system's odp_tm_t handle is - * returned. + * @param name The name to be assigned to this TM system. Cannot + * be NULL, and also must be unique amongst all other + * TM system names. + * @param requirements The minimum required feature set and limits needed + * by the ODP application. + * @param egress Describes the single egress "spigot" of this + * TM system. + * @return Returns ODP_TM_INVALID upon failure, otherwise the + * newly created TM system's odp_tm_t handle is + * returned. */ odp_tm_t odp_tm_create(const char *name, odp_tm_requirements_t *requirements, @@ -558,21 +558,21 @@ odp_tm_t odp_tm_create(const char *name, * the existing (built-in or created by odp_tm_create) TM system that best * matches the requirements is returned. * - * @param[in] name If NULL then only uses the requirements parameter to - * find a closest match, otherwise if the name is - * matched by an existing TM system it is returned. - * @param[in] requirements Used when the name is NULL (in which case the - * closest match is returned) or when the name is - * not-NULL, but doesn't match any existing TM system - * in which case the requirements is used to find the - * FIRST TM system matching exactly these limits. - * @param[in] egress If a TM system is found, then this specifies the - * egress "spigot" to be associated with this TM - * system. - * @return If an existing TM system (built-in or previously - * created via odp_tm_create) is found, its - * odp_tm_t value is returned, otherwise - * ODP_TM_INVALID is returned. + * @param name If NULL then only uses the requirements parameter to + * find a closest match, otherwise if the name is + * matched by an existing TM system it is returned. + * @param requirements Used when the name is NULL (in which case the + * closest match is returned) or when the name is + * not-NULL, but doesn't match any existing TM system + * in which case the requirements is used to find the + * FIRST TM system matching exactly these limits. + * @param egress If a TM system is found, then this specifies the + * egress "spigot" to be associated with this TM + * system. + * @return If an existing TM system (built-in or previously + * created via odp_tm_create) is found, its + * odp_tm_t value is returned, otherwise + * ODP_TM_INVALID is returned. */ odp_tm_t odp_tm_find(const char *name, odp_tm_requirements_t *requirements, @@ -591,7 +591,7 @@ odp_tm_t odp_tm_find(const char *name, * In addition, ODP TM implementations should fail API requests that "exceed" * the limits or features contracted for in the requirements. * - * @param[in] odp_tm The odp_tm_t value of the TM system to be + * @param odp_tm The odp_tm_t value of the TM system to be * queried. * @param[out] capabilities A pointer to an odp_tm_capabilities_t record * where the actual limits used by the TM system are @@ -619,9 +619,9 @@ int odp_tm_capability(odp_tm_t odp_tm, odp_tm_capabilities_t *capabilities); * TM system, other than EVENTUALLY these packets will be either sent (in ANY * order) or freed. * - * @param[in] odp_tm The odp_tm_t value of the TM system to be destroyed (and - * hence destroyed (and hence freed). - * @return 0 upon success, < 0 upon failure. + * @param odp_tm The odp_tm_t value of the TM system to be destroyed (and + * hence destroyed (and hence freed). + * @return 0 upon success, < 0 upon failure. */ int odp_tm_destroy(odp_tm_t odp_tm);

@@ -640,13 +640,13 @@ int odp_tm_destroy(odp_tm_t odp_tm); * calls to this function with drop_eligible_enabled == FALSE - i.e. must * always return 0 when disabling this feature. * - * @param[in] odp_tm Odp_tm is used to identify the TM system - * whose egress behavior is being changed. - * @param[in] color The packet color whose egress marking is - * being changed. - * @param[in] drop_eligible_enabled If true then will set the DEI bit for - * egressed VLAN tagged pkts with this color. - * @return 0 upon success, < 0 upon failure. + * @param odp_tm Odp_tm is used to identify the TM system + * whose egress behavior is being changed. + * @param color The packet color whose egress marking is + * being changed. + * @param drop_eligible_enabled If true then will set the DEI bit for + * egressed VLAN tagged pkts with this color. + * @return 0 upon success, < 0 upon failure. */ int odp_tm_vlan_marking(odp_tm_t odp_tm, odp_packet_color_t color, @@ -669,16 +669,16 @@ int odp_tm_vlan_marking(odp_tm_t odp_tm, * calls to this function with ecn_ce_enabled == FALSE - i.e. must always * return 0 when disabling this feature. * - * @param[in] odp_tm Odp_tm is used to identify the TM system whose - * egress behavior is being changed. - * @param[in] color The packet color whose egress marking is - * being changed. - * @param[in] ecn_ce_enabled If true then egressed IPv4/IPv6 pkts whose - * protocol field is TCP AND whose ECN subfield has - * either one of the two values 1 or 2, will set this - * subfield to the value ECN_CE - i.e. Congestion - * Experienced (whose value is 3). - * @return 0 upon success, < 0 upon failure. + * @param odp_tm Odp_tm is used to identify the TM system whose + * egress behavior is being changed. + * @param color The packet color whose egress marking is + * being changed. + * @param ecn_ce_enabled If true then egressed IPv4/IPv6 pkts whose + * protocol field is TCP AND whose ECN subfield has + * either one of the two values 1 or 2, will set this + * subfield to the value ECN_CE - i.e. Congestion + * Experienced (whose value is 3). + * @return 0 upon success, < 0 upon failure. */ int odp_tm_ecn_marking(odp_tm_t odp_tm, odp_packet_color_t color, @@ -709,15 +709,15 @@ int odp_tm_ecn_marking(odp_tm_t odp_tm, * calls to this function with drop_prec_enabled == FALSE - i.e. must always * return 0 when disabling this feature. * - * @param[in] odp_tm Odp_tm is used to identify the TM system whose - * egress behavior is being changed. - * @param[in] color The packet color whose egress marking is - * being changed. - * @param[in] drop_prec_enabled If true then egressed IPv4/IPv6 pkts with this - * color will have the pkt's Drop Precedence - * sub-subfield of the DSCP subfield set to - * LOW, MEDIUM or HIGH drop precedence. - * @return 0 upon success, < 0 upon failure. + * @param odp_tm Odp_tm is used to identify the TM system whose + * egress behavior is being changed. + * @param color The packet color whose egress marking is + * being changed. + * @param drop_prec_enabled If true then egressed IPv4/IPv6 pkts with this + * color will have the pkt's Drop Precedence + * sub-subfield of the DSCP subfield set to + * LOW, MEDIUM or HIGH drop precedence. + * @return 0 upon success, < 0 upon failure. */ int odp_tm_drop_prec_marking(odp_tm_t odp_tm, odp_packet_color_t color, @@ -785,8 +785,8 @@ typedef struct { /** odp_tm_shaper_params_init() must be called to initialize any * odp_tm_shaper_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_shaper_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_shaper_params_t record which + * is to be initialized. */ void odp_tm_shaper_params_init(odp_tm_shaper_params_t *params);

@@ -794,14 +794,14 @@ void odp_tm_shaper_params_init(odp_tm_shaper_params_t *params); * subsequently be attached to any number (including zero) of tm_queues * or tm_nodes. * - * @param[in] name Optional name associated with this shaper profile. Can - * be NULL. If non-NULL must be unique amongst the set of - * all other shaper profiles. - * @param[in] params The profile parameters. See comments associated with - * the odp_tm_shaper_params_t for more details. - * @return Returns ODP_TM_INVALID upon failure, or the newly - * allocated odp_tm_shaper_t value representing this - * profile object. + * @param name Optional name associated with this shaper profile. Can + * be NULL. If non-NULL must be unique amongst the set of + * all other shaper profiles. + * @param params The profile parameters. See comments associated with + * the odp_tm_shaper_params_t for more details. + * @return Returns ODP_TM_INVALID upon failure, or the newly + * allocated odp_tm_shaper_t value representing this + * profile object. */ odp_tm_shaper_t odp_tm_shaper_create(const char *name, odp_tm_shaper_params_t *params); @@ -812,9 +812,9 @@ odp_tm_shaper_t odp_tm_shaper_create(const char *name, * profile object. It is an error if this shaper profile is still being * referenced by an active (connected) tm_node. * - * @param[in] shaper_profile Specifies the shaper profile object which is - * being destroyed. - * @return Returns < 0 upon failure or 0 upon success. + * @param shaper_profile Specifies the shaper profile object which is + * being destroyed. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_shaper_destroy(odp_tm_shaper_t shaper_profile);

@@ -822,7 +822,7 @@ int odp_tm_shaper_destroy(odp_tm_shaper_t shaper_profile); * with the specified shaper profile object, and copies them into the supplied * record. * - * @param[in] shaper_profile Specifies the shaper profile object whose + * @param shaper_profile Specifies the shaper profile object whose * values are to be read. * @param[out] params A pointer to an odp_tm_shaper_params_t record * where the current shaper profile object values @@ -837,12 +837,12 @@ int odp_tm_shaper_params_read(odp_tm_shaper_t shaper_profile, * effect that all tm_input's and tm_nodes that are associated (attached?) * with this shaper profile object will be updated with the new values. * - * @param[in] shaper_profile Specifies the shaper profile object whose - * values are to be set. - * @param[in] params A pointer to an odp_tm_shaper_params_t record - * where the new shaper profile object values - * are taken from. - * @return Returns < 0 upon failure or 0 upon success. + * @param shaper_profile Specifies the shaper profile object whose + * values are to be set. + * @param params A pointer to an odp_tm_shaper_params_t record + * where the new shaper profile object values + * are taken from. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_shaper_params_update(odp_tm_shaper_t shaper_profile, odp_tm_shaper_params_t *params); @@ -850,10 +850,10 @@ int odp_tm_shaper_params_update(odp_tm_shaper_t shaper_profile, /** odp_tm_shaper_lookup() can be used to find the shaper profile object * created with the specified name. * - * @param[in] name Name of a previously created shaper profile. Cannot be - * NULL. - * @return Returns ODP_TM_INVALID upon failure, or the shaper - * profile handle created with this name. + * @param name Name of a previously created shaper profile. Cannot be NULL. + * + * @return Returns ODP_TM_INVALID upon failure, or the shaper + * profile handle created with this name. */ odp_tm_shaper_t odp_tm_shaper_lookup(const char *name);

@@ -896,22 +896,22 @@ typedef struct { /** odp_tm_sched_params_init() must be called to initialize any * odp_tm_sched_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_sched_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_sched_params_t record which + * is to be initialized. */ void odp_tm_sched_params_init(odp_tm_sched_params_t *params);

/** odp_tm_sched_create() creates a scheduler profile object, which can * subsequently be attached to any number (including zero) of tm_nodes. * - * @param[in] name Optional name associated with this scheduler profile. - * Can be NULL. If non-NULL must be unique amongst the - * set of all other scheduler profiles. - * @param[in] params The profile parameters. See comments associated with - * the odp_tm_sched_params_t for more details. - * @return Returns ODP_TM_INVALID upon failure, or the newly - * allocated odp_tm_sched_t value representing this profile - * object. + * @param name Optional name associated with this scheduler profile. + * Can be NULL. If non-NULL must be unique amongst the + * set of all other scheduler profiles. + * @param params The profile parameters. See comments associated with + * the odp_tm_sched_params_t for more details. + * @return Returns ODP_TM_INVALID upon failure, or the newly + * allocated odp_tm_sched_t value representing this profile + * object. */ odp_tm_sched_t odp_tm_sched_create(const char *name, odp_tm_sched_params_t *params); @@ -922,9 +922,9 @@ odp_tm_sched_t odp_tm_sched_create(const char *name, * profile object. It is an error if this scheduler profile is still being * referenced by an active (connected) tm_node. * - * @param[in] sched_profile Specifies the shaper profile object which is - * being destroyed. - * @return Returns < 0 upon failure or 0 upon success. + * @param sched_profile Specifies the shaper profile object which is + * being destroyed. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_sched_destroy(odp_tm_sched_t sched_profile);

@@ -932,7 +932,7 @@ int odp_tm_sched_destroy(odp_tm_sched_t sched_profile); * with the specified scheduler profile object, and copies them into the * supplied record. * - * @param[in] sched_profile Specifies the scheduler profile whose values + * @param sched_profile Specifies the scheduler profile whose values * are to be read. * @param[out] params A pointer to an odp_tm_sched_params_t record * where the current scheduler profile object @@ -947,12 +947,12 @@ int odp_tm_sched_params_read(odp_tm_sched_t sched_profile, * the effect that all tm_nodes that are associated (attached?) with this * Scheduler profile object will be updated with the new values. * - * @param[in] sched_profile Specifies the Scheduler profile object whose - * values are to be set. - * @param[in] params A pointer to an odp_tm_sched_params_t record - * where the new scheduler profile object values - * are taken from. - * @return Returns < 0 upon failure or 0 upon success. + * @param sched_profile Specifies the Scheduler profile object whose + * values are to be set. + * @param params A pointer to an odp_tm_sched_params_t record + * where the new scheduler profile object values + * are taken from. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_sched_params_update(odp_tm_sched_t sched_profile, odp_tm_sched_params_t *params); @@ -960,10 +960,10 @@ int odp_tm_sched_params_update(odp_tm_sched_t sched_profile, /** odp_tm_sched_lookup() can be used to find the scheduler profile object * created with the specified name. * - * @param[in] name Name of a previously created scheduler profile. Cannot be - * NULL. - * @return Returns ODP_TM_INVALID upon failure, or the scheduler - * profile handle created with this name. + * @param name Name of a previously created scheduler profile. Cannot be NULL. + * + * @return Returns ODP_TM_INVALID upon failure, or the scheduler + * profile handle created with this name. */ odp_tm_sched_t odp_tm_sched_lookup(const char *name);

@@ -985,8 +985,8 @@ typedef struct { /** odp_tm_threshold_params_init() must be called to initialize any * odp_tm_threshold_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_threshold_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_threshold_params_t record which + * is to be initialized. */ void odp_tm_threshold_params_init(odp_tm_threshold_params_t *params);

@@ -994,14 +994,14 @@ void odp_tm_threshold_params_init(odp_tm_threshold_params_t *params); * can subsequently be attached to any number (including zero) of tm_queues or * tm_nodes. * - * @param[in] name Optional name associated with this queue threshold - * profile. Can be NULL. If non-NULL must be unique - * amongst the set of all other queue threshold profiles. - * @param[in] params The profile parameters. See comments associated with - * the odp_tm_threshold_params_t for more details. - * @return Returns ODP_TM_INVALID upon failure, or the newly - * allocated odp_tm_threshold_t value representing this - * profile object. + * @param name Optional name associated with this queue threshold + * profile. Can be NULL. If non-NULL must be unique + * amongst the set of all other queue threshold profiles. + * @param params The profile parameters. See comments associated with + * the odp_tm_threshold_params_t for more details. + * @return Returns ODP_TM_INVALID upon failure, or the newly + * allocated odp_tm_threshold_t value representing this + * profile object. */ odp_tm_threshold_t odp_tm_threshold_create(const char *name, odp_tm_threshold_params_t *params); @@ -1012,9 +1012,9 @@ odp_tm_threshold_t odp_tm_threshold_create(const char *name, * profile object. It is an error if this threshold profile is still being * referenced by an active (connected) tm_queue or tm_node. * - * @param[in] threshold_profile Specifies the queue thresholds profile - * object which is being destroyed. - * @return Returns < 0 upon failure or 0 upon success. + * @param threshold_profile Specifies the queue thresholds profile + * object which is being destroyed. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_threshold_destroy(odp_tm_threshold_t threshold_profile);

@@ -1022,7 +1022,7 @@ int odp_tm_threshold_destroy(odp_tm_threshold_t threshold_profile); * with the specified queue thresholds profile object, and copies them into the * supplied record. * - * @param[in] threshold_profile Specifies the queue thresholds profile + * @param threshold_profile Specifies the queue thresholds profile * object whose values are to be read. * @param[out] params A pointer to an odp_tm_threshold_params_t * record where the current queue thresholds @@ -1038,12 +1038,12 @@ int odp_tm_thresholds_params_read(odp_tm_threshold_t threshold_profile, * associated (attached?) with this queue thresholds profile object will be * updated with the new values. * - * @param[in] threshold_profile Specifies the queue thresholds profile - * object whose values are to be set. - * @param[in] params A pointer to an odp_tm_threshold_params_t - * record where the current queue thresholds - * profile object values are taken from. - * @return Returns < 0 upon failure or 0 upon success. + * @param threshold_profile Specifies the queue thresholds profile + * object whose values are to be set. + * @param params A pointer to an odp_tm_threshold_params_t + * record where the current queue thresholds + * profile object values are taken from. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_thresholds_params_update(odp_tm_threshold_t threshold_profile, odp_tm_threshold_params_t *params); @@ -1051,10 +1051,10 @@ int odp_tm_thresholds_params_update(odp_tm_threshold_t threshold_profile, /** odp_tm_thresholds_lookup() can be used to find the queue thresholds * profile object created with the specified name. * - * @param[in] name Name of a previously created queue thresholds profile. - * Cannot be NULL. - * @return Returns ODP_TM_INVALID upon failure, or the queue - * thresholds profile handle created with this name. + * @param name Name of a previously created queue thresholds profile. + * Cannot be NULL. + * @return Returns ODP_TM_INVALID upon failure, or the queue + * thresholds profile handle created with this name. */ odp_tm_threshold_t odp_tm_thresholds_lookup(const char *name);

@@ -1121,8 +1121,8 @@ typedef struct { /** odp_tm_wred_params_init() must be called to initialize any * odp_tm_wred_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_wred_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_wred_params_t record which + * is to be initialized. */ void odp_tm_wred_params_init(odp_tm_wred_params_t *params);

@@ -1130,14 +1130,14 @@ void odp_tm_wred_params_init(odp_tm_wred_params_t *params); * profile object, which can subsequently be attached to any number (including * zero) of tm_queues or tm_nodes. * - * @param[in] name Optional name associated with this WRED profile. Can - * be NULL. If non-NULL must be unique amongst the set of - * all other WRED profiles. - * @param[in] params The profile parameters. See comments associated with the - * odp_tm_wred_params_t for more details. - * @return Returns ODP_TM_INVALID upon failure, or the newly - * allocated odp_tm_wred_t value representing this profile - * object. + * @param name Optional name associated with this WRED profile. Can + * be NULL. If non-NULL must be unique amongst the set of + * all other WRED profiles. + * @param params The profile parameters. See comments associated with the + * odp_tm_wred_params_t for more details. + * @return Returns ODP_TM_INVALID upon failure, or the newly + * allocated odp_tm_wred_t value representing this profile + * object. */ odp_tm_wred_t odp_tm_wred_create(const char *name, odp_tm_wred_params_t *params); @@ -1148,9 +1148,9 @@ odp_tm_wred_t odp_tm_wred_create(const char *name, * profile object. It is an error if this profile object is still being * referenced by an active (connected) tm_node. * - * @param[in] wred_profile Specifies the WRED profile object which is - * being destroyed. - * @return Returns < 0 upon failure or 0 upon success. + * @param wred_profile Specifies the WRED profile object which is + * being destroyed. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_wred_destroy(odp_tm_wred_t wred_profile);

@@ -1158,7 +1158,7 @@ int odp_tm_wred_destroy(odp_tm_wred_t wred_profile); * with the specified WRED profile object, and copies them into the supplied * record. * - * @param[in] wred_profile Specifies the WRED profile object whose + * @param wred_profile Specifies the WRED profile object whose * values are to be read. * @param[out] params A pointer to an odp_tm_wred_params_t record * where the current WRED profile object values @@ -1173,12 +1173,12 @@ int odp_tm_wred_params_read(odp_tm_wred_t wred_profile, * effect that all tm_input's and tm_nodes that are associated (attached?) * with this WRED profile object will be updated with the new values. * - * @param[in] wred_profile Specifies the WRED profile object whose - * values are to be set. - * @param[in] params A pointer to an odp_tm_wred_params_t record - * where the new WRED profile object values - * are taken from. - * @return Returns < 0 upon failure or 0 upon success. + * @param wred_profile Specifies the WRED profile object whose + * values are to be set. + * @param params A pointer to an odp_tm_wred_params_t record + * where the new WRED profile object values + * are taken from. + * @return Returns < 0 upon failure or 0 upon success. */ int odp_tm_wred_params_update(odp_tm_wred_t wred_profile, odp_tm_wred_params_t *params); @@ -1186,10 +1186,10 @@ int odp_tm_wred_params_update(odp_tm_wred_t wred_profile, /** odp_tm_wred_lookup() can be used to find the WRED profile object created * with the specified name. * - * @param[in] name Name of a previously created WRED profile. Cannot be - * NULL. - * @return Returns ODP_TM_INVALID upon failure, or the WRED - * profile handle created with this name. + * @param name Name of a previously created WRED profile. Cannot be NULL. + * + * @return Returns ODP_TM_INVALID upon failure, or the WRED + * profile handle created with this name. */ odp_tm_wred_t odp_tm_wred_lookup(const char *name);

@@ -1237,8 +1237,8 @@ typedef struct { /** odp_tm_node_params_init() must be called to initialize any * odp_tm_node_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_node_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_node_params_t record which + * is to be initialized. */ void odp_tm_node_params_init(odp_tm_node_params_t *params);

@@ -1249,15 +1249,15 @@ void odp_tm_node_params_init(odp_tm_node_params_t *params); * strict priority levels for an tm_node cannot be changed after tm_node * creation. The level parameter MUST be in the range 0..max_level - 1. * - * @param[in] odp_tm Odp_tm is used to identify the TM system into which this - * odp_tm_node object is created. - * @param[in] name Optional name that can be used later later to find this - * same odp_tm_node_t. Can be NULL, otherwise must be - * unique across all odp_tm_node objects. - * @param[in] params A pointer to a record holding (an extensible) set of - * properties/attributes of this tm_node. - * @return Returns ODP_TM_INVALID upon failure, otherwise returns - * a valid odp_tm_node_t handle if successful. + * @param odp_tm Odp_tm is used to identify the TM system into which this + * odp_tm_node object is created. + * @param name Optional name that can be used later later to find this + * same odp_tm_node_t. Can be NULL, otherwise must be + * unique across all odp_tm_node objects. + * @param params A pointer to a record holding (an extensible) set of + * properties/attributes of this tm_node. + * @return Returns ODP_TM_INVALID upon failure, otherwise returns + * a valid odp_tm_node_t handle if successful. */ odp_tm_node_t odp_tm_node_create(odp_tm_t odp_tm, const char *name, @@ -1268,21 +1268,21 @@ odp_tm_node_t odp_tm_node_create(odp_tm_t odp_tm, * The odp_tm_node_destroy frees the resources used by a tm_node_t object. * The tm_node to be destroyed MUST not have any parent or child entities. * - * @param[in] tm_node Specifies the tm_node to be destroyed (freed). - * @return Returns -1 upon failure, 0 upon success. + * @param tm_node Specifies the tm_node to be destroyed (freed). + * @return Returns -1 upon failure, 0 upon success. */ int odp_tm_node_destroy(odp_tm_node_t tm_node);

/** The odp_tm_node_shaper_config() function is used to dynamically set or * change the shaper profile associated with this tm_node. * - * @param[in] tm_node Specifies the tm_node to be changed. - * @param[in] shaper_profile Specifies the shaper profile that should - * now be used for the shaper entity within the - * given tm_node. Note that it is legal to specify - * ODP_TM_INVALID indicating that this tm_node - * no longer implements a shaper function. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_node Specifies the tm_node to be changed. + * @param shaper_profile Specifies the shaper profile that should + * now be used for the shaper entity within the + * given tm_node. Note that it is legal to specify + * ODP_TM_INVALID indicating that this tm_node + * no longer implements a shaper function. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_node_shaper_config(odp_tm_node_t tm_node, odp_tm_shaper_t shaper_profile); @@ -1290,15 +1290,15 @@ int odp_tm_node_shaper_config(odp_tm_node_t tm_node, /** The odp_tm_node_sched_config() function is used to dynamically set or * change the scheduler profile associated with a tm_node. * - * @param[in] tm_node Specifies the tm_node to be changed. - * @param[in] tm_fan_in_node Specifies which of the specified tm_node's - * fan-in's weights etc are to be changed. The - * fan-in is identified by the "producer"/parent - * tm_node actually connected to this fan-in. - * @param[in] sched_profile Specifies the scheduler profile that should - * now be used for the WFQ/RR entity within the - * given tm_node. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_node Specifies the tm_node to be changed. + * @param tm_fan_in_node Specifies which of the specified tm_node's + * fan-in's weights etc are to be changed. The + * fan-in is identified by the "producer"/parent + * tm_node actually connected to this fan-in. + * @param sched_profile Specifies the scheduler profile that should + * now be used for the WFQ/RR entity within the + * given tm_node. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_node_sched_config(odp_tm_node_t tm_node, odp_tm_node_t tm_fan_in_node, @@ -1307,10 +1307,10 @@ int odp_tm_node_sched_config(odp_tm_node_t tm_node, /** The odp_tm_node_threshold_config() function is used to dynamically set or * change the queue threshold profile associated with this tm_node. * - * @param[in] tm_node Specifies the tm_node to be changed. - * @param[in] thresholds_profile Specifies the queue threshold profile that - * should now be used for the given tm_node. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_node Specifies the tm_node to be changed. + * @param thresholds_profile Specifies the queue threshold profile that + * should now be used for the given tm_node. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_node_threshold_config(odp_tm_node_t tm_node, odp_tm_threshold_t thresholds_profile); @@ -1319,16 +1319,16 @@ int odp_tm_node_threshold_config(odp_tm_node_t tm_node, * change the WRED profile associated with this tm_node or tm_node/pkt_color * combination. * - * @param[in] tm_node Specifies the tm_node to be changed. - * @param[in] pkt_color Specifies the pkt_color that this profile is to be - * used with. Can also be the special value - * ALL_PKT_COLORS. - * @param[in] wred_profile Specifies the WRED profile that should now be used - * by this tm_queue, when processing pkts of this - * pkt_color. It can be the value ODP_TM_INVALID - * indicating that this tm_queue/pkt_color combination - * no longer implements WRED. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_node Specifies the tm_node to be changed. + * @param pkt_color Specifies the pkt_color that this profile is to be + * used with. Can also be the special value + * ALL_PKT_COLORS. + * @param wred_profile Specifies the WRED profile that should now be used + * by this tm_queue, when processing pkts of this + * pkt_color. It can be the value ODP_TM_INVALID + * indicating that this tm_queue/pkt_color combination + * no longer implements WRED. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_node_wred_config(odp_tm_node_t tm_node, odp_packet_color_t pkt_color, @@ -1337,34 +1337,33 @@ int odp_tm_node_wred_config(odp_tm_node_t tm_node, /** odp_tm_node_lookup() can be used to find the tm_node object created with * the specified name. * - * @param[in] odp_tm Odp_tm is used to identify the TM system into which this - * odp_tm_node object is created. - * @param[in] name Name of a previously created tm_node. Cannot be - * NULL. - * @return Returns ODP_TM_INVALID upon failure, or the tm_node - * handle created with this name. + * @param odp_tm Odp_tm is used to identify the TM system into which this + * odp_tm_node object is created. + * @param name Name of a previously created tm_node. Cannot be NULL. + * + * @return Returns ODP_TM_INVALID upon failure, or the tm_node + * handle created with this name. */ odp_tm_node_t odp_tm_node_lookup(odp_tm_t odp_tm, const char *name);

/** odp_tm_node_context() can be used to get the user_context value that is * associated with the given tm_node. * - * @param[in] tm_node Specifies the tm_node whose user_context is to be gotten. - * @return Returns the user_context pointer associated with this - * tm_node. Returns NULL if the tm_node is not valid OR - * if the user_context was NLL. - * handle created with this name. + * @param tm_node Specifies the tm_node whose user_context is to be gotten. + * @return Returns the user_context pointer associated with this + * tm_node. Returns NULL if the tm_node is not valid OR + * if the user_context was NULL. */ void *odp_tm_node_context(odp_tm_node_t tm_node);

/** odp_tm_node_context_set() can be used to set the user_context value that is * associated with the given tm_node. * - * @param[in] tm_node Specifies the tm_node whose user_context is to be set. - * @param[in] user_context Generic pointer associated with the given tm_node. - * Does not have any effect on the tm_node semantics. - * @return Returns 0 upon success and -1 if the given tm_node - * is not valid. + * @param tm_node Specifies the tm_node whose user_context is to be set. + * @param user_context Generic pointer associated with the given tm_node. + * Does not have any effect on the tm_node semantics. + * @return Returns 0 upon success and -1 if the given tm_node + * is not valid. */ int odp_tm_node_context_set(odp_tm_node_t tm_node, void *user_context);

@@ -1406,8 +1405,8 @@ typedef struct { /** odp_tm_queue_params_init() must be called to initialize any * odp_tm_queue_params_t record before it is first used or assigned to. * - * @param[in] params A pointer to an odp_tm_queue_params_t record which - * is to be initialized. + * @param params A pointer to an odp_tm_queue_params_t record which + * is to be initialized. */ void odp_tm_queue_params_init(odp_tm_queue_params_t *params);

@@ -1419,12 +1418,12 @@ void odp_tm_queue_params_init(odp_tm_queue_params_t *params); * number of buffers and instead limit the queue memory usage by buffer counts * versus strictly using byte counts. * - * @param[in] odp_tm Odp_tm is used to identify the TM system into which this - * odp_tm_queue object is created. - * @param[in] params A pointer to a record holding (an extensible) set of - * properties/attributes of this tm_queue. - * @return Returns ODP_TM_INVALID upon failure, otherwise a valid - * odp_tm_queue_t handle. + * @param odp_tm Odp_tm is used to identify the TM system into which this + * odp_tm_queue object is created. + * @param params A pointer to a record holding (an extensible) set of + * properties/attributes of this tm_queue. + * @return Returns ODP_TM_INVALID upon failure, otherwise a valid + * odp_tm_queue_t handle. */ odp_tm_queue_t odp_tm_queue_create(odp_tm_t odp_tm, odp_tm_queue_params_t *params); @@ -1433,44 +1432,43 @@ odp_tm_queue_t odp_tm_queue_create(odp_tm_t odp_tm, * used by a tm_queue_t object. The tm_queue to be destroyed MUST not be * connected in a tm system, and consequently cannot contain any pkts. * - * @param[in] tm_queue Specifies the tm_queue to be destroyed (freed). - * @return Returns -1 upon failure, 0 upon success. + * @param tm_queue Specifies the tm_queue to be destroyed (freed). + * @return Returns -1 upon failure, 0 upon success. */ int odp_tm_queue_destroy(odp_tm_queue_t tm_queue);

/** odp_tm_queue_context() can be used to get the user_context value that is * associated with the given tm_queue. * - * @param[in] tm_queue Specifies the tm_queue whose user_context is to be - * returned. - * @return Returns the user_context pointer associated with this - * tm_queue. Returns NULL if the tm_quue is not valid OR - * if the user_context was NULL. + * @param tm_queue Specifies the tm_queue whose user_context is to be + * returned. + * @return Returns the user_context pointer associated with this + * tm_queue. Returns NULL if the tm_quue is not valid OR + * if the user_context was NULL. */ void *odp_tm_queue_context(odp_tm_queue_t tm_queue);

/** odp_tm_queue_context_set() can be used to set the user_context value that is * associated with the given tm_queue. * - * @param[in] tm_queue Specifies the tm_queue whose user_context is to be - * set. - * @param[in] user_context Generic pointer associated with the given tm_queue. - * Does not have any effect on the tm_queue semantics. - * @return Returns 0 upon success and -1 if the given tm_queu - * is not valid. + * @param tm_queue Specifies the tm_queue whose user_context is to be set. + * @param user_context Generic pointer associated with the given tm_queue. + * Does not have any effect on the tm_queue semantics. + * @return Returns 0 upon success and -1 if the given tm_queue + * is not valid. */ int odp_tm_queue_context_set(odp_tm_queue_t tm_queue, void *user_context);

/** The odp_tm_queue_shaper_config() function is used to dynamically set * or change the shaper profile associated with this tm_queue. * - * @param[in] tm_queue Specifies the tm_queue to be changed. - * @param[in] shaper_profile Specifies the shaper profile that should now be - * used for shaping the tm_queue's packet stream. - * Note that it is legal to specify ODP_TM_INVALID - * indicating that this tm_queue no longer - * implements a shaper function. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_queue Specifies the tm_queue to be changed. + * @param shaper_profile Specifies the shaper profile that should now be + * used for shaping the tm_queue's packet stream. + * Note that it is legal to specify ODP_TM_INVALID + * indicating that this tm_queue no longer + * implements a shaper function. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_queue_shaper_config(odp_tm_queue_t tm_queue, odp_tm_shaper_t shaper_profile); @@ -1480,15 +1478,15 @@ int odp_tm_queue_shaper_config(odp_tm_queue_t tm_queue, * the name, this function affects a tm_node scheduler - specifically the * scheduler fan-in when such fan-in comes from an tm_queue. * - * @param[in] tm_node Specifies the tm_node to be changed. - * @param[in] tm_fan_in_queue Specifies which of the specified tm_node's - * fan-in's weights etc are to be changed. The - * fan-in is identified by the "producer"/parent - * tm_queue actually connected to this fan-in. - * @param[in] sched_profile Specifies the scheduler profile that should - * now be used for the WFQ/RR entity within the - * given tm_node. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_node Specifies the tm_node to be changed. + * @param tm_fan_in_queue Specifies which of the specified tm_node's + * fan-in's weights etc are to be changed. The + * fan-in is identified by the "producer"/parent + * tm_queue actually connected to this fan-in. + * @param sched_profile Specifies the scheduler profile that should + * now be used for the WFQ/RR entity within the + * given tm_node. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_queue_sched_config(odp_tm_node_t tm_node, odp_tm_queue_t tm_fan_in_queue, @@ -1497,10 +1495,10 @@ int odp_tm_queue_sched_config(odp_tm_node_t tm_node, /** The odp_tm_queue_threshold_config() function is used to dynamically set or * change the queue threshold profile associated with this tm_queue. * - * @param[in] tm_queue Specifies the tm_queue to be changed. - * @param[in] thresholds_profile Specifies the queue threshold profile that - * should now be used for the given tm_queue. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_queue Specifies the tm_queue to be changed. + * @param thresholds_profile Specifies the queue threshold profile that + * should now be used for the given tm_queue. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_queue_threshold_config(odp_tm_queue_t tm_queue, odp_tm_threshold_t thresholds_profile); @@ -1509,16 +1507,16 @@ int odp_tm_queue_threshold_config(odp_tm_queue_t tm_queue, * the WRED profile associated with this tm_queue or tm_queue/pkt_color * combination. * - * @param[in] tm_queue Specifies the tm_queue to be changed. - * @param[in] pkt_color Specifies the pkt_color that this profile is to be - * used with. Can also be the special value - * ALL_PKT_COLORS. - * @param[in] wred_profile Specifies the WRED profile that should now be used - * by this tm_queue, when processing pkts of this - * pkt_color. It can be the value ODP_TM_INVALID - * indicating that this tm_queue/pkt_color combination - * no longer implements WRED. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_queue Specifies the tm_queue to be changed. + * @param pkt_color Specifies the pkt_color that this profile is to be + * used with. Can also be the special value + * ALL_PKT_COLORS. + * @param wred_profile Specifies the WRED profile that should now be used + * by this tm_queue, when processing pkts of this + * pkt_color. It can be the value ODP_TM_INVALID + * indicating that this tm_queue/pkt_color combination + * no longer implements WRED. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_queue_wred_config(odp_tm_queue_t tm_queue, odp_packet_color_t pkt_color, @@ -1532,14 +1530,14 @@ int odp_tm_queue_wred_config(odp_tm_queue_t tm_queue, * dst_tm_node. Note that an ODP_TM_ROOT handle passed in for the * dst_tm_node implies connection to the egress/root object of this TM system. * - * @param[in] src_tm_node odp_tm_node_t handle of the tm_node whose output is - * to be connected to the fan-in of the next tm_node - * as represented by the dst_tm_node. - * @param[in] dst_tm_node odp_tm_node_t handle of the tm_node object that will - * receive all of the pkt_descs from the src tm_node - * output. If ODP_TM_ROOT, then attachment is to - * the root egress object/spigot. - * @return 0 upon success, < 0 on failure. + * @param src_tm_node odp_tm_node_t handle of the tm_node whose output is + * to be connected to the fan-in of the next tm_node + * as represented by the dst_tm_node. + * @param dst_tm_node odp_tm_node_t handle of the tm_node object that will + * receive all of the pkt_descs from the src tm_node + * output. If ODP_TM_ROOT, then attachment is to + * the root egress object/spigot. + * @return 0 upon success, < 0 on failure. */ int odp_tm_node_connect(odp_tm_node_t src_tm_node, odp_tm_node_t dst_tm_node);

@@ -1550,11 +1548,10 @@ int odp_tm_node_connect(odp_tm_node_t src_tm_node, odp_tm_node_t dst_tm_node); * tm_queue to be in the fanin tree (directly or indirectly) of this tm_node. * Note that it is legal for this tm_node to no fanout connection. * - * @param[in] src_tm_node odp_tm_node_t handle of the tm_node whose output is - * to be disconnected from the fan-in of the next - * tm_node. + * @param src_tm_node odp_tm_node_t handle of the tm_node whose output is + * to be disconnected from the fan-in of the next tm_node. * - * @return 0 upon success, < 0 on failure. + * @return 0 upon success, < 0 on failure. */ int odp_tm_node_disconnect(odp_tm_node_t src_tm_node);

@@ -1562,12 +1559,12 @@ int odp_tm_node_disconnect(odp_tm_node_t src_tm_node); * parent tm_node or to the egress/root node. The tm_queue will then become * one of the dst node's fan-in set. * - * @param[in] tm_queue Specifies the tm_queue. - * @param[in] dst_tm_node odp_tm_node_t handle of the tm_node object that will - * receive all of the pkt_descs from the src tm_node - * output. If ODP_TM_ROOT, then attachment is to - * the root egress object/spigot. - * @return Returns 0 upon success and < 0 upon failure. + * @param tm_queue Specifies the tm_queue. + * @param dst_tm_node odp_tm_node_t handle of the tm_node object that will + * receive all of the pkt_descs from the src tm_node + * output. If ODP_TM_ROOT, then attachment is to + * the root egress object/spigot. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_queue_connect(odp_tm_queue_t tm_queue, odp_tm_node_t dst_tm_node);

@@ -1577,8 +1574,8 @@ int odp_tm_queue_connect(odp_tm_queue_t tm_queue, odp_tm_node_t dst_tm_node); * tm_queue from its fanout. Note that it is legal for this tm_queue to * have no fanout connection. * - * @param[in] tm_queue Specifies the tm_queue. - * @return 0 upon success, < 0 on failure. + * @param tm_queue Specifies the tm_queue. + * @return 0 upon success, < 0 on failure. */ int odp_tm_queue_disconnect(odp_tm_queue_t tm_queue);

@@ -1597,10 +1594,10 @@ int odp_tm_queue_disconnect(odp_tm_queue_t tm_queue); * shaper_color produced from the TM shaper entities within the tm_inputs and * tm_nodes. * - * @param[in] tm_queue Specifies the tm_queue (and indirectly the TM system). - * @param[in] pkt Handle to a packet. - * @return Returns 0 upon success, < 0 upon failure. One of the - * more common failure reasons is WRED drop. + * @param tm_queue Specifies the tm_queue (and indirectly the TM system). + * @param pkt Handle to a packet. + * @return Returns 0 upon success, < 0 upon failure. One of the + * more common failure reasons is WRED drop. */ int odp_tm_enq(odp_tm_queue_t tm_queue, odp_packet_t pkt);

@@ -1608,10 +1605,10 @@ int odp_tm_enq(odp_tm_queue_t tm_queue, odp_packet_t pkt); * except that it also returns (an approximation to?) the current tm_queue * packet queue count. * - * @param[in] tm_queue Specifies the tm_queue (and indirectly the TM system). - * @param[in] pkt Handle to a packet. - * @return Returns the number of packets previously enqueued on - * this tm_queue upon success, < 0 upon failure. + * @param tm_queue Specifies the tm_queue (and indirectly the TM system). + * @param pkt Handle to a packet. + * @return Returns the number of packets previously enqueued on + * this tm_queue upon success, < 0 upon failure. */ int odp_tm_enq_with_cnt(odp_tm_queue_t tm_queue, odp_packet_t pkt);

@@ -1656,7 +1653,7 @@ typedef struct { * The odp_tm_node_info() function is used to extract various bits of * configuration associated with a given tm_node. * - * @param[in] tm_node Specifies the tm_node to be queried. + * @param tm_node Specifies the tm_node to be queried. * @param[out] info A pointer to an odp_tm_node_info_t record that is to * be filled in by this call. * @return Returns < 0 upon failure, 0 upon success. @@ -1716,11 +1713,11 @@ typedef struct { * Note that all new additions to a fanin list always take place at the end of * the list. * - * @param[in] tm_node Specifies the tm_node to be queried. - * @param[inout] info A pointer to an odp_tm_node_fanin_info_t record that - * is used to determine which fanin entry is to be - * next filled in by this call. - * @return Returns < 0 upon failure, 0 upon success. + * @param tm_node Specifies the tm_node to be queried. + * @param[in,out] info A pointer to an odp_tm_node_fanin_info_t record that + * is used to determine which fanin entry is to be + * next filled in by this call. + * @return Returns < 0 upon failure, 0 upon success. */ int odp_tm_node_fanin_info(odp_tm_node_t tm_node, odp_tm_node_fanin_info_t *info); @@ -1761,7 +1758,7 @@ typedef struct { * The odp_tm_queue_info() function is used to extract various bits of * configuration associated with a given tm_queue. * - * @param[in] tm_queue Specifies the tm_queue to be queried. + * @param tm_queue Specifies the tm_queue to be queried. * @param[out] info A pointer to an odp_tm_queue_info_t record that is to * be filled in by this call. * @return Returns < 0 upon failure, 0 upon success. @@ -1845,7 +1842,7 @@ typedef struct { * regardless of query_flags if the cost of returning all the counts is * comparable to the cost of checking the query_flags. * - * @param[in] tm_queue Specifies the tm_queue (and indirectly the + * @param tm_queue Specifies the tm_queue (and indirectly the * TM system). * @param[out] query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. @@ -1865,8 +1862,8 @@ int odp_tm_queue_query(odp_tm_queue_t tm_queue, * returning all the counts is comparable to the cost of checking the * query_flags. * - * @param[in] odp_tm Specifies the TM system. - * @param[in] priority Supplies the strict priority level used to specify + * @param odp_tm Specifies the TM system. + * @param priority Supplies the strict priority level used to specify * which tm_queues are included in the info values. * @param[out] query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. @@ -1887,7 +1884,7 @@ int odp_tm_priority_query(odp_tm_t odp_tm, * returning all the counts is comparable to the cost of checking the * query_flags. * - * @param[in] odp_tm Specifies the TM system. + * @param odp_tm Specifies the TM system. * @param[out] query_flags A set of flag bits indicating which counters are * being requested to be returned in the info record. * @param[out] info Pointer to an odp_tm_query_info_t record where the @@ -1904,14 +1901,14 @@ int odp_tm_total_query(odp_tm_t odp_tm, * semantic effects other than returning these queue threshold values in the * odp_tm_query_info_t record. * - * @param[in] odp_tm Specifies the TM system. - * @param[in] priority Supplies the strict priority level that - * the threshold profile params are associated - * with. - * @param[in] thresholds_profile Specifies the queue threshold profile that - * should now be associated with the supplied - * strict priority level. - * @return Returns 0 upon success and < 0 upon failure. + * @param odp_tm Specifies the TM system. + * @param priority Supplies the strict priority level that + * the threshold profile params are associated with. + * + * @param thresholds_profile Specifies the queue threshold profile that + * should now be associated with the supplied + * strict priority level. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_priority_threshold_config(odp_tm_t odp_tm, uint8_t priority, @@ -1923,11 +1920,11 @@ int odp_tm_priority_threshold_config(odp_tm_t odp_tm, * other than returning these queue threshold values in the * odp_tm_query_info_t record. * - * @param[in] odp_tm Specifies the TM system. - * @param[in] thresholds_profile Specifies the queue threshold profile that - * should now be used for the entire TM - * system. - * @return Returns 0 upon success and < 0 upon failure. + * @param odp_tm Specifies the TM system. + * @param thresholds_profile Specifies the queue threshold profile that + * should now be used for the entire TM + * system. + * @return Returns 0 upon success and < 0 upon failure. */ int odp_tm_total_threshold_config(odp_tm_t odp_tm, odp_tm_threshold_t thresholds_profile); @@ -1941,8 +1938,8 @@ int odp_tm_total_threshold_config(odp_tm_t odp_tm, * since for some implementations this call could take a fairly long time * to execute! * - * @param[in] odp_tm Specifies the TM system. - * @return Returns 1 if the TM system is idle and 0 otherwise. + * @param odp_tm Specifies the TM system. + * @return Returns 1 if the TM system is idle and 0 otherwise. */ odp_bool_t odp_tm_is_idle(odp_tm_t odp_tm);

@@ -1950,7 +1947,7 @@ odp_bool_t odp_tm_is_idle(odp_tm_t odp_tm); * information about the specified TM system to the ODP log. The intended use * is for debugging. * - * @param[in] odp_tm Specifies the TM system. + * @param odp_tm Specifies the TM system. */ void odp_tm_stats_print(odp_tm_t odp_tm);

commit 297df8bbdd88a2104c6dd0f6c2e506eb5140dd1c Author: Petri Savolainen petri.savolainen@linaro.org Date: Mon Dec 4 14:18:17 2017 +0200

api: cls: remove param-in doxygen tag

All parameters are input only (tag [in]) by default. Output parameters are better highlighted, when only those are tagged. Also changed tab to spaces inside documentation. Text is more readable on various editors when tabs and spaces are not mixed.

Signed-off-by: Petri Savolainen petri.savolainen@linaro.org Reviewed-by: Bill Fischofer bill.fischofer@linaro.org Signed-off-by: Maxim Uvarov maxim.uvarov@linaro.org

diff --git a/include/odp/api/spec/classification.h b/include/odp/api/spec/classification.h index 16bf3e6e..4db046fc 100644 --- a/include/odp/api/spec/classification.h +++ b/include/odp/api/spec/classification.h @@ -287,7 +287,7 @@ typedef struct odp_cls_cos_param { * * Initialize an odp_cls_cos_param_t to its default value for all fields * - * @param param Address of the odp_cls_cos_param_t to be initialized + * @param param Address of the odp_cls_cos_param_t to be initialized */ void odp_cls_cos_param_init(odp_cls_cos_param_t *param);

@@ -296,10 +296,10 @@ void odp_cls_cos_param_init(odp_cls_cos_param_t *param); * * Outputs classification capabilities on success. * - * @param[out] capability Pointer to classification capability structure. + * @param[out] capability Pointer to classification capability structure. * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_cls_capability(odp_cls_capability_t *capability);

@@ -308,12 +308,12 @@ int odp_cls_capability(odp_cls_capability_t *capability); * * The use of class-of-service name is optional. Unique names are not required. * - * @param name Name of the class-of-service or NULL. Maximum string - * length is ODP_COS_NAME_LEN. - * @param param Class-of-service parameters + * @param name Name of the class-of-service or NULL. Maximum string + * length is ODP_COS_NAME_LEN. + * @param param Class-of-service parameters * - * @retval Class-of-service handle - * @retval ODP_COS_INVALID on failure. + * @retval Class-of-service handle + * @retval ODP_COS_INVALID on failure. * * @note ODP_QUEUE_INVALID and ODP_POOL_INVALID are valid values for queue * and pool associated with a class of service and when any one of these values @@ -327,12 +327,11 @@ odp_cos_t odp_cls_cos_create(const char *name, odp_cls_cos_param_t *param); * based on the packet parameters and hash protocol field configured with the * class of service. * - * @param cos class of service - * @param packet Packet handle + * @param cos class of service + * @param packet Packet handle * - * @retval Returns the queue handle on which this packet will be - * enqueued. - * @retval ODP_QUEUE_INVALID for error case + * @retval Returns the queue handle on which this packet will be enqueued. + * @retval ODP_QUEUE_INVALID for error case * * @note The packet has to be updated with valid header pointers L2, L3 and L4. */ @@ -341,60 +340,54 @@ odp_queue_t odp_cls_hash_result(odp_cos_t cos, odp_packet_t packet); /** * Discard a class-of-service along with all its associated resources * - * @param[in] cos_id class-of-service instance. + * @param cos_id class-of-service instance. * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_destroy(odp_cos_t cos_id);

/** * Assign a queue for a class-of-service * - * @param[in] cos_id class-of-service instance. + * @param cos_id class-of-service instance. + * @param queue_id Identifier of a queue where all packets of this specific + * class of service will be enqueued. * - * @param[in] queue_id Identifier of a queue where all packets - * of this specific class of service - * will be enqueued. - * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_queue_set(odp_cos_t cos_id, odp_queue_t queue_id);

/** * Get the queue associated with the specific class-of-service * -* @param[in] cos_id class-of-service instance. -* -* @retval queue_handle Queue handle associated with the -* given class-of-service +* @param cos_id class-of-service instance. * -* @retval ODP_QUEUE_INVALID on failure +* @retval Queue handle associated with the given class-of-service +* @retval ODP_QUEUE_INVALID on failure */ odp_queue_t odp_cos_queue(odp_cos_t cos_id);

/** * Get the number of queues linked with the specific class-of-service * - * @param cos_id class-of-service instance. + * @param cos_id class-of-service instance. * - * @return Number of queues linked with the class-of-service. + * @return Number of queues linked with the class-of-service. */ uint32_t odp_cls_cos_num_queue(odp_cos_t cos_id);

/** * Get the list of queue associated with the specific class-of-service * - * @param[in] cos_id class-of-service instance. - * - * @param[out] queue Array of queue handles associated - * with the class-of-service. - * - * @param[in] num Maximum number of queue handles to output. + * @param cos_id class-of-service instance. + * @param[out] queue Array of queue handles associated with + * the class-of-service. + * @param num Maximum number of queue handles to output. * - * @return Number of queues linked with CoS - * @retval 0 on failure + * @return Number of queues linked with CoS + * @retval on 0 failure */ uint32_t odp_cls_cos_queues(odp_cos_t cos_id, odp_queue_t queue[], uint32_t num); @@ -402,11 +395,11 @@ uint32_t odp_cls_cos_queues(odp_cos_t cos_id, odp_queue_t queue[], /** * Assign packet drop policy for specific class-of-service * - * @param[in] cos_id class-of-service instance. - * @param[in] drop_policy Desired packet drop policy for this class. + * @param cos_id class-of-service instance. + * @param drop_policy Desired packet drop policy for this class. * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure * * @note Optional. */ @@ -415,10 +408,9 @@ int odp_cos_drop_set(odp_cos_t cos_id, odp_cls_drop_t drop_policy); /** * Get the drop policy configured for a specific class-of-service instance. * -* @param[in] cos_id class-of-service instance. +* @param cos_id class-of-service instance. * -* @retval Drop policy configured with the given -* class-of-service +* @retval Drop policy configured with the given class-of-service */ odp_cls_drop_t odp_cos_drop(odp_cos_t cos_id);

@@ -426,13 +418,14 @@ odp_cls_drop_t odp_cos_drop(odp_cos_t cos_id); * Request to override per-port class of service * based on Layer-2 priority field if present. * - * @param[in] pktio_in Ingress port identifier. - * @param[in] num_qos Number of QoS levels, typically 8. - * @param[in] qos_table Values of the Layer-2 QoS header field. - * @param[in] cos_table Class-of-service assigned to each of the - * allowed Layer-2 QOS levels. - * @retval 0 on success - * @retval <0 on failure + * @param pktio_in Ingress port identifier. + * @param num_qos Number of QoS levels, typically 8. + * @param qos_table Values of the Layer-2 QoS header field. + * @param cos_table Class-of-service assigned to each of the allowed + * Layer-2 QOS levels. + * + * @retval 0 on success + * @retval <0 on failure */ int odp_cos_with_l2_priority(odp_pktio_t pktio_in, uint8_t num_qos, @@ -443,16 +436,15 @@ int odp_cos_with_l2_priority(odp_pktio_t pktio_in, * Request to override per-port class of service * based on Layer-3 priority field if present. * - * @param[in] pktio_in Ingress port identifier. - * @param[in] num_qos Number of allowed Layer-3 QoS levels. - * @param[in] qos_table Values of the Layer-3 QoS header field. - * @param[in] cos_table Class-of-service assigned to each of the - * allowed Layer-3 QOS levels. - * @param[in] l3_preference when true, Layer-3 QoS overrides - * L2 QoS when present. + * @param pktio_in Ingress port identifier. + * @param num_qos Number of allowed Layer-3 QoS levels. + * @param qos_table Values of the Layer-3 QoS header field. + * @param cos_table Class-of-service assigned to each of the allowed + * Layer-3 QOS levels. + * @param l3_preference when true, Layer-3 QoS overrides L2 QoS when present. * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure * * @note Optional. */ @@ -462,7 +454,6 @@ int odp_cos_with_l3_qos(odp_pktio_t pktio_in, odp_cos_t cos_table[], odp_bool_t l3_preference);

- /** * @typedef odp_cos_flow_set_t * Set of header fields that take part in flow signature hash calculation: @@ -554,7 +545,7 @@ typedef struct odp_pmr_param_t { * * Initialize an odp_pmr_param_t to its default values for all fields * - * @param param Address of the odp_pmr_param_t to be initialized + * @param param Address of the odp_pmr_param_t to be initialized */ void odp_cls_pmr_param_init(odp_pmr_param_t *param);

@@ -571,14 +562,14 @@ void odp_cls_pmr_param_init(odp_pmr_param_t *param); * of inspecting the return value when installing such rules, and perform * appropriate fallback action. * - * @param[in] terms Array of odp_pmr_param_t entries, one entry per - * term desired. - * @param[in] num_terms Number of terms in the match rule. - * @param[in] src_cos source CoS handle - * @param[in] dst_cos destination CoS handle + * @param terms Array of odp_pmr_param_t entries, one entry per term + * desired. + * @param num_terms Number of terms in the match rule. + * @param src_cos source CoS handle + * @param dst_cos destination CoS handle * - * @return Handle to the Packet Match Rule. - * @retval ODP_PMR_INVAL on failure + * @return Handle to the Packet Match Rule. + * @retval ODP_PMR_INVAL on failure */ odp_pmr_t odp_cls_pmr_create(const odp_pmr_param_t *terms, int num_terms, odp_cos_t src_cos, odp_cos_t dst_cos); @@ -593,10 +584,10 @@ odp_pmr_t odp_cls_pmr_create(const odp_pmr_param_t *terms, int num_terms, * may not guarantee the availability of hardware resources to create the * same or essentially similar rule. * - * @param[in] pmr_id Identifier of the PMR to be destroyed + * @param pmr_id Identifier of the PMR to be destroyed * - * @retval 0 on success - * @retval <0 on failure + * @retval 0 on success + * @retval <0 on failure */ int odp_cls_pmr_destroy(odp_pmr_t pmr_id);

@@ -607,31 +598,30 @@ int odp_cls_pmr_destroy(odp_pmr_t pmr_id); * The packet pool associated with class of service will supersede the * packet pool associated with the pktio interface. * -* @param cos_id class of service handle -* @param pool_id packet pool handle +* @param cos_id class of service handle +* @param pool_id packet pool handle * -* @retval 0 on success -* @retval <0 on failure +* @retval 0 on success +* @retval <0 on failure */ 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 +* @param cos_id class of service handle * -* @retval pool handle of the associated pool -* @retval ODP_POOL_INVALID if no associated pool found or -* in case of an error +* @retval pool handle of the associated pool +* @retval ODP_POOL_INVALID if no associated pool found or in case 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 - * @return uint64_t value that can be used to print/display this - * handle + * @param hdl odp_cos_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 @@ -642,9 +632,9 @@ uint64_t odp_cos_to_u64(odp_cos_t hdl); /** * Get printable value for an odp_pmr_t * - * @param hdl odp_pmr_t handle to be printed - * @return uint64_t value that can be used to print/display this - * handle + * @param hdl odp_pmr_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

commit 32bd7464a8d86b0d83daf1760202dbdc5eabccec Author: Petri Savolainen petri.savolainen@linaro.org Date: Mon Dec 4 13:51:50 2017 +0200

api: queue: remove param-in doxygen tag

All parameters are input only (tag [in]) by default. Output parameters are better highlighted, when only those are tagged.

Signed-off-by: Petri Savolainen petri.savolainen@linaro.org Reviewed-by: Bill Fischofer bill.fischofer@linaro.org Signed-off-by: Maxim Uvarov maxim.uvarov@linaro.org

diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index 73598be0..014d3362 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -309,7 +309,7 @@ int odp_queue_enq(odp_queue_t queue, odp_event_t ev); * has to take care of them. * * @param queue Queue handle - * @param[in] events Array of event handles + * @param events Array of event handles * @param num Number of event handles to enqueue * * @return Number of events actually enqueued (0 ... num)

-----------------------------------------------------------------------

Summary of changes: include/odp/api/spec/classification.h | 166 +++++---- include/odp/api/spec/queue.h | 2 +- include/odp/api/spec/traffic_mngr.h | 639 +++++++++++++++++----------------- 3 files changed, 397 insertions(+), 410 deletions(-)

hooks/post-receive