From patchwork Fri Jul 17 13:54:18 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11670413 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 C902113B1 for ; Fri, 17 Jul 2020 13:57:01 +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 9FC2420717 for ; Fri, 17 Jul 2020 13:57:01 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="HMkfzexk"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="Z6e2Az59" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 9FC2420717 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=2ilr6AZFwtDAMwA6WxdwXriTSx1DqMVr5WRszJEFyZc=; b=HMkfzexkNErJLkEB4Dpig+QG0 C9zrF9RgjbLsmJ7XvwbvXdtm5Xrc/WNuvWHMAwrXSwwhN4wj9M8ekYHfligcpVvPhuHs+dilUi3Us etkPKVaTaGcUyRTEzoiiCA6p6XEiVpk8VaNv1mUWOxfzR0Azbj7ZmKL9J2jbQvG/pafNN5tBfpJcD wl+tVcvNGRpOiswXn0g8tWLL2v8e0+ol8ExOrjhT+CDv8I4zw+C298pxa+YpO/pbTxnp5eSf87D9m FWXqMTzsz2vLU80wSPHHT+kiHlFVtIFqFaB3h7VYOF7oWNJDWVls3ywctXt3gIn5goc59GSIqt+aX /t+G6i37g==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwQpa-00038W-2s; Fri, 17 Jul 2020 13:55:18 +0000 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jwQou-0002t4-BJ for linux-arm-kernel@lists.infradead.org; Fri, 17 Jul 2020 13:54:37 +0000 Received: by mail-wm1-x344.google.com with SMTP id 17so17180235wmo.1 for ; Fri, 17 Jul 2020 06:54:36 -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=BdU11UOQFuXyCSynzxRXM0IT1vARtgrxd2bUOuqypjo=; b=Z6e2Az599CouQ+hjKJ3fh171GrmBXuuQYoyxs21YgHQXcnooWtd0d4qYE1hp7Fwp5Z SM8M9boXYBJvn8lwPVCVxW6+FNHJUOfLDJ52Mrw0pvO9wEGLC8olytK/rYr01bgfpIRX NfOd0UXXmOtLeEZgF7joBx8fm4hIDMZDinwqPn3IXqLfsoAW+pE3JeoJdYkxDJ+rSeGm zl3LNaO8Iip6w5A2lPOWUgmwjQqpCN61R357z3ZYuT4myLa+74zeRFOI1eyXwWOm8FDM ISnduGtoskDm+LkUDeOMHuTItePm8NNoAdICqcjQFMk/XhvtEoz3VYA6B7hUX6aUJ1V1 XjxA== 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=BdU11UOQFuXyCSynzxRXM0IT1vARtgrxd2bUOuqypjo=; b=A/ntQt+JqQNyRDUj+X+lxK2UecIKHwopx4tUkfplwqmSPd6GS5o/8HQbDEpIYr+CAv YLQS+ubF6TyDuCkkez7JhlE4BktTw0Jwo7npnoj6hb3SBzlAfYLdBGvURMU9XA1DkAdw ONQPJGXAWRIISM+sYRje+Dmdgqe5aX74ogQZI3LjsIZjoZZY9c+uYvOhrjm4XYirsV94 b7t+40JiJr8pl2X+dAX8DB4NMYIGww60shPbaocQu2gFqEQYnx4giVXl0YEIOnT3lNWX h6BVbF0uA2ZXZyJlyj04aXwtwBtYTLL9wRr/Z2TCdYFjpjJpyNIbqkmrxO4R3bLofdyR d5Zg== X-Gm-Message-State: AOAM532r5i8is/ZVqpiAZtFsGeuUxHEHR30mwSuY+btpOB1fPQVgvXpE twuivgeMyXgo+OZkYJh+QqzcyQ== X-Google-Smtp-Source: ABdhPJw7B9TDI0XMbwrUhXUY/EXKQH5gIkMZxaFo6XtGIcaYGVLxDNa64CokR+smlhl5Hzf6a9aXJQ== X-Received: by 2002:a7b:cd83:: with SMTP id y3mr9305717wmj.105.1594994075163; Fri, 17 Jul 2020 06:54:35 -0700 (PDT) Received: from localhost.localdomain ([2.27.167.94]) by smtp.gmail.com with ESMTPSA id w128sm16118356wmb.19.2020.07.17.06.54.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 17 Jul 2020 06:54:34 -0700 (PDT) From: Lee Jones To: broonie@kernel.org Subject: [PATCH v2 08/14] spi: spi-pl022: Provide missing struct attribute/function param docs Date: Fri, 17 Jul 2020 14:54:18 +0100 Message-Id: <20200717135424.2442271-9-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200717135424.2442271-1-lee.jones@linaro.org> References: <20200717135424.2442271-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-20200717_095436_435806_C4375BA2 X-CRM114-Status: GOOD ( 13.63 ) 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:344 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_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 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: 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. */