From patchwork Tue Oct 24 13:19:04 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Boccassi X-Patchwork-Id: 30797 X-Patchwork-Delegate: ferruh.yigit@amd.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 64EEF1B7F0; Tue, 24 Oct 2017 15:19:10 +0200 (CEST) Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) by dpdk.org (Postfix) with ESMTP id 0AD2F1B7EE for ; Tue, 24 Oct 2017 15:19:09 +0200 (CEST) Received: by mail-wm0-f68.google.com with SMTP id t69so15686290wmt.2 for ; Tue, 24 Oct 2017 06:19:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=B+Wy9XIRpp3YG2OCWMDzGax5hVLPLMr57YfVAm1wqTQ=; b=S3RVNG+YDMP3t8ugp8gPMMDft4XIHb0Mzli2BGazRTGmfuXxBmSfX5ptzHPB+zLcAd n18p09dav8Bpg/+6+LtW6UYwhzRbgdTp09+JA4MRVyn2Xjmo/7XRoocRmH4GSkmM0fS1 wJUvqRrLH8Ui/wJoumVt/8i/DVNojQaaY9svUu44WI2BaB16V2xz2GIF4Q0R+5tYtWgB n1ycfATu+/FvZr2ZMOGmQKz9EU15dhwxnJDbr/49XxLUO7RLWFilM5BfMLHkOIjrVo5W FeE2C0InL/BJk8OZ3AvQi2RZBp1x2oirnn916DAfReuYrDfRTIwbFYNu/GW29lVlu9pv EyeQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=B+Wy9XIRpp3YG2OCWMDzGax5hVLPLMr57YfVAm1wqTQ=; b=e8DPNiH4le5rI4WWYeSHmQrJmp2rQ+7dSHlL0K9vNIwVuCyd2jUfruN88rX60n+gJg cVWdDweMuszDbhSvQOP5PPEQNnx97ryfhRZ6hdMu8EUXiqbZ7S3hDNbCicBmhESQmIyW tRqRNKjfVYH+MHsf3kaTCUT4/a57XtQv6F7hTvX3BwBQ2so4i+YR0svyY0k7TeyjTqg4 aGEQTPcH9P6nUXJxxWgnR/qykBA827hnKPckFlg249Ghwp5yn1ccnrGHlzdAX/pi4L9+ oKG7VOgrHApRvaVUVUtacb29xho7J6vz+VjjDtNbIP3a/RrV5smYhJvPD4+ePNDY68Em 8esw== X-Gm-Message-State: AMCzsaWC/0b3WpfRppii2yAbB5xjycbbCKaIK1r/r0FP2irGVPxVD+Bo z1wG95gTYMgStVPd5c1xd9LE2VwM6Qk= X-Google-Smtp-Source: ABhQp+TEhQM3uWvVUE+iegzpMEsp4C81k7zfLT3RbzEmNHCpeb406Ax+uSW+c2B4b4w1pyKcQPPijQ== X-Received: by 10.80.152.229 with SMTP id j92mr12598323edb.279.1508851148476; Tue, 24 Oct 2017 06:19:08 -0700 (PDT) Received: from localhost ([213.251.34.151]) by smtp.gmail.com with ESMTPSA id i61sm184196edc.32.2017.10.24.06.19.07 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 24 Oct 2017 06:19:07 -0700 (PDT) From: luca.boccassi@gmail.com To: dev@dpdk.org Cc: wenzhuo.lu@intel.com, wei.dai@intel.com, remy.horton@intel.com, thomas@monjalon.net, Luca Boccassi Date: Tue, 24 Oct 2017 14:19:04 +0100 Message-Id: <20171024131905.17917-1-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171024110312.24029-1-luca.boccassi@gmail.com> References: <20171024110312.24029-1-luca.boccassi@gmail.com> Subject: [dpdk-dev] [PATCH v3 1/2] ethdev: document error codes of reset 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" From: Luca Boccassi This new function returns 0 on success and various error codes on different failures. Attempt to document them. Signed-off-by: Luca Boccassi Acked-by: Thomas Monjalon --- lib/librte_ether/rte_ethdev.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index b773589d6..697f6b2e0 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2269,6 +2269,14 @@ void rte_eth_dev_close(uint16_t port_id); * * @param port_id * The port identifier of the Ethernet device. + * + * @return + * - (0) if successful. + * - (-EINVAL) if port identifier is invalid. + * - (-ENOTSUP) if hardware doesn't support this function. + * - (-EPERM) if not ran from the primary process. + * - (-EIO) if re-initialisation failed. + * - (-ENOMEM) if the reset failed due to OOM. */ int rte_eth_dev_reset(uint16_t port_id);