From patchwork Tue Apr 5 21:38:05 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Gardiner X-Patchwork-Id: 688831 Received: from bear.ext.ti.com (bear.ext.ti.com [192.94.94.41]) by demeter1.kernel.org (8.14.4/8.14.3) with ESMTP id p35LfFCs008907 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 5 Apr 2011 21:41:36 GMT Received: from dlep33.itg.ti.com ([157.170.170.112]) by bear.ext.ti.com (8.13.7/8.13.7) with ESMTP id p35LdJHt027541 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Tue, 5 Apr 2011 16:39:19 -0500 Received: from linux.omap.com (localhost [127.0.0.1]) by dlep33.itg.ti.com (8.13.7/8.13.7) with ESMTP id p35LdJto028472; Tue, 5 Apr 2011 16:39:19 -0500 (CDT) Received: from linux.omap.com (localhost [127.0.0.1]) by linux.omap.com (Postfix) with ESMTP id DBA7680632; Tue, 5 Apr 2011 16:39:14 -0500 (CDT) X-Original-To: davinci-linux-open-source@linux.davincidsp.com Delivered-To: davinci-linux-open-source@linux.davincidsp.com Received: from dflp52.itg.ti.com (dflp52.itg.ti.com [128.247.22.96]) by linux.omap.com (Postfix) with ESMTP id EFCBA80631 for ; Tue, 5 Apr 2011 16:38:20 -0500 (CDT) Received: from white.ext.ti.com (localhost [127.0.0.1]) by dflp52.itg.ti.com (8.13.7/8.13.7) with ESMTP id p35LcH3h006520 for ; Tue, 5 Apr 2011 16:38:17 -0500 (CDT) Received: from psmtp.com (na3sys009amx227.postini.com [74.125.149.111]) by white.ext.ti.com (8.13.7/8.13.7) with SMTP id p35LcGvo016796 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 5 Apr 2011 16:38:17 -0500 Received: from na3sys009aog115.obsmtp.com ([209.85.218.47]) (using TLSv1) by na3sys009amx227.postini.com ([74.125.148.10]) with SMTP; Tue, 05 Apr 2011 14:38:17 PDT Received: from mail-yi0-f47.google.com ([209.85.218.47]) (using TLSv1) by na3sys009aob115.postini.com ([74.125.148.12]) with SMTP ID DSNKTZuLyJUcuYWHRCXt6rBEkG+iNaf5VyV5@postini.com; Tue, 05 Apr 2011 14:38:17 PDT Received: by mail-yi0-f47.google.com with SMTP id 13so425336yia.34 for ; Tue, 05 Apr 2011 14:38:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nanometrics.ca; s=google; h=domainkey-signature:from:to:cc:subject:date:message-id:x-mailer :in-reply-to:references; bh=FmZrVs0YCezkHj3ECQItyL06bcC3dna4K/5vT0+gBC0=; b=AkB4oCbMIFMaPYfF6VA2R9AyqD5n6QLRtKbL8MuNqTbs6JONvdw34dKn5fGa6V+G9i Swh+kz5mVqIlsupDIBcQzHlHvY85EzEmmD2n/ZQNngPjLrOFvhZBshjTNcSKoZNByVxN GsRpR2o5o0u7GrsoKYvJWCKUv5INI4ptpMhc8= DomainKey-Signature: a=rsa-sha1; c=nofws; d=nanometrics.ca; s=google; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; b=HkHFpuJu7Tn+E4z239KHxmQ+IU1bwkuFSw8PXrwcqOUL1qrtCOv+1u7cYm5kzUrcGF l79TnA+0pqxLnsVkPDcFZWFfnUU8GHZe7RWjpgG3hcZ21wKx3MoriTYbcftOD5d04843 zLOKnqLnfOwM0uMaNaj1ie0m4dsJbIBCgYluo= Received: by 10.91.203.40 with SMTP id f40mr1061952agq.185.1302039496266; Tue, 05 Apr 2011 14:38:16 -0700 (PDT) Received: from localhost.localdomain ([206.191.47.130]) by mx.google.com with ESMTPS id c24sm6932367ana.21.2011.04.05.14.38.14 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 05 Apr 2011 14:38:15 -0700 (PDT) From: Ben Gardiner To: davinci-linux-open-source@linux.davincidsp.com, linux-i2c@vger.kernel.org, Sekhar Nori , Ben Dooks Subject: [PATCH 2/6] i2c-davinci: convert davinci_i2c_platform_data to kerneldoc Date: Tue, 5 Apr 2011 17:38:05 -0400 Message-Id: <0710b48a8514dface179b54c615b7cc0bba20d42.1302031487.git.bengardiner@nanometrics.ca> X-Mailer: git-send-email 1.7.1 In-Reply-To: References: X-pstn-neptune: 0/0/0.00/0 X-pstn-levels: (S:99.90000/99.90000 CV:99.9000 FC:95.5390 LC:95.5390 R:95.9108 P:95.9108 M:97.0282 C:98.6951 ) X-pstn-settings: 2 (0.5000:0.0750) s cv GT3 gt2 gt1 r p m c X-pstn-addresses: from [db-null] Cc: linux-kernel@vger.kernel.org, Bastian Ruppert , Philby John , Ben Dooks , linux-arm-kernel@lists.infradead.org X-BeenThere: davinci-linux-open-source@linux.davincidsp.com X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: davinci-linux-open-source-bounces@linux.davincidsp.com Errors-To: davinci-linux-open-source-bounces@linux.davincidsp.com X-Greylist: Sender succeeded STARTTLS authentication, not delayed by milter-greylist-4.2.6 (demeter1.kernel.org [140.211.167.41]); Tue, 05 Apr 2011 21:41:36 +0000 (UTC) The davinci_i2c_platform_data struct is mach-specific but still deserves to be documented using kernel doc. Signed-off-by: Ben Gardiner Cc: Sekhar Nori Cc: Ben Dooks --- arch/arm/mach-davinci/include/mach/i2c.h | 17 ++++++++++++----- 1 files changed, 12 insertions(+), 5 deletions(-) diff --git a/arch/arm/mach-davinci/include/mach/i2c.h b/arch/arm/mach-davinci/include/mach/i2c.h index 2312d19..ab07a44 100644 --- a/arch/arm/mach-davinci/include/mach/i2c.h +++ b/arch/arm/mach-davinci/include/mach/i2c.h @@ -12,12 +12,19 @@ #ifndef __ASM_ARCH_I2C_H #define __ASM_ARCH_I2C_H -/* All frequencies are expressed in kHz */ +/** + * davinci_i2c_platform_data - Platform data for I2C master device on DaVinci + * + * @bus_freq: standard bus frequency (kHz) + * @bus_delay: post-transaction delay (usec) + * @sda_pin: GPIO pin ID to use for SDA + * @scl_pin: GPIO pin ID to use for SCL + */ struct davinci_i2c_platform_data { - unsigned int bus_freq; /* standard bus frequency (kHz) */ - unsigned int bus_delay; /* post-transaction delay (usec) */ - unsigned int sda_pin; /* GPIO pin ID to use for SDA */ - unsigned int scl_pin; /* GPIO pin ID to use for SCL */ + unsigned int bus_freq; + unsigned int bus_delay; + unsigned int sda_pin; + unsigned int scl_pin; }; /* for board setup code */