From patchwork Mon Apr 6 15:56:02 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 46785 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f69.google.com (mail-la0-f69.google.com [209.85.215.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 1D82C214BA for ; Mon, 6 Apr 2015 15:56:19 +0000 (UTC) Received: by layy10 with SMTP id y10sf6739542lay.0 for ; Mon, 06 Apr 2015 08:56:18 -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=cNZI2EeEUgmEY6ya/eINdeZ0PYsy860cNCfSoteVrgk=; b=C21wfKndJVQ8haDNTtxcbumZDanZRVzYwFCaPaoIlCIwhR2UacqOGMU555pNFT09Tv TgvrxV8/NcyInOuUk66Y/p0SVnoL2V7uGMW3rtElqWEwIbpQWX/5YW9a+fE5NDEk8X1W SezOOPk1PbYaKjv1A544SjKEd0b873AsZgExQdqL0AMgmZwNv8rz9mMGl6ydJ+h3aF39 Ztm0OtLZcqwC1eoCnLn84EeH9dfphVOEwdLtje87R6if6ZManaxfW5a+Se8BOEfOh4MZ n3+yWic2UcnOYKt85jc/Cm5z9RczoQboQr0U/rXv+irdFYxvS4F27C7DZR6l2GGDpmjo KCfw== X-Gm-Message-State: ALoCoQm82LX/blMvjOEwP2bwgWS9P5vxjbhHUMkWwQATOTrff4IpHPQObrA3YjHjHI2xACd8+kHz X-Received: by 10.194.71.227 with SMTP id y3mr3283200wju.3.1428335778054; Mon, 06 Apr 2015 08:56:18 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.205.70 with SMTP id le6ls397578lac.50.gmail; Mon, 06 Apr 2015 08:56:17 -0700 (PDT) X-Received: by 10.152.170.199 with SMTP id ao7mr13926834lac.27.1428335777894; Mon, 06 Apr 2015 08:56:17 -0700 (PDT) Received: from mail-lb0-f178.google.com (mail-lb0-f178.google.com. [209.85.217.178]) by mx.google.com with ESMTPS id pl9si3851633lbb.70.2015.04.06.08.56.17 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 06 Apr 2015 08:56:17 -0700 (PDT) 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 lbbqq2 with SMTP id qq2so14129965lbb.3 for ; Mon, 06 Apr 2015 08:56:17 -0700 (PDT) X-Received: by 10.152.87.204 with SMTP id ba12mr14474641lab.35.1428335777680; Mon, 06 Apr 2015 08:56:17 -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.57.201 with SMTP id k9csp3431042lbq; Mon, 6 Apr 2015 08:56:17 -0700 (PDT) X-Received: by 10.229.202.136 with SMTP id fe8mr18676870qcb.26.1428335776098; Mon, 06 Apr 2015 08:56:16 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id k135si4510498qhc.14.2015.04.06.08.56.14; Mon, 06 Apr 2015 08:56:16 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: by lists.linaro.org (Postfix, from userid 109) id E603064E4D; Mon, 6 Apr 2015 15:56:14 +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=-0.7 required=5.0 tests=RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, 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 761CF64DDF; Mon, 6 Apr 2015 15:56:12 +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 6482064E0C; Mon, 6 Apr 2015 15:56:11 +0000 (UTC) Received: from mail-ob0-f171.google.com (mail-ob0-f171.google.com [209.85.214.171]) by lists.linaro.org (Postfix) with ESMTPS id 1A95E64DDF for ; Mon, 6 Apr 2015 15:56:10 +0000 (UTC) Received: by obbgh1 with SMTP id gh1so45512760obb.1 for ; Mon, 06 Apr 2015 08:56:09 -0700 (PDT) X-Received: by 10.182.142.101 with SMTP id rv5mr19364677obb.13.1428335769489; Mon, 06 Apr 2015 08:56:09 -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 ku2sm3918959obc.12.2015.04.06.08.56.08 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 06 Apr 2015 08:56:08 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 6 Apr 2015 10:56:02 -0500 Message-Id: <1428335762-8511-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH] 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.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 --- include/odp/api/packet_io.h | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h index 6d31aeb..e960f10 100644 --- a/include/odp/api/packet_io.h +++ b/include/odp/api/packet_io.h @@ -52,15 +52,22 @@ extern "C" { * 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 dev name loop is specially pktio reserved name for device used for + * testing. Usually it's loop back interface. + * + * @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);