From patchwork Tue Jan 5 17:16:03 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 59199 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp6091107lbb; Tue, 5 Jan 2016 09:16:17 -0800 (PST) X-Received: by 10.55.212.92 with SMTP id l89mr125844377qki.70.1452014177147; Tue, 05 Jan 2016 09:16:17 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id n204si939695qhn.104.2016.01.05.09.16.16; Tue, 05 Jan 2016 09:16:17 -0800 (PST) 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; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 6C19B6178A; Tue, 5 Jan 2016 17:16:16 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=N48FoaKn; dkim-adsp=none (unprotected policy); dkim-atps=neutral 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.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2,T_DKIM_INVALID,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 7255C61791; Tue, 5 Jan 2016 17:16: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 7042761793; Tue, 5 Jan 2016 17:16:10 +0000 (UTC) Received: from mail-qg0-f43.google.com (mail-qg0-f43.google.com [209.85.192.43]) by lists.linaro.org (Postfix) with ESMTPS id 950166178A for ; Tue, 5 Jan 2016 17:16:09 +0000 (UTC) Received: by mail-qg0-f43.google.com with SMTP id e32so192877247qgf.3 for ; Tue, 05 Jan 2016 09:16:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=tBufgGxDYLUF6787RI/IeEwZFjStp0Pp8+eWSBH6IQE=; b=N48FoaKnlSGDxsesxjR0QSzo+qhKQ1fvySbYRdvZP6Oy4ib2xbbAGwaGVW8Y6/nt5o zWa5HmpSM7qcanzYEZG4xLQ53lwbrWTmS5qe9UmoO5ehmGfeajw5RmjrxUiIhBIHYRcW X5mcYbgPn643+C2viCmREZQsMUe7Vg6Q19Tdc= 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=tBufgGxDYLUF6787RI/IeEwZFjStp0Pp8+eWSBH6IQE=; b=c3fvQr8YXdt2FL7ucv41IHNPJNAD09kSMrBnknMFNV2uvMrTqXEHz9ZetiFzges8kE 0J1Sf8nK6bo52y7RklUAAV3kbymERF6fnkSAbMPrC9vEUULbu0yVpU5+XAYTFVME40Rq VmKrQO/hKnDZ7dcPqDXsS/5yRcx2UAWUtsNHW4twS0rcR+H10hsIfTQYxJJp/Ie+Vqio 9/vsjF5+NDcr49BG6Wdr7nOTxM4ngCZwwrwvetziRQ7XkoXtnrKLuKKX/jP+t/MrrzjM CKdyJ+3EJBs3rA9bJCFkMRyGJ6zsXyJronNrPK+2yriVX8Tphj9896+g5588fXE/yi82 RzNQ== X-Gm-Message-State: ALoCoQkoeOPFhgjBG3oSNsq1eg36uUr9AGzvowRqScTFhvu/lRU0xjoQZnzaS3iwdFEglGhuXUewgSx9ENLQZtmmRpogaN8QHg== X-Received: by 10.140.242.147 with SMTP id n141mr83547713qhc.2.1452014169284; Tue, 05 Jan 2016 09:16:09 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id c17sm21279175qgd.29.2016.01.05.09.16.08 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 05 Jan 2016 09:16:08 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Tue, 5 Jan 2016 12:16:03 -0500 Message-Id: <1452014163-27121-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH] doc: users-guide: fix function highlighting 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" Use "*" for function highlighting and promote crypto to its own section from a subsection of queues Signed-off-by: Mike Holmes Reviewed-by: Bill Fischofer --- doc/users-guide/users-guide.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 8bc8521..e65f836 100644 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -754,9 +754,9 @@ on ordered queues. Multiple events are processed in parallel and the use of ordered queues ensures that they will be placed on +dest_q+ in the same order as they originated. While processing in parallel, the use of ordered locks enables critical sections to be processed in order within the overall parallel -flow. When a thread arrives at the _odp_schedule_order_lock()_ call, it waits +flow. When a thread arrives at the *odp_schedule_order_lock()* call, it waits until the locking order for this lock for all prior events has been resolved -and then enters the critical section. The _odp_schedule_order_unlock()_ call +and then enters the critical section. The *odp_schedule_order_unlock()* call releases the critical section and allows the next order to enter it. === Queue Scheduling Summary @@ -765,14 +765,14 @@ NOTE: Both ordered and parallel queues improve throughput over atomic queues due to parallel event processing, but require that the application take steps to ensure context data synchronization if needed. -=== Cryptographic services +== Cryptographic services ODP provides support for cryptographic operations required by various security protocols (e.g. IPSec). To apply a cryptographic operation to a packet a session must be created first. Packets processed by a session share the same cryptographic parameters like algorithms, keys, initialization vectors. A session is created with -odp_crypto_session_create() call. After session creation a cryptographic operation -can be applied to a packet using odp_crypto_operation() call. +*odp_crypto_session_create()* call. After session creation a cryptographic operation +can be applied to a packet using *odp_crypto_operation()* call. Depending on the session type - synchronous or asynchronous the operation returns when the operation completed or after the request has been submitted. In the asynchronous case an operation completion event will be enqueued on the session