From patchwork Fri Aug 28 12:59:15 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Uvarov X-Patchwork-Id: 52792 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-lb0-f198.google.com (mail-lb0-f198.google.com [209.85.217.198]) by patches.linaro.org (Postfix) with ESMTPS id D2BCE21569 for ; Fri, 28 Aug 2015 12:59:38 +0000 (UTC) Received: by lbbpd10 with SMTP id pd10sf16565744lbb.3 for ; Fri, 28 Aug 2015 05:59:37 -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=b7E/Q3VgV461htbBjFc5OUp9XQsWsfO1V6/Xs24V2iw=; b=OG/wJ9P511NNYYE3Ohmi41a75cSPUF8nX7JWd0VPXQCfftxgyvrHIv3fpqByUl85Gg 2Uh9Y5Dr2DF6CiVwc3Zomw4AGX+SZBX3CwUbuWJbaSyhunvOh1lOzEzVhZxdyxaWeqsR FvqQM0B98XFGI2q3+wtlbjogp2xlPLaxG/t4nws0nNVcw3tX+UDwrWMK3F/srGKFuHxg oyQjdIi8V4KIsVJJJBLXufiFjpCMjkc6ikg4+DJvN4U9rQ2t6scDyULL8ck5HNwEorlc 6QobUIPNaHelLYpYF+SLS0UzJyTM/qLE8UhSClACIx8lp1jxJ80SxsW7J4aVrfrJtbGl 64zg== X-Gm-Message-State: ALoCoQluNt+wctoVPaWB4m1g03uXF9snBR5hBrTbPZ3ORs+ty/YYJcTeSLq/q+OWBxPug2UkvnQW X-Received: by 10.180.35.162 with SMTP id i2mr1122476wij.6.1440766777816; Fri, 28 Aug 2015 05:59:37 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.219.34 with SMTP id pl2ls17412lac.5.gmail; Fri, 28 Aug 2015 05:59:37 -0700 (PDT) X-Received: by 10.152.7.7 with SMTP id f7mr4723778laa.62.1440766777666; Fri, 28 Aug 2015 05:59:37 -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 e10si5678598lam.108.2015.08.28.05.59.37 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 28 Aug 2015 05:59:37 -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 lbbtg9 with SMTP id tg9so29648456lbb.1 for ; Fri, 28 Aug 2015 05:59:37 -0700 (PDT) X-Received: by 10.152.26.163 with SMTP id m3mr4828379lag.86.1440766777558; Fri, 28 Aug 2015 05:59:37 -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.151.194 with SMTP id us2csp523730lbb; Fri, 28 Aug 2015 05:59:36 -0700 (PDT) X-Received: by 10.140.202.19 with SMTP id x19mr16265335qha.42.1440766776643; Fri, 28 Aug 2015 05:59:36 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id l45si6720340qgd.116.2015.08.28.05.59.35; Fri, 28 Aug 2015 05:59:36 -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 A2EE061B51; Fri, 28 Aug 2015 12:59:35 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 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=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 9568C61A45; Fri, 28 Aug 2015 12:59:31 +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 98DD561A45; Fri, 28 Aug 2015 12:59:24 +0000 (UTC) Received: from mail-la0-f53.google.com (mail-la0-f53.google.com [209.85.215.53]) by lists.linaro.org (Postfix) with ESMTPS id 721D5619C7 for ; Fri, 28 Aug 2015 12:59:23 +0000 (UTC) Received: by laba3 with SMTP id a3so31829905lab.1 for ; Fri, 28 Aug 2015 05:59:21 -0700 (PDT) X-Received: by 10.152.170.230 with SMTP id ap6mr4820034lac.73.1440766761074; Fri, 28 Aug 2015 05:59:21 -0700 (PDT) Received: from localhost.localdomain (ppp91-76-161-180.pppoe.mtu-net.ru. [91.76.161.180]) by smtp.gmail.com with ESMTPSA id cy1sm1394849lac.22.2015.08.28.05.59.20 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 28 Aug 2015 05:59:20 -0700 (PDT) From: Maxim Uvarov To: lng-odp@lists.linaro.org Date: Fri, 28 Aug 2015 15:59:15 +0300 Message-Id: <1440766755-18405-1-git-send-email-maxim.uvarov@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv2] api: pktio description of doxygen group 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: maxim.uvarov@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.mailfrom=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: Maxim Uvarov --- v2: more detailed description. include/odp/api/packet_io.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h index e00d011..aaa4e43 100644 --- a/include/odp/api/packet_io.h +++ b/include/odp/api/packet_io.h @@ -19,7 +19,18 @@ extern "C" { #endif /** @defgroup odp_packet_io ODP PACKET IO - * Operations on a packet. + * Operations on a packet Input/Output interface. + * + * Packet IO is the Ingress and Egress interface to ODP processing. It + * allows manipulation of the interface for setting such attributes as + * the mtu, mac etc. + * Pktio is usually followed by the classifier and a default class COS + * can be set so that the scheduler may distribute flows. The interface + * may be used directly in polled mode with odp_pktio_recv() & + * odp_pktio_send(). + * Diagnostic massages can be enhanced by using odp_pktio_to_u64 which + * will generate a printable reference for a pktio handle for use with + * the logging @ref odp_ver_abt_log_dbg. * @{ */