From patchwork Wed Jul 23 12:55:17 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Glass X-Patchwork-Id: 372921 X-Patchwork-Delegate: sjg@chromium.org Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from theia.denx.de (theia.denx.de [85.214.87.163]) by ozlabs.org (Postfix) with ESMTP id 00EB31400E4 for ; Wed, 23 Jul 2014 22:59:27 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id CE35AA7549; Wed, 23 Jul 2014 14:58:41 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at theia.denx.de Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 01gS6WvPemaT; Wed, 23 Jul 2014 14:58:41 +0200 (CEST) Received: from theia.denx.de (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id 68769A76B9; Wed, 23 Jul 2014 14:56:41 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by theia.denx.de (Postfix) with ESMTP id B4562A7425 for ; Wed, 23 Jul 2014 14:56:15 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at theia.denx.de Received: from theia.denx.de ([127.0.0.1]) by localhost (theia.denx.de [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id kblUfo5v-16n for ; Wed, 23 Jul 2014 14:56:13 +0200 (CEST) X-policyd-weight: NOT_IN_SBL_XBL_SPAMHAUS=-1.5 NOT_IN_SPAMCOP=-1.5 NOT_IN_BL_NJABL=-1.5 (only DNSBL check requested) Received: from mail-qg0-f74.google.com (mail-qg0-f74.google.com [209.85.192.74]) by theia.denx.de (Postfix) with ESMTPS id 41518A755B for ; Wed, 23 Jul 2014 14:55:56 +0200 (CEST) Received: by mail-qg0-f74.google.com with SMTP id z60so65928qgd.3 for ; Wed, 23 Jul 2014 05:55:55 -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:in-reply-to :references; bh=kSrjIUkHqTJVkauN67HRKCJUjFkHqhoMF79MsA2kiLY=; b=hn3YNpJUd8AtVKSRGOhs7OzD7LsIqHQTjSBI6z5pdoitASyORR6mEJomNCSE+44R6x z31pnl7AIjljiH//U9e0qKiEUBgfsSFcBkH9PMetnObuJmUBhu7BsGHHL8v3kqBnO9No EPBO/ef37NGw2XvCsS+bOqEsTSMhs56M567a8sUn5JicORRQTmBG+iipGmabyCQRNSST g+D2TIyBAY0kdsA5X7bogbE6xBKmnR+j+TyOHLssSp8jPEocH1V+QKY2b0lu+sO4UKD9 +fUEmNMcw9WYx4G38c9w0zarVB9m45yVl00IQNhE34KJQimoWCOlt8iqcBprVmNMNaNK LpYQ== X-Gm-Message-State: ALoCoQkp/25QJ2qvWMqMLLqkMa3rUxjwgMsHKe2xXj8Bt9ZpZQqSJD3DrhLXfy4761OkjqzYR4gJ X-Received: by 10.236.155.132 with SMTP id j4mr411553yhk.56.1406120155324; Wed, 23 Jul 2014 05:55:55 -0700 (PDT) Received: from corp2gmr1-1.hot.corp.google.com (corp2gmr1-1.hot.corp.google.com [172.24.189.92]) by gmr-mx.google.com with ESMTPS id l23si391472yhg.1.2014.07.23.05.55.55 for (version=TLSv1.1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 23 Jul 2014 05:55:55 -0700 (PDT) Received: from kaki.bld.corp.google.com (kaki.bld.corp.google.com [172.29.216.32]) by corp2gmr1-1.hot.corp.google.com (Postfix) with ESMTP id 218A631C27E; Wed, 23 Jul 2014 05:55:55 -0700 (PDT) Received: by kaki.bld.corp.google.com (Postfix, from userid 121222) id D0B74220450; Wed, 23 Jul 2014 06:55:54 -0600 (MDT) From: Simon Glass To: U-Boot Mailing List Date: Wed, 23 Jul 2014 06:55:17 -0600 Message-Id: <1406120124-9373-23-git-send-email-sjg@chromium.org> X-Mailer: git-send-email 2.0.0.526.g5318336 In-Reply-To: <1406120124-9373-1-git-send-email-sjg@chromium.org> References: <1406120124-9373-1-git-send-email-sjg@chromium.org> Subject: [U-Boot] [PATCH v3 22/29] dm: Tidy up some header file comments X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.11 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: u-boot-bounces@lists.denx.de Errors-To: u-boot-bounces@lists.denx.de Fix up the style of a few comments and add/clarify a few others. Signed-off-by: Simon Glass --- Changes in v3: None Changes in v2: None include/dm/device.h | 2 +- include/dm/platdata.h | 10 ++++++++-- include/dm/root.h | 3 ++- include/dm/uclass-id.h | 2 +- include/dm/uclass.h | 2 +- 5 files changed, 13 insertions(+), 6 deletions(-) diff --git a/include/dm/device.h b/include/dm/device.h index 6005e7e..9077490 100644 --- a/include/dm/device.h +++ b/include/dm/device.h @@ -124,7 +124,7 @@ struct udevice_id { * This is typically only useful for device-tree-aware drivers (those with * an of_match), since drivers which use platdata will have the data * provided in the U_BOOT_DEVICE() instantiation. - * ops: Driver-specific operations. This is typically a list of function + * @ops: Driver-specific operations. This is typically a list of function * pointers defined by the driver, to implement driver functions required by * the uclass. * @flags: driver flags - see DM_FLAGS_... diff --git a/include/dm/platdata.h b/include/dm/platdata.h index 0ef3353..2bc8b14 100644 --- a/include/dm/platdata.h +++ b/include/dm/platdata.h @@ -11,9 +11,15 @@ #ifndef _DM_PLATDATA_H #define _DM_PLATDATA_H +/** + * struct driver_info - Information required to instantiate a device + * + * @name: Device name + * @platdata: Driver-specific platform data + */ struct driver_info { - const char *name; - const void *platdata; + const char *name; + const void *platdata; }; #define U_BOOT_DEVICE(__name) \ diff --git a/include/dm/root.h b/include/dm/root.h index 09f9303..02c7788 100644 --- a/include/dm/root.h +++ b/include/dm/root.h @@ -35,7 +35,8 @@ int dm_scan_platdata(bool pre_reloc_only); /** * dm_scan_fdt() - Scan the device tree and bind drivers * - * This scans the device tree and creates a driver for each node + * This scans the device tree and creates a driver for each node. Only + * the top-level subnodes are examined. * * @blob: Pointer to device tree blob * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC diff --git a/include/dm/uclass-id.h b/include/dm/uclass-id.h index f0e691c..77ff9ea 100644 --- a/include/dm/uclass-id.h +++ b/include/dm/uclass-id.h @@ -19,7 +19,7 @@ enum uclass_id { UCLASS_TEST_FDT, /* U-Boot uclasses start here */ - UCLASS_GPIO, + UCLASS_GPIO, /* Bank of general-purpose I/O pins */ UCLASS_COUNT, UCLASS_INVALID = -1, diff --git a/include/dm/uclass.h b/include/dm/uclass.h index 0b5ade6..8d09ecf 100644 --- a/include/dm/uclass.h +++ b/include/dm/uclass.h @@ -98,7 +98,7 @@ int uclass_get(enum uclass_id key, struct uclass **ucp); * * The device is probed to activate it ready for use. * - * id: ID to look up + * @id: ID to look up * @index: Device number within that uclass (0=first) * @devp: Returns pointer to device (there is only one per for each ID) * @return 0 if OK, -ve on error