From patchwork Thu May 19 04:05:32 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 68065 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp2978820qge; Wed, 18 May 2016 21:05:45 -0700 (PDT) X-Received: by 10.140.152.16 with SMTP id 16mr11807581qhy.77.1463630745202; Wed, 18 May 2016 21:05:45 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id t7si10322317qge.75.2016.05.18.21.05.44; Wed, 18 May 2016 21:05:45 -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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 6AF5D6167D; Thu, 19 May 2016 04:05:44 +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 3196161661; Thu, 19 May 2016 04:05:39 +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 C813461651; Thu, 19 May 2016 04:05:37 +0000 (UTC) Received: from mail-oi0-f51.google.com (mail-oi0-f51.google.com [209.85.218.51]) by lists.linaro.org (Postfix) with ESMTPS id E1F6A61651 for ; Thu, 19 May 2016 04:05:36 +0000 (UTC) Received: by mail-oi0-f51.google.com with SMTP id v145so109717169oie.0 for ; Wed, 18 May 2016 21:05:36 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=O2HGcMy5NXJjAuSKXLM5wTBw8QGgtnnRbLDJFCOxhBs=; b=jzMPDfPzIlDtP7opwPUUJmRKbqWxMMYVtMFZqNf2mUjNTvr21bLhJXlg9GCGkNDMQX Q/v9yWSYRBBte18FpX7+YsNroQTKK94gcd5Lr2LD8OL/RMPzRibvOMoC2LNBJ3pGgYzR yh7nMHWpWkTwo2c4I35ce1WejaZi5Oxysbm+M2gmrdK1vfwydQqhVDMNcMhZ6nG0LkTI YZz07KaKYJ+NUm7uRQOFwf0Y5H+T4lXkUg4GbnUFwePVYlPnDTDrK9xo6G/EpTxZfAmW PCTkxfWx+P/ynTQ2riCZVdmWvzkF1FVXuZsPstZg6JPD5fC1KE1HDgk0xO87XDetLn/R T6ww== X-Gm-Message-State: AOPr4FVEyFHlKmCShDMrovpC4AvwBxvgWLKc5pRdq8+J5VWiHkUT3Q7TQ0RTK+OqnKu9cCWF7Hk= X-Received: by 10.157.33.59 with SMTP id i56mr6767608otb.30.1463630736367; Wed, 18 May 2016 21:05:36 -0700 (PDT) Received: from localhost.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id u11sm3294565oie.29.2016.05.18.21.05.35 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 18 May 2016 21:05:35 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Wed, 18 May 2016 23:05:32 -0500 Message-Id: <1463630733-30902-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [PATCH 1/2] doc: userguide: add section describing helpers X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" 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" Signed-off-by: Bill Fischofer --- doc/users-guide/users-guide.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 62f5833..745b85f 100755 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -155,6 +155,17 @@ and minor release numbers correspond to the ODP API level that the suite validates and the fix level represents the service level of the validation suite itself for that API level. +=== ODP Helpers +ODP also provides a set of _helper_ functions that are +distinguished by the `odph_` prefix. These are not part of the ODP API +specification, but may be useful to both applications and implementations. +This include things like mappings for common packet headers (IPv4, IPv6, +TCP, UDP, etc.) as well as wrapper functions for the Posix threading model +used in the odp-linux reference implementation of ODP. Helpers also provide +a home for utility APIs that are more experimental in nature and +are not part of the official ODP API specification. ODP helper APIs are +described further in the _ODP Helper Reference Manual_. + === ODP Design Goals ODP has three primary goals that follow from its component structure. The first is application portability across a wide range of platforms. These platforms