From patchwork Wed Jul 15 15:06:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11665723 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id AA80F138C for ; Wed, 15 Jul 2020 15:10:40 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 824D920658 for ; Wed, 15 Jul 2020 15:10:40 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="hSLpwt8Z"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="rtO/R+gF" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 824D920658 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=rGE/Cw6cw5X/vlG8eqBR8aY7eqb0UlKXqauNa0Y7zh0=; b=hSLpwt8Zu2uj8ffq8t3SAQXwF dHv8BsxvvKfhrnwFd76N5vNpwV+XqirJnZxv9aoSFkkjNr3pHscZnR6r33JWwnHePZpEbJ/n/i+IF VYZ+OA7oT8uZT4ncwx/YqN29Jka6ysyv85yhSxkF9LOZLqjfLV64L6NZkb9BwJraVrdX1j7W4vw06 LurSIQdklgRpghwqkdUhQZxWzyNq61wsm0NPfozQCc2L8UIhLrIyFs/+WGhHMNbZFegUIgQDwmvIa YQGJaPr+6Bsu7eJ0wTWF645kpNLcaxCCtI0tfVjJABNby3Y0s5X9FXOCvaUzxsbvxv7vDBzfqn1wa GZhIAF02w==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvj14-00073P-Ot; Wed, 15 Jul 2020 15:08:14 +0000 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jvize-0006Vh-BY for linux-arm-kernel@lists.infradead.org; Wed, 15 Jul 2020 15:06:49 +0000 Received: by mail-wr1-x443.google.com with SMTP id q5so3075977wru.6 for ; Wed, 15 Jul 2020 08:06:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=bjh7OhojJcRmD5KkKwacJpyMf8L6Fg+f9kXKvvMc3JQ=; b=rtO/R+gF9zsxdsObRHLZjii928eu9P6U4fV47qT04PDZqfN1Aq+9wmYpIrjcPldh7T yP1DLy0eimKSKjz+BYeWPwFsrz3w33TZgBqvD+zngaL580tLU7cwgnteXFXEa2cVb63a C3hCJVfmWgf8lgOF6706sYiBVu2V51RlGIqpapFdC5++3X0ambcY9JvZQCYe85kYOmw7 bSpz8d0j/QI47062tJVsowpUDTU7eNVnWs3lPdNm2HUsKNOkvlscGCVf3IgWF57B7ma/ SicBianzkJtzdwiwzI2qiNr5ecy2Jif9S6uDJm1um/jUNYgDmdZ52yFNt5ixduLTT+cK f0qg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=bjh7OhojJcRmD5KkKwacJpyMf8L6Fg+f9kXKvvMc3JQ=; b=YjqsponH6AWeluljbWEgEeJ5p2M7ZtX3btWZLHQqeoSJzbZiQTHgsYQ1vFLT8QCgIj nWVYtJ0akge1cN/a3HyvkHW4J/SCo4mzNVU5BL6sfjyb1La2H3nt4R8/2jg3Xuos5iO+ HZJ/BoHv+4i1mQwZIDfW4vusNstTwNLOTiGsg/vu7rZwX9oaO1lqLIyMi4z1IzJ1WwBl XmLF+Ot+yQIKETP0xKIg+5L473VZM8r+V795KOl4FfbkXi1+VzCshampNilW06Gt9b19 PTzHWfy6GaCvzauD+f+6BTUMReXO4P6AzwBnujLOkR6GhRT0SHNG/9EDX/f4i/nvN9bJ Au/w== X-Gm-Message-State: AOAM532u9sOnjYypKpUpwL5M4fTvws/z5dqYmM/slo8uLYvPWBJ7jt4e C2YD5xpPGM5zjyI/Ni6sP42NPg== X-Google-Smtp-Source: ABdhPJz/qORqv4SB3JCQPZLx2YoBeuFRtlxnr/5oEScOZOZu+WtAdMW0hpudATx8mM94Ld2/ZEFr8w== X-Received: by 2002:adf:fa10:: with SMTP id m16mr7456479wrr.134.1594825605304; Wed, 15 Jul 2020 08:06:45 -0700 (PDT) Received: from localhost.localdomain ([2.31.163.61]) by smtp.gmail.com with ESMTPSA id w2sm3906140wrs.77.2020.07.15.08.06.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Jul 2020 08:06:44 -0700 (PDT) From: Lee Jones To: broonie@kernel.org Subject: [PATCH 08/14] spi: spi-pl022: Provide missing struct attribute/function param docs Date: Wed, 15 Jul 2020 16:06:26 +0100 Message-Id: <20200715150632.409077-9-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200715150632.409077-1-lee.jones@linaro.org> References: <20200715150632.409077-1-lee.jones@linaro.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200715_110646_495684_593DCA2D X-CRM114-Status: GOOD ( 14.49 ) X-Spam-Score: -0.2 (/) X-Spam-Report: SpamAssassin version 3.4.4 on merlin.infradead.org summary: Content analysis details: (-0.2 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:443 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Linus Walleij , linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, Sachin Verma , Lee Jones , linux-arm-kernel@lists.infradead.org Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org Also demote non-worthy kerneldoc headers to standard comment blocks. Fixes the following W=1 kernel build warning(s): drivers/spi/spi-pl022.c:304: warning: cannot understand function prototype: 'enum ssp_writing ' drivers/spi/spi-pl022.c:330: warning: Function parameter or member 'loopback' not described in 'vendor_data' drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'rx_lev_trig' not described in 'pl022' drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'tx_lev_trig' not described in 'pl022' drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'dma_running' not described in 'pl022' drivers/spi/spi-pl022.c:670: warning: Function parameter or member 'pl022' not described in 'readwriter' drivers/spi/spi-pl022.c:1250: warning: Function parameter or member 'irq' not described in 'pl022_interrupt_handler' drivers/spi/spi-pl022.c:1250: warning: Function parameter or member 'dev_id' not described in 'pl022_interrupt_handler' drivers/spi/spi-pl022.c:1343: warning: Function parameter or member 'pl022' not described in 'set_up_next_transfer' drivers/spi/spi-pl022.c:1343: warning: Function parameter or member 'transfer' not described in 'set_up_next_transfer' Cc: Linus Walleij Cc: Sachin Verma Signed-off-by: Lee Jones Acked-by: Linus Walleij --- drivers/spi/spi-pl022.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/drivers/spi/spi-pl022.c b/drivers/spi/spi-pl022.c index 66028ebbc336d..d1776fea287e5 100644 --- a/drivers/spi/spi-pl022.c +++ b/drivers/spi/spi-pl022.c @@ -298,7 +298,7 @@ enum ssp_reading { READING_U32 }; -/** +/* * The type of writing going on on this chip */ enum ssp_writing { @@ -317,6 +317,7 @@ enum ssp_writing { * @extended_cr: 32 bit wide control register 0 with extra * features and extra features in CR1 as found in the ST variants * @pl023: supports a subset of the ST extensions called "PL023" + * @loopback: supports loopback mode * @internal_cs_ctrl: supports chip select control register */ struct vendor_data { @@ -353,11 +354,14 @@ struct vendor_data { * @read: the type of read currently going on * @write: the type of write currently going on * @exp_fifo_level: expected FIFO level + * @rx_lev_trig: receive FIFO watermark level which triggers IRQ + * @tx_lev_trig: transmit FIFO watermark level which triggers IRQ * @dma_rx_channel: optional channel for RX DMA * @dma_tx_channel: optional channel for TX DMA * @sgt_rx: scattertable for the RX transfer * @sgt_tx: scattertable for the TX transfer * @dummypage: a dummy page used for driving data on the bus with DMA + * @dma_running: indicates whether DMA is in operation * @cur_cs: current chip select (gpio) * @chipselects: list of chipselects (gpios) */ @@ -662,7 +666,7 @@ static void load_ssp_default_config(struct pl022 *pl022) writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase)); } -/** +/* * This will write to TX and read from RX according to the parameters * set in pl022. */ @@ -1237,6 +1241,8 @@ static inline void pl022_dma_remove(struct pl022 *pl022) /** * pl022_interrupt_handler - Interrupt handler for SSP controller + * @irq: IRQ number + * @dev_id: Local device data * * This function handles interrupts generated for an interrupt based transfer. * If a receive overrun (ROR) interrupt is there then we disable SSP, flag the @@ -1334,7 +1340,7 @@ static irqreturn_t pl022_interrupt_handler(int irq, void *dev_id) return IRQ_HANDLED; } -/** +/* * This sets up the pointers to memory for the next message to * send out on the SPI bus. */