From patchwork Fri Jun 26 13:05:25 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11627589 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 594F5913 for ; Fri, 26 Jun 2020 13:08:57 +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 2D9752080C for ; Fri, 26 Jun 2020 13:08:57 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="Ljg2ZdxB"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="IQ7ok0HF" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 2D9752080C 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=Y3e1oUbyuMcN0INIaXWp/CIwODbNCrjl42Ol5SvAKIw=; b=Ljg2ZdxBXYmWh/q0dLiT2IZfI yVhanxaBQI9G+87V1AlwplN0kr9eu8g/g7J+K9sOVfZ9pGN5oW6QqQEDe5XJg6tUTrlViwI1mYFfM X0GrgHcoeDyHDUDuK5qbFdZMJm5bDFcGYLbEsXgZJ5TfgzDIxzv3lh5u9CTsmHeVzF0uw1C4l5l8i 7kImcAp7TmMy3uTZyo9gZqm43nQbFfmYPbwxJfPHf4AknArhxx2jyv5GLamzvTSf5TE8yhzkyX00x vg1qhxmDbg0mnTs1TcyyuDTMlOigOAh2L45NqsH8j3tI/SQV80aKkg8XMm1/tsOsPy3L+sfFrZ5Qh L8stblBzw==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1joo45-00039Z-Ha; Fri, 26 Jun 2020 13:06:45 +0000 Received: from mail-wr1-x444.google.com ([2a00:1450:4864:20::444]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1joo34-0002iQ-1l for linux-arm-kernel@lists.infradead.org; Fri, 26 Jun 2020 13:05:45 +0000 Received: by mail-wr1-x444.google.com with SMTP id f18so1379500wrs.0 for ; Fri, 26 Jun 2020 06:05:41 -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=wgIF2Tzx4eGBueCHKg86n/uEbujpF9PDzYcT2/3mg20=; b=IQ7ok0HF4tKRxVuvEs17kkX6k+cf/VouH+TSqbBr+XLgYtS7BRaQowsbrDttWVuvPc E7AqbgsIs9MIqUKO4193FmdzsBWz8ZBRtnrfrFwXv9VjBGww9Xq9ha+/iMi7Njv3vtJl ICkZlU0pFyjugJPCj9LXhEoMytPjjDR0Uvwj8IV1ndWViuTfybwqOsxvx1WrTqd7cH06 W1TO2mrjQZ1h2pQ1vGmACWESyt5q4Me02Zj5yjlbJc3n6wF5P2WuR3SkSAlD79Lf+dBA O71OZrslrwEWGs3Nav792wgk1CsCAzUtRJrHod5wrFXh8JN0dvN8M4ZlrlAY5j30+AIp 125A== 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=wgIF2Tzx4eGBueCHKg86n/uEbujpF9PDzYcT2/3mg20=; b=aM2AkEHIL0JkG0/6+9z+5PNLo2O4nddSs6jkk/ec+owR5dE6Ae+Bz9z4mZPs5nkSKF JO+EmHkhOtTTA9mBU429SAXjAeSmwSeHoCGBkc331XtcmDR/BWdpTT97sJRsCVrbiPIF xps1UxZvt7GbpIHUQJ59ssjtUXLGKLFv5q3084JgKiLgqZZyDvzux9nTFz2btY/w3rhj 1bjwmA5SmEzb3wRCv+UNpTsOk2fqPsxfIuTheyBvs27FXgkxtckqITphE7T8T0kx87a7 NMzT5BLuMHVNn8vQVfPxPuWUGU+QjQe6jixBNBMriEKqFX5geXqqcNcZIWcIKahd/y/+ 8XvA== X-Gm-Message-State: AOAM532e+t3rxnrGYbV2G/mnagwtbUCWeZj9sHYpVQj7ODJ8Q/AARzAY vX171AmaPzsGIgkd04uYGLxUmQ== X-Google-Smtp-Source: ABdhPJwgQ+N90JMO76E5nSShh82EMIgdI+DtTpbaW3v6JMh6ZlktTQ/YpvCCbUfSm6baoLg6e4CgEQ== X-Received: by 2002:adf:e884:: with SMTP id d4mr3582523wrm.176.1593176740964; Fri, 26 Jun 2020 06:05:40 -0700 (PDT) Received: from localhost.localdomain ([2.27.35.144]) by smtp.gmail.com with ESMTPSA id u20sm16746904wmc.44.2020.06.26.06.05.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Jun 2020 06:05:40 -0700 (PDT) From: Lee Jones To: arnd@arndb.de, gregkh@linuxfoundation.org Subject: [PATCH 10/10] misc: pti: Fix documentation for bit-rotted function pti_tty_driver_write() Date: Fri, 26 Jun 2020 14:05:25 +0100 Message-Id: <20200626130525.389469-11-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200626130525.389469-1-lee.jones@linaro.org> References: <20200626130525.389469-1-lee.jones@linaro.org> MIME-Version: 1.0 X-Spam-Note: CRM114 invocation failed 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:444 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_EF Message has a valid DKIM or DK signature from envelope-from domain -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 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: J Freyensee , Lee Jones , linux-kernel@vger.kernel.org, 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 The API has moved on since the original function header was authored. This changes brings the function's documentation back into line with reality, complete descriptions of the latest arguments to be used. Squashes the following W=1 kernel build warnings: drivers/misc/pti.c:510: warning: Function parameter or member 'tty' not described in 'pti_tty_driver_wr drivers/misc/pti.c:510: warning: Function parameter or member 'buf' not described in 'pti_tty_driver_wr drivers/misc/pti.c:510: warning: Excess function parameter 'filp' description in 'pti_tty_driver_write' drivers/misc/pti.c:510: warning: Excess function parameter 'data' description in 'pti_tty_driver_write' Cc: J Freyensee Signed-off-by: Lee Jones Acked-by: Arnd Bergmann --- drivers/misc/pti.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/drivers/misc/pti.c b/drivers/misc/pti.c index b7f510676cd61..07e9da7918ebd 100644 --- a/drivers/misc/pti.c +++ b/drivers/misc/pti.c @@ -496,9 +496,8 @@ static void pti_tty_cleanup(struct tty_struct *tty) * pti_tty_driver_write()- Write trace debugging data through the char * interface to the PTI HW. Part of the misc device implementation. * - * @filp: Contains private data which is used to obtain - * master, channel write ID. - * @data: trace data to be written. + * @tty: tty struct containing pti information. + * @buf: trace data to be written. * @len: # of byte to write. * * Returns: