From patchwork Sun Aug 9 13:24:36 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 52099 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 patches.linaro.org (Postfix) with ESMTPS id 9ED372152A for ; Sun, 9 Aug 2015 13:28:25 +0000 (UTC) Received: by labth1 with SMTP id th1sf53089147lab.2 for ; Sun, 09 Aug 2015 06:28:24 -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:in-reply-to:references: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=yBBJtTyRbH10EdmauakcgoV5ZzQTaOizVeyZ4/vQ/vk=; b=V6QXMuy0VUWlb9IUV1J7ioG4Mcbf1eaYyJv4/kABGVvhMMXM++upHwOpt47zoSo2kx 3riMJbml1EgERR8H+MZWTblOyJOt+sM1CXzNMjPu5m0c21PxbJNjtuLbrQySQq4fPmJK WxhBx3VmBdRIrkINuc30H50+X0CHVOxss89IG7YHKe99dkRXuSWga25WUQegsRUL5gbs JVNOOLVyyfo0J38M+5+OneuxhwQ+mMUqqfUb3AZDbbDvHBMigDXdtNoSzc5uNA+Kai90 xdBSZEM5OGCKgKeHuqJp1kgSDviYSzuYupPublgu2VJri3rct2yf6CWBLq7tFw8xiV8a z+YQ== X-Gm-Message-State: ALoCoQlOyEC9iQgAqvU9+3wpH7E1cIywrXNrC544RfqT+z9fpIXJx9FBXnNJl94VqYnY8IPUayD7 X-Received: by 10.180.11.226 with SMTP id t2mr2269193wib.0.1439126904608; Sun, 09 Aug 2015 06:28:24 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.43.161 with SMTP id x1ls575777lal.45.gmail; Sun, 09 Aug 2015 06:28:24 -0700 (PDT) X-Received: by 10.152.115.132 with SMTP id jo4mr16455053lab.113.1439126904115; Sun, 09 Aug 2015 06:28:24 -0700 (PDT) Received: from mail-la0-f52.google.com (mail-la0-f52.google.com. [209.85.215.52]) by mx.google.com with ESMTPS id zn4si793345lbb.177.2015.08.09.06.28.24 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 09 Aug 2015 06:28:24 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.52 as permitted sender) client-ip=209.85.215.52; Received: by labjt7 with SMTP id jt7so69897660lab.0 for ; Sun, 09 Aug 2015 06:28:24 -0700 (PDT) X-Received: by 10.152.1.66 with SMTP id 2mr16688842lak.56.1439126903994; Sun, 09 Aug 2015 06:28:23 -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.7.198 with SMTP id l6csp1428778lba; Sun, 9 Aug 2015 06:28:22 -0700 (PDT) X-Received: by 10.50.176.138 with SMTP id ci10mr7213177igc.32.1439126902750; Sun, 09 Aug 2015 06:28:22 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id om10si3750370igb.81.2015.08.09.06.28.21; Sun, 09 Aug 2015 06:28:22 -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 C288861E5B; Sun, 9 Aug 2015 13:28:21 +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=disabled 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 2800861F5D; Sun, 9 Aug 2015 13:26: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 6D65561CBD; Sun, 9 Aug 2015 13:25:37 +0000 (UTC) Received: from mail-ob0-f177.google.com (mail-ob0-f177.google.com [209.85.214.177]) by lists.linaro.org (Postfix) with ESMTPS id B821E61F59 for ; Sun, 9 Aug 2015 13:24:54 +0000 (UTC) Received: by obbhe7 with SMTP id he7so11279202obb.0 for ; Sun, 09 Aug 2015 06:24:54 -0700 (PDT) X-Received: by 10.60.68.66 with SMTP id u2mr3370797oet.69.1439126694225; Sun, 09 Aug 2015 06:24:54 -0700 (PDT) Received: from localhost.localdomain (cpe-24-28-70-239.austin.res.rr.com. [24.28.70.239]) by smtp.gmail.com with ESMTPSA id rg1sm10096074oeb.11.2015.08.09.06.24.53 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 09 Aug 2015 06:24:53 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Sun, 9 Aug 2015 08:24:36 -0500 Message-Id: <1439126687-19932-3-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1439126687-19932-1-git-send-email-bill.fischofer@linaro.org> References: <1439126687-19932-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv13 02/13] api: queue: document ordered chain enq support 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.215.52 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 Expand documentation of odp_queue_enq_multi() to describe support for ordered chains. Signed-off-by: Bill Fischofer --- include/odp/api/queue.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h index ce04eb4..5a6dbc0 100644 --- a/include/odp/api/queue.h +++ b/include/odp/api/queue.h @@ -173,6 +173,29 @@ int odp_queue_enq(odp_queue_t queue, odp_event_t ev); * * @return Number of events actually enqueued (0 ... num) * @retval <0 on failure + * + * @note odp_queue_enq_multi() serves two purposes. First, it allows + * multiple events to be enqueued via a single call. In addition, it + * permits multiple events to partitipate in ordering. When an event + * originating from an ordered queue is followed by one or more events + * that did not originate from an ordered queue, then these subsequent + * events are "chained" to the ordered event such that they participate + * in its ordering. This provides a convenient means for an application + * to split a packet into multiple packets and have them retain the + * relative order of the original packet. + * + * @note If multiple events originating from ordered queues are passed + * to odp_queue_enq_multi() then they (and their associated chains, if + * any) are handled independently. To see this, consider the following + * array of events: uo1, uo2, o1, uo3, uo4, o2, o3, uo5. When this + * array is passed to odp_queue_enq_multi() then unordered events uo1 and + * uo2 will be added to queue, then ordered event o1 and the chained + * events uo3, and uo4, will be added, then ordered event o2, then ordered + * event o3 and the chained event uo5 will be added. In all cases, + * unordered events that are chained to ordered events inherit the relative + * order of their ordered lead event. Note also that there is no + * requirement that the ordered events passed to this routine all originate + * from the same ordered queue sine each is treated independently. */ int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num);