From patchwork Tue Oct 25 12:49:01 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 79169 Delivered-To: patch@linaro.org Received: by 10.140.97.247 with SMTP id m110csp3093931qge; Tue, 25 Oct 2016 05:49:40 -0700 (PDT) X-Received: by 10.107.8.79 with SMTP id 76mr15991898ioi.154.1477399780110; Tue, 25 Oct 2016 05:49:40 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id h6si1257606iti.109.2016.10.25.05.49.39; Tue, 25 Oct 2016 05:49:40 -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 9964E60A38; Tue, 25 Oct 2016 12:49:39 +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=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL 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 2EBBD60E53; Tue, 25 Oct 2016 12:49:15 +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 E1BB160A38; Tue, 25 Oct 2016 12:49:10 +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 CF38B609FA for ; Tue, 25 Oct 2016 12:49:07 +0000 (UTC) Received: by mail-oi0-f45.google.com with SMTP id m72so95548346oik.3 for ; Tue, 25 Oct 2016 05:49:07 -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=IqmIrsJLZKkbOI/BpW8vWAS/dLAcspYnvUWre/cqHmg=; b=IA/rEn5d5JKBBY8QxMzfjNCyLjK0m+HAZmXjfgA3d2DiCYyewgc5TQPQ/LkbWasc0d TSpGtx7ec6vUgjXG0kjgrb5Gu4gkfpv+bmws1MRtqiupJwx4TPSR0SRoe2C+JFzDIvoY r6cVxm529MrQwHXVXP2ZAE57vvQCk2vIk7lTs7hUtmZ73q/p9uenx6vyzfQgzghvTtE3 YOpT0AlDXOOLCqJbvN4AMWYjP/YxRd4gM86X+0RmYpAILax139WVvDPpdwf9OS8nHmIO Tov6RoT6su/hIqof797qYrnZv4PqsKavIMJcteSC8flMiWehMbIjDNDTbCvcK6kKdQgh 1U2g== X-Gm-Message-State: AA6/9Rk+AWU24Vr/LtR646km2UW22gMw4XNjzRFKv1izSyq15F8eUQ4+JbAomVYdkcQzFaz9shA= X-Received: by 10.202.198.81 with SMTP id w78mr23351454oif.142.1477399747223; Tue, 25 Oct 2016 05:49:07 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id g17sm6296544otd.38.2016.10.25.05.49.06 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 25 Oct 2016 05:49:06 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 25 Oct 2016 07:49:01 -0500 Message-Id: <1477399744-16516-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.7.4 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH 1/4] api: random: document usage of use_entropy parameter 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: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Address bug https://bugs.linaro.org/show_bug.cgi?id=2557 by adding documentation regarding handling of the use_entropy parameter of odp_random_data() Signed-off-by: Bill Fischofer --- include/odp/api/spec/random.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) -- 2.7.4 diff --git a/include/odp/api/spec/random.h b/include/odp/api/spec/random.h index 00fa15b..8b9d449 100644 --- a/include/odp/api/spec/random.h +++ b/include/odp/api/spec/random.h @@ -28,9 +28,10 @@ extern "C" { * * @param[out] buf Output buffer * @param size Size of output buffer - * @param use_entropy Use entropy - * - * @todo Define the implication of the use_entropy parameter + * @param use_entropy Use entropy. When true indicates that true random + * data is requested. Otherwise this routine returns + * pseudo-random data. Request is expected to fail if + * true random data is requested but cannot be supplied. * * @return Number of bytes written * @retval <0 on failure