From patchwork Thu Mar 13 01:15:44 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Lechner X-Patchwork-Id: 14014106 Received: from mail-oo1-f52.google.com (mail-oo1-f52.google.com [209.85.161.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6DF9B17CA1B for ; Thu, 13 Mar 2025 01:16:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.161.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741828587; cv=none; b=mv/K5irz2ikrawJ97rIFFD2XWNfSd4q4bGQokOL9UjETU8P3VblljCGyK6EP455H1E4Bhd1C5w5+dOONN2CIGseoiuIOTrBr9J9Yd76OLUJBGlWU9ATjWxtLi2ufu5JBMtNntQz6DN+CFIZUszzCIZnnlS3oVzFQQfUgSODMc+4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1741828587; c=relaxed/simple; bh=G6T/2KDF4C5JsW8WYTxDGIcsK077JHDl513PdKR03Zs=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=D4/9gLTVz/RqskVPymix/+dzSUY16D3Jmk133TuNcq6O+RD+omAcDWyfOBI1grhJ2Yp+9cvPv+Gshm6xYLaY/iGbwF0eCIUQqFBMO6ojcV3eXtL9/ZB/Lsw95O7JU7rJ5ILPgUhHPtLgxoSqVISpe+FvUqaV5p8NXSNjCJKrFQY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com; spf=pass smtp.mailfrom=baylibre.com; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b=ssBCQ26N; arc=none smtp.client-ip=209.85.161.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=baylibre.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b="ssBCQ26N" Received: by mail-oo1-f52.google.com with SMTP id 006d021491bc7-5fc447b03f2so96285eaf.0 for ; Wed, 12 Mar 2025 18:16:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1741828584; x=1742433384; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=vqKSGn1O/86vBug4de9CRWQ48RhJd0oISYiM5GUaq+8=; b=ssBCQ26Nc0hQaHiJlO/z4uVuuBE78mMbY+leGhaTqCvKxV0bHC1AwVPtv5Xa+9u7f4 6Or8VyBdgeT3T8Tj6mO+em157qp+/GNAU4AGGTjyGk00sSrYHeU4k+fTapdj7M/8rdAp O3YZCVTsnWyYU3NWXySyReBbJiIT5AYX8uI/mBpgpaZ8yKaJb1Uww76DRMbjwXyPMDDJ DfNOLG4EOaFA2mzxz8DH9u0z0JIQDNuk/+fKInUJ0OQ43FXEqahXUg94tZixS/dMaqZz 3QjgA3gi/X0/J0uF6GI0J05Mn/GoSAnTfrqdYX4rDf0bwggwudYaZ58C66xcFM/qtI9r 6Iog== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1741828584; x=1742433384; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=vqKSGn1O/86vBug4de9CRWQ48RhJd0oISYiM5GUaq+8=; b=ujNuUNRCi0p2DUAVoyZ5792oCHihMHqB7a47GQP/1Txrg+WV1IpdwBGJvIdOhqEiR7 TYTcIe9CYwl15u/V6vTPGfI+Okze+So6PDuW2KFzupczDzYcYARaFxnOgrIvPUt5AG61 ya3QQpyipdQwrJhdLskht/f9qC9OEikXnVtuW2qfXCJrhMRJCUstDXBRxLRplgaxCxXq HRMl4iRF/GLYoOLygP4BGEnQI1fOOEx1g4HmVTeQ9BJPuyODoZngxHl5KV/w98ZezoDW vuA/eWwgOfIIfxchj9XxdOhSlBplMQMa8WrfpNvo/xDWjg6gQ1OenDlu8g0rtlcgMYFy OPLA== X-Forwarded-Encrypted: i=1; AJvYcCVEKXi2mqQcVU3w4j8ViAo+LdXD5xV2r1oqfVDMQEUqKADQxN/vCe4RL/5rbIDzuP7wTQ0uo2AAZVk=@vger.kernel.org X-Gm-Message-State: AOJu0Yxz9+Ym6kElExFSvzSAFEj5kfxSxoWFCj4Pn+Y3AKPb1BeUmHBF +1xgkdFIDxDe79gJJ9P/2TaqzaOmO6eB1Q1wvm4v0iF7r+YeWFJy+4eb/s7OCs9O6l4+d3/p16x ssOg= X-Gm-Gg: ASbGncvJIgH4nJWC7jVwRJ4sBZPEEZY8BYzd6zScvbRMm/bykOn+UXpb4yfGcc25530 WCm0yRHpEwfVYjxlFZUGoS8vVbJRJgaDfy9Lh7K2z+2fLBbC7shQyG2xAv+NjqzBnGyQ/uaMvjQ xBIEtu1JZ/S2tTPnEefeKeVpqOGI8YrMJDljiRexGuBFj1CT8i9smS/9njPe0PS567506b/68ba ua1ssUK1X1RHMQ7wvq95pYDA94TrJEg+HAx+phoMEG9I1hcUFgtQCK+0d2IK+EDxg7uC/6chVEL R9669VhU2o42RMAXWpZmOvvDb1G/HbC7PCWnhPMWk9Ns9gGlOsYdRk6yhkzo/c3iycQeScdIdfG rs5sKn7RO6gg= X-Google-Smtp-Source: AGHT+IFn+Gu4WaglzOvc/w350Ccu55y0spz2nKJMrLuphFNAedL18lQyKziTYY0RnAUjpY2+hWiHUg== X-Received: by 2002:a4a:ec46:0:b0:601:bf4d:86e6 with SMTP id 006d021491bc7-601bf4d88d1mr5787314eaf.1.1741828584549; Wed, 12 Mar 2025 18:16:24 -0700 (PDT) Received: from [127.0.1.1] (ip98-183-112-25.ok.ok.cox.net. [98.183.112.25]) by smtp.gmail.com with ESMTPSA id 006d021491bc7-601db659ad8sm39865eaf.8.2025.03.12.18.16.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Mar 2025 18:16:23 -0700 (PDT) From: David Lechner Date: Wed, 12 Mar 2025 20:15:44 -0500 Subject: [PATCH 06/11] iio: adc: ad7606: fix kernel-doc comments Precedence: bulk X-Mailing-List: linux-iio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20250312-iio-adc-ad7606-improvements-v1-6-d1ec04847aea@baylibre.com> References: <20250312-iio-adc-ad7606-improvements-v1-0-d1ec04847aea@baylibre.com> In-Reply-To: <20250312-iio-adc-ad7606-improvements-v1-0-d1ec04847aea@baylibre.com> To: Jonathan Cameron , linux-iio@vger.kernel.org Cc: Michael Hennerich , Angelo Dureghello , Alexandru Ardelean , Beniamin Bia , Stefan Popa , linux-kernel@vger.kernel.org, David Lechner X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=7781; i=dlechner@baylibre.com; h=from:subject:message-id; bh=G6T/2KDF4C5JsW8WYTxDGIcsK077JHDl513PdKR03Zs=; b=owEBgwJ8/ZANAwAKAR+K+IyC93wDAcsmYgBn0jHbIlTN9NpWATQrGaRPKhfK7x4ZDeRxfGXTW +l8VL0aqNOJAkkEAAEKADMWIQSKc9gqah9QmQfzc4gfiviMgvd8AwUCZ9Ix2xUcZGF2aWRAbGVj aG5vbG9neS5jb20ACgkQH4r4jIL3fAOg1hAAkJ4wWePRT0ryxssBC1FBgRQaSo+RSKtGWSTPxO7 iSrSvH+3+TqfJNQ1MHeeDCY/5v1tUxDYlcEUZPfFsHdsunYUFUgcPhETm9qsTjJB/11eTZNXKoe GtrEa1WM6xtT6rXAD4Yq1/cQpHruvq1WHACRH2M5n1TUpjzDNDwms+Tlphb7aIYDvBWewM9HW0V xb0rXtMAliIhDdb5627WsOO57wzwVn8UQrXr4LF5YxHCPII9HtsmD6mvlhl5EjI3wYsNmHQdS6a DmL8sePfnqGgFmiBalVdTScGZDVXwPEVUVF7s5ODUVp+r41JG/qXylrlhsWLNW+2xvZXRd98QTD Gsd1WJxtLmrzZelk9AsavwpKVk+1SbYITaKyrQeuk8fYCyuGgiTelPZPkPj1wna93hWPJ7a/qlt r5UfwEz4wzWSJVVmIj1eMKtXcQfV36izGNkxIvod8EFNmKbzJjRmrBZkdYueClhmWe22A9pDaKG fzza7PvpeAoz1VaqyTFZwZCnYeWfwDsutZOMbKGjXin9yigJd4aBdtV1/e4gSiNu4p3nC+lMmkx P0cXw7XW85ZBPI8EErEaeMKAyotpi2i2z99ltexlQxH2hFxYfoz2qbYWnVQb/Sk8GDkfcKVopuy cKxbdlh18FJSIq0nEKLmgLRvxz2+9gVGYlzeoCc5twPk= X-Developer-Key: i=dlechner@baylibre.com; a=openpgp; fpr=8A73D82A6A1F509907F373881F8AF88C82F77C03 Fix several issues with kernel-doc comments in ad7606.h: * Add missing ":" to @param names. * Add some missing parameters. * Remove some non-existent parameters. * Fix alignment and wrapping. * Fix some spelling. `./scripts/kernel-doc -v -none drivers/iio/adc/ad7606*` is happy now. Signed-off-by: David Lechner --- drivers/iio/adc/ad7606.h | 90 ++++++++++++++++++++++++------------------------ 1 file changed, 45 insertions(+), 45 deletions(-) diff --git a/drivers/iio/adc/ad7606.h b/drivers/iio/adc/ad7606.h index 71a30525eaab512fa811f28fa79268a1a976bc8c..3da78488c8a247dccbff930023f98717d540081a 100644 --- a/drivers/iio/adc/ad7606.h +++ b/drivers/iio/adc/ad7606.h @@ -120,17 +120,17 @@ typedef int (*ad7606_sw_setup_cb_t)(struct iio_dev *indio_dev); /** * struct ad7606_chip_info - chip specific information * @channels: channel specification - * @max_samplerate: maximum supported samplerate - * @name device name + * @max_samplerate: maximum supported sample rate + * @name: device name * @num_channels: number of channels - * @num_adc_channels the number of channels the ADC actually inputs. + * @num_adc_channels: the number of channels the ADC actually inputs. * @scale_setup_cb: callback to setup the scales for each channel * @sw_setup_cb: callback to setup the software mode if available. - * @oversampling_avail pointer to the array which stores the available + * @oversampling_avail: pointer to the array which stores the available * oversampling ratios. - * @oversampling_num number of elements stored in oversampling_avail array - * @os_req_reset some devices require a reset to update oversampling - * @init_delay_ms required delay in milliseconds for initialization + * @oversampling_num: number of elements stored in oversampling_avail array + * @os_req_reset: some devices require a reset to update oversampling + * @init_delay_ms: required delay in milliseconds for initialization * after a restart */ struct ad7606_chip_info { @@ -149,10 +149,10 @@ struct ad7606_chip_info { /** * struct ad7606_chan_scale - channel scale configuration - * @scale_avail pointer to the array which stores the available scales - * @num_scales number of elements stored in the scale_avail array - * @range voltage range selection, selects which scale to apply - * @reg_offset offset for the register value, to be applied when + * @scale_avail: pointer to the array which stores the available scales + * @num_scales: number of elements stored in the scale_avail array + * @range: voltage range selection, selects which scale to apply + * @reg_offset: offset for the register value, to be applied when * writing the value of 'range' to the register value */ struct ad7606_chan_scale { @@ -165,32 +165,33 @@ struct ad7606_chan_scale { /** * struct ad7606_state - driver instance specific data - * @dev pointer to kernel device - * @chip_info entry in the table of chips that describes this device - * @bops bus operations (SPI or parallel) - * @chan_scales scale configuration for channels - * @oversampling oversampling selection - * @cnvst_pwm pointer to the PWM device connected to the cnvst pin - * @base_address address from where to read data in parallel operation - * @sw_mode_en software mode enabled - * @oversampling_avail pointer to the array which stores the available + * @dev: pointer to kernel device + * @chip_info: entry in the table of chips that describes this device + * @bops: bus operations (SPI or parallel) + * @chan_scales: scale configuration for channels + * @oversampling: oversampling selection + * @cnvst_pwm: pointer to the PWM device connected to the cnvst pin + * @base_address: address from where to read data in parallel operation + * @sw_mode_en: software mode enabled + * @oversampling_avail: pointer to the array which stores the available * oversampling ratios. - * @num_os_ratios number of elements stored in oversampling_avail array - * @write_scale pointer to the function which writes the scale - * @write_os pointer to the function which writes the os - * @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), + * @num_os_ratios: number of elements stored in oversampling_avail array + * @back: pointer to the iio_backend structure, if used + * @write_scale: pointer to the function which writes the scale + * @write_os: pointer to the function which writes the os + * @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 + * @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 - * @complete completion to indicate end of conversion - * @trig The IIO trigger associated with the device. - * @data buffer for reading data from the device - * @d16 be16 buffer for reading data from the device + * @gpio_os: GPIO descriptors to control oversampling on the device + * @trig: The IIO trigger associated with the device. + * @completion: completion to indicate end of conversion + * @data: buffer for reading data from the device + * @d16: be16 buffer for reading data from the device */ struct ad7606_state { struct device *dev; @@ -232,17 +233,16 @@ struct ad7606_state { /** * struct ad7606_bus_ops - driver bus operations - * @iio_backend_config function pointer for configuring the iio_backend for + * @iio_backend_config: function pointer for configuring the iio_backend for * the compatibles that use it - * @read_block function pointer for reading blocks of data + * @read_block: function pointer for reading blocks of data * @sw_mode_config: pointer to a function which configured the device * for software mode - * @reg_read function pointer for reading spi register - * @reg_write function pointer for writing spi register - * @write_mask function pointer for write spi register with mask - * @update_scan_mode function pointer for handling the calls to iio_info's update_scan - * mode when enabling/disabling channels. - * @rd_wr_cmd pointer to the function which calculates the spi address + * @reg_read: function pointer for reading spi register + * @reg_write: function pointer for writing spi register + * @update_scan_mode: function pointer for handling the calls to iio_info's + * update_scan mode when enabling/disabling channels. + * @rd_wr_cmd: pointer to the function which calculates the spi address */ struct ad7606_bus_ops { /* more methods added in future? */ @@ -258,9 +258,9 @@ struct ad7606_bus_ops { }; /** - * struct ad7606_bus_info - agregate ad7606_chip_info and ad7606_bus_ops - * @chip_info entry in the table of chips that describes this device - * @bops bus operations (SPI or parallel) + * struct ad7606_bus_info - aggregate ad7606_chip_info and ad7606_bus_ops + * @chip_info: entry in the table of chips that describes this device + * @bops: bus operations (SPI or parallel) */ struct ad7606_bus_info { const struct ad7606_chip_info *chip_info;