From patchwork Tue Sep 18 12:15:03 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandru Ardelean X-Patchwork-Id: 10604267 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 7D782161F for ; Tue, 18 Sep 2018 12:15:25 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6BAC52A5A2 for ; Tue, 18 Sep 2018 12:15:25 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5FF7D2A7B2; Tue, 18 Sep 2018 12:15:25 +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 AD04B2A5A2 for ; Tue, 18 Sep 2018 12:15:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729397AbeIRRrn (ORCPT ); Tue, 18 Sep 2018 13:47:43 -0400 Received: from mail-eopbgr680071.outbound.protection.outlook.com ([40.107.68.71]:45312 "EHLO NAM04-BN3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726812AbeIRRrn (ORCPT ); Tue, 18 Sep 2018 13:47:43 -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=zdn6oM107GXrypN7I4H+hjZlMYM2P/1jg/YHL4hmC2c=; b=v8YGq2GI0XOTFVclj3itC2qcBAsEJ/DaEkN8Mwic36uT2cXmqh2wau3r5Jci6K+ZTFT1Z/puaQDmrXE82VyVVjZy/SZR9A21D3oxVTXYXStmhISWsT3n6+hmzZXa+CPP+1VoxH8rEimUb+ljzoojyRt1ONl57Cz9Rsd44LaXvEA= Received: from BN3PR03CA0066.namprd03.prod.outlook.com (2a01:111:e400:7a4d::26) by DM5PR03MB3130.namprd03.prod.outlook.com (2603:10b6:4:3c::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1143.17; Tue, 18 Sep 2018 12:15:18 +0000 Received: from BY2FFO11FD016.protection.gbl (2a01:111:f400:7c0c::112) by BN3PR03CA0066.outlook.office365.com (2a01:111:e400:7a4d::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.1143.15 via Frontend Transport; Tue, 18 Sep 2018 12:15:18 +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 BY2FFO11FD016.mail.protection.outlook.com (10.1.14.148) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.1164.13 via Frontend Transport; Tue, 18 Sep 2018 12:15:17 +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 w8ICFHww014685 (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=FAIL); Tue, 18 Sep 2018 05:15:17 -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; Tue, 18 Sep 2018 08:15:17 -0400 Received: from saturn.analog.com ([10.50.1.244]) by zeus.spd.analog.com (8.15.1/8.15.1) with ESMTP id w8ICFAOV003855; Tue, 18 Sep 2018 08:15:11 -0400 From: Alexandru Ardelean To: , , , CC: , , Alexandru Ardelean Subject: [PATCH V2] staging:iio:ad7606: update structs with doc annotations Date: Tue, 18 Sep 2018 15:15:03 +0300 Message-ID: <20180918121503.12651-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)(346002)(376002)(396003)(136003)(2980300002)(438002)(189003)(199004)(356003)(246002)(15650500001)(305945005)(44832011)(336012)(6666003)(86362001)(575784001)(36756003)(2906002)(48376002)(2616005)(106002)(426003)(50466002)(5660300001)(1076002)(2201001)(54906003)(107886003)(110136005)(7636002)(476003)(51416003)(47776003)(478600001)(53416004)(106466001)(8936002)(126002)(26005)(16586007)(77096007)(186003)(8676002)(316002)(486006)(14444005)(50226002)(7696005)(4326008);DIR:OUT;SFP:1101;SCL:1;SRVR:DM5PR03MB3130;H:nwd2mta1.analog.com;FPR:;SPF:Pass;LANG:en;PTR:nwd2mail10.analog.com;MX:1;A:1; X-Microsoft-Exchange-Diagnostics: 1;BY2FFO11FD016;1:CJw1w6ARmbfhswns3mEOJxpZA+T+tVAF2s3nIit1MAufy7I5dX9yb05+4sb0ghXmZ2kotzlfVLjGzjpQ9LNLb5U55TtKD2QHOW7uxuoPZNR0ayGhKK7iHCYxxOXSqmFN X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 7b09979c-dfc3-4a46-8dcb-08d61d6065de X-Microsoft-Antispam: BCL:0;PCL:0;RULEID:(7020095)(4652040)(8989299)(4534165)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(4608076)(2017052603328)(7153060);SRVR:DM5PR03MB3130; X-Microsoft-Exchange-Diagnostics: 1;DM5PR03MB3130;3:qKFvhEi1EhDxRLkgCG72MdoE3jmWwL/9zW2mx4RfRa76I/zThOs9rOnKk02sgrGI80zeOG0Ac2yUJXcJqNcIb9kV7OF038B0c6kvyYpJg2g3Ds5j4KLH7CmWR1OS4FIkKn3y+HUqWCTNXBK0fDvnnYRsPa+dX53czww6UMFROqxzMbY3NGeN7qo7rd/us5Ve8GeRRICA6CwQ8C8fXvlgsfPn27+OKNo6Oul1cGXpVqG+GNtzges2DNhqsUUPbtECGK6XsSSkR35GUMh02SGDPAZiXjvO6IcmuHa7zJUvzgic0ItK+TYZzdtgJgSoJPnUew9ypp3Rd5WnPlhBVbJfeSGWWgr/Ib1kMCqFECOmtNA=;25:x/wmJDwoqFMR4GxdLHCh5RIDEDVRw7dQhd+dcPj4fDE9cVuParFWaM0dfRk4UBK5wUk3lJbwd8J3zXgI8//Q7KeD70b9XD8Urn7csiu6Me4JKX5JvFoUB+C5MWf45k380qO+//P3q5jnxeVXQJfNIcW/Dcd4+UL7xLJfWdxsFoVRBk/ljUIL/RvI5Lnur4C8Z4egyTmu8E0o185ZQD2DDMV+je5+DttKT3/nwdnx93fnxrlXcp84+Tqy5eEDDUqXJBCBulsZg1EYClSzhHgaeB3fdz3gSnVG+SjBij9Ub5ycGxrRpsAlBW5rCQgPoUKmq6jXaeq2+tjT9mIBhMb7lg== X-MS-TrafficTypeDiagnostic: DM5PR03MB3130: X-Microsoft-Exchange-Diagnostics: 1;DM5PR03MB3130;31:Ckhvb8V0jcqxAEK57Hv1LJfb5Q8opVlLHGpVTSzm+sA+nExk3H0MzUegfOfBdgFE94LmlUGWkmiuhfsdPUGE1c/vfeKA7OA+p9mxJkJ9yuYQh/YRhLRRrHGOL0rgwXkyyVRQJpEv6M8CYWpn7GEWw+JUr6VJbLcDVoh9SBSABhNeZzshSPse06L+5UvHaxxDjlKxjByxxNPb4VL8pmXlcs+PT8JiGUW1qMpARpf23pI=;20:I6dkbfcQe4Ef2T9nKjPfcIR52Ho8FTpbRtg6Qnsi/nWBZFEqRPVzl2QmNUyJLiWllg2+PQvzpiD73azgoBZe/2IL1NYx0CP9h4xfa+COIqg6MZEGJxipcO5FlTSh0O1mgjNQch5luy0R1IDGVieQ2/e1a/AA7IWXuep/Rj0KS/Ech6xHW/FvPulcWPAyG7JkddVMSsc52KcQrQnLkNUjE+augcXvaE24qAzxiJsXsltxJp/H+cgS4hRsExkOmUaC4jvswUEgWM4oLFWqB1WCgtfJIsx5QlWfD8IWMYvqa8yJ7gNZw0CoUuGMxpws2VxMYmhpcer3Z6oCx3A8knShpdrpv78ij5eRu4ln1HoybHW17FYCeTFfRw4BGfgAx15fHBncgnfscl+ujmop1RTUXUfLu0VwmT9EL53InAdMwkudcZyznce33cCSz2hRPuSR4L41g/xSt9D3bSQwUOO1L6wF8DK7AP/ZTQ+KfnGMFYj5tSUIoni/AVK0B/10ZuBM 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)(5005006)(8121501046)(3231355)(944501410)(52105095)(93006095)(93004095)(3002001)(10201501046)(6055026)(149027)(150027)(6041310)(20161123562045)(20161123558120)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123560045)(201708071742011)(7699050);SRVR:DM5PR03MB3130;BCL:0;PCL:0;RULEID:;SRVR:DM5PR03MB3130; X-Microsoft-Exchange-Diagnostics: 1;DM5PR03MB3130;4:uaTqMxBSqHyqjE/AjzM1jU00hjkVjGgtoYea9yGr8ys8xgfRdRJKCkkGa3CiefoPegXvCZ12Pr7mya42TmmmTgqcPuebr3X27v7a43TitCjTiaGUjfx1Y/Y+goMf1iE5IWZk67lR3+yvDn5osTxVQ7/7e1jmRNC/1lt4KgoTY2bYQ5lgFmWzd5u1kzVoje4lau4E+Vtp1O3odg4SUDLSMUEkIECiOyI9qjOi2ndMk5A8sinzRsvbCbu/IXGPGjTzhuQI2dFHmy5Bq4GywIlhhWInKRimFVdCwUFmQ7FHedlhlPpsdx0XLHvi3+Lac4B+ X-Forefront-PRVS: 0799B1B2D7 X-Microsoft-Exchange-Diagnostics: 1;DM5PR03MB3130;23:n/PNzP81gaoXzXh1j0y8QScR/8dx6ZX2h3wQ7Bmk9F4oeY7Ksa9a4kz8psngDPgtWdm0yJUWddZi40I3K3BsH9arqJZUKIrc/2rgbQCS4o7pZIPLykZWNLNYMFXVSpPPQLeBgSEctpbdqtSIjSLZZlOED/4nNTipjvGbLtI9WnW5Wlky2PQ/iudFLNMPar738+8XO9ZL1kVbtz93ynKfgOXCHG3JQ8YAJeED/ZFMjfcSkgnC9cA9tYINzW0l1cmzUHTFtCgbYd5fbkL14QjAnzhIyKRDp8K/BgGSi5MlWhe7KBC+Iroh8qdZgu+pT/2KN9diuYaBax/8aovoWizWFReSapB43hFfJseuxQqmnLqnc3GW+HJ/ov2yh+Lw4dBHOc4XOe8zi1u9A3I8tkwV28UZkKQKeLYTrLq00659siDV/goxoozFwZyk+y9BmiIRGhsvet3cgKXp+SrKESLp1IxmI26jr5TJ6HuixrfTgJ1P72cr/NIS9gxy94IOIwB4uAFeOAO9nNqN0ErZgYn3f4Olpvbby1nIJ/IpRjKIYbK2Q4FQazWFxAx3ssXwDuZsBiJqIv7uUZJGq3DQpp0kj583PSvnTJ8x6OYa/Uv52EpdgIOwXuymKGIeOVse5eOeVrnOWLownpDydTLPzASkfYkCk0KksVWMu1xdhJIYQwSaNjQSgk662rvtESfW/uY+0jxG/2dLpbutttBik24szi+EBCKTE4EFZ3JDvLjinYYXMMzLu0NFMcCXmFve7Uph9zH8bbXIrIPMqt5EJY2CKo9Veyyvg/C3BarTJQpFmniP67Pu9n4O59BnGnNiw7wF5uOgvCkbpsBgRDcAg+LjFXX4iIbJT1rbCL3uP0mxX7APPR026nq1pa0onw1X5ubn/XiL5NbQAeLrGMGu2Q3c4OSdnQw8QppMrgy01wHe1Z5QcE/3QvQkX6gPZ84JG0K2eg++1ZnqnH0/2VZYKHoZ260xSHQxS+BISieCwR+Z8Z3zlv58jE/MhPgZhHNYyZkiMh1A+HZs7+VwJSyaGhvvjqIJDZdAjmrlX6NJnQ8ayNBQBR9CJa+9PZZv2jhnwQQfE6FEqX4xzCYFwkupyTU5Gb7TNRyRId2jL7jAv389dRo= X-Microsoft-Antispam-Message-Info: RXlINefCJMswVpPrJgz9NoNE6PbLxe3+11NMO35M5LaaJQ+vWBx7GirfkOpz7ihP7DVPyzTndGoWgr2JhmdpjbobHh/yVLbPz8seozk8ldsA75n0RxdQW1prBtakizuljGNQtOED21oPtK9SX4Hp6JtEGQ5AOPZb9bA5Z9ja0JLU2dGA4jMEDGwg9oDxaGRUo12roslFZOjq07WErtcuKyI/6znXRVoISSpnECyjj0LQ7i+SeSMgxVnyvISg1wRmlbiOaVQZJhAOF4srX/Anz2ewGhJFhntbnodua6EByyKzNqIj4neC7wyObdjuI1eeQTMl2ocZ1Xc5dwY5QiwQTg1FUyqCdepuHeWrnnSAcpg= X-Microsoft-Exchange-Diagnostics: 1;DM5PR03MB3130;6:LuIdSzzIgwQjA2cJulQiF/3vYhIGyn9db4G9to7ooGJVTnSUX6uUmrlMSJvRKX+Vm/AB4tziKNzLYCYdaRsBZ+3GqmqFEWdx9nb/xy5fMqaovoankAa6+HrKSx1ejBPdiv+TWIBsgjI+ImgMUKUNzC54rqslrbwppmel5HGUKtmcOkZh8jXcHGuNVjeWDX2zxeeFvHQcCZAmXVJ+piDEPWn8ljoFWQ2mz7oFd1O2duOXBEJWEx6m/iOOE+NNHJ3MbwVYUq7GUGo+fW8iEx3BzmFXmTd8+6pTYbIhJQQ2rrsqchyQ125knfY//p6qG3CfoHU1IsFyQ06GIgWlxrwNTx2B+w1JxFCf+iktkP97UZsfGxh5sq7CSVL7r/W6pfwz+U+xbcvt3eFzECQUbztQNdtJRdNS7eHrnTnryrOowHN3tTijPPSopoczjxyfOB/rQRjn0Hm/ebd9zgsOtUNduQ==;5:hcy3OXGB5xzvdMjTKeZINndfCCC+QWrdgAxyfW0GQ1cWhNFqBmyZQSkNPXtbAWG5VAMzK2+8IKihEBV2VWCsOSUqB6Fshcz6kWFPxhjT2U5ZG0VRMWN2b/KsZqonftbzyb0/sIpuQl4MSBRS3OCMfN3w6mylbWbSXdllvxVZRPg=;7:PydELlCYQdW0+Hj/zORBbGAMxMaxo+L0ExN5OJGTYAANFL5ddNLgU9cTvWdGwllXauLNtmV9mQhbhPAfjBPjF5AqKJ0xFN6QZb2Z+h8zSzOlvxOK3xMHRnAN6MZ5fbEX0aMlPmofR5GLQOdwegKVBXl7vOOGDnQVf+Z+Ujy7cITR2P6cI1DgACnSnvUHv6kM3h9I/xHny2jNWiso97xebdIqcpQ4PaADwJ6tBfKEQHVrftlnm8ebbmu45TVKnNjV SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: analog.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Sep 2018 12:15:17.9841 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 7b09979c-dfc3-4a46-8dcb-08d61d6065de 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: DM5PR03MB3130 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 | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/drivers/staging/iio/adc/ad7606.h b/drivers/staging/iio/adc/ad7606.h index 4983e3aa6b0e..86188054b60b 100644 --- a/drivers/staging/iio/adc/ad7606.h +++ b/drivers/staging/iio/adc/ad7606.h @@ -24,7 +24,27 @@ struct ad7606_chip_info { /** * struct ad7606_state - driver instance specific data - * @lock protect sensor state + * @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 work struct for continuously reading data from the device + * into an IIO triggered buffer + * @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 from concurrent accesses to GPIOs + * @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 +75,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);