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: 235702 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp1724696ilg; Fri, 17 Jul 2020 06:55:07 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwAQjL4nnhU14cm0ke8Hus97gZvq346sve4j4fsm0E60Tfc2f6fjrfTxWUvSQLlYASB6Ya+ X-Received: by 2002:aa7:c991:: with SMTP id c17mr9383457edt.278.1594994107044; Fri, 17 Jul 2020 06:55:07 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594994107; cv=none; d=google.com; s=arc-20160816; b=Y0fxusonEG0gOdf45NmKPDsWU856ZF3cYkQ/OemI+/tsDGJgzsqxFi58jjCRHbV01g YRTgULlgADVcKHEFlf88I8y/k5Ug9A20H6dtUVgta3a6CXtnxyuNbnK843OWsy0KCD00 as5fwEo683SKBAJWWWwtgUyk6RFg7AT9Mgp6tG3+Oi8zhLKVjDP80VvR1IOQYkk/GpQx nq5ZwWtf+7qUsXRdmOTVBM51A5njcEt4DCRBUoeY6wD6X9hfwFESr2WXTZc7U0HdssL+ LEYiA7Da7GrbQlPNf4pTt5syB5vdHS28dr5QS7CO5vrSOlfSnKMYEA/ruGsKzVUmMCu4 ERug== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=BdU11UOQFuXyCSynzxRXM0IT1vARtgrxd2bUOuqypjo=; b=KsgVF7RKZSppc6wYDsmCYbjkl6/KULMFGSz2Owkk/aGxFEpyvABKiDHDxQA1RgF9XI n0SiM0SehGPtbxMi34uQvrjGdvFT8BPkuIfDbmBzXv68tu7ff/fsNiHaayQva1l8zh3h r65F57e8Ow+Maa9RdNbqPit9gaa+zrmu/8pJndHLBM8KZtpEfA3bRLHc6he8riQ2C4Hv 47flsmoxzU7MHlD/Io3YNG+dxG1hgENkFNpLNlIOcsXtj2AEH+kRC0907mbt98MBCw8X nD0s9Obn97+kwXl73wTUlIKI7qLlTi53oMKQUd+z3WfAntUNaeI0Oec79IWfVPnr8X/W BrDQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Z6e2Az59; spf=pass (google.com: domain of linux-spi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-spi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id oq5si5227174ejb.110.2020.07.17.06.55.06; Fri, 17 Jul 2020 06:55:07 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-spi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=Z6e2Az59; spf=pass (google.com: domain of linux-spi-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-spi-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727033AbgGQNzE (ORCPT + 2 others); Fri, 17 Jul 2020 09:55:04 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38662 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727001AbgGQNyg (ORCPT ); Fri, 17 Jul 2020 09:54:36 -0400 Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7E25EC0619D5 for ; Fri, 17 Jul 2020 06:54:36 -0700 (PDT) Received: by mail-wm1-x344.google.com with SMTP id c80so14957471wme.0 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=btn4GGQrgf0dnDnFn/bFEB4GzOsN64GvSP5CMVtrCXKZK13blA3T2DpIL+z6zgNJDA G1FaCbjMr5YSCbXpixFa29BIX5Y/YHSMAW2QVIEXUyu+/Lki7/fv9nY/qMhUApYVtqBZ VHBbzx1d1EFIPUBH6mXHe0x7P8DEiTkSXGIF3VPIBZCCHjPGK/qqKp75WkqxqGvFH7Kt ps/osIT7/ZcixyHWX4Us3yKZ7q0Teo6yhf9D+4SEtafLZ8uNGGIMy2mU40yN6+iePO9W KVOsdeDVdG1q4YSE0c6SVcA0jcZ1DcQLnZZv/WusvTZdrb8LjOFkbWDQtiRTrWZsbA8b y/hA== X-Gm-Message-State: AOAM532ghgitowdLl5ebeSEPNnkcxUT+AnhbYOaHSHGbOIk0LZektgxN 92QM94o6me6M1wkH/xbKf1c69w== 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 Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org, Lee Jones , Sachin Verma , Linus Walleij 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 Sender: linux-spi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-spi@vger.kernel.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(-) -- 2.25.1 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. */