From patchwork Sun Apr 7 06:08:14 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yang Li X-Patchwork-Id: 13620010 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 75E75CD11C2 for ; Sun, 7 Apr 2024 06:08:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=eFJ6vkNmi5nfmSKJ/ezDQNMDSU2B5QjxEPGp3M7Ri+c=; b=Gljryov3VsMlU3 eZ5JGmr5QGGPDAh1xRoa+5ltEsbOdj2ut8PWd4e/56IVlxi3tVhBOg18Y6sGvHdRfTFc/242EyHrf fJMSCXNN49lu4XCxC6IjwI7uzB2kcJL3N2Emdmc/MakAiw0O3M+eTqRH9PZyeIcT1S/qKF9nRKHx/ vGyY8xRzPvthCJyBuAVxuPhIS+pC8XqWcszWpH+/I2xi1CkKLSV9ZQ372B+EdOcWkEMAnUFjHwzFB yZS6Za1U8zUTB+3phYiVXinIptejcUDdOOD2sDsBIBt3KsR1A0VQAlzU30BHMPER3Eeb9DBCul08t lCED9l0QgAKtNjxl+11g==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtLhe-0000000BrpW-1k5B; Sun, 07 Apr 2024 06:08:30 +0000 Received: from out30-130.freemail.mail.aliyun.com ([115.124.30.130]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1rtLhb-0000000Broh-1Irm for linux-arm-kernel@lists.infradead.org; Sun, 07 Apr 2024 06:08:29 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.alibaba.com; s=default; t=1712470098; h=From:To:Subject:Date:Message-Id:MIME-Version; bh=OpSGDUWMbIKM8Bslv9SNkMz8YI1ytup7lt5o1mnR3b0=; b=hHtx6NodvobBhDzQAm2RDhW6/lO9h5dQr09If8iHuFBPk0ugWDe1Y3nAFJVOEVtxhIuKx7NIae2n9d+c5vzp3ldVw8B1YGmTfP/dVvTxE155wXJny4Tg+bEP8022IEREpe9wnl4pjzp5xfpQGpz4M92kqQFHa7350J2fSc7QYM4= X-Alimail-AntiSpam: AC=PASS;BC=-1|-1;BR=01201311R191e4;CH=green;DM=||false|;DS=||;FP=0|-1|-1|-1|0|-1|-1|-1;HT=ay29a033018046060;MF=yang.lee@linux.alibaba.com;NM=1;PH=DS;RN=4;SR=0;TI=SMTPD_---0W4.IlbM_1712470095; Received: from localhost(mailfrom:yang.lee@linux.alibaba.com fp:SMTPD_---0W4.IlbM_1712470095) by smtp.aliyun-inc.com; Sun, 07 Apr 2024 14:08:16 +0800 From: Yang Li To: linux@armlinux.org.uk Cc: linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Yang Li Subject: [PATCH -next] ARM: Add kernel-doc comments to ssp_read_word() Date: Sun, 7 Apr 2024 14:08:14 +0800 Message-Id: <20240407060814.96307-1-yang.lee@linux.alibaba.com> X-Mailer: git-send-email 2.20.1.7.g153144c MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240406_230827_534884_9B89C654 X-CRM114-Status: UNSURE ( 8.31 ) X-CRM114-Notice: Please train this message. X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org This commit adds kernel-doc style comments with complete parameter descriptions for the function ssp_read_word(). Signed-off-by: Yang Li --- arch/arm/mach-sa1100/ssp.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/arch/arm/mach-sa1100/ssp.c b/arch/arm/mach-sa1100/ssp.c index 613fd767afcf..3c97e372bdc4 100644 --- a/arch/arm/mach-sa1100/ssp.c +++ b/arch/arm/mach-sa1100/ssp.c @@ -73,6 +73,8 @@ int ssp_write_word(u16 data) /** * ssp_read_word - read a word from the SSP port * + * @data: Pointer to the 16-bit buffer where the read data should be stored. + * * Wait for a data word in the SSP receive FIFO, and return the * received data. Data is LSB justified. *