From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E9546426E6; Sun, 8 Oct 2023 03:51:52 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CB3A340697; Sun, 8 Oct 2023 03:51:35 +0200 (CEST) Received: from NAM12-BN8-obe.outbound.protection.outlook.com (mail-bn8nam12on2093.outbound.protection.outlook.com [40.107.237.93]) by mails.dpdk.org (Postfix) with ESMTP id 581BE4067D for ; Sun, 8 Oct 2023 03:51:34 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=L+EIdIGtNc5+N83tQlRj8adMB3cTnJOXrcePjnCZUArHmo9kjdWkCxwhjPViHzUjVHkmVrHt2QnA19N2XOEy5ntxjSr293xCRcSGpoAujIo8Lah4xj4YiqbE6lNimMn8tCFSvikwp/DlVK3owoYbkRzS/NkTNUbst3TtFwqUa58fcgYOYL8qocNJRMicqJ1YTzwDL1DZRqaf3+w6vfXZDYavpU32QXss/H9rzMQqcryA2CzTFHlAICO7KtCnyXRHwGfJweSxDwUDNrbYYp0ZTUfHDpa+4NGESatHYo25b8h3pRJEBJIv1YEWQLKwID+eOiMsj9bbG/NwuyB/ow9QGQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=RLv62KYSeTJdWLfvUn3SGfp8vzepnddlcNxrnblvZlA=; b=V+gprN32m4sRQaiP6L3TSuEMqsxxW2LT3pyTFZobuTmoGYlMRN5W8/OEF8ToIabKb1VopkchdiyMRklTRNL4Jm7kmy0M+4tJF+ef/3sUkNPu9WotjFS0awZCWtMHEXZXPkLSobPdATCMOlOfdXND5sst69jtKELRXG9IZpsCfR4UfvRTaS9B2ZGV/gIkSpnAVNpwkPhry4mX6kUsElDrHm3SKgGCer3o5tVBcc0/uOdQWBpyATrZyE4vA6H4/p/S1JeENp2v92tXoKXsyFUgbtOSEV9+uRFawpNq+uHGx1evXvUjBcgybyaYv5Z9kWP175T18aNhwgJ1AneUCnT0mA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=corigine.com; dmarc=pass action=none header.from=corigine.com; dkim=pass header.d=corigine.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=corigine.onmicrosoft.com; s=selector2-corigine-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=RLv62KYSeTJdWLfvUn3SGfp8vzepnddlcNxrnblvZlA=; b=Qa/45HjyOcQ1+XQ0xtHQoghmyDW125IL6r1058ya1IP75xXfOuSAoztbQ2WeHfCvFGZSzY/yoLJKRFacO5tKNkW2sk7lNej0RRT11j6auDIYqsOHD/odzk9TcgsmKLgv3HvPjcEl7GH8ffKW98x0nmaFMGslQUI262kMleIdyHA= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) by BLAPR13MB4579.namprd13.prod.outlook.com (2603:10b6:208:327::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6838.41; Sun, 8 Oct 2023 01:51:31 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::28c0:63e2:ecd1:9314]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::28c0:63e2:ecd1:9314%4]) with mapi id 15.20.6813.027; Sun, 8 Oct 2023 01:51:31 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, Long Wu , James Hershaw , Chaoyong He Subject: [PATCH v3 3/8] net/bonding: modify interface comment format Date: Sun, 8 Oct 2023 09:50:36 +0800 Message-Id: <20231008015041.1551165-4-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20231008015041.1551165-1-chaoyong.he@corigine.com> References: <20231007013440.1309422-1-chaoyong.he@corigine.com> <20231008015041.1551165-1-chaoyong.he@corigine.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: SJ0PR05CA0173.namprd05.prod.outlook.com (2603:10b6:a03:339::28) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|BLAPR13MB4579:EE_ X-MS-Office365-Filtering-Correlation-Id: 37b58c2f-61a8-4198-db2a-08dbc7a11828 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: poFkJZmLO490IGyu8NIzlw0g9qh0K8pcHYlc5pzfeaBUWLJMVKyF1EqMjYLZrTdRCJYpFCBwW2d+MVH5dwYa7sENQ2Y2lCkF07xBWyBhP6eEzKbB3tdILv0h4+MdRugdWZSveap+kJ/qtsoS1l5UDsGdm61hDT002SA/rHz97rTfoaoh+sVqmreYFuNqZ81nmjF4mxEOLb4bWaejADxqznnCtebwMNss7KHf9vd8OMatT+WsjSIvhM3ec6hNVQ6/E4ltbGtV7em3gGjAKbmuPL0sXykrxFZ4P+td6kC5PX+h5ErnbtorDuOzAB/H+i9E6zIu+HWBiMd5kE8AFA+Mt6Va4Akp2Qn0KPbsr6MU941FsQ3CWNyTR8Txbb1Ozl1NLHL1ZZ/HYf3w8NoSBpyk6EG7PAVbQPmJyD1DE3Ku9UCn+Q0r1cYW4A4E04oGo5lChhjwJ0xFUzTYHtHDR2yRNF5KOcOnRa1bXREcElrA7bt/Am+yl0lcBNzcdxTHTIV+/tXxJ5l0BKx2Q3iMQqae4xMEkHQuGURCRYcHiXtuhoyZJE6GtRrShnwtrWepFR0JvuMMArkOviwjkoPW+48LxG+vbdUMF+4GsyrTNzxHSx3mKWYsORxdyDKAhAOuA4vmb5r0oCyzLgJFmIqEDnCS7gBg8rLHbhE8qXe8JTe/hiA= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR13MB5545.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(39830400003)(376002)(396003)(366004)(136003)(346002)(230922051799003)(451199024)(186009)(64100799003)(1800799009)(41300700001)(1076003)(107886003)(2616005)(316002)(6916009)(66556008)(66946007)(54906003)(66476007)(36756003)(5660300002)(44832011)(83380400001)(38350700002)(38100700002)(30864003)(86362001)(2906002)(26005)(8676002)(8936002)(4326008)(478600001)(6486002)(6506007)(52116002)(6512007); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?sb4JZfjkX76heeiCrgYUze/u41hhDIN4lBrRigp1/AWGX4qZ10Z1601QFI0H?= =?us-ascii?Q?//FJMhI9CV38VEBa5qm2ukrmjDTRem2fjusz2xxf96FWWmkBmoRTUHRTAbYW?= =?us-ascii?Q?ttUb8jQ2I/An43HxyRv66OdxQMu2rajaWeoMHjpCxGfSNTu3+D3uwjB1lclZ?= =?us-ascii?Q?3PE/T6ng/y+tmOdkeIcv26cPzIeiVZYFHeJCCGb8gI4ljbFbdYwK6CVMjag3?= =?us-ascii?Q?1G9R1DNjkaRqWINtZNo/EgXH729WQU1b4uTsGMz5eGTsvViR5+MZlryavbPR?= =?us-ascii?Q?/4+230qEE6PR2MGtUtOsHjmoj01kTMOiFaPYYu/6Utixcf5fkjkkLXRIeRhF?= =?us-ascii?Q?6J/uDOxSUiXJ3YcU7PLGM5XvS9Jj/l/dxEfTNkh53yGT7L3jEmeDr4PzeAEb?= =?us-ascii?Q?syVGybBqP3vU0rfSete+u9qk0Ky+y5k07OqpB+qx0aDZxDpn62Z4QXr/eWkB?= =?us-ascii?Q?1R9hxvCln5zjVodYGiVqm9yRcO2ypCqS4QZp4RUG1fOssxQR8ym2HCCZFdBf?= =?us-ascii?Q?V2lv2Qj059cxyom7JuMlWTOzhM4YEcLItML+bb62LxOtFvhiAvkRqt28JmYz?= =?us-ascii?Q?MFNWWqpw+2AhZJ2IbcJKGvSqpaslweM6ZfM+XrQcL4z/9sNEwfOP1FxIMKQv?= =?us-ascii?Q?MwdN5Y9VwFtNltt5fCTURfiDQqfbU9wUXF/wkvCydO3l/8VCeJOtH0EMwOQ+?= =?us-ascii?Q?bYDoiRqPnv+MDtZoL0nv+W6GiqTArNDNMveO8ODcg+jMvsGFQHbMJZxdJnfn?= =?us-ascii?Q?JYdMnhJwzPsUmLZVB26TVM1pokMavG889CT4csz424yOcSEzMfyFS1rMPWHR?= =?us-ascii?Q?wdGy+1NxtIxulK+Plf4KPWwrD8N75zsAwYXFpDKRjkqLljuG9p8eJVgkOvbX?= =?us-ascii?Q?iv23RzL/XKo1OQU6GqLyLCjP6na9NrP+bJhtbgx0lmO1WvU5y606vugAJEz/?= =?us-ascii?Q?8KR9yHE0PWdVys7LsEbgv9kAT3a+xVGASKyoYp0O8V3BgV/653rv5HgQVZDT?= =?us-ascii?Q?zsGDPFxF0K+lFDHNrV0yqDq165+8Jf/foG6F1tbp3tzjRv1e7DKC/B6Yrhsj?= =?us-ascii?Q?Bg1xBbCngmfl1KhJB3LyyesKs6TSfaPErSBXu2YtkOHmMyuuXeGJ5F8iuzUp?= =?us-ascii?Q?2OGbWoaflJjB7cMN1OqqiTHzs8RFfmb9qjdZixJe3xW7BjBeEPFgx3o+LSnG?= =?us-ascii?Q?ZfQ+U3/TuCq6all1bc/Zedzd87pED4kirAqpyhkJCaeV735Y4pu6kA0Tvc5j?= =?us-ascii?Q?L0WTSsH/aZaH5Vx/xSPiliUtS/AOnwU7LGiHTiZobBpmTBCfhuERM4zn07yt?= =?us-ascii?Q?+7PQuKKnws0xwutDyG6AvvfnMHmuagk7HcexzpsuxO70xdVB9J82yq+JuiZr?= =?us-ascii?Q?loP7/K1AjCuI60vpK1mtXtFSP8q5IPWcviI5Ggx9yABjMX1IDu3s0w6Zl5PH?= =?us-ascii?Q?qQnSCddzDWnHtAGYsWdHzUI7X2gAkSNSVCkyXc2nczuM3+r11Ok2RnICC7IS?= =?us-ascii?Q?UseMArdJY9bSuwRSM88PthHRD9lA7/E1gMuPDM5PUIz/ymZ3eJgOx7WyIF4V?= =?us-ascii?Q?IbjZHGf0gsl5ZOPW2N3NRT4QmvUcu2PjDnmwGu+fgCFz0b0n8qbhvnr5WZfY?= =?us-ascii?Q?Uw=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: 37b58c2f-61a8-4198-db2a-08dbc7a11828 X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Oct 2023 01:51:31.6669 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: bFFnJ4Ooud2Ie3oWK0G9yv7oUAUhK91JUwHLbNSd2q5h+IzyQ0apjuqnEmHZnhuqVLNARVPUeSb/HI6KiF13SL5M0z++LdotlKf06ZlG/4w= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLAPR13MB4579 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Long Wu Most of the previous interface comment format does not meet the current standards and were not uniform. Modify them to meet current standards. Signed-off-by: Long Wu Reviewed-by: James Hershaw Reviewed-by: Chaoyong He --- drivers/net/bonding/eth_bond_8023ad_private.h | 52 +++--- drivers/net/bonding/rte_eth_bond.h | 150 +++++++++++------- drivers/net/bonding/rte_eth_bond_8023ad.h | 76 ++++++--- drivers/net/bonding/rte_eth_bond_alb.h | 34 ++-- 4 files changed, 199 insertions(+), 113 deletions(-) diff --git a/drivers/net/bonding/eth_bond_8023ad_private.h b/drivers/net/bonding/eth_bond_8023ad_private.h index ab7d15f81a..29ee8700c3 100644 --- a/drivers/net/bonding/eth_bond_8023ad_private.h +++ b/drivers/net/bonding/eth_bond_8023ad_private.h @@ -196,10 +196,13 @@ struct bond_dev_private; * * Set mode 4 configuration of bonding interface. * - * @pre Bonding interface must be stopped. + * @pre + * Bonding interface must be stopped. * - * @param dev Bonding interface - * @param conf new configuration. If NULL set default configuration. + * @param dev + * Bonding interface + * @param conf + * new configuration. If NULL set default configuration. */ void bond_mode_8023ad_setup(struct rte_eth_dev *dev, @@ -210,9 +213,11 @@ bond_mode_8023ad_setup(struct rte_eth_dev *dev, * * Enables 802.1AX mode and all active members on bonding interface. * - * @param dev Bonding interface + * @param dev + * Bonding interface + * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int bond_mode_8023ad_enable(struct rte_eth_dev *dev); @@ -222,7 +227,8 @@ bond_mode_8023ad_enable(struct rte_eth_dev *dev); * * Disables 802.1AX mode of the bonding interface and members. * - * @param dev Bonding interface + * @param dev + * Bonding interface * @return * 0 on success, negative value otherwise. */ @@ -232,7 +238,8 @@ int bond_mode_8023ad_disable(struct rte_eth_dev *dev); * @internal * * Starts 802.3AX state machines management logic. - * @param dev Bonding interface + * @param dev + * Bonding interface * @return * 0 if machines was started, 1 if machines was already running, * negative value otherwise. @@ -244,7 +251,8 @@ bond_mode_8023ad_start(struct rte_eth_dev *dev); * @internal * * Stops 802.3AX state machines management logic. - * @param dev Bonding interface + * @param dev + * Bonding interface * @return * 0 if this call stopped state machines, -ENOENT if alarm was not set. */ @@ -255,9 +263,12 @@ bond_mode_8023ad_stop(struct rte_eth_dev *dev); * @internal * * Passes given slow packet to state machines management logic. - * @param internals Bonding device private data. - * @param member_id Member port id. - * @param slot_pkt Slow packet. + * @param internals + * Bonding device private data. + * @param member_id + * Member port id. + * @param slot_pkt + * Slow packet. */ void bond_mode_8023ad_handle_slow_pkt(struct bond_dev_private *internals, @@ -268,11 +279,13 @@ bond_mode_8023ad_handle_slow_pkt(struct bond_dev_private *internals, * * Appends given member used member * - * @param dev Bonding interface. - * @param port_id Member port ID to be added + * @param dev + * Bonding interface. + * @param port_id + * Member port ID to be added * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ void bond_mode_8023ad_activate_member(struct rte_eth_dev *dev, uint16_t port_id); @@ -282,18 +295,21 @@ bond_mode_8023ad_activate_member(struct rte_eth_dev *dev, uint16_t port_id); * * Denitializes and removes given member from 802.1AX mode. * - * @param dev Bonding interface. - * @param member_num Position of member in active_members array + * @param dev + * Bonding interface. + * @param member_num + * Position of member in active_members array * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int bond_mode_8023ad_deactivate_member(struct rte_eth_dev *dev, uint16_t member_pos); /** * Updates state when MAC was changed on bonding device or one of its members. - * @param bond_dev Bonding device + * @param bond_dev + * Bonding device */ void bond_mode_8023ad_mac_address_update(struct rte_eth_dev *bond_dev); diff --git a/drivers/net/bonding/rte_eth_bond.h b/drivers/net/bonding/rte_eth_bond.h index 6be5e46deb..28aa341d2f 100644 --- a/drivers/net/bonding/rte_eth_bond.h +++ b/drivers/net/bonding/rte_eth_bond.h @@ -95,12 +95,15 @@ extern "C" { /** * Create a bonding rte_eth_dev device * - * @param name Name of new link bonding device. - * @param mode Mode to initialize bonding device in. - * @param socket_id Socket Id on which to allocate eth_dev resources. + * @param name + * Name of new link bonding device. + * @param mode + * Mode to initialize bonding device in. + * @param socket_id + * Socket Id on which to allocate eth_dev resources. * * @return - * Port Id of created rte_eth_dev on success, negative value otherwise + * Port Id of created rte_eth_dev on success, negative value otherwise */ int rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id); @@ -108,10 +111,11 @@ rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id); /** * Free a bonding rte_eth_dev device * - * @param name Name of the link bonding device. + * @param name + * Name of the link bonding device. * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ int rte_eth_bond_free(const char *name); @@ -119,11 +123,13 @@ rte_eth_bond_free(const char *name); /** * Add a rte_eth_dev device as a member to the bonding device * - * @param bonding_port_id Port ID of bonding device. - * @param member_port_id Port ID of member device. + * @param bonding_port_id + * Port ID of bonding device. + * @param member_port_id + * Port ID of member device. * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ __rte_experimental int @@ -132,11 +138,13 @@ rte_eth_bond_member_add(uint16_t bonding_port_id, uint16_t member_port_id); /** * Remove a member rte_eth_dev device from the bonding device * - * @param bonding_port_id Port ID of bonding device. - * @param member_port_id Port ID of member device. + * @param bonding_port_id + * Port ID of bonding device. + * @param member_port_id + * Port ID of member device. * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ __rte_experimental int @@ -145,11 +153,13 @@ rte_eth_bond_member_remove(uint16_t bonding_port_id, uint16_t member_port_id); /** * Set link bonding mode of bonding device * - * @param bonding_port_id Port ID of bonding device. - * @param mode Bonding mode to set + * @param bonding_port_id + * Port ID of bonding device. + * @param mode + * Bonding mode to set * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ int rte_eth_bond_mode_set(uint16_t bonding_port_id, uint8_t mode); @@ -157,10 +167,11 @@ rte_eth_bond_mode_set(uint16_t bonding_port_id, uint8_t mode); /** * Get link bonding mode of bonding device * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * link bonding mode on success, negative value otherwise + * link bonding mode on success, negative value otherwise */ int rte_eth_bond_mode_get(uint16_t bonding_port_id); @@ -168,11 +179,13 @@ rte_eth_bond_mode_get(uint16_t bonding_port_id); /** * Set member rte_eth_dev as primary member of bonding device * - * @param bonding_port_id Port ID of bonding device. - * @param member_port_id Port ID of member device. + * @param bonding_port_id + * Port ID of bonding device. + * @param member_port_id + * Port ID of member device. * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ int rte_eth_bond_primary_set(uint16_t bonding_port_id, uint16_t member_port_id); @@ -180,10 +193,11 @@ rte_eth_bond_primary_set(uint16_t bonding_port_id, uint16_t member_port_id); /** * Get primary member of bonding device * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * Port Id of primary member on success, -1 on failure + * Port Id of primary member on success, -1 on failure */ int rte_eth_bond_primary_get(uint16_t bonding_port_id); @@ -191,13 +205,16 @@ rte_eth_bond_primary_get(uint16_t bonding_port_id); /** * Populate an array with list of the members port id's of the bonding device * - * @param bonding_port_id Port ID of bonding eth_dev to interrogate - * @param members Array to be populated with the current active members - * @param len Length of members array + * @param bonding_port_id + * Port ID of bonding eth_dev to interrogate + * @param members + * Array to be populated with the current active members + * @param len + * Length of members array * * @return - * Number of members associated with bonding device on success, - * negative value otherwise + * Number of members associated with bonding device on success, + * negative value otherwise */ __rte_experimental int @@ -208,13 +225,16 @@ rte_eth_bond_members_get(uint16_t bonding_port_id, uint16_t members[], * Populate an array with list of the active members port id's of the bonding * device. * - * @param bonding_port_id Port ID of bonding eth_dev to interrogate - * @param members Array to be populated with the current active members - * @param len Length of members array + * @param bonding_port_id + * Port ID of bonding eth_dev to interrogate + * @param members + * Array to be populated with the current active members + * @param len + * Length of members array * * @return - * Number of active members associated with bonding device on success, - * negative value otherwise + * Number of active members associated with bonding device on success, + * negative value otherwise */ __rte_experimental int @@ -224,12 +244,13 @@ rte_eth_bond_active_members_get(uint16_t bonding_port_id, uint16_t members[], /** * Set explicit MAC address to use on bonding device and it's members. * - * @param bonding_port_id Port ID of bonding device. - * @param mac_addr MAC Address to use on bonding device overriding - * members MAC addresses + * @param bonding_port_id + * Port ID of bonding device. + * @param mac_addr + * MAC Address to use on bonding device overriding members MAC addresses * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ int rte_eth_bond_mac_address_set(uint16_t bonding_port_id, @@ -239,10 +260,11 @@ rte_eth_bond_mac_address_set(uint16_t bonding_port_id, * Reset bonding device to use MAC from primary member on bonding device and it's * members. * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * 0 on success, negative value otherwise + * 0 on success, negative value otherwise */ int rte_eth_bond_mac_address_reset(uint16_t bonding_port_id); @@ -252,11 +274,13 @@ rte_eth_bond_mac_address_reset(uint16_t bonding_port_id); * balance mode, this parameter is otherwise ignored in other modes of * operation. * - * @param bonding_port_id Port ID of bonding device. - * @param policy Balance mode transmission policy. + * @param bonding_port_id + * Port ID of bonding device. + * @param policy + * Balance mode transmission policy. * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int rte_eth_bond_xmit_policy_set(uint16_t bonding_port_id, uint8_t policy); @@ -264,10 +288,11 @@ rte_eth_bond_xmit_policy_set(uint16_t bonding_port_id, uint8_t policy); /** * Get the transmit policy set on bonding device for balance mode operation * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * Balance transmit policy on success, negative value otherwise. + * Balance transmit policy on success, negative value otherwise. */ int rte_eth_bond_xmit_policy_get(uint16_t bonding_port_id); @@ -276,11 +301,13 @@ rte_eth_bond_xmit_policy_get(uint16_t bonding_port_id); * Set the link monitoring frequency (in ms) for monitoring the link status of * member devices * - * @param bonding_port_id Port ID of bonding device. - * @param internal_ms Monitoring interval in milliseconds + * @param bonding_port_id + * Port ID of bonding device. + * @param internal_ms + * Monitoring interval in milliseconds * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int @@ -290,10 +317,11 @@ rte_eth_bond_link_monitoring_set(uint16_t bonding_port_id, uint32_t internal_ms) * Get the current link monitoring frequency (in ms) for monitoring of the link * status of member devices * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * Monitoring interval on success, negative value otherwise. + * Monitoring interval on success, negative value otherwise. */ int rte_eth_bond_link_monitoring_get(uint16_t bonding_port_id); @@ -303,11 +331,13 @@ rte_eth_bond_link_monitoring_get(uint16_t bonding_port_id); * Set the period in milliseconds for delaying the disabling of a bonding link * when the link down status has been detected * - * @param bonding_port_id Port ID of bonding device. - * @param delay_ms Delay period in milliseconds. + * @param bonding_port_id + * Port ID of bonding device. + * @param delay_ms + * Delay period in milliseconds. * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int rte_eth_bond_link_down_prop_delay_set(uint16_t bonding_port_id, @@ -317,10 +347,11 @@ rte_eth_bond_link_down_prop_delay_set(uint16_t bonding_port_id, * Get the period in milliseconds set for delaying the disabling of a bonding * link when the link down status has been detected * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * Delay period on success, negative value otherwise. + * Delay period on success, negative value otherwise. */ int rte_eth_bond_link_down_prop_delay_get(uint16_t bonding_port_id); @@ -329,11 +360,13 @@ rte_eth_bond_link_down_prop_delay_get(uint16_t bonding_port_id); * Set the period in milliseconds for delaying the enabling of a bonding link * when the link up status has been detected * - * @param bonding_port_id Port ID of bonding device. - * @param delay_ms Delay period in milliseconds. + * @param bonding_port_id + * Port ID of bonding device. + * @param delay_ms + * Delay period in milliseconds. * * @return - * 0 on success, negative value otherwise. + * 0 on success, negative value otherwise. */ int rte_eth_bond_link_up_prop_delay_set(uint16_t bonding_port_id, @@ -343,10 +376,11 @@ rte_eth_bond_link_up_prop_delay_set(uint16_t bonding_port_id, * Get the period in milliseconds set for delaying the enabling of a bonding * link when the link up status has been detected * - * @param bonding_port_id Port ID of bonding device. + * @param bonding_port_id + * Port ID of bonding device. * * @return - * Delay period on success, negative value otherwise. + * Delay period on success, negative value otherwise. */ int rte_eth_bond_link_up_prop_delay_get(uint16_t bonding_port_id); diff --git a/drivers/net/bonding/rte_eth_bond_8023ad.h b/drivers/net/bonding/rte_eth_bond_8023ad.h index 4c280c7565..4936d7fc0c 100644 --- a/drivers/net/bonding/rte_eth_bond_8023ad.h +++ b/drivers/net/bonding/rte_eth_bond_8023ad.h @@ -155,8 +155,10 @@ struct rte_eth_bond_8023ad_member_info { * * Function returns current configuration of 802.3AX mode. * - * @param port_id Bonding device id - * @param conf Pointer to timeout structure. + * @param port_id + * Bonding device id + * @param conf + * Pointer to timeout structure. * * @return * 0 - if ok @@ -171,8 +173,10 @@ rte_eth_bond_8023ad_conf_get(uint16_t port_id, * * Function set new configuration of 802.3AX mode. * - * @param port_id Bonding device id - * @param conf Configuration, if NULL set default configuration. + * @param port_id + * Bonding device id + * @param conf + * Configuration, if NULL set default configuration. * @return * 0 - if ok * -EINVAL if configuration is invalid. @@ -186,8 +190,10 @@ rte_eth_bond_8023ad_setup(uint16_t port_id, * * Function returns current state of given member device. * - * @param member_id Port id of valid member. - * @param conf buffer for configuration + * @param member_id + * Port id of valid member. + * @param conf + * buffer for configuration * @return * 0 - if ok * -EINVAL if conf is NULL or member id is invalid (not a member of given @@ -201,9 +207,12 @@ rte_eth_bond_8023ad_member_info(uint16_t port_id, uint16_t member_id, /** * Configure a member port to start collecting. * - * @param port_id Bonding device id - * @param member_id Port id of valid member. - * @param enabled Non-zero when collection enabled. + * @param port_id + * Bonding device id + * @param member_id + * Port id of valid member. + * @param enabled + * Non-zero when collection enabled. * @return * 0 - if ok * -EINVAL if member is not valid. @@ -215,8 +224,10 @@ rte_eth_bond_8023ad_ext_collect(uint16_t port_id, uint16_t member_id, /** * Get COLLECTING flag from member port actor state. * - * @param port_id Bonding device id - * @param member_id Port id of valid member. + * @param port_id + * Bonding device id + * @param member_id + * Port id of valid member. * @return * 0 - if not set * 1 - if set @@ -228,9 +239,12 @@ rte_eth_bond_8023ad_ext_collect_get(uint16_t port_id, uint16_t member_id); /** * Configure a member port to start distributing. * - * @param port_id Bonding device id - * @param member_id Port id of valid member. - * @param enabled Non-zero when distribution enabled. + * @param port_id + * Bonding device id + * @param member_id + * Port id of valid member. + * @param enabled + * Non-zero when distribution enabled. * @return * 0 - if ok * -EINVAL if member is not valid. @@ -242,8 +256,10 @@ rte_eth_bond_8023ad_ext_distrib(uint16_t port_id, uint16_t member_id, /** * Get DISTRIBUTING flag from member port actor state. * - * @param port_id Bonding device id - * @param member_id Port id of valid member. + * @param port_id + * Bonding device id + * @param member_id + * Port id of valid member. * @return * 0 - if not set * 1 - if set @@ -256,9 +272,12 @@ rte_eth_bond_8023ad_ext_distrib_get(uint16_t port_id, uint16_t member_id); * LACPDU transmit path for external 802.3ad state machine. Caller retains * ownership of the packet on failure. * - * @param port_id Bonding device id - * @param member_id Port ID of valid member device. - * @param lacp_pkt mbuf containing LACPDU. + * @param port_id + * Bonding device id + * @param member_id + * Port ID of valid member device. + * @param lacp_pkt + * mbuf containing LACPDU. * * @return * 0 on success, negative value otherwise. @@ -284,7 +303,8 @@ rte_eth_bond_8023ad_ext_slowtx(uint16_t port_id, uint16_t member_id, * * Bonding port must be stopped to change this configuration. * - * @param port_id Bonding device id + * @param port_id + * Bonding device id * * @return * 0 on success, negative value otherwise. @@ -299,9 +319,11 @@ rte_eth_bond_8023ad_dedicated_queues_enable(uint16_t port_id); * * Bonding port must be stopped to change this configuration. * - * @see rte_eth_bond_8023ad_slow_pkt_hw_filter_enable + * @see + * rte_eth_bond_8023ad_slow_pkt_hw_filter_enable * - * @param port_id Bonding device id + * @param port_id + * Bonding device id * @return * 0 on success, negative value otherwise. * @@ -309,9 +331,11 @@ rte_eth_bond_8023ad_dedicated_queues_enable(uint16_t port_id); int rte_eth_bond_8023ad_dedicated_queues_disable(uint16_t port_id); -/* +/** * Get aggregator mode for 8023ad - * @param port_id Bonding device id + * + * @param port_id + * Bonding device id * * @return * aggregator mode on success, negative value otherwise @@ -321,7 +345,9 @@ rte_eth_bond_8023ad_agg_selection_get(uint16_t port_id); /** * Set aggregator mode for 8023ad - * @param port_id Bonding device id + * @param port_id + * Bonding device id + * * @return * 0 on success, negative value otherwise */ diff --git a/drivers/net/bonding/rte_eth_bond_alb.h b/drivers/net/bonding/rte_eth_bond_alb.h index f51c355d36..3cf0d87750 100644 --- a/drivers/net/bonding/rte_eth_bond_alb.h +++ b/drivers/net/bonding/rte_eth_bond_alb.h @@ -63,9 +63,12 @@ bond_mode_alb_enable(struct rte_eth_dev *bond_dev); * forwarded to application without changes. If it is ARP reply, client table * is updated. * - * @param eth_h ETH header of received packet. - * @param offset Vlan header offset. - * @param internals Bonding data. + * @param eth_h + * ETH header of received packet. + * @param offset + * Vlan header offset. + * @param internals + * Bonding data. */ void bond_mode_alb_arp_recv(struct rte_ether_hdr *eth_h, uint16_t offset, @@ -77,12 +80,15 @@ bond_mode_alb_arp_recv(struct rte_ether_hdr *eth_h, uint16_t offset, * If it is ARP Reply, it is send on member stored in client table for that * connection. On Reply function also updates data in client table. * - * @param eth_h ETH header of transmitted packet. - * @param offset Vlan header offset. - * @param internals Bonding data. + * @param eth_h + * ETH header of transmitted packet. + * @param offset + * Vlan header offset. + * @param internals + * Bonding data. * * @return - * Index of member on which packet should be sent. + * Index of member on which packet should be sent. */ uint16_t bond_mode_alb_arp_xmit(struct rte_ether_hdr *eth_h, uint16_t offset, @@ -91,12 +97,15 @@ bond_mode_alb_arp_xmit(struct rte_ether_hdr *eth_h, uint16_t offset, /** * Function fills packet with ARP data from client_info. * - * @param client_info Data of client to which packet is sent. - * @param pkt Pointer to packet which is sent. - * @param internals Bonding data. + * @param client_info + * Data of client to which packet is sent. + * @param pkt + * Pointer to packet which is sent. + * @param internals + * Bonding data. * * @return - * Index of member on which packet should be sent. + * Index of member on which packet should be sent. */ uint16_t bond_mode_alb_arp_upd(struct client_data *client_info, @@ -105,7 +114,8 @@ bond_mode_alb_arp_upd(struct client_data *client_info, /** * Function updates member indexes of active connections. * - * @param bond_dev Pointer to bonding device struct. + * @param bond_dev + * Pointer to bonding device struct. */ void bond_mode_alb_client_list_upd(struct rte_eth_dev *bond_dev); -- 2.39.1