From patchwork Tue Nov 3 15:28:23 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 11878129 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.8 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F21A0C388F7 for ; Tue, 3 Nov 2020 15:35:27 +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 952F6221FB for ; Tue, 3 Nov 2020 15:35:27 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="ugT9GCAk"; dkim=fail reason="signature verification failed" (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="S+09FZvF" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 952F6221FB 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+linux-arm-kernel=archiver.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=bLMQDEbiXkZyx1kQY2TfNOgwXSq2ekWcveYDDfkUkcg=; b=ugT9GCAkTSDHRtLKA+s5AV8pn EHFIlGQ3z5TdCF1eV+jI7Dn4vJyJc9FlyO0KEhELg1/1z94AeUu3PBBMQ/KzOtSz4dc3971YK3fPL 0JvfeCJbKjRcF7fTT04JhZbpdQzWvnG4tgYV3gzIV86HlOj4deP/4hb6AYUwETmxFaemm5F48Rt5P EUxV8JqV3bMYyyhWwB+QWAE1YXdCyHbweXUJO0PQnf5zeTo5TTDYwo1g0XpZM1lDbJbXzEp+5wG8D DbyDW31BQRfJOXoE8Ll/BEsmoroWHUwqGWgj9L+sQVEcAqYiamC4ZP4PDWLEgwTQS+8w5kkxBTSam OdMai6+5w==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1kZyI2-0002nh-SW; Tue, 03 Nov 2020 15:32:11 +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 1kZyFQ-0001m5-1F for linux-arm-kernel@lists.infradead.org; Tue, 03 Nov 2020 15:29:31 +0000 Received: by mail-wr1-x443.google.com with SMTP id y12so18996627wrp.6 for ; Tue, 03 Nov 2020 07:29:23 -0800 (PST) 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=09rWMfnYlRyV4fsHRd/rYRk+bGuNPAWsDGRa94IF8Wk=; b=S+09FZvFo+rK/fy0qh1+2+2ezmDUOTqA9WfstkdC8TVG+rdrmhYY9rJMIcDCXpsL/G bDLmAQnwpYAZMoRXcQ4N01Gy8ojxHPkG9neRk9sfn5pJnQnQ0JxkbXBQzWB9DdEPCN+a p8gHudq7skun6bpt+D9RMmdq1zkxYIpkgGR/kFlwnhfEOlIoA3PQenpl5h7k3TKUgrV4 Db/dO+666vsL2jh7ymUlDQueZ2LXqrvE0K179aq+tOiRm2DCu94BbtxbzWQkDya4shKM zNT0iY8O0m4KwVaPFPn5xE+71dTtKMVQhFSTecmquvcggiC1kfwA0aBc9mnQCZYtvk9B +z9Q== 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=09rWMfnYlRyV4fsHRd/rYRk+bGuNPAWsDGRa94IF8Wk=; b=q+k0TqAvCVEILqGaWEFwerZzduyEN2REPMbj2AELXYf9cjQ0j9UlQ6snTUcUkYghhE rrZDA6Lmv9f9Rl4ByRRZmzKhQMHUhLy+7j76d413IjxiLzsw5uDpvyKzmAu3Uy505Nqu tPvQDHq5VOaqEpG67vyV4bgzmsc4Rnp/LN3kHZ8nKQLhoL+FWZx0MJLLlfTbG3tB6Xb/ rBI75L0maxphGz/hAN2HkgK0n/Vhva1EuxtEE/IM7JnHSAKgMGKzfSmNAMmZWtnNwVvQ VBlZZ7UVyhBGd1FCJ/5Jp1Gij5u0uDPtjhQOPmU54KvdM6T/nt/JvEYs9olE80PmT+Sy gRJA== X-Gm-Message-State: AOAM533hnilD6nvx1N/p55EpkZl5KpO7/teTfoJbjHAE3Ea5nQ2KdAR3 wJc9YguAuDAgK/MJ5k9dkBha8g== X-Google-Smtp-Source: ABdhPJzIyWFyZ3KPxpe4y9AY0PXslJv88KbGM78JaEbhk9VnsCtW3zJgrDjS4ckZLYicz+h9XI7yfw== X-Received: by 2002:a5d:5106:: with SMTP id s6mr26077698wrt.51.1604417363188; Tue, 03 Nov 2020 07:29:23 -0800 (PST) Received: from dell.default ([91.110.221.242]) by smtp.gmail.com with ESMTPSA id j127sm3491779wma.31.2020.11.03.07.29.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 Nov 2020 07:29:22 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Subject: [PATCH 10/25] soc: ti: wkup_m3_ipc: Document 'm3_ipc' parameter throughout Date: Tue, 3 Nov 2020 15:28:23 +0000 Message-Id: <20201103152838.1290217-11-lee.jones@linaro.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201103152838.1290217-1-lee.jones@linaro.org> References: <20201103152838.1290217-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-20201103_102925_388125_38720B16 X-CRM114-Status: GOOD ( 16.57 ) 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: Dave Gerlach , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Santosh Shilimkar Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Fixes the following W=1 kernel build warning(s): drivers/soc/ti/wkup_m3_ipc.c:227: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_set_mem_type' drivers/soc/ti/wkup_m3_ipc.c:236: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_set_resume_address' drivers/soc/ti/wkup_m3_ipc.c:248: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_request_pm_status' drivers/soc/ti/wkup_m3_ipc.c:268: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_prepare_low_power' drivers/soc/ti/wkup_m3_ipc.c:322: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_finish_low_power' drivers/soc/ti/wkup_m3_ipc.c:369: warning: Function parameter or member 'm3_ipc' not described in 'wkup_m3_set_rtc_only' drivers/soc/ti/wkup_m3_ipc.c:369: warning: Excess function parameter 'wkup_m3_wakeup' description in 'wkup_m3_set_rtc_only' Cc: Santosh Shilimkar Cc: Dave Gerlach Signed-off-by: Lee Jones --- drivers/soc/ti/wkup_m3_ipc.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/drivers/soc/ti/wkup_m3_ipc.c b/drivers/soc/ti/wkup_m3_ipc.c index e9ece45d7a333..c3e2161df732b 100644 --- a/drivers/soc/ti/wkup_m3_ipc.c +++ b/drivers/soc/ti/wkup_m3_ipc.c @@ -218,6 +218,7 @@ static int wkup_m3_is_available(struct wkup_m3_ipc *m3_ipc) /* Public functions */ /** * wkup_m3_set_mem_type - Pass wkup_m3 which type of memory is in use + * @m3_ipc: Pointer to wkup_m3_ipc context * @mem_type: memory type value read directly from emif * * wkup_m3 must know what memory type is in use to properly suspend @@ -230,6 +231,7 @@ static void wkup_m3_set_mem_type(struct wkup_m3_ipc *m3_ipc, int mem_type) /** * wkup_m3_set_resume_address - Pass wkup_m3 resume address + * @m3_ipc: Pointer to wkup_m3_ipc context * @addr: Physical address from which resume code should execute */ static void wkup_m3_set_resume_address(struct wkup_m3_ipc *m3_ipc, void *addr) @@ -239,6 +241,7 @@ static void wkup_m3_set_resume_address(struct wkup_m3_ipc *m3_ipc, void *addr) /** * wkup_m3_request_pm_status - Retrieve wkup_m3 status code after suspend + * @m3_ipc: Pointer to wkup_m3_ipc context * * Returns code representing the status of a low power mode transition. * 0 - Successful transition @@ -260,6 +263,7 @@ static int wkup_m3_request_pm_status(struct wkup_m3_ipc *m3_ipc) /** * wkup_m3_prepare_low_power - Request preparation for transition to * low power state + * @m3_ipc: Pointer to wkup_m3_ipc context * @state: A kernel suspend state to enter, either MEM or STANDBY * * Returns 0 if preparation was successful, otherwise returns error code @@ -315,6 +319,7 @@ static int wkup_m3_prepare_low_power(struct wkup_m3_ipc *m3_ipc, int state) /** * wkup_m3_finish_low_power - Return m3 to reset state + * @m3_ipc: Pointer to wkup_m3_ipc context * * Returns 0 if reset was successful, otherwise returns error code */ @@ -362,8 +367,7 @@ static const char *wkup_m3_request_wake_src(struct wkup_m3_ipc *m3_ipc) /** * wkup_m3_set_rtc_only - Set the rtc_only flag - * @wkup_m3_wakeup: struct wkup_m3_wakeup_src * gets assigned the - * wakeup src value + * @m3_ipc: Pointer to wkup_m3_ipc context */ static void wkup_m3_set_rtc_only(struct wkup_m3_ipc *m3_ipc) {