From patchwork Wed Jun 6 16:07:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tzung-Bi Shih X-Patchwork-Id: 10450623 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id D8E3760234 for ; Wed, 6 Jun 2018 16:07:58 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C71A729968 for ; Wed, 6 Jun 2018 16:07:58 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id BA69229970; Wed, 6 Jun 2018 16:07:58 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.8 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from alsa0.perex.cz (alsa0.perex.cz [77.48.224.243]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C2D3B29968 for ; Wed, 6 Jun 2018 16:07:57 +0000 (UTC) Received: from alsa0.perex.cz (localhost [127.0.0.1]) by alsa0.perex.cz (Postfix) with ESMTP id B0FC3267217; Wed, 6 Jun 2018 18:07:54 +0200 (CEST) X-Original-To: alsa-devel@alsa-project.org Delivered-To: alsa-devel@alsa-project.org Received: by alsa0.perex.cz (Postfix, from userid 1000) id B9B67267252; Wed, 6 Jun 2018 18:07:52 +0200 (CEST) Received: from mail-pf0-f196.google.com (mail-pf0-f196.google.com [209.85.192.196]) by alsa0.perex.cz (Postfix) with ESMTP id 166232671EE for ; Wed, 6 Jun 2018 18:07:49 +0200 (CEST) Received: by mail-pf0-f196.google.com with SMTP id a12-v6so3383774pfi.3 for ; Wed, 06 Jun 2018 09:07:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=Sc6Cq6dv++NQfVWRbk19iYz7eLmbVegfpv1FWwwEKXk=; b=KsRWUXxjv6ebS60H5zIrVmU+CmX0ymWbi+/A9kSMsmZgXsHQVJO1hPrPxG380rLcvD jFIuUXjL9vtJv6xnHv3cadfAuePAdk+szTO/v/fa3LyO+3I/pYDtVyFOFjZeSOK7s0Ex kC5FvZ4KO8K3t0J8i6A7Bu0nu4f2xK+ABOpdHK3hzzN7fZdYugI6H7t1Tl3U54l749lX hizUmBDqjIZtnP8shRPq01SWYaUSXpf0+B11WCd1qqOAc0OVJQjvXZiXeQi375FGhSHk Uz7t3PaZN0v2G7YAL5Tl+6Pt8Au3JRgtCG6evth3/gbOOkEWBKAhz+FygLIXmxJaAPZP Zp9g== 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; bh=Sc6Cq6dv++NQfVWRbk19iYz7eLmbVegfpv1FWwwEKXk=; b=koZRqLMG3463aIqHmRMuXGetINOwCnpaVYJ7tpVVxwmFa8vVAXtHWtqQ+Ymo1/nvDm MiWAJtHxNS7ii8dhwhbGm0p/TjslEo+TUzInhIbp7Otsu8POKB9LrI3+1zOnIZ4sc0RH qwyeMuMfBZ1BB76xDFWFdvOol/qET1BsyhLc7JFEiQtj10zbjA/LezscSdp+BvGFu6nF YRgAOFpJcgdGAOrQMR9g6WE/xEtJ9mrkAULLId4GNuhWrpiIH4cm61/iHIm2afam6KQp qWAHVPJve7ApbBtVmY2UrgcDXMr6GztQrqVEya2TaRV3x+T0iwVqxE+1ce23QmeU3tF9 cpyg== X-Gm-Message-State: APt69E0EsDXVX1WRR1bBJ7BEhJmoMqDJ4XtNH+XXhTmre1lmy+E/bwo/ RvWHtP0bw8GPIdvIyOCJ+8u6egvJYa+hgQ== X-Google-Smtp-Source: ADUXVKJ5/Ic6KaOXxcisdhAQWFWdjmfXLn4M44UgtmXE9RaijcXzjNEze6UQEJZco/dFoUym1dnORg== X-Received: by 2002:a62:fcb:: with SMTP id 72-v6mr3043485pfp.231.1528301267770; Wed, 06 Jun 2018 09:07:47 -0700 (PDT) Received: from tzungbi-z840.tpe.corp.google.com ([2401:fa00:1:10:95a9:d668:d3a7:7f3b]) by smtp.gmail.com with ESMTPSA id b72-v6sm17107261pfj.56.2018.06.06.09.07.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 06 Jun 2018 09:07:47 -0700 (PDT) From: Tzung-Bi Shih To: alsa-devel@alsa-project.org Date: Thu, 7 Jun 2018 00:07:36 +0800 Message-Id: <20180606160736.169077-1-tzungbi@google.com> X-Mailer: git-send-email 2.18.0.rc1.242.g61856ae69a-goog Cc: tzungbi@google.com, cychiang@google.com Subject: [alsa-devel] [PATCH] ASoC: dapm: update function comments X-BeenThere: alsa-devel@alsa-project.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Alsa-devel mailing list for ALSA developers - http://www.alsa-project.org" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org X-Virus-Scanned: ClamAV using ClamSMTP snd_soc_dapm_put_volsw() and snd_soc_dapm_put_enum_double() returns 0 if the value is unchanged and 1 if changed. Both 0 and 1 indicate a success. Signed-off-by: Tzung-Bi Shih Reviewed-by: Charles Keepax --- sound/soc/soc-dapm.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sound/soc/soc-dapm.c b/sound/soc/soc-dapm.c index 2d9709104ec5..9843086dc1ed 100644 --- a/sound/soc/soc-dapm.c +++ b/sound/soc/soc-dapm.c @@ -3178,7 +3178,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_volsw); * * Callback to set the value of a dapm mixer control. * - * Returns 0 for success. + * Returns either 0 or 1 for success: 1 if changed, 0 if unchanged. */ int snd_soc_dapm_put_volsw(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol) @@ -3311,7 +3311,7 @@ EXPORT_SYMBOL_GPL(snd_soc_dapm_get_enum_double); * * Callback to set the value of a dapm enumerated double mixer control. * - * Returns 0 for success. + * Returns either 0 or 1 for success: 1 if changed, 0 if unchanged. */ int snd_soc_dapm_put_enum_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)