From patchwork Fri Dec 19 15:28:17 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Petri Savolainen X-Patchwork-Id: 42492 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ee0-f71.google.com (mail-ee0-f71.google.com [74.125.83.71]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 60CA526CB1 for ; Fri, 19 Dec 2014 15:29:11 +0000 (UTC) Received: by mail-ee0-f71.google.com with SMTP id c13sf903243eek.2 for ; Fri, 19 Dec 2014 07:29:10 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state: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=sIG09rGPYWJMOA68/aa8T4PU2PonhHNHFXk/Q/NLIVw=; b=fI8YHW/YvSNha637dSUDmaV6JkuwJz5gMQX6bXSD3u99SKKiJ0OtFyT8Di9EVYFYaV 7ytlSqw1tF/cgHdF0+LW5uvjAjr7dNuF0HtXf53Z5OyJy6uzL/wTK+P2spEWB9+WFQlb Df/9PKSBEAgiAiXNKI4rC6M81nF23RnKrGLnoTjft4yERu7CRDaDtmcBsHWooSUtHQ0s xP8QektNo/BLBmvS8xFxLf3/jlf0Jx2J1kcvdzcleRlP+clgIICgKJOwXfY97rd5Fbro Qum9BzycFomBwrkdZBkdbbzydh4xfV1aXzqaLUdh48HMg/9CGKBjLiPirTfCQvoQbXLU LpgA== X-Gm-Message-State: ALoCoQmGgIePm0b6oMyMbGdCjI72ozQWF0jUQMjrVadjP2puh0MlR3kBKVQUn2jWSLfl+wXH5aho X-Received: by 10.194.178.163 with SMTP id cz3mr1193366wjc.1.1419002950546; Fri, 19 Dec 2014 07:29:10 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.203.226 with SMTP id kt2ls1312918lac.52.gmail; Fri, 19 Dec 2014 07:29:10 -0800 (PST) X-Received: by 10.112.185.68 with SMTP id fa4mr8456418lbc.84.1419002950377; Fri, 19 Dec 2014 07:29:10 -0800 (PST) Received: from mail-la0-f45.google.com (mail-la0-f45.google.com. [209.85.215.45]) by mx.google.com with ESMTPS id go8si5176325lbc.46.2014.12.19.07.29.10 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 19 Dec 2014 07:29:10 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.45 as permitted sender) client-ip=209.85.215.45; Received: by mail-la0-f45.google.com with SMTP id gq15so1025852lab.4 for ; Fri, 19 Dec 2014 07:29:10 -0800 (PST) X-Received: by 10.152.27.8 with SMTP id p8mr8441150lag.69.1419002950250; Fri, 19 Dec 2014 07:29:10 -0800 (PST) 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.142.69 with SMTP id ru5csp309737lbb; Fri, 19 Dec 2014 07:29:09 -0800 (PST) X-Received: by 10.140.34.204 with SMTP id l70mr13906403qgl.55.1419002948008; Fri, 19 Dec 2014 07:29:08 -0800 (PST) Received: from ip-10-35-177-41.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id e96si12116616qgd.23.2014.12.19.07.29.00 (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 19 Dec 2014 07:29:07 -0800 (PST) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-35-177-41.ec2.internal) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y1zU9-0000lW-Qr; Fri, 19 Dec 2014 15:28:57 +0000 Received: from mail-qc0-f171.google.com ([209.85.216.171]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y1zU2-0000lH-V8 for lng-odp@lists.linaro.org; Fri, 19 Dec 2014 15:28:50 +0000 Received: by mail-qc0-f171.google.com with SMTP id r5so796752qcx.16 for ; Fri, 19 Dec 2014 07:28:45 -0800 (PST) X-Received: by 10.140.39.116 with SMTP id u107mr13912990qgu.98.1419002925733; Fri, 19 Dec 2014 07:28:45 -0800 (PST) Received: from localhost.localdomain (ec2-23-23-178-99.compute-1.amazonaws.com. [23.23.178.99]) by mx.google.com with ESMTPSA id p4sm9692288qar.48.2014.12.19.07.28.43 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 19 Dec 2014 07:28:44 -0800 (PST) From: Petri Savolainen To: lng-odp@lists.linaro.org Date: Fri, 19 Dec 2014 17:28:17 +0200 Message-Id: <1419002899-17314-1-git-send-email-petri.savolainen@linaro.org> X-Mailer: git-send-email 2.2.1 X-Topics: patch Subject: [lng-odp] [PATCH 1/3] api: buffer_pool: Correct buf_size pool param documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 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-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: petri.savolainen@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.45 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 Buf_size parameter defines minimum buffer/segment length. Use 0 for default length. Signed-off-by: Petri Savolainen --- .../linux-generic/include/api/odp_buffer_pool.h | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h b/platform/linux-generic/include/api/odp_buffer_pool.h index 4da5f84..27e816d 100644 --- a/platform/linux-generic/include/api/odp_buffer_pool.h +++ b/platform/linux-generic/include/api/odp_buffer_pool.h @@ -35,18 +35,19 @@ extern "C" { /** * Buffer pool parameters * Used to communicate buffer pool creation options. + * + * @see ODP_CONFIG_PACKET_BUF_LEN_MIN, ODP_CONFIG_BUFFER_ALIGN_MIN, + * ODP_CONFIG_BUFFER_ALIGN_MAX */ typedef struct odp_buffer_pool_param_t { - uint32_t buf_size; /**< Buffer size in bytes. The maximum - number of bytes application will - store in each buffer. For packets, this - is the maximum packet data length, and - configured headroom and tailroom will be - added to this number */ - uint32_t buf_align; /**< Minimum buffer alignment in bytes. - Valid values are powers of two. Use 0 - for default alignment. Default will - always be a multiple of 8. */ + uint32_t buf_size; /**< Minimum buffer length in bytes. For packets, + this is the minimum segment buffer length. The + length includes head-/tailroom bytes. Use 0 for + default length. */ + uint32_t buf_align; /**< Minimum buffer alignment in bytes. Valid values + are powers of two. Use 0 for default + alignment. Default will always be a multiple + of 8. */ uint32_t num_bufs; /**< Number of buffers in the pool */ int buf_type; /**< Buffer type */ } odp_buffer_pool_param_t;