From patchwork Wed Nov 26 19:20:52 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 41563 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f199.google.com (mail-wi0-f199.google.com [209.85.212.199]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id A183225E18 for ; Wed, 26 Nov 2014 19:21:17 +0000 (UTC) Received: by mail-wi0-f199.google.com with SMTP id bs8sf2374694wib.2 for ; Wed, 26 Nov 2014 11:21:16 -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=ehMMWWpHdbdEoD9LLYkn9zJMMbAKfboNR/XdUmJOqoI=; b=DO/rRD3AjuaWgf/o/vhKhVNDqX4xCrqJcGAExnCaTxx19x/5hdbWJzLg+lZ0wRWPYA 1IS+NLMMXYRIg1aV8lUQHLgOujPUKGIPnSxCBllCPNoaypgIHTpNeFGHHN2A2so5Y5om DemztEyaFT/EsbN0W//vpsFMwSzJ8n1q6EiKfJzsy4wiLA6aLKDh1vLAXcOGtiCEOJMv jhi5spRIn4sXA4lqnRDMeLqM+3LF0yMquRT1Rlnj4SdzwEQTjX8MBerywz5HpneR6tLI yDgm8C3WpEmBsHQ1hWrwWZDmoobdQazr9n3IZWoGOWAEDpMifH8fYCuOdm+NDOwxpIUq +VDg== X-Gm-Message-State: ALoCoQl1EUmUNm37qrzdWRtFsWbRry/e4+b3JFO3cqAFKXDWxYssx7k0kMIzrVlFNaLC9fF9exce X-Received: by 10.112.32.163 with SMTP id k3mr412347lbi.17.1417029676811; Wed, 26 Nov 2014 11:21:16 -0800 (PST) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.9.38 with SMTP id w6ls641085laa.49.gmail; Wed, 26 Nov 2014 11:21:16 -0800 (PST) X-Received: by 10.152.29.41 with SMTP id g9mr564307lah.32.1417029676518; Wed, 26 Nov 2014 11:21:16 -0800 (PST) Received: from mail-lb0-f182.google.com (mail-lb0-f182.google.com. [209.85.217.182]) by mx.google.com with ESMTPS id u18si5268579lal.73.2014.11.26.11.21.16 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 26 Nov 2014 11:21:16 -0800 (PST) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.182 as permitted sender) client-ip=209.85.217.182; Received: by mail-lb0-f182.google.com with SMTP id f15so3272126lbj.27 for ; Wed, 26 Nov 2014 11:21:16 -0800 (PST) X-Received: by 10.112.62.166 with SMTP id z6mr34746473lbr.74.1417029676349; Wed, 26 Nov 2014 11:21:16 -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.184.201 with SMTP id ew9csp683905lbc; Wed, 26 Nov 2014 11:21:15 -0800 (PST) X-Received: by 10.224.67.7 with SMTP id p7mr23973376qai.97.1417029675026; Wed, 26 Nov 2014 11:21:15 -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 h12si6092704qay.54.2014.11.26.11.21.13 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Wed, 26 Nov 2014 11:21:15 -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 1Xti9I-0000C2-HQ; Wed, 26 Nov 2014 19:21:12 +0000 Received: from mail-qc0-f176.google.com ([209.85.216.176]) by ip-10-35-177-41.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1Xti9B-0000Bs-Kl for lng-odp@lists.linaro.org; Wed, 26 Nov 2014 19:21:05 +0000 Received: by mail-qc0-f176.google.com with SMTP id i17so2607945qcy.35 for ; Wed, 26 Nov 2014 11:21:00 -0800 (PST) X-Received: by 10.140.49.107 with SMTP id p98mr47296248qga.20.1417029660436; Wed, 26 Nov 2014 11:21:00 -0800 (PST) Received: from fedora1.holmesfamily.ws ([98.221.136.245]) by mx.google.com with ESMTPSA id e2sm4673279qaw.10.2014.11.26.11.20.59 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 26 Nov 2014 11:20:59 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 26 Nov 2014 14:20:52 -0500 Message-Id: <1417029652-31887-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.1.0 X-Topics: patch Subject: [lng-odp] [PATCH] api: doxygen: odp_system_info.h 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: mike.holmes@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.217.182 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 Improve the documentation regarding possible return values. Signed-off-by: Mike Holmes --- platform/linux-generic/include/api/odp_system_info.h | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/platform/linux-generic/include/api/odp_system_info.h b/platform/linux-generic/include/api/odp_system_info.h index bcd08d7..28ce669 100644 --- a/platform/linux-generic/include/api/odp_system_info.h +++ b/platform/linux-generic/include/api/odp_system_info.h @@ -28,28 +28,34 @@ extern "C" { /** * CPU frequency in Hz * - * @return CPU frequency in Hz + * @retval CPU frequency in Hz + * @retval 0 on error */ uint64_t odp_sys_cpu_hz(void); /** * Huge page size in bytes * - * @return Huge page size in bytes + * @retval Huge page size in bytes + * @retval 0 on error */ uint64_t odp_sys_huge_page_size(void); /** * Page size in bytes * - * @return Page size in bytes + * This is set at compile time via ODP_PAGE_SIZE + * @retval Page size in bytes + * */ uint64_t odp_sys_page_size(void); /** * CPU model name * - * @return Pointer to CPU model name string + * @note max size is 127 chars + null termination + * @retval Pointer to CPU model name string + * @retval null teminated string on failure */ const char *odp_sys_cpu_model_str(void); @@ -63,7 +69,10 @@ int odp_sys_cache_line_size(void); /** * Core count * - * @return Core count + * @note The total physical number of cores, the current number avalable might be less. + * + * @retval Core count + * @retval 0 on error */ int odp_sys_core_count(void);