From patchwork Thu Sep 13 11:07:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandru Ardelean X-Patchwork-Id: 10599245 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 61506920 for ; Thu, 13 Sep 2018 11:08:00 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 502682A04A for ; Thu, 13 Sep 2018 11:08:00 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 437C32A161; Thu, 13 Sep 2018 11:08:00 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id CE7962A04A for ; Thu, 13 Sep 2018 11:07:55 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726792AbeIMQQx (ORCPT ); Thu, 13 Sep 2018 12:16:53 -0400 Received: from mail-eopbgr690088.outbound.protection.outlook.com ([40.107.69.88]:59712 "EHLO NAM04-CO1-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726741AbeIMQQw (ORCPT ); Thu, 13 Sep 2018 12:16:52 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=analog.onmicrosoft.com; s=selector1-analog-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=TCepYp7/gFLb022HDwQ8vdS7Ugb2NdsIvnDp9T0Wd5c=; b=t2bkB1Q5jf0XAUQ6QM2RjyoFhUe/hlOEbp9UrhYryvRJlhZQyoqlIJZus4Yk1YWYVe7C7duSlEJyk5Aup5KsGf+YN6zRFn6ouiuNs7eCD3qxRohHPp2YLCU5ZuCgLYrFmHD6kimk8UO3YIlCtHbk0jH++foy/XUdEsJtPDnt6gk= Received: from BN6PR03CA0057.namprd03.prod.outlook.com (2603:10b6:404:4c::19) by CY4PR03MB3127.namprd03.prod.outlook.com (2603:10b6:910:53::28) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1122.18; Thu, 13 Sep 2018 11:07:50 +0000 Received: from BL2FFO11FD006.protection.gbl (2a01:111:f400:7c09::180) by BN6PR03CA0057.outlook.office365.com (2603:10b6:404:4c::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.1143.14 via Frontend Transport; Thu, 13 Sep 2018 11:07:50 +0000 Authentication-Results: spf=pass (sender IP is 137.71.25.55) smtp.mailfrom=analog.com; gmx.de; dkim=none (message not signed) header.d=none;gmx.de; dmarc=bestguesspass action=none header.from=analog.com; Received-SPF: Pass (protection.outlook.com: domain of analog.com designates 137.71.25.55 as permitted sender) receiver=protection.outlook.com; client-ip=137.71.25.55; helo=nwd2mta1.analog.com; Received: from nwd2mta1.analog.com (137.71.25.55) by BL2FFO11FD006.mail.protection.outlook.com (10.173.161.2) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.1143.11 via Frontend Transport; Thu, 13 Sep 2018 11:07:49 +0000 Received: from NWD2HUBCAS9.ad.analog.com (nwd2hubcas9.ad.analog.com [10.64.69.109]) by nwd2mta1.analog.com (8.13.8/8.13.8) with ESMTP id w8DB7nMo029512 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=FAIL); Thu, 13 Sep 2018 04:07:49 -0700 Received: from zeus.spd.analog.com (10.64.82.11) by NWD2HUBCAS9.ad.analog.com (10.64.69.109) with Microsoft SMTP Server id 14.3.210.2; Thu, 13 Sep 2018 07:07:49 -0400 Received: from saturn.analog.com ([10.50.1.244]) by zeus.spd.analog.com (8.15.1/8.15.1) with ESMTP id w8DB7kOD002830; Thu, 13 Sep 2018 07:07:46 -0400 From: Alexandru Ardelean To: , , , CC: , , Alexandru Ardelean Subject: [PATCH] staging:iio:ad7606: update structs with doc annotations Date: Thu, 13 Sep 2018 14:07:36 +0300 Message-ID: <20180913110736.31182-1-alexandru.ardelean@analog.com> X-Mailer: git-send-email 2.17.1 MIME-Version: 1.0 X-ADIRoutedOnPrem: True X-EOPAttributedMessage: 0 X-MS-Office365-Filtering-HT: Tenant X-Forefront-Antispam-Report: CIP:137.71.25.55;IPV:NLI;CTRY:US;EFV:NLI;SFV:NSPM;SFS:(10009020)(39860400002)(136003)(346002)(396003)(376002)(2980300002)(438002)(199004)(189003)(50466002)(356003)(47776003)(7636002)(7696005)(44832011)(478600001)(305945005)(426003)(1857600001)(2616005)(16586007)(110136005)(8676002)(51416003)(48376002)(5660300001)(486006)(36756003)(316002)(336012)(6666003)(54906003)(106466001)(26005)(126002)(53416004)(476003)(575784001)(15650500001)(186003)(2906002)(106002)(77096007)(107886003)(50226002)(1076002)(8936002)(86362001)(4326008)(246002)(2201001)(14444005);DIR:OUT;SFP:1101;SCL:1;SRVR:CY4PR03MB3127;H:nwd2mta1.analog.com;FPR:;SPF:Pass;LANG:en;PTR:nwd2mail10.analog.com;A:1;MX:1; X-Microsoft-Exchange-Diagnostics: 1;BL2FFO11FD006;1:W3hwCvJwPiHbIrAcTu3vLk/6Kwfb94lS5EtwobSF+2jN9QsIUobUQ1zm298tUK3JwWAbrN/23HQ/73bndzbxEC0yP1U0asME+bTgic+rTHuU/AHvNllDdGCkk9bWGAaY X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: ad64cb05-afdc-44fa-ba1f-08d6196924c2 X-Microsoft-Antispam: BCL:0;PCL:0;RULEID:(7020095)(4652040)(8989137)(4534165)(4627221)(201703031133081)(201702281549075)(8990107)(5600074)(711020)(4608076)(2017052603328)(7153060);SRVR:CY4PR03MB3127; X-Microsoft-Exchange-Diagnostics: 1;CY4PR03MB3127;3:DHoWAkTJ1zZMxkNzJK3ku0IusKsTABBjQnFMwRzK3t3AOysh9B3beyxn4v9FjhrMKzbf3srDouVTeixp9ir1VGphDqm3fCnmwvpviA2Fm9qqmXhbnv4HVzUyxsesgFpysmUxmuM4pQ+KCx2SsFnE3r435nP1zqbk9OgRCQWjAIqt+Wn5HVtD3P1ec209W/YQQ6x0yAnUWzN+fOu7OOkPMlkKGN6084RpjBf9uvlZxhi4Fttd6iKVpGSsgdWonjuvBMonODLs5mr3rqAKk4xGmEfAQRfIuPllE0Z9s71vzCoGkLq+y7IrESYxX294TraobcNIHbMkQ8RZOEc7LAA0pt/JLO61yv3wcbGHDcOhd7E=;25:rthotV6NwZd9ppBg5PvtJzYEU8mJzyXudsknz+AIQ1njAgykTuqcUyEvw/Z6t+iGig5sioYd+uLzCAMeR/dwQsmkcIroqLaWfJWharumoWlhk1XFQ4mm2Fgh+pqpw9sBOQnAbkepyywgdwC7VFxg6br7sqQ1jFyZv8veKdcnUDC3ZA3hN1LIBiYNcKEI1o5g3yRkI6+HAIr7gCdMVBen+PCVVYEB5h5AAFFU3K8UxWdLVFCpdfWNT+YR0xZyMREYVYJL1vrzXQkJe+nLIC4rgitTc0k33Ip+9qPEFEUR2rQm3KIZk7q8e88h222gzqCqNDuZE5Gazk05hHfX3qsEAQ== X-MS-TrafficTypeDiagnostic: CY4PR03MB3127: X-Microsoft-Exchange-Diagnostics: 1;CY4PR03MB3127;31:4wDyTEfO7hESJFxnzsmYz5ALeraiJpHMMeQ/RZ1CxGI2bt5gzK9bOP2M40vtVCiTxOktWAQmzBAxjIr9ZeCt8W4n1guam2VIGNbePj95Q8BiiSeOsd1wRD8meOBWvWJO2g+CZqipW1nY6MTif88BDSjvV+VpZYSTomGPM8Wts4c+JdowviXvK5jQpoDfT3ASw1CT6sVzFPgzLL1DGhsv08s8YVJkEy2A5JLqL/hi5hU=;20:W7vzOFXl07qc79Mf5jIRPBnb4PcvyjmAmmHv3x9uvR0SFKvtv5+LNu5YHc441guqOn3gyzcBxFk/KHK5S6O99z5zAkK4H/R2RZ4cfCJmYYAwfx1Hlyb57HNPseHiEO1dhmdjjOQZ8tZXmxWmv91ATH4CxixFq3xMS2gKuJ4kLouWUdFsCiwYgx9/MvwJYrxWZQS6fWCUcchh64HAen5Ca7bOITw0hahscFafCuvVWe2BAGMP5LygA/+uDQUh4q47wyS8e+i0pLBCbPooNpyOlsvumW30yZ/AEsYeSXLyWJA9IFA0j9pujtwoOghylBpJ8hEBj1IaHBW4KcGQ29thoY6MZEzZX0RtcD6qvTzURZRPQ6XHhxEhsF0vXmqIjyx+hk8SJ+dea9ql3iUp7nmL2o32LfYFRJ+LTFLzIc1X5NWkuVf+9bfb+nl/RQQwhIXaLlPFifLMl+iSVhKAs5wefMPnxFmMrrjtpg9YNLjMvCXIBMmoyoAU1SSIc9lzj7xl X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(232431446821674); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(3002001)(93006095)(93004095)(3231311)(944501410)(52105095)(10201501046)(6055026)(149027)(150027)(6041310)(20161123562045)(20161123558120)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(201708071742011)(7699050);SRVR:CY4PR03MB3127;BCL:0;PCL:0;RULEID:;SRVR:CY4PR03MB3127; X-Microsoft-Exchange-Diagnostics: 1;CY4PR03MB3127;4:LnwE1kiWwcO30PzhZcxTBLP1cYV8A8xJ6799j8gnnuGwCKaX1vtrXRN9w7G8uuuSM1YmY/58CpSXmRbR77dAKRH27vqQA0XSbcSiioD5qRU31/h+gr4R2eNhAqKSCM/tz4+csbUrNVijhp3tuGZPSLJ+kLUoo4w1yoMSEYuF9FnDDD94+426xNcgC/8D8CYggvXJrVPme5QBHd+We6aXR3hNszxduekKhX9dN9V6XoTDXjg+HRuzrD/u/bDMxfolLxvJ+FvLCD6aM/ud8mNwjq6w4QBA7rkcoJH5HfYT5qAcHhS2zp5k9gTfSlwktcBq X-Forefront-PRVS: 07943272E1 X-Microsoft-Exchange-Diagnostics: 1;CY4PR03MB3127;23:xPa9oC1c3dITRWwMTSjbBlPRn4C9wsfVyW1CrDYdi061Aa5/3WaHsUOQ3paBxpcSyWV2vksKrZ1AxAfi8pklANnAQRLstYp8fTwO+6B1+3gnKrN5EPVJW/NgKFLt5E1bYYZrHnOn4oTUT25sSb7ph2D/jQrErlhTSIjBLLbd0WSn6quuqLrFQZRFu5C05W9jmwiQLTJfgc141AC2UxQ+XxT6nUvixG0V0k1lIaQRPbGHsnPQDTUNs+Kg092L0/dUiDUdHg2RrzheQeuNIDD/Y9wNxdAbEucJkIcufjZnjrnurvO+C6ArrM8JsFW8ADBgBMFzEOteL8RKQpm/LN24cReI4mVnnx7uPsc3u4AOqoKUESkgwZxsGG4TtQxSaqKFcaJ1WhKvSh8twkjVCwgSOSZjo1n3c8yYq965Li4dIpi8MPtyG6FX9NuOxcAaHNwLJFxsOFv7xLQWaWhLnFzBdjE1BmKTQ3DU/8ZK2ZBHefcUiwUuIts5Tegv81SqHd+Cquwz+N+aNL0mCW5J2GNyw3tEbMBVp6y0+Y5vdS8ZEKnPqsrteVA4yIrlB0mPLd8qBcP/5INmv5s5kO/VSDL28y0bb0V6Y/ju/l7E4J54vc9HBa3pzdLhdKoxu46Q5Tk3mDdExCdtSALLzRTpZZ0EH/rDerx6ad5t1F/5/o6rOBbZ6VR7zGFMOttRXumQPVnilIVb9T1xUTdoJP8P1JmJUWdUUaE+C4GzGCWFLtVnhpwEwZBsp4SIh+i0sqKG2JlJMDT0qH6SVVc/tdmf4wycYAV+QX3y7By48oTJXi+4hBN7mJ792VfoUSVVi8c65je4PXhBOQGiVy4Nir5bBWnEeFiGmYa1+6jlj3IKOHm/jXjMUwMK2X6O7o1bN1wF3CfZxu2jnM0AaNGhLrX5x3BWTTkGvz0NC74LVD6//2lXhe2oErfLX+d4COePxxUmxxL9+vVPSsQZ5CBONHEqe/yJ8DNz7bLpH3tL8JweJwx/fzt+QflHTdJ0j9ngncLWb3yGw2MqXwyquY6zxDAI14hgcrQ5Se9WKk3NzgRPF4imC2+Zpfw3jNI91XIK43S9rwSfwN5ckn0UKCQP2kjAhUGHJm72n9qIhlZ2qQ4d+d9pHGJbO53ULIGdTZ7JdLGQNH6uE5n0k0QAX2k18C1UnbBNwg== X-Microsoft-Antispam-Message-Info: KQFs3Oo2SWpxIZhdICBCRJL7W28ysSEwiNCpQQ6u8qyCkMHEBow8Fvn+QvxX0uFQXIVDuV6h9G/YYuNyCI4/AoxNlp+CdVhC6qP5ODGP6u14Rs4uydHYGukiwBgnpoN4BG2oAcpffn8FpkZbjv9hVr6WF2yFpfqXEISh3S31DDVPD7Vni+CjQJaO1Egt8P+gsPOwBwcC2Brk/OeonZdepPDi/HsNesnH3DoXH8BlEhK2E+MsAFXQowfeyoxwEY6e9c8BVT+NA2PPYDYkgdqPyQaRp9X0c2Rt0J2EZcBmlJMXfmJLyFznrtFWYmCOaAixO3Dy0L7weyEiq4CxiaheVx4w6SO+wzlCzhKT1XJFoQQ= X-Microsoft-Exchange-Diagnostics: 1;CY4PR03MB3127;6:H+hYRIpIj9m7T2f3QorTh9VwRvyQW0e+r0lzgo4FCihXWSlxL1NaOOtKmdfV0k0cIoAUCJN59uTCw3M6dCEzHedr5cjRyE2nbBv2ctB6tmGqfoinktVzftBFmPYqJQp5+WhQrCCxXyjAtsis4HmA+jSuBPbAEvAs80N7eM4tac06uNYmudIWRteuzJ5k1Cl8XG+6xBFpbfdUXQ6olCuQwXmeQINbh0zC7taHGSCRJzX+goxn4Ml7JAmrzTbFDxOBlenTla4F5MZAfhPz/10xvXmBkxwxpkVYcx+4wnknspZsdYLhUcYBGC43a++jgPP1Y+qhug9UhZYyuR8h+GGIc4gLVEqreeLhWHG7vfDFoBitg6zJ9MWbA4JwBvHRSlDAQP818NIHGLcwTAJ6zwQoIZPWwGCcMxeg2H64jiEkrHV4R2wCgqRbb8URtux6vw0fdOO6hUp8rgMtEhKOeaklMQ==;5:xYz8UlXS5/fMwJm6AeRjFRr3YpWGDH0UxuaSOwv6NtOh8PVJ9spDkLFziRyBSu3d6daPPGLEZO4iZNE9Me0n66bi9eMng5wwmDWJ455lOmZwdn7OcX/HysPkKwACyhwF0KcjV9R32ifTBfAwlPBBVfG2MmEmImYqE5Q3tIQhy7g=;7:n0169nKfzXKkj+Zzp0egEwSRDklBkbJ+VDW/LgrnwJqBBTYHQXH71TZKdvkRZAkliJWmUQqiyuBxeL5Bs1MT4B0u7F4hLO6U1Dux9FlUiXHvGqpKfbxuWMJHLdW3seTijKF6r7q8BzqsIvSaTfMpo8jMQpvhctQdvxd08pF0fHj40A98f0UFxnN03RIYiqLOU95j/RQTl/q9hyEu+KrwSvY09M0SzHoUB/P/l5n0nnICHUlvhO/58KugnH3nOd3l SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: analog.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Sep 2018 11:07:49.7412 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: ad64cb05-afdc-44fa-ba1f-08d6196924c2 X-MS-Exchange-CrossTenant-Id: eaa689b4-8f87-40e0-9c6f-7228de4d754a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=eaa689b4-8f87-40e0-9c6f-7228de4d754a;Ip=[137.71.25.55];Helo=[nwd2mta1.analog.com] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR03MB3127 Sender: linux-iio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The current structs are only partially documented via annotations. This change updates annotations for all structs in the ad7606.h file. Signed-off-by: Alexandru Ardelean --- drivers/staging/iio/adc/ad7606.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/drivers/staging/iio/adc/ad7606.h b/drivers/staging/iio/adc/ad7606.h index 4983e3aa6b0e..f422296354c9 100644 --- a/drivers/staging/iio/adc/ad7606.h +++ b/drivers/staging/iio/adc/ad7606.h @@ -24,7 +24,26 @@ struct ad7606_chip_info { /** * struct ad7606_state - driver instance specific data + * @dev pointer to kernel device + * @chip_info entry in the table of chips that describes this device + * @reg regulator info for the the power supply of the device + * @poll_work struct info for reading data in buffer mode + * @wq_data_avail wait queue struct for buffer mode + * @bops bus operations (SPI or parallel) + * @range voltage range selection, selects which scale to apply + * @oversampling oversampling selection + * @done marks whether reading data is done + * @base_address address from where to read data in parallel operation * @lock protect sensor state + * @gpio_convst GPIO descriptor for conversion start signal (CONVST) + * @gpio_reset GPIO descriptor for device hard-reset + * @gpio_range GPIO descriptor for range selection + * @gpio_standby GPIO descriptor for stand-by signal (STBY), + * controls power-down mode of device + * @gpio_frstdata GPIO descriptor for reading from device when data + * is being read on the first channel + * @gpio_os GPIO descriptors to control oversampling on the device + * @data buffer for reading data from the device */ struct ad7606_state { @@ -55,6 +74,10 @@ struct ad7606_state { unsigned short data[12] ____cacheline_aligned; }; +/** + * struct ad7606_bus_ops - driver bus operations + * @read_block function pointer for reading blocks of data + */ struct ad7606_bus_ops { /* more methods added in future? */ int (*read_block)(struct device *dev, int num, void *data);