From patchwork Mon Apr 25 14:18:57 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 66580 Delivered-To: patch@linaro.org Received: by 10.140.93.198 with SMTP id d64csp1064862qge; Mon, 25 Apr 2016 07:19:09 -0700 (PDT) X-Received: by 10.107.157.203 with SMTP id g194mr43937040ioe.82.1461593948914; Mon, 25 Apr 2016 07:19:08 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id p201si14123293iop.74.2016.04.25.07.19.08; Mon, 25 Apr 2016 07:19:08 -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 40B4B61893; Mon, 25 Apr 2016 14:19:08 +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 1912C6186F; Mon, 25 Apr 2016 14:19:04 +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 099A96187B; Mon, 25 Apr 2016 14:19:02 +0000 (UTC) Received: from mail-oi0-f45.google.com (mail-oi0-f45.google.com [209.85.218.45]) by lists.linaro.org (Postfix) with ESMTPS id 01CBC6186A for ; Mon, 25 Apr 2016 14:19:01 +0000 (UTC) Received: by mail-oi0-f45.google.com with SMTP id r78so177939142oie.0 for ; Mon, 25 Apr 2016 07:19:00 -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=Lz42cyMK1XokBuQ0ee0el06Kop4hlvllMTfdN1+jEwk=; b=m9gdOXmIhdCrgRacAiE3awwatRXi1qkqDVnDlcSV+loEy8vfMBdfcVlSVFBSS8H10e M12exNRPj3P2UDHWZcua/T0gsY+3o/xryUlHou5ziac7rEzn+uZX7ftLVOQ5I9Pv/1Np +Zgxsf30oTZ69I39sknHuz/7il3MjauPHgcEmOBHFH9iG8hZQWLT3PuCDx3vRonU7d0H Rg7cHsJvlxLpqM1suWUGWpKCSAZZDNSfkESG6tBaeLQsXnNmAL7oVq6PCB2gLCRw0PPh KmCm/I6ja/fo6vzg6RzC6rooQtjTYqENe+YE5AFZR8jpcsVBJjr923aa0b2nmWdXWrM9 BSaQ== X-Gm-Message-State: AOPr4FXAlyVXwpgbqBrwwNvtYQSZY1g++xKg7dWMGL2tScyL8pOC245YyNNhmnGVcV9f7YVO6+U= X-Received: by 10.157.62.183 with SMTP id b52mr16392356otc.104.1461593940403; Mon, 25 Apr 2016 07:19:00 -0700 (PDT) Received: from Ubuntu15.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id 50sm6511083ote.39.2016.04.25.07.18.59 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 25 Apr 2016 07:18:59 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 25 Apr 2016 09:18:57 -0500 Message-Id: <1461593937-31831-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH] api: packet: update description for odp_packet_align() 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" Minor rewording for clarity and to specify 0 as a don't care value for the align parameter. Signed-off-by: Bill Fischofer --- include/odp/api/spec/packet.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/include/odp/api/spec/packet.h b/include/odp/api/spec/packet.h index de128df..8eddf2f 100644 --- a/include/odp/api/spec/packet.h +++ b/include/odp/api/spec/packet.h @@ -646,11 +646,11 @@ int odp_packet_rem_data(odp_packet_t *pkt, uint32_t offset, uint32_t len); * Align packet data * * Modify packet data alignment so that 'len' bytes between 'offset' and - * 'offset' plus 'len' are contiguous in memory and start in minimum alignment + * 'offset' plus 'len' are contiguous in memory and have a minimum alignment * of 'align' bytes. * * A successful operation overwrites the packet handle with a new handle, which - * application must use as the reference to the packet instead of the old + * the application must use as the reference to the packet instead of the old * handle. Depending on the implementation, the old and new handles may be * equal. * @@ -667,7 +667,10 @@ int odp_packet_rem_data(odp_packet_t *pkt, uint32_t offset, uint32_t len); * @param offset Byte offset of the contiguous area * @param len Byte length of the contiguous area (0 ... packet_len) * @param align Minimum byte alignment of the contiguous area. - * Implementation rounds up to nearest power of two. + * Valid values are powers of 2. Use 0 to indicate no + * special alignment requirement. The implementation may + * silently cap the maximum supported alignment, which + * must be at least 8. * * @retval 0 Operation successful, old pointers remain valid * @retval >0 Operation successful, old pointers need to be updated