From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 63A05A0471 for ; Wed, 17 Jul 2019 17:01:05 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 21C191BE0D; Wed, 17 Jul 2019 17:01:05 +0200 (CEST) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 0A50D1BDE2 for ; Wed, 17 Jul 2019 17:01:02 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Jul 2019 08:01:01 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,274,1559545200"; d="scan'208";a="167980504" Received: from irsmsx152.ger.corp.intel.com ([163.33.192.66]) by fmsmga008.fm.intel.com with ESMTP; 17 Jul 2019 08:01:01 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.45]) by IRSMSX152.ger.corp.intel.com ([169.254.6.27]) with mapi id 14.03.0439.000; Wed, 17 Jul 2019 16:00:58 +0100 From: "Singh, Jasvinder" To: "Dumitrescu, Cristian" , "dev@dpdk.org" CC: "Tovar, AbrahamX" , "Krakowiak, LukaszX" Thread-Topic: [PATCH v4 06/11] sched: improve doxygen comments Thread-Index: AQHVO3Bk0/qy05S1vUqPiXq/d22H86bO6XhA Date: Wed, 17 Jul 2019 15:00:57 +0000 Message-ID: <54CBAA185211B4429112C315DA58FF6D3FD9489B@IRSMSX103.ger.corp.intel.com> References: <20190711102659.59001-2-jasvinder.singh@intel.com> <20190712095729.159767-1-jasvinder.singh@intel.com> <20190712095729.159767-7-jasvinder.singh@intel.com> <3EB4FA525960D640B5BDFFD6A3D891268E8EEE05@IRSMSX108.ger.corp.intel.com> In-Reply-To: <3EB4FA525960D640B5BDFFD6A3D891268E8EEE05@IRSMSX108.ger.corp.intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMjUwYTFhODItNTViZS00YjM1LWE4ZTYtZTdjMjAxYjczNTFmIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiOXc4UllVRFYydXh6TTJ5aHVkc2VWYVVwaUJWZ3FOWHpVUXI3UEhcL1wvclwvRXBCOG10RVZxUkljbzdWUTJHT2wrNCJ9 x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v4 06/11] sched: improve doxygen comments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > > /** Port configuration parameters. */ struct rte_sched_port_params { > > - const char *name; /**< String to be associated */ > > - int socket; /**< CPU socket ID */ > > - uint32_t rate; /**< Output port rate > > - * (measured in bytes per second) */ > > - uint32_t mtu; /**< Maximum Ethernet frame size > > - * (measured in bytes). > > - * Should not include the framing > > overhead. */ > > - uint32_t frame_overhead; /**< Framing overhead per packet > > - * (measured in bytes) */ > > - uint32_t n_subports_per_port; /**< Number of subports */ > > - uint32_t n_pipes_per_subport; /**< Number of pipes per subport > > */ > > + /** Name of the port to be associated */ > > + const char *name; > > + > > + /** CPU socket ID */ > > + int socket; > > + > > + /** Output port rate (measured in bytes per second) */ > > + uint32_t rate; > > + > > + /** Maximum Ethernet frame size (measured in bytes). > > + * Should not include the framing overhead. > > + */ > > + uint32_t mtu; > > + > > + /** Framing overhead per packet (measured in bytes) */ > > + uint32_t frame_overhead; > > + > > + /** Number of subports */ > > + uint32_t n_subports_per_port; > > + > > + /** Number of subport_pipes */ > > + uint32_t n_pipes_per_subport; > > + > > + /** Packet queue size for each traffic class. > > + * All the pipes within the same subport share the similar > > + * configuration for the queues. Queues which are not needed, have > > + * zero size. > > + */ > > uint16_t qsize[RTE_SCHED_QUEUES_PER_PIPE]; > > - /**< Packet queue size for each traffic class. > > - * Queues which are not needed are allowed to have zero size. */ > > + > > + /** Pipe profile table. > > + * Every pipe is configured using one of the profiles from this table= . > > + */ > > struct rte_sched_pipe_params *pipe_profiles; > > - /**< Pipe profile table. > > - * Every pipe is configured using one of the profiles from this table= . > > */ > > - uint32_t n_pipe_profiles; /**< Profiles in the pipe profile ta= ble */ > > + > > + /** Profiles in the pipe profile table */ > > + uint32_t n_pipe_profiles; > > + > > + /** Max profiles allowed in the pipe profile table */ > > uint32_t n_max_pipe_profiles; > > - /**< Max profiles allowed in the pipe profile table */ > > + > > #ifdef RTE_SCHED_RED > > - struct rte_red_params > > red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][RTE_COLORS]; /**< > RED > > parameters */ > > + /** RED parameters */ > > + struct rte_red_params > > red_params[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE][RTE_COLORS]; > > #endif > > }; > > > > @@ -328,8 +369,8 @@ rte_sched_port_get_memory_footprint(struct > > rte_sched_port_params *params); > > * Pointer to pre-allocated subport statistics structure where the s= tatistics > > * counters should be stored > > * @param tc_ov > > - * Pointer to pre-allocated 4-entry array where the oversubscription= status > > for > > - * each of the 4 subport traffic classes should be stored. > > + * Pointer to pre-allocated 13-entry array where the oversubscriptio= n > > status for > > + * each of the subport traffic classes should be stored. > > * @return > > * 0 upon success, error code otherwise > > */ > > @@ -374,7 +415,7 @@ rte_sched_queue_read_stats(struct rte_sched_port > > *port, > > * @param pipe > > * Pipe ID within subport > > * @param traffic_class > > - * Traffic class ID within pipe (0 .. 3) > > + * Traffic class ID within pipe (0 .. 12) > > * @param queue > > * Queue ID within pipe traffic class (0 .. 3) > > * @param color > > @@ -401,7 +442,7 @@ rte_sched_port_pkt_write(struct rte_sched_port > > *port, > > * @param pipe > > * Pipe ID within subport > > * @param traffic_class > > - * Traffic class ID within pipe (0 .. 3) > > + * Traffic class ID within pipe (0 .. 12) > > * @param queue > > * Queue ID within pipe traffic class (0 .. 3) > > * >=20 > It would be great if we could replace these magic numbers of 3, 12, etc w= ith > the corresponding macros (in the API file at least, but it would be great= to do it > in the .c file as well). > > -- Improved API doxygen comments in v5, thanks.