From patchwork Tue Dec 19 21:22:31 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ulf Hansson X-Patchwork-Id: 10124433 X-Patchwork-Delegate: geert@linux-m68k.org 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 16786603B5 for ; Tue, 19 Dec 2017 21:23:49 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 08DB0287B3 for ; Tue, 19 Dec 2017 21:23:49 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id F16D728B4B; Tue, 19 Dec 2017 21:23:48 +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=-7.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A7D49287B3 for ; Tue, 19 Dec 2017 21:23:48 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753342AbdLSVXg (ORCPT ); Tue, 19 Dec 2017 16:23:36 -0500 Received: from mail-lf0-f65.google.com ([209.85.215.65]:39177 "EHLO mail-lf0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753174AbdLSVXD (ORCPT ); Tue, 19 Dec 2017 16:23:03 -0500 Received: by mail-lf0-f65.google.com with SMTP id m20so8613941lfi.6 for ; Tue, 19 Dec 2017 13:23:02 -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; bh=B2dtHgFNzb2UrZK6K3gClLvywVXm3hxHvwuv6UELdgA=; b=XpytnqB6chVXDYrdzok1RBtsXPQJV2imh79s98X/6tKleicsH4bSESMY2pFnYuRiCI TvAGyku8mfcmikQAn0nG10u/fwDjbWIskNIbHlUiVY5yZvbcJ5CFjk7CZ8dILyfFNZs2 NGAITXPcFW/oODlgdafhdqI1gS3AXvzbo1tIc= 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; bh=B2dtHgFNzb2UrZK6K3gClLvywVXm3hxHvwuv6UELdgA=; b=PYV09fFv+SwvHd4baS/5BHYuW3nYQFYoFqqR/grmctEgpybBtTvQHCemNypbIxZZm/ DI76kVuDZQGivMCbXs3uj7nHU5Es89DcSfM8DOza9c9qPBFB9L8RZtOglKzuTmS5v9tz hoHb/nC+NeWygeopf4aON+nQxM97l6CV4oNtP5MzCamIXcJ/0UQP5pnQUWPS2o+4/Jnm k9P5AqXnN/Bnhfi3qkky0jLnqhZf/qNmwUPIYpC9ywdVbL8I0XieT5Vh2lM1oPIw5Baq 0md3bnUnCKGpmO5eu9f0kFI1BXlcPjzC971yq6s/3AlMOtIdE4xMTJEtbdyvsB/+K72u HkHA== X-Gm-Message-State: AKGB3mIJ5xIZfWS41SPyg9gpdHTKxI2lONUYRVlEKHRgnp0mIuqaOTYI xnCpw9Hvr/WO+NDRKo+3WcfVFg== X-Google-Smtp-Source: ACJfBouADR+64U/jT8dQLPxOlgLf3lUrLpkKg5hcDPdTx01brwXO0GVxzQLTA5KigM/jTWrjDSUVJQ== X-Received: by 10.46.83.29 with SMTP id h29mr2989757ljb.144.1513718581723; Tue, 19 Dec 2017 13:23:01 -0800 (PST) Received: from localhost.localdomain (h-158-174-22-67.NA.cust.bahnhof.se. [158.174.22.67]) by smtp.gmail.com with ESMTPSA id 13sm3173068ljv.37.2017.12.19.13.23.00 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 19 Dec 2017 13:23:00 -0800 (PST) From: Ulf Hansson To: Kishon Vijay Abraham I , linux-kernel@vger.kernel.org Cc: "Rafael J . Wysocki" , linux-pm@vger.kernel.org, Yoshihiro Shimoda , Geert Uytterhoeven , linux-renesas-soc@vger.kernel.org, Ulf Hansson , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 3/3] phy: core: Update the runtime PM section in the docs to reflect changes Date: Tue, 19 Dec 2017 22:22:31 +0100 Message-Id: <1513718551-28624-4-git-send-email-ulf.hansson@linaro.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1513718551-28624-1-git-send-email-ulf.hansson@linaro.org> References: <1513718551-28624-1-git-send-email-ulf.hansson@linaro.org> Sender: linux-renesas-soc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-renesas-soc@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Let's update and clarify he phy documentation, to reflect the latest changes around the runtime PM deployment in the phy core. Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Signed-off-by: Ulf Hansson --- Documentation/phy.txt | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/Documentation/phy.txt b/Documentation/phy.txt index 457c3e0..6d9e3d3 100644 --- a/Documentation/phy.txt +++ b/Documentation/phy.txt @@ -160,19 +160,21 @@ associated with this PHY. PM Runtime ========== -This subsystem is pm runtime enabled. So while creating the PHY, -pm_runtime_enable of the phy device created by this subsystem is called and -while destroying the PHY, pm_runtime_disable is called. Note that the phy -device created by this subsystem will be a child of the device that calls -phy_create (PHY provider device). - -So pm_runtime_get_sync of the phy_device created by this subsystem will invoke -pm_runtime_get_sync of PHY provider device because of parent-child relationship. -It should also be noted that phy_power_on and phy_power_off performs -phy_pm_runtime_get_sync and phy_pm_runtime_put respectively. -There are exported APIs like phy_pm_runtime_get, phy_pm_runtime_get_sync, -phy_pm_runtime_put, phy_pm_runtime_put_sync, phy_pm_runtime_allow and -phy_pm_runtime_forbid for performing PM operations. +This subsystem deploys runtime PM support. More precisely, calls to +pm_runtime_get_sync() and to pm_runtime_put() surrounds calls to the phy +provider callbacks, ->init|exit(), in phy_init|exit(). At phy_power_on(), the +runtime PM usage count is raised again, via pm_runtime_get_sync(). The usage +count remain raised, until the internal phy power on count reaches zero in +phy_power_off(), at which point pm_runtime_put() is called to restore the +runtime PM usage count. In this way, the device is guranteed to stay runtime +resumed as long as the phy is powered on. + +In regards to the runtime PM deployment in the phy core, it should also be +noted that it's deployed for the phy provider device, which is the parent of +the phy child device. In other words, the phy device created by the phy core +remains runtime PM disabled. Of course, whether runtime PM is really used or +not, depends on whether the phy provider driver has enabled runtime PM for its +provider device. PHY Mappings ============