From patchwork Thu Feb 26 16:07:53 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 45184 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f198.google.com (mail-we0-f198.google.com [74.125.82.198]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 7690120674 for ; Thu, 26 Feb 2015 16:08:19 +0000 (UTC) Received: by wesu56 with SMTP id u56sf9052143wes.1 for ; Thu, 26 Feb 2015 08:08:18 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=Sa1luT18ff2bVL2JSG+pKFeaRQUGHy3s51aZ/PpQhOo=; b=OoRAfZgrF05VIR34pJIIH/VoOOmJRzvc/FJIfUySWC455o2HnQH7Wz53bFWwJrDIzm HWaxBRzzpgtVq5Pt/sRVP0Nt0s8rBMbrVvjXMuzBrQg6EpHTZ/uS0ORNyg++Nmm7rnB6 ESx0e2qFbh5whb9gWURyA3ivtLqGBq1yO7wftFtHV4K0bOPpZa+f6p9OKnFx8mlu4NJ7 AInsN8HgCgb1G7pMagiMnSyyuQgSZ/8CacXLPWCA2j/7YOo4oU6xOkbltRtQwaIpu7sC S1BvsoRGG5SgC1m797P3IgW3N7+lqikh55TORH6sHBuwWSf3drexAUQvW+vMS6Ieqnp5 98pg== X-Gm-Message-State: ALoCoQlNu09DdMzuF6WtXbenaW0TITfn0hZ0yFDhAvs7qE6GowNbACVLnF+k9jylJ4CBJRm6MZa3 X-Received: by 10.180.13.98 with SMTP id g2mr3823557wic.3.1424966898565; Thu, 26 Feb 2015 08:08:18 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.28.132 with SMTP id b4ls59119lah.33.gmail; Thu, 26 Feb 2015 08:08:18 -0800 (PST) X-Received: by 10.112.138.105 with SMTP id qp9mr8352514lbb.104.1424966898309; Thu, 26 Feb 2015 08:08:18 -0800 (PST) Received: from mail-lb0-f180.google.com (mail-lb0-f180.google.com. [209.85.217.180]) by mx.google.com with ESMTPS id o4si936748lal.67.2015.02.26.08.08.17 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 26 Feb 2015 08:08:17 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) client-ip=209.85.217.180; Received: by lbdu10 with SMTP id u10so11818061lbd.7 for ; Thu, 26 Feb 2015 08:08:17 -0800 (PST) X-Received: by 10.152.179.172 with SMTP id dh12mr8113610lac.76.1424966897821; Thu, 26 Feb 2015 08:08:17 -0800 (PST) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.35.133 with SMTP id h5csp3397492lbj; Thu, 26 Feb 2015 08:08:17 -0800 (PST) X-Received: by 10.140.147.147 with SMTP id 141mr20080701qht.57.1424966896159; Thu, 26 Feb 2015 08:08:16 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id 16si1169951qgg.5.2015.02.26.08.08.14 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 26 Feb 2015 08:08:16 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YR0yy-0000KC-JZ; Thu, 26 Feb 2015 16:08:12 +0000 Received: from mail-oi0-f44.google.com ([209.85.218.44]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YR0ys-0000Jz-PP for lng-odp@lists.linaro.org; Thu, 26 Feb 2015 16:08:06 +0000 Received: by mail-oi0-f44.google.com with SMTP id a3so10144067oib.3 for ; Thu, 26 Feb 2015 08:08:01 -0800 (PST) X-Received: by 10.202.181.136 with SMTP id e130mr6073772oif.53.1424966881439; Thu, 26 Feb 2015 08:08:01 -0800 (PST) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by mx.google.com with ESMTPSA id v71sm549583oif.19.2015.02.26.08.08.00 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 26 Feb 2015 08:08:00 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 26 Feb 2015 10:07:53 -0600 Message-Id: <1424966873-704-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCHv2] example: l2fwd: add missing doxygen documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: bill.fischofer@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.180 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Bill Fischofer Reviewed-by: Mike Holmes --- example/l2fwd/odp_l2fwd.c | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/example/l2fwd/odp_l2fwd.c b/example/l2fwd/odp_l2fwd.c index 0326a3c..887eb6b 100644 --- a/example/l2fwd/odp_l2fwd.c +++ b/example/l2fwd/odp_l2fwd.c @@ -240,6 +240,13 @@ static void *pktio_ifburst_thread(void *arg) /** * Create a pktio handle, optionally associating a default input queue. + * + * @param dev Name of device to open + * @param pool Pool to associate with device for packet RX/TX + * @param mode Packet processing mode for this device (BURST or QUEUE) + * + * @return The handle of the created pktio object. + * @retval ODP_PKTIO_INVALID if the create fails. */ static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool, int mode)