| Message ID | 1478280870-1669-1-git-send-email-bala.manoharan@linaro.org |
|---|---|
| State | Accepted |
| Commit | 2c060a9d3b9f067f4cca2094be845e54392077ec |
| Headers | show |
This patch got lost somehow. Pls review the same. Regards, Bala On 4 November 2016 at 23:04, Balasubramanian Manoharan <bala.manoharan@linaro.org> wrote: > Updates classification configuration documentation. > > Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> > --- > v2: Incorporates review comments > include/odp/api/spec/packet_io.h | 17 ++++++++++------- > 1 file changed, 10 insertions(+), 7 deletions(-) > > diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h > index d46e405..6598d3e 100644 > --- a/include/odp/api/spec/packet_io.h > +++ b/include/odp/api/spec/packet_io.h > @@ -189,12 +189,11 @@ typedef struct odp_pktin_queue_param_t { > > /** Number of input queues to be created > * > - * When classifier is enabled the number of queues may be zero > - * (in odp_pktin_queue_config() step), otherwise at least one > - * queue is required. More than one input queues require either flow > - * hashing or classifier enabled. The maximum value is defined by > - * pktio capability 'max_input_queues'. Queue type is defined by the > - * input mode. The default value is 1. */ > + * When classifier is enabled in odp_ipktin_queue_config() this > + * value is ignored, otherwise at least one queue is required. > + * More than one input queues require flow hashing configured. > + * The maximum value is defined by pktio capability 'max_input_queues'. > + * Queue type is defined by the input mode. The default value is 1. */ > unsigned num_queues; > > /** Queue parameters > @@ -202,7 +201,9 @@ typedef struct odp_pktin_queue_param_t { > * These are used for input queue creation in ODP_PKTIN_MODE_QUEUE > * or ODP_PKTIN_MODE_SCHED modes. Scheduler parameters are considered > * only in ODP_PKTIN_MODE_SCHED mode. Default values are defined in > - * odp_queue_param_t documentation. */ > + * odp_queue_param_t documentation. > + * when classifier is enabled in odp_pktin_queue_config() this > + * value is ignored. */ > odp_queue_param_t queue_param; > > } odp_pktin_queue_param_t; > @@ -887,6 +888,8 @@ int odp_pktio_mac_addr(odp_pktio_t pktio, void *mac_addr, int size); > * > * @retval 0 on success > * @retval <0 on failure > + * > + * @note The default_cos has to be unique per odp_pktio_t instance. > */ > int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos); > > -- > 1.9.1 >
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Otherwise OK, but a typo could be corrected during merge. See under. -Petri > -----Original Message----- > From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of > Balasubramanian Manoharan > Sent: Friday, November 04, 2016 7:35 PM > To: lng-odp@lists.linaro.org > Subject: [lng-odp] [API-NEXTv2 1/1] api: pktio: adds further definition > for classification configuration > > Updates classification configuration documentation. > > Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> > --- > v2: Incorporates review comments > include/odp/api/spec/packet_io.h | 17 ++++++++++------- > 1 file changed, 10 insertions(+), 7 deletions(-) > > diff --git a/include/odp/api/spec/packet_io.h > b/include/odp/api/spec/packet_io.h > index d46e405..6598d3e 100644 > --- a/include/odp/api/spec/packet_io.h > +++ b/include/odp/api/spec/packet_io.h > @@ -189,12 +189,11 @@ typedef struct odp_pktin_queue_param_t { > > /** Number of input queues to be created > * > - * When classifier is enabled the number of queues may be zero > - * (in odp_pktin_queue_config() step), otherwise at least one > - * queue is required. More than one input queues require either > flow > - * hashing or classifier enabled. The maximum value is defined by > - * pktio capability 'max_input_queues'. Queue type is defined by > the > - * input mode. The default value is 1. */ > + * When classifier is enabled in odp_ipktin_queue_config() this > + * value is ignored, otherwise at least one queue is required. > + * More than one input queues require flow hashing configured. > + * The maximum value is defined by pktio capability > 'max_input_queues'. > + * Queue type is defined by the input mode. The default value is 1. > */ > unsigned num_queues; > > /** Queue parameters > @@ -202,7 +201,9 @@ typedef struct odp_pktin_queue_param_t { > * These are used for input queue creation in ODP_PKTIN_MODE_QUEUE > * or ODP_PKTIN_MODE_SCHED modes. Scheduler parameters are > considered > * only in ODP_PKTIN_MODE_SCHED mode. Default values are defined in > - * odp_queue_param_t documentation. */ > + * odp_queue_param_t documentation. > + * when classifier is enabled in odp_pktin_queue_config() this Capital 'W': When classifier ... > + * value is ignored. */ > odp_queue_param_t queue_param; > > } odp_pktin_queue_param_t; > @@ -887,6 +888,8 @@ int odp_pktio_mac_addr(odp_pktio_t pktio, void > *mac_addr, int size); > * > * @retval 0 on success > * @retval <0 on failure > + * > + * @note The default_cos has to be unique per odp_pktio_t instance. > */ > int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos); > > -- > 1.9.1
On 12/23/16 11:41, Savolainen, Petri (Nokia - FI/Espoo) wrote: > Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> > Merged, > Otherwise OK, but a typo could be corrected during merge. See under. > Done. > -Petri > > >> -----Original Message----- >> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of >> Balasubramanian Manoharan >> Sent: Friday, November 04, 2016 7:35 PM >> To: lng-odp@lists.linaro.org >> Subject: [lng-odp] [API-NEXTv2 1/1] api: pktio: adds further definition >> for classification configuration >> >> Updates classification configuration documentation. >> >> Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> >> --- >> v2: Incorporates review comments >> include/odp/api/spec/packet_io.h | 17 ++++++++++------- >> 1 file changed, 10 insertions(+), 7 deletions(-) >> >> diff --git a/include/odp/api/spec/packet_io.h >> b/include/odp/api/spec/packet_io.h >> index d46e405..6598d3e 100644 >> --- a/include/odp/api/spec/packet_io.h >> +++ b/include/odp/api/spec/packet_io.h >> @@ -189,12 +189,11 @@ typedef struct odp_pktin_queue_param_t { >> >> /** Number of input queues to be created >> * >> - * When classifier is enabled the number of queues may be zero >> - * (in odp_pktin_queue_config() step), otherwise at least one >> - * queue is required. More than one input queues require either >> flow >> - * hashing or classifier enabled. The maximum value is defined by >> - * pktio capability 'max_input_queues'. Queue type is defined by >> the >> - * input mode. The default value is 1. */ >> + * When classifier is enabled in odp_ipktin_queue_config() this >> + * value is ignored, otherwise at least one queue is required. >> + * More than one input queues require flow hashing configured. >> + * The maximum value is defined by pktio capability >> 'max_input_queues'. >> + * Queue type is defined by the input mode. The default value is 1. >> */ >> unsigned num_queues; >> >> /** Queue parameters >> @@ -202,7 +201,9 @@ typedef struct odp_pktin_queue_param_t { >> * These are used for input queue creation in ODP_PKTIN_MODE_QUEUE >> * or ODP_PKTIN_MODE_SCHED modes. Scheduler parameters are >> considered >> * only in ODP_PKTIN_MODE_SCHED mode. Default values are defined in >> - * odp_queue_param_t documentation. */ >> + * odp_queue_param_t documentation. >> + * when classifier is enabled in odp_pktin_queue_config() this > > > Capital 'W': When classifier ... > > > >> + * value is ignored. */ >> odp_queue_param_t queue_param; >> >> } odp_pktin_queue_param_t; >> @@ -887,6 +888,8 @@ int odp_pktio_mac_addr(odp_pktio_t pktio, void >> *mac_addr, int size); >> * >> * @retval 0 on success >> * @retval <0 on failure >> + * >> + * @note The default_cos has to be unique per odp_pktio_t instance. >> */ >> int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos); >> >> -- >> 1.9.1 >
diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h index d46e405..6598d3e 100644 --- a/include/odp/api/spec/packet_io.h +++ b/include/odp/api/spec/packet_io.h @@ -189,12 +189,11 @@ typedef struct odp_pktin_queue_param_t { /** Number of input queues to be created * - * When classifier is enabled the number of queues may be zero - * (in odp_pktin_queue_config() step), otherwise at least one - * queue is required. More than one input queues require either flow - * hashing or classifier enabled. The maximum value is defined by - * pktio capability 'max_input_queues'. Queue type is defined by the - * input mode. The default value is 1. */ + * When classifier is enabled in odp_ipktin_queue_config() this + * value is ignored, otherwise at least one queue is required. + * More than one input queues require flow hashing configured. + * The maximum value is defined by pktio capability 'max_input_queues'. + * Queue type is defined by the input mode. The default value is 1. */ unsigned num_queues; /** Queue parameters @@ -202,7 +201,9 @@ typedef struct odp_pktin_queue_param_t { * These are used for input queue creation in ODP_PKTIN_MODE_QUEUE * or ODP_PKTIN_MODE_SCHED modes. Scheduler parameters are considered * only in ODP_PKTIN_MODE_SCHED mode. Default values are defined in - * odp_queue_param_t documentation. */ + * odp_queue_param_t documentation. + * when classifier is enabled in odp_pktin_queue_config() this + * value is ignored. */ odp_queue_param_t queue_param; } odp_pktin_queue_param_t; @@ -887,6 +888,8 @@ int odp_pktio_mac_addr(odp_pktio_t pktio, void *mac_addr, int size); * * @retval 0 on success * @retval <0 on failure + * + * @note The default_cos has to be unique per odp_pktio_t instance. */ int odp_pktio_default_cos_set(odp_pktio_t pktio, odp_cos_t default_cos);
Updates classification configuration documentation. Signed-off-by: Balasubramanian Manoharan <bala.manoharan@linaro.org> --- v2: Incorporates review comments include/odp/api/spec/packet_io.h | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) -- 1.9.1