From patchwork Sat Dec 9 14:40:07 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pavan Nikhilesh X-Patchwork-Id: 32054 X-Patchwork-Delegate: jerinj@marvell.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 8E13925E5; Sat, 9 Dec 2017 15:41:01 +0100 (CET) Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0081.outbound.protection.outlook.com [104.47.38.81]) by dpdk.org (Postfix) with ESMTP id 38D06201 for ; Sat, 9 Dec 2017 15:40:59 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=1n5PM9jYD5b7N34zxN9qAH9sgM4rty2FJJc/F9Ogsho=; b=eM4LHuPPl0CQM10sBqb1C4GYMCSu6sEnDPxwnyVBL5zRapG6bQgfztCkUZz/t7PyLkEluN0Istv0TT8AT5lliKM79mdRAJZXvZ4/KsOrFTizC7PErbtFXZ8NNPQrTZTBddj5Y6AZ6c+AOYcFECNLJSSFHbU7/2E4seodW9uDvUU= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Pavan.Bhagavatula@cavium.com; Received: from localhost.localdomain (103.16.71.47) by MWHPR07MB3472.namprd07.prod.outlook.com (10.164.192.23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.302.9; Sat, 9 Dec 2017 14:40:56 +0000 From: Pavan Nikhilesh To: jerin.jacob@caviumnetworks.com Cc: dev@dpdk.org, Pavan Nikhilesh Date: Sat, 9 Dec 2017 20:10:07 +0530 Message-Id: <20171209144007.30167-1-pbhagavatula@caviumnetworks.com> X-Mailer: git-send-email 2.14.1 MIME-Version: 1.0 X-Originating-IP: [103.16.71.47] X-ClientProxiedBy: HK2PR02CA0180.apcprd02.prod.outlook.com (10.171.31.16) To MWHPR07MB3472.namprd07.prod.outlook.com (10.164.192.23) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 2a636314-a37c-4834-ff28-08d53f12dbf3 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(5600026)(4604075)(4534020)(4602075)(4627115)(201703031133081)(201702281549075)(2017052603307); SRVR:MWHPR07MB3472; X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3472; 3:Yh/qGKtrz34zRfKXxNDpyPPc1VJoFuZ9ksTpjFNSBi75L/rry16NiNocJrehS7HSsP7+tDDH/ftJOtlR1HxSzGaT7Qy7PbQ5FmWQQRmMigBrppND7ERMxPQwfg5D+49KXd/urjAf9Iaid1x5VZhkxXSSpNLcTJR1bXsmKJKqI5rrOHjGTkkWGPFHchEf931sKXthnYX1G375Vg9z1CbF06qW7ZWbybI31Y35vIWKMeSsDZds1He8vcZDFZnI9l4a; 25:15sSQwvuYx6Om1rG4qwzCAya+NCm/gTKlnfqvNYY2dYMPbVJajUE/bYJGrODfZww2XTSoQh28Opfgj56WoF9EgBMVNDSUjJ9NGJUJazmNDzPusqzT1VP0d9PmifD7uCzfFgZgVLV+4lCKRCiCwJ9Q7a8NK1HgYhmpmnxJYUx0jP2C+J6EOCeki3SklHi23qkUF9L+J1xwOCZfUbMMBZgDyjmjhxp/2EyPj3NxgVpEcDiYmVn4gRfL1ItfD7ROh2CKnXfplEfGkU5fGBVIyvrVl068kJJO94PVIQsWzj2KnBdZ4lBswZY5TVVXGyhHn3fV9DQD6aDyCTbwbsbwbeYcQ==; 31:Yi4SA1qcIqvf/m/8wlgqk07T4B4Y7lsYbraQoQZ78l0KgozL4dIIPiFDOXUF8xIso8u/eivL4kotb9FSY53YNZJzX5rxV6yr/pgXb/1gre1veCSjw0ievixdVcLwUi3GfaHVQpcklUka4vb2j2e8tKCbt5qEYJ8U6g0bWsvmhxPtipmjKLyNJpeJjfFUtbPIVp5vUsmrTQmlPnozSGxUXtrYStjyw/vLrN55lJMyFbw= X-MS-TrafficTypeDiagnostic: MWHPR07MB3472: X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3472; 20:VsA1XqZ4SmeaVU+xlSrAfwQxOxfws5iR9BilsJbihSVPFLgeN4KZfOZfgdj+J773d7mNfNmlcBZFUFXVQp6NHQcR0njjtFfv6FX9Gs5IJKOmStfgkMcHBQ6xq1muSPueRG413Hph+WdDKN+kdycZrk7OWKJ6Q+0GZzRe1yfPjDmayABSpsQtBo5DNn8t8NLlcmX3vuE0P48m7PwATRNXY86Kis2h8DbPd6UozgHRf8d/DbwGdXfikrfk33wL44BPCGtKL6wgx5hjyNGJm5s2qPio2U9wxz675ktYIs9ddC09zy5moGhLDl6keeq1vSV6IFtTLfxXDXYKarqHSCupCLS1ePjGZsQVwPk6F+pfIhrXnnf878yggUjp2oGGZlaHYE6Thhwhqmz5i+Mn2drpVyBQ04ZssRlD/LrPhgByUubXD4SGtPtJ1qFLQ2kdvuLe29cjdcC9LF9ZMErcYg3esxKpStIHC34uxUwc74aoLAxyLkrQMXSK7dKuSKb7ueyyMEAU1EuGpK+Bk5AlbD6yxxCXbWrUTXjgFWLmUEIqxSucCcIwK5HHxo3AeYq0PhEd4MwcoQCbmgPfP96V/raeUy8wjuec3NFEQI8sbOHGq7w=; 4:2OhccansWPv3AA7ITyCVy+Gi5I0LOI2JIEyK8cgzqqjov2gV3+O49Cf03tx1wVdFYvMVbv8bsDZSgmUAVM9wfXwjisDyx+X12q7fqO2njAMrYK3LopjsiJD7rhKZmb5bhvhKXDbRFcI+oiXv7gAtma8ym2AOO/zs6GlXNjeFVw1i7b6IPVJ/TkUN+of/GyM4DCDq9O3+psJiVPO72eO1ZFGckjB1GOqZ2BO2VREtE1yFG7ROm3YgV2MDK1B/Zg81WTix51KJAqHylOu/thOMIQ== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040450)(2401047)(8121501046)(5005006)(93006095)(3002001)(10201501046)(3231022)(6041248)(20161123562025)(20161123564025)(20161123560025)(20161123555025)(20161123558100)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(6072148)(201708071742011); SRVR:MWHPR07MB3472; BCL:0; PCL:0; RULEID:(100000803101)(100110400095); SRVR:MWHPR07MB3472; X-Forefront-PRVS: 05168A3970 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6069001)(346002)(376002)(366004)(189003)(199004)(107886003)(316002)(7736002)(4326008)(36756003)(33646002)(81166006)(8676002)(34206002)(106356001)(81156014)(105586002)(50466002)(48376002)(6666003)(2351001)(478600001)(6636002)(2361001)(42882006)(68736007)(72206003)(25786009)(6486002)(6506006)(52116002)(2906002)(53936002)(66066001)(47776003)(8936002)(5660300001)(50226002)(1076002)(305945005)(6116002)(6512007)(3846002)(37006003)(51416003)(16586007)(97736004)(16526018)(42262002); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR07MB3472; H:localhost.localdomain; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; MWHPR07MB3472; 23:S738DrmyO9v4o6ml9JJ6JbFVp4VF4wDj5OHWUZz6n?= dcsqw06ii5KgUo1qtmMX0sDEAWcuNBSmUSL+2KQnFQsCXVpZKZRlGsTFhpfcz/yr/ErxImTxGiKv0ntQQyjOv46KHe5JE1dWCjqAq9qj5nQqKSjGmW8wiP5DwUrkL8rlwPV897gbfxWeL8zTJZ6VHiN95TxTp0vlJ/ZGxVwoHjHefLs9eMBJJCHlZsZRXl2nA8tfJtfZdMoZ8UIIG+X/CUQMTBFsHsFWwuSBBngzRctyT9SL9oBxDAUHh2GY1I8TVeapXqjY+PY6tRqOKy+t+ej+uS3HhuYv/8C7CkbM6tIWt1f7u3ASlHZklQH5uVu1BkP9bpDYHIw2Ee4mgM4jXeBFBwzdf6ZNu6LLt/oSsZbipSx3n+PLl77RjZecVG+9NMtz0gRI2PMkmmEvec28jCrtnBjRP6rX2DGdVmhqrSNYqIFN8DsaU7Md4jdZ86qjBZoU/9EgqP8nVYKZ62o3gqcSY60dxR/m/KqRkMKSrDq6A/Di2ckjMgsoMYJLdr+iXMzwRbbkfKerkVCqIHeWcAZL3QCFTzi7cmsKNHOhwkyLqPfaUhZ7s/RgcQSXY6FcFbnRYVWwBnThpsuteSaK/jU7YjI9TiNUqUpadAljzkzu8dYOZx5Kxs+YSaUOZrtUGUEKUYmY21QtkgXrrIlEXac/AYvh1onqPa/3KP4JaYPPDwS96xlzdY5udwN9f51XUaYNWDTP3QLTBabu7uk0jyBcboj/zK+m4epnJWno+Hi1AsOPzD7GPnpHTo9MzciXbSDQ/ErlSR9ekSMxZlemY5YA1D6jxj8EWUaHqZ6YFQsm9fwXD9vFv+ydq89iwH4uOAtydGzukLYskEmQz7VwlbjeUxqfRKpmzK40qTRuUaDJVwKUunomEDFN0wv4xWx65/q5XYU7i6istWKBEXR1b/NRVyD9uU5mq9sPJBIFNptfKWD5SZfHwF/KjO+CPtECYtISxWAlgZIExNqxYOpkNBGB6TTQ6PeS7E1aGeHI933NqoJ2jqQarg2adDBWQQRadfbeMZKY0ho9WIypp8ysiMDJSvjanLvrVA/O6xMiApz89GaXJZBeaSa1sfyrPfRpjk0sQQUBbZ3DsBPj+jzwAu7 X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3472; 6:D0pS23Pc0srsI4gY71w5IBR+nn8sNOeOxOV0ENNB1FwxBLJ48K+FV74RYjgdJMyv4TINRpYLio+Lm3ucPPQgMv5CDK5S0l3lhdJu232teXBsdQBg0TY41gZR8cGHdsTnn7kZDM3bakMx/PGg3HgFJEJ/lgonSB2QiiWfsGuLXPMa0sLeR1nSkLINcrDIvEwOjzpFN+Z/jwVF2Rz46UR8vUIjL5TouKXzNfm1AeHH2JQJIabFf12hN7VapPKIxjyGipjrZQ5MS3hUcXJJUqSO3Mk+/67AZYgX1FqQ33OAoHfrIM4+xLfiJ+CwEccpFZOxRJS1vtQs3vmMv2lHKpfeTX3rksdk93gLGcKYmSs/4y0=; 5:F5R4hoJr3LqmG71Rez4yBX2W8CUlvq6Vwcok6IQ57lN1+pXXtT9Wlhq+YPjIXX22d7g+k2VkbhDU2fePBIj3X1u2gG3X0IIjii2yIpoy5a0ZozKkNqm1LE0LWJDL1D39Ik/o0NQgErVJw3Rpf4G2vxTNmP7waP2lSSbGZJ6wRMk=; 24:czUnDg8shyS/jAdvJUrYSi2oJGoGnH2CLYVdee4Vleg5jJvVyD0J1udBkARw5kF1TyK0+lVYC/sjk80u8ioaxizC7W8mTjpEoU0Ig8+SZLs=; 7:aR2UauDKRj3JY8KTX+Io93o3DhnmgO0PEKaQQUXiQNWcMWpQY3ByAdgDSuCPrODp/pa+RMyxhBANj8M40OzZIFojCqg/9LphecDjtKaeJYZyTe8xW31HNHcXuSs6Q1baNpRkrEqaQ4hshUQ5H7cef0GvY3zTaJVtTaUvDbtv+U/oJ5mZ4NFhveYL/Kws3Gwcp/Ihsfo9l8xIxAPuNl6k1DUdJEYWnogMG/1adhHmqGCZshfInMV94YDQedU2Hxei SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Dec 2017 14:40:56.3705 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 2a636314-a37c-4834-ff28-08d53f12dbf3 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR07MB3472 Subject: [dpdk-dev] [PATCH] eventdev: fix 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" Fix doxygen return values and indentation. Fixes: 64103dbcd673 ("eventdev: add dev attribute get function") Signed-off-by: Pavan Nikhilesh Acked-by: Kevin Laatz --- lib/librte_eventdev/rte_eventdev.h | 50 ++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h index f1949ff7d..611e58b79 100644 --- a/lib/librte_eventdev/rte_eventdev.h +++ b/lib/librte_eventdev/rte_eventdev.h @@ -420,9 +420,9 @@ rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); * @param[out] attr_value A pointer that will be filled in with the attribute * value if successful. * - * @retval 0 Successfully retrieved attribute value - * -EINVAL Invalid device or *attr_id* provided, or *attr_value* - * is NULL + * @return + * - 0: Successfully retrieved attribute value + * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL */ int rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, @@ -640,18 +640,22 @@ rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, /** * Get an attribute from a queue. * - * @param dev_id Eventdev id - * @param queue_id Eventdev queue id - * @param attr_id The attribute ID to retrieve - * @param[out] attr_value A pointer that will be filled in with the attribute - * value if successful + * @param dev_id + * Eventdev id + * @param queue_id + * Eventdev queue id + * @param attr_id + * The attribute ID to retrieve + * @param[out] attr_value + * A pointer that will be filled in with the attribute value if successful * - * @retval 0 Successfully returned value - * -EINVAL invalid device, queue or attr_id provided, or attr_value - * was NULL - * -EOVERFLOW returned when attr_id is set to - * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to - * RTE_EVENT_QUEUE_CFG_ALL_TYPES + * @return + * - 0: Successfully returned value + * - -EINVAL: invalid device, queue or attr_id provided, or attr_value was + * NULL + * - -EOVERFLOW: returned when attr_id is set to + * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to + * RTE_EVENT_QUEUE_CFG_ALL_TYPES */ int rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, @@ -754,14 +758,18 @@ rte_event_port_setup(uint8_t dev_id, uint8_t port_id, /** * Get an attribute from a port. * - * @param dev_id Eventdev id - * @param port_id Eventdev port id - * @param attr_id The attribute ID to retrieve - * @param[out] attr_value A pointer that will be filled in with the attribute - * value if successful + * @param dev_id + * Eventdev id + * @param port_id + * Eventdev port id + * @param attr_id + * The attribute ID to retrieve + * @param[out] attr_value + * A pointer that will be filled in with the attribute value if successful * - * @retval 0 Successfully returned value - * -EINVAL Invalid device, port or attr_id, or attr_value was NULL + * @return + * - 0: Successfully returned value + * - (-EINVAL) Invalid device, port or attr_id, or attr_value was NULL */ int rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id,