From patchwork Wed Sep 16 09:01:21 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 256320 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.5 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham 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 D733DC433E2 for ; Wed, 16 Sep 2020 09:01:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id CCD2720708 for ; Wed, 16 Sep 2020 09:01:39 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="S9o15MDn" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726452AbgIPJBi (ORCPT ); Wed, 16 Sep 2020 05:01:38 -0400 Received: from www.zeus03.de ([194.117.254.33]:57938 "EHLO mail.zeus03.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726438AbgIPJBh (ORCPT ); Wed, 16 Sep 2020 05:01:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=simple; d=sang-engineering.com; h= from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; s=k1; bh=7kb+F2bvxmBG8X/Ty0ZF3ZbyH/Z 6biJTdAu4JDoS9bw=; b=S9o15MDnmsIFZwubZq7mWq9aWAwHXQchVx8Uaj6rosC yxGIg5DOvygoySCw5EeSvPwH0RjPUHT3xvUs9nnzDMmbO7k7wSqxZGOD4sy4GDFZ 89VsRde9xoA/UIhfQNTDeGFmtuAndi8BgwjwMxNsSmFdSy8soCwGbFw2xXZF2NDw = Received: (qmail 2516260 invoked from network); 16 Sep 2020 11:01:34 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 16 Sep 2020 11:01:34 +0200 X-UD-Smtp-Session: l3s3148p1@qSyug2qv+w8ut2cR From: Wolfram Sang To: linux-mmc@vger.kernel.org Cc: Wolfram Sang Subject: [PATCH] mmc: core: document mmc_hw_reset Date: Wed, 16 Sep 2020 11:01:21 +0200 Message-Id: <20200916090121.2350-1-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.28.0 MIME-Version: 1.0 Sender: linux-mmc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-mmc@vger.kernel.org Add documentation for mmc_hw_reset to make sure the intended use case is clear. Signed-off-by: Wolfram Sang --- While working on this, I get the feeling this function should be renamed to 'mmc_card_reset' or something similar. 'hw' is still confusing because it could easily be the host controller, too. I volunteer to prepare a patch if we can agree on a better name. drivers/mmc/core/core.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/drivers/mmc/core/core.c b/drivers/mmc/core/core.c index 8ccae6452b9c..a9ad72a18d1b 100644 --- a/drivers/mmc/core/core.c +++ b/drivers/mmc/core/core.c @@ -2063,6 +2063,16 @@ static void mmc_hw_reset_for_init(struct mmc_host *host) host->ops->hw_reset(host); } +/** + * mmc_hw_reset - reset the card + * @host: MMC host to which the card is attached + * + * Reset the remote card. This function is only for upper layers, like the + * block layer or card drivers. You cannot use it in host drivers (struct + * mmc_card might be gone then). + * + * Return: 0 on success, -errno on failure + */ int mmc_hw_reset(struct mmc_host *host) { int ret;