From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) by dpdk.org (Postfix) with ESMTP id 75AA09B6B for ; Thu, 19 Oct 2017 15:48:49 +0200 (CEST) Received: by mail-wm0-f68.google.com with SMTP id u138so16163901wmu.5 for ; Thu, 19 Oct 2017 06:48:49 -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; bh=8WQd3GWRb4/37Fv/H5wF5V7EDidfnZST0uqe4lu/sWc=; b=bPogV+4CJCpQ6mK2bIHZ/c0LQMcwHQK2k1jLYc8qV8uGCWS9k794y46vuSgr+B+NG3 GS/8MGQlOtxUjt8o5mVVowtl6hBmmdNsJCDBcxqAJiTgI+pgSTQzqSW0JpuWERR+Z/v6 lBHG28L3TKkbxJIsZ1zSVwEKFDMl0OOqbAnqDdQWr0ZKd1EdZ820KoV7Ah0atXG3dWjT t+kj0+U1ZBF7MG1DIBD0ZNC663RmzbRfWVN9KXZXUte0Nk6GT80eQ9udurOOvELpijtw U6G/QPFCxEWxIdYBX1mR3wAH8uKXMk87PS5DjSzSPIXRWfd11qqyxhi+UufEDSFJDI5i DHsQ== 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; bh=8WQd3GWRb4/37Fv/H5wF5V7EDidfnZST0uqe4lu/sWc=; b=Rt1T8dls+IowGhjVF9jlXCdAOCBxWoJXbMW34S5+yvHg5hbWK/bT1hC1Ple302iszV T60q3+2rthceHec8mlfZdkJBnQCfSymWsh8dQ2HncTPMO+rfLolvB7lwDJ38YUyoujUL HeVhSaKbZncedZcpEmVWGf5ysUFtlgZC3TGa5cNKR1IEUDSgGoMlXY1RvDPqyk+sdm5Z HFsn1SAw/L71u+s4gnC5j1Upsom0+b7tqq/R9LN3OEiBUqC4pvQMPXFLBKguft8aFGhz NeZrYcErBgyiWOIOtggjLGU8/cJztjiwHRaPDsMJ0m73+kq0DHF0h8SZH6zMOvP8hLBR kA8w== X-Gm-Message-State: AMCzsaXkRqin+DxfXJfP5z+q9Pzm6gPHi5wTnnUZYTqAJPj4oZsfXuUb /eBIZZfiBt//E/1rqv1++afWACGW5TE= X-Google-Smtp-Source: ABhQp+Tr7JVuiOuJhup4Rk5jkG19NZMeAOEAzI+omnCc8+kdqmIEHUcEfa2GntZc+BSdAOsCcneEcg== X-Received: by 10.80.244.211 with SMTP id v19mr2480658edm.92.1508420928581; Thu, 19 Oct 2017 06:48:48 -0700 (PDT) Received: from localhost ([213.251.34.151]) by smtp.gmail.com with ESMTPSA id w13sm10440172edk.46.2017.10.19.06.48.47 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 19 Oct 2017 06:48:47 -0700 (PDT) From: luca.boccassi@gmail.com To: dev@dpdk.org Cc: wenzhuo.lu@intel.com, wei.dai@intel.com, remy.horton@intel.com, Luca Boccassi Date: Thu, 19 Oct 2017 14:48:26 +0100 Message-Id: <20171019134827.22740-1-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.11.0 Subject: [dpdk-dev] [PATCH 1/2] ethdev: document rte_eth_dev_reset return codes 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: , X-List-Received-Date: Thu, 19 Oct 2017 13:48:49 -0000 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 --- 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 aaf02b33d..9cdb9724a 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2262,6 +2262,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); -- 2.11.0