From patchwork Wed Jun 8 15:33:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Jander X-Patchwork-Id: 581100 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 53DE3C43334 for ; Wed, 8 Jun 2022 15:33:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S243922AbiFHPdt (ORCPT ); Wed, 8 Jun 2022 11:33:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59826 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S244439AbiFHPdp (ORCPT ); Wed, 8 Jun 2022 11:33:45 -0400 Received: from smtp15.bhosted.nl (smtp15.bhosted.nl [IPv6:2a02:9e0:8000::26]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E916D260F for ; Wed, 8 Jun 2022 08:33:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonic.nl; s=202111; h=content-transfer-encoding:mime-version:message-id:date:subject:cc:to:from: from; bh=sgOi0wZt64PvzV9T5wbU6JWnzoPTwGt8hGmYzxvQxks=; b=XhApxaLiOKxmY7hz7GCGsdSFSBwfcy172V0MF8dc3NEUeoWVLgLHjCsguV4DEXCaSRcf/E1VadzjN qGknx8qlia51glFKSXpDO2rRf3KY+uij7yYXwDptqaWRL9ZxJFZPDhJxT6eeCDTOtBob6Lwfu0Aco8 c6MB3JV2S7dXkDh8j6NrR7/SvQPutEIo1lCk8L+bObgEE2m0mRSqucQC3p4CRXY/AIf8XFQLzq3E0b MbRznsiP9w+F2VFRZ/dAVDqRNQxIv25kVwS1WWzfWs94A93FADRvpF6Ts6/oqUKp7fsmF1o2SHaeU0 VrCZM+z9UyBhWL/KFIWkCUeoqGtzVrQ== X-MSG-ID: 5f31577c-e740-11ec-b450-0050569d3a82 From: David Jander To: Mark Brown Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org, Linux Next Mailing List , Stephen Rothwell , Andy Shevchenko , David Jander Subject: [PATCH v2] spi: : Add missing documentation for struct members Date: Wed, 8 Jun 2022 17:33:09 +0200 Message-Id: <20220608153309.2899565-1-david@protonic.nl> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.org Fixes these "make htmldocs" warnings: include/linux/spi/spi.h:82: warning: Function parameter or member 'syncp' not described in 'spi_statistics' include/linux/spi/spi.h:213: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_device' include/linux/spi/spi.h:676: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_controller' Fixes: 6598b91b5ac3 ("spi: spi.c: Convert statistics to per-cpu u64_stats_t") Reported-by: Stephen Rothwell Signed-off-by: David Jander --- v2: - Correct patch subject line style - Add the text of the actual warnings that are being fixed - Add a Fixes: tag --- include/linux/spi/spi.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h index eac8d3caf954..2e63b4935deb 100644 --- a/include/linux/spi/spi.h +++ b/include/linux/spi/spi.h @@ -35,7 +35,8 @@ extern struct bus_type spi_bus_type; /** * struct spi_statistics - statistics for spi transfers - * @lock: lock protecting this structure + * @syncp: seqcount to protect members in this struct for per-cpu udate + * on 32-bit systems * * @messages: number of spi-messages handled * @transfers: number of spi_transfers handled @@ -155,7 +156,7 @@ extern int spi_delay_exec(struct spi_delay *_delay, struct spi_transfer *xfer); * @cs_inactive: delay to be introduced by the controller after CS is * deasserted. If @cs_change_delay is used from @spi_transfer, then the * two delays will be added up. - * @statistics: statistics for the spi_device + * @pcpu_statistics: statistics for the spi_device * * A @spi_device is used to interchange data between an SPI slave * (usually a discrete chip) and CPU memory. @@ -439,7 +440,7 @@ extern struct spi_device *spi_new_ancillary_device(struct spi_device *spi, u8 ch * @max_native_cs: When cs_gpiods is used, and this field is filled in, * spi_register_controller() will validate all native CS (including the * unused native CS) against this value. - * @statistics: statistics for the spi_controller + * @pcpu_statistics: statistics for the spi_controller * @dma_tx: DMA transmit channel * @dma_rx: DMA receive channel * @dummy_rx: dummy receive buffer for full-duplex devices