From patchwork Thu Aug 29 08:51:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Chen-Yu Tsai X-Patchwork-Id: 13782807 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 4C2DFC83013 for ; Thu, 29 Aug 2024 09:02:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From: Reply-To:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=7f9k7PpUQjpljatpt98ZEbTrZ2XDZjx22JMjFJskajY=; b=xDhQoEPmlgorZdTjQWGlMoijXZ hDemn7uId8ZjQ4iiPuGjeE5N0fsoffSMeepCaHzrAf4nOAXRiPYFhYhv1UFLvdDhEhJm+0ZcftMQp Paubg/lj8u73nAdJUwLcatm9xpCeAz0hMYAFZ0TwtBKrYFA5VxElcenb5bSwm34PtFmJfFx/zLpBn robY+F6GsT1ajHVStoEGYsyRLGzZUKEOi5S8zLri2Bhvei93COtZyYs+DvHQBtfgRCWFjYfaiuEaf Gw8i528sHjZ9OwsoWDBi7zh/GWplb8Vjv/pf2qlQ8ta/Ouy/FEM1JVziwhWErrFQxowtAFz45CMb5 Rtc2+0BQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjb2d-00000001GNO-2OF7; Thu, 29 Aug 2024 09:02:07 +0000 Received: from mail-pl1-x632.google.com ([2607:f8b0:4864:20::632]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sjasw-00000001Du3-3zvZ for linux-arm-kernel@lists.infradead.org; Thu, 29 Aug 2024 08:52:08 +0000 Received: by mail-pl1-x632.google.com with SMTP id d9443c01a7336-204f52fe74dso3561725ad.1 for ; Thu, 29 Aug 2024 01:52:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; t=1724921526; x=1725526326; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=7f9k7PpUQjpljatpt98ZEbTrZ2XDZjx22JMjFJskajY=; b=CMHrnEKVG71FaMcHN4yfl4bV55sA77nmoUbhXOFDURwOzTrWCi1WTn1J9hQNpYp5BV QBmeAUEeso+iCtrQn1etkbmP7+8shCbKHZJGMAWBrM9PExtUjkBZRx7KTsgKiH7dI2Tv l6QdIZ2JRLi7qd0u3HxM0NidyIUz2yYhN7LOg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724921526; x=1725526326; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=7f9k7PpUQjpljatpt98ZEbTrZ2XDZjx22JMjFJskajY=; b=CUi4heobKtABUtb4It3km9QEbDgNiGOqCf1swOhpLuj2gILCdET4hUN4WEtgXzCJFJ 5sLXv/7TOPIgBbIe3X9S2YTN2VyhiP/pWKB3ii1aNi4v6NLcywvOd0QKjqs3O0d0+sET C4BGZs/kEwl/iTrlz39+rp13OB2QNGPpkqXx4khghiDfjHB+OWsNFT3K0jysoqv+L4JP bo3/gU9rMnoZycXh28F3hhquZRVDgJWOS4q1rmYyIAMAzvYPcT1tVPYUfzSHrrTgD6eX 13DzNDHAzpnM8nyIoOBXZkx6cOUzUV9wLewjiYnrlkDOUAISPMN7suqRq8sEhMEpNUCO cHkw== X-Forwarded-Encrypted: i=1; AJvYcCU5Q8KiPZpNN5270Gd/l5o8mwan8DfD44ijvuYGMMpq0mlU7qq5EPay00IEgQnRMOWYlXbqcX/Dy/1s9QUVggIZ@lists.infradead.org X-Gm-Message-State: AOJu0YxWMXzW5jWj8AGNDayOfoHJ5z+DtKQ0cyb1fH1Jlhciw6eeE72h L8hUQgSsHe99rEDC5nBi/iWq4+gyFsELSYQ/9Pp9bPHIc8dWURRFLttq4uE9Gg== X-Google-Smtp-Source: AGHT+IGhKkcGNXI0K2CzplNu1hl3pLJjO1nnoCWwWYcUIQxyGIW+1Pl1x1rPn6MjaWMLeftQHomqJg== X-Received: by 2002:a17:902:ec84:b0:203:a0c7:3156 with SMTP id d9443c01a7336-2050c23699amr22267205ad.5.1724921526443; Thu, 29 Aug 2024 01:52:06 -0700 (PDT) Received: from wenstp920.tpe.corp.google.com ([2401:fa00:1:10:fbe5:6d6c:1cc7:23f3]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-20515543fbdsm6924165ad.218.2024.08.29.01.52.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2024 01:52:05 -0700 (PDT) From: Chen-Yu Tsai To: Mark Brown , Liam Girdwood Cc: Chen-Yu Tsai , linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Andy Shevchenko , Matti Vaittinen Subject: [PATCH v2 08/10] regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc Date: Thu, 29 Aug 2024 16:51:28 +0800 Message-ID: <20240829085131.1361701-9-wenst@chromium.org> X-Mailer: git-send-email 2.46.0.295.g3b9ea8a38a-goog In-Reply-To: <20240829085131.1361701-1-wenst@chromium.org> References: <20240829085131.1361701-1-wenst@chromium.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240829_015207_041563_623B7C52 X-CRM114-Status: GOOD ( 14.42 ) 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 kernel-doc complains about missing "Return" section for the function regulator_irq_map_event_simple(). Add a "Return" section for it based on its behavior. The function actually always returns 0, but fills in fields in its @rid parameter as needed. Expand the description of the parameter to cover this. While at it fix a typo found in the description of the same function. Reported-by: Matti Vaittinen Closes: https://lore.kernel.org/all/e341240e-1c1f-49a2-91cd-440888fdbda0@gmail.com/ Signed-off-by: Chen-Yu Tsai --- Changes since v1: - Update commit subject to reflect changes - Was 'regulator: irq_helpers: Add missing "Return" kerneldoc section' - Add period ('.') to the end of the "Return" section sentence - Fix typo in function description spotted by Marti - Describe output fields in @rid clearly --- drivers/regulator/irq_helpers.c | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c index 5ab1a0befe12..2de7b907c81d 100644 --- a/drivers/regulator/irq_helpers.c +++ b/drivers/regulator/irq_helpers.c @@ -404,16 +404,21 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel); /** * regulator_irq_map_event_simple - regulator IRQ notification for trivial IRQs * - * @irq: Number of IRQ that occurred - * @rid: Information about the event IRQ indicates - * @dev_mask: mask indicating the regulator originating the IRQ + * @irq: Number of IRQ that occurred. + * @rid: Information about the event IRQ indicates. + * The function fills in the ®ulator_err_state->notifs + * and ®ulator_err_state->errors fields of + * ®ulator_irq_data->states as output. + * @dev_mask: mask indicating the regulator originating the IRQ. * * Regulators whose IRQ has single, well defined purpose (always indicate * exactly one event, and are relevant to exactly one regulator device) can - * use this function as their map_event callbac for their regulator IRQ - * notification helperk. Exactly one rdev and exactly one error (in + * use this function as their map_event callback for their regulator IRQ + * notification helper. Exactly one rdev and exactly one error (in * "common_errs"-field) can be given at IRQ helper registration for * regulator_irq_map_event_simple() to be viable. + * + * Return: 0. */ int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid, unsigned long *dev_mask)