From patchwork Thu Apr 23 20:36:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 47477 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f197.google.com (mail-lb0-f197.google.com [209.85.217.197]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 400122121F for ; Thu, 23 Apr 2015 20:37:15 +0000 (UTC) Received: by lbos2 with SMTP id s2sf7012665lbo.2 for ; Thu, 23 Apr 2015 13:37:14 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to: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=V2JRHE/Qpc9+T+u0AevyoLEdfv9eHOHqHn7hZNh4MxI=; b=UKc7ezJpCl55ZS2saEPTGA77dg3ca7CYaGbT8eZOWOdKDUyvB7Z84moK1b/h/bqQgK P288zBVwh6ecdzDnZxhTq3NnPnKbNqqVbhGnwvF9lsyjmi4o02nNClmm8wICVNKVPM3n oWsrxphhJZZ+ZaZyUe/kur/+7wPZqOt9JmSCFitSZpiqfgMGWz+aRX+w1Alm3eNVpn5w eSbWo4pDfXUfbkfLguDKpODGIrGNH/7nJLcvts1cLIbrc5nINerkGHzID0Dp2G3695Un xtaKYdzVr5kTZkcYjs71xzZB1viLQB+7BTXi+s4MDPdFF6MSDNLhd1ajMM0QPciOdMrJ c2mw== X-Gm-Message-State: ALoCoQlvjs7UABRYxpJ9W2+BCb4TIzZdmqvTurdqvqZsyBpNU9qGVPPQ69oNdJXtE3LT7inTB1Vk X-Received: by 10.112.93.203 with SMTP id cw11mr2275704lbb.0.1429821433985; Thu, 23 Apr 2015 13:37:13 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.2.9 with SMTP id 9ls490483laq.89.gmail; Thu, 23 Apr 2015 13:37:13 -0700 (PDT) X-Received: by 10.112.184.70 with SMTP id es6mr4007691lbc.117.1429821433697; Thu, 23 Apr 2015 13:37:13 -0700 (PDT) Received: from mail-lb0-f182.google.com (mail-lb0-f182.google.com. [209.85.217.182]) by mx.google.com with ESMTPS id jm1si6741436lbc.84.2015.04.23.13.37.13 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 23 Apr 2015 13:37:13 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.182 as permitted sender) client-ip=209.85.217.182; Received: by lbbqq2 with SMTP id qq2so22159533lbb.3 for ; Thu, 23 Apr 2015 13:37:13 -0700 (PDT) X-Received: by 10.112.150.100 with SMTP id uh4mr4019220lbb.112.1429821433556; Thu, 23 Apr 2015 13:37:13 -0700 (PDT) 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.67.65 with SMTP id l1csp796721lbt; Thu, 23 Apr 2015 13:37:12 -0700 (PDT) X-Received: by 10.140.192.83 with SMTP id n80mr5813919qha.1.1429821431990; Thu, 23 Apr 2015 13:37:11 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id q88si9230792qkh.69.2015.04.23.13.37.10; Thu, 23 Apr 2015 13:37:11 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id 44E716201A; Thu, 23 Apr 2015 20:37:10 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252.ec2.internal X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from ip-10-142-244-252.ec2.internal (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id E9B0E62000; Thu, 23 Apr 2015 20:37:08 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 89C7962016; Thu, 23 Apr 2015 20:37:07 +0000 (UTC) Received: from mail-ob0-f173.google.com (mail-ob0-f173.google.com [209.85.214.173]) by lists.linaro.org (Postfix) with ESMTPS id 12BF362000 for ; Thu, 23 Apr 2015 20:37:07 +0000 (UTC) Received: by obcux3 with SMTP id ux3so23026229obc.2 for ; Thu, 23 Apr 2015 13:37:06 -0700 (PDT) X-Received: by 10.182.16.201 with SMTP id i9mr4318491obd.58.1429821426344; Thu, 23 Apr 2015 13:37:06 -0700 (PDT) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by mx.google.com with ESMTPSA id d129sm5432101oig.15.2015.04.23.13.37.05 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 23 Apr 2015 13:37:05 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 23 Apr 2015 13:36:59 -0700 Message-Id: <1429821419-11648-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv2] api: pktio: Clarify doc on default pool usage on odp_pktio_open X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 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" 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.182 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 --- Changes for v2: Correct grammatical ambiguities throughout doc for odp_pktio_open(). include/odp/api/packet_io.h | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h index 6d31aeb..89356a6 100644 --- a/include/odp/api/packet_io.h +++ b/include/odp/api/packet_io.h @@ -47,20 +47,28 @@ extern "C" { /** * Open an ODP packet IO instance * - * Packet IO handles are single instance per device, attempts to open an already - * open device will fail, returning ODP_PKTIO_INVALID with errno set. - * odp_pktio_lookup() may be used to obtain a handle to an already open device. + * Packet IO handles are a single instance per device. Attempts to open an + * already open device will fail, returning ODP_PKTIO_INVALID with errno set. + * odp_pktio_lookup() may be used to obtain a handle to an already open + * device. * * @param dev Packet IO device name - * @param pool Pool from which to allocate buffers for storing packets + * @param pool Default pool from which to allocate buffers for storing packets * received over this packet IO * * @return ODP packet IO handle * @retval ODP_PKTIO_INVALID on failure * - * @note dev name loop is specially pktio reserved name for - * device used for testing. Usually it's loop back - * interface. + * @note The device name "loop" is a reserved name for a loopback device used + * for testing purposes. + * + * @note Packets arriving via this interface assigned to a CoS by the + * classifier are received into the pool associated with that CoS. This + * will occur either becuase this pktio is assigned a default CoS via + * the odp_pktio_default_cos_set() routine, or because a matching PMR + * assigned the packet to a specific CoS. The default pool specified + * here is applicable only for those packets that are not assigned to a + * more specific CoS. */ odp_pktio_t odp_pktio_open(const char *dev, odp_pool_t pool);