From patchwork Thu Feb 26 17:17:49 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 45196 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-we0-f200.google.com (mail-we0-f200.google.com [74.125.82.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id B04982043C for ; Thu, 26 Feb 2015 17:18:16 +0000 (UTC) Received: by wesw55 with SMTP id w55sf9423265wes.0 for ; Thu, 26 Feb 2015 09:18:15 -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:in-reply-to :references: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=2deA+2F+q6KvReOdO75wr2UHjsjF4cZCLqxATnUbueY=; b=FCg9ZRnwHA6bGtktgbu216QFsvE9EKbLv0FWS+UB7qcc2778NKK8HIuHIlSMksXaPP 3xcgJ3VBzfwNi8rrxDhilcaZlcWFddpI7wXVaCm3Dr5We56oIxwy4jpWmEOPebfXHgzt mbrnJfluOZBRNAW1lnUoObl38FGbTEz+dSTnvxhq378XtgmOBPSJ+xDY8M+/5cZsjhba LM6eUjNfbPJhvWp167ro/4HuVGFap2rb7huOBtyOagH2O3lbVYDS0pbuWktBLL6yCsRr ep10eZ0USq3ceVAh9HEAfvM7ak/2pHSEVNakuKr2stUB+g/XG3Z7kCuMEPXIMQWSSY5s y3pA== X-Gm-Message-State: ALoCoQl6zlpEY8Qf0xzAgqfP5uRre8tQGPGDbG0MYQZe+oqtSUfURaXCesnrziI3x6bDIS19ThEi X-Received: by 10.112.199.69 with SMTP id ji5mr1484565lbc.0.1424971095790; Thu, 26 Feb 2015 09:18:15 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.43.48 with SMTP id t16ls63313lal.55.gmail; Thu, 26 Feb 2015 09:18:15 -0800 (PST) X-Received: by 10.112.146.66 with SMTP id ta2mr8969928lbb.0.1424971095514; Thu, 26 Feb 2015 09:18:15 -0800 (PST) Received: from mail-lb0-f178.google.com (mail-lb0-f178.google.com. [209.85.217.178]) by mx.google.com with ESMTPS id s6si1069526las.86.2015.02.26.09.18.15 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 26 Feb 2015 09:18:15 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.178 as permitted sender) client-ip=209.85.217.178; Received: by lbvp9 with SMTP id p9so12213278lbv.3 for ; Thu, 26 Feb 2015 09:18:15 -0800 (PST) X-Received: by 10.152.115.136 with SMTP id jo8mr8992762lab.32.1424971095164; Thu, 26 Feb 2015 09:18:15 -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 h5csp3436741lbj; Thu, 26 Feb 2015 09:18:14 -0800 (PST) X-Received: by 10.140.129.65 with SMTP id 62mr20424762qhb.11.1424971093414; Thu, 26 Feb 2015 09:18:13 -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 i204si1335273qhc.56.2015.02.26.09.18.12 (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 26 Feb 2015 09:18:13 -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 1YR24g-0005Lk-AN; Thu, 26 Feb 2015 17:18:10 +0000 Received: from mail-ob0-f178.google.com ([209.85.214.178]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1YR24Y-0005JW-Jk for lng-odp@lists.linaro.org; Thu, 26 Feb 2015 17:18:02 +0000 Received: by mail-ob0-f178.google.com with SMTP id uz6so12531465obc.9 for ; Thu, 26 Feb 2015 09:17:57 -0800 (PST) X-Received: by 10.202.78.88 with SMTP id c85mr6375494oib.98.1424971077262; Thu, 26 Feb 2015 09:17:57 -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 q2sm660083obq.14.2015.02.26.09.17.56 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 26 Feb 2015 09:17:56 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 26 Feb 2015 11:17:49 -0600 Message-Id: <1424971069-16432-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 In-Reply-To: <1424971069-16432-1-git-send-email-bill.fischofer@linaro.org> References: <1424971069-16432-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [PATCH 2/2] example: packet: add more 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.178 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/packet/odp_pktio.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/example/packet/odp_pktio.c b/example/packet/odp_pktio.c index 5eec796..bb07726 100644 --- a/example/packet/odp_pktio.c +++ b/example/packet/odp_pktio.c @@ -100,6 +100,16 @@ static void parse_args(int argc, char *argv[], appl_args_t *appl_args); static void print_info(char *progname, appl_args_t *appl_args); static void usage(char *progname); +/** + * 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) { odp_pktio_t pktio;