From patchwork Tue Dec 23 11:29:05 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Petri Savolainen X-Patchwork-Id: 42561 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 ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 1285C2188F for ; Tue, 23 Dec 2014 11:29:45 +0000 (UTC) Received: by mail-la0-f69.google.com with SMTP id gd6sf3937470lab.8 for ; Tue, 23 Dec 2014 03:29:43 -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=N7rCBCkIdiTm/+jdkVQPQF4aFf3KTEWx1mXRx8ar7Fc=; b=e/9FEREk6L7zx5Uf/J8t83srtODxIwS7bOPq8yx1GQMC5d2GcQmmUQClsjOLkeMBOo 7MLKbYLGS2SI+T5snrK4jsIjlDR+OxbsBrgi9mWRRYnGhjzNXWtSqABTB6LCeIgYDrw3 E7hwKRfqRp7grDTD1xro8Q3RTKHKrA/DoV1Msp4XZf5zSBMHGuQOPWErHp4TeiSfSYMK M4BgwOlPnqXfASeY8BkhKAO+pw61IylOVlyEdmNkk3fF2lyxGXvTGLOFBvh94XrHjMNf iG/TIgtxjqp3g4ApgZPNcHjMEfRw0vX4K2t5PZfJ7WzoaCWeRNdDUxjyYZS05j495ppo ImCw== X-Gm-Message-State: ALoCoQklkPB6T5n6Ss/ndHk+9FE+U7Vq0Xz0PV+Jrql7oOP7g2Ub/8Ilo59c6y+WvFz5vuhByneb X-Received: by 10.112.14.2 with SMTP id l2mr3378381lbc.5.1419334183800; Tue, 23 Dec 2014 03:29:43 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.43.41 with SMTP id t9ls1670204lal.51.gmail; Tue, 23 Dec 2014 03:29:43 -0800 (PST) X-Received: by 10.112.168.164 with SMTP id zx4mr26995408lbb.28.1419334183653; Tue, 23 Dec 2014 03:29:43 -0800 (PST) Received: from mail-la0-f42.google.com (mail-la0-f42.google.com. [209.85.215.42]) by mx.google.com with ESMTPS id n3si19583142lah.45.2014.12.23.03.29.43 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 23 Dec 2014 03:29:43 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.42 as permitted sender) client-ip=209.85.215.42; Received: by mail-la0-f42.google.com with SMTP id gd6so5435128lab.1 for ; Tue, 23 Dec 2014 03:29:43 -0800 (PST) X-Received: by 10.112.131.1 with SMTP id oi1mr26397143lbb.2.1419334183461; Tue, 23 Dec 2014 03:29:43 -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 ru5csp1298041lbb; Tue, 23 Dec 2014 03:29:42 -0800 (PST) X-Received: by 10.229.248.69 with SMTP id mf5mr44391555qcb.29.1419334181771; Tue, 23 Dec 2014 03:29:41 -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 s3si22903867qak.101.2014.12.23.03.29.39 (version=TLSv1 cipher=RC4-SHA bits=128/128); Tue, 23 Dec 2014 03:29:41 -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 1Y3Nej-0001lP-Bv; Tue, 23 Dec 2014 11:29:37 +0000 Received: from mail-qc0-f172.google.com ([209.85.216.172]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Y3Nec-0001lF-PQ for lng-odp@lists.linaro.org; Tue, 23 Dec 2014 11:29:30 +0000 Received: by mail-qc0-f172.google.com with SMTP id m20so4561573qcx.3 for ; Tue, 23 Dec 2014 03:29:25 -0800 (PST) X-Received: by 10.140.49.5 with SMTP id p5mr19767535qga.15.1419334165364; Tue, 23 Dec 2014 03:29:25 -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 i76sm18673042qgd.4.2014.12.23.03.29.22 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Tue, 23 Dec 2014 03:29:23 -0800 (PST) From: Petri Savolainen To: lng-odp@lists.linaro.org Date: Tue, 23 Dec 2014 13:29:05 +0200 Message-Id: <1419334146-28747-1-git-send-email-petri.savolainen@linaro.org> X-Mailer: git-send-email 2.2.1 X-Topics: patch Subject: [lng-odp] [PATCH v2 1/2] 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.42 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 | 28 +++++++++++++--------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/platform/linux-generic/include/api/odp_buffer_pool.h b/platform/linux-generic/include/api/odp_buffer_pool.h index 8380ac1..9329405 100644 --- a/platform/linux-generic/include/api/odp_buffer_pool.h +++ b/platform/linux-generic/include/api/odp_buffer_pool.h @@ -35,19 +35,25 @@ 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 num_bufs; /**< Number of buffers in the pool */ + uint32_t buf_size; /**< Minimum buffer size in bytes. For packets, + this is the minimum segment buffer length, + which includes possible head-/tailroom bytes. + Use 0 for the default size of the buffer type + (e.g. for timeouts or min packet segment + 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. For packets, + this is the total number of segments and the + maximum number of packets (in case that all + packets have a single segment). */ int buf_type; /**< Buffer type */ } odp_buffer_pool_param_t;