From patchwork Fri Jan 19 00:01:55 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lina Iyer X-Patchwork-Id: 10174291 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 82A27602B8 for ; Fri, 19 Jan 2018 00:04:04 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 71E8B1FF62 for ; Fri, 19 Jan 2018 00:04:04 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 66A4A27B13; Fri, 19 Jan 2018 00:04:04 +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=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID 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 E81A51FF62 for ; Fri, 19 Jan 2018 00:04:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755314AbeASADs (ORCPT ); Thu, 18 Jan 2018 19:03:48 -0500 Received: from smtp.codeaurora.org ([198.145.29.96]:54376 "EHLO smtp.codeaurora.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754758AbeASAC4 (ORCPT ); Thu, 18 Jan 2018 19:02:56 -0500 Received: by smtp.codeaurora.org (Postfix, from userid 1000) id 7DDE160A24; Fri, 19 Jan 2018 00:02:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=codeaurora.org; s=default; t=1516320175; bh=BcPlEQwfgBna2vzF0kI0vtL0BZyRCpV/wqCFaYE1hbE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DVgB41YxDSMVqm50jsm2yhLnilkVVKEZbW9DrnflxhWsWz/6eewozqRQJJUBEyzzs XpSstiB3FA0YDDRaPHwlllSGacjmMFm2nvuyd//RmXJeZzQ0DABR90jjJewkF0KX1y /tu0vVRNpP/L8KRchAISoFXxohgC5bgHMhM+HDlw= Received: from codeaurora.org (i-global254.qualcomm.com [199.106.103.254]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: ilina@smtp.codeaurora.org) by smtp.codeaurora.org (Postfix) with ESMTPSA id 625CC6081E; Fri, 19 Jan 2018 00:02:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=codeaurora.org; s=default; t=1516320175; bh=BcPlEQwfgBna2vzF0kI0vtL0BZyRCpV/wqCFaYE1hbE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DVgB41YxDSMVqm50jsm2yhLnilkVVKEZbW9DrnflxhWsWz/6eewozqRQJJUBEyzzs XpSstiB3FA0YDDRaPHwlllSGacjmMFm2nvuyd//RmXJeZzQ0DABR90jjJewkF0KX1y /tu0vVRNpP/L8KRchAISoFXxohgC5bgHMhM+HDlw= DMARC-Filter: OpenDMARC Filter v1.3.2 smtp.codeaurora.org 625CC6081E Authentication-Results: pdx-caf-mail.web.codeaurora.org; dmarc=none (p=none dis=none) header.from=codeaurora.org Authentication-Results: pdx-caf-mail.web.codeaurora.org; spf=none smtp.mailfrom=ilina@codeaurora.org From: Lina Iyer To: andy.gross@linaro.org, david.brown@linaro.org Cc: sboyd@codeaurora.org, rnayak@codeaurora.org, linux-arm-msm@vger.kernel.org, linux-soc@vger.kernel.org, devicetree@vger.kernel.org, linux-pm@vger.kernel.org, Lina Iyer Subject: [PATCH 2/4] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs Date: Thu, 18 Jan 2018 17:01:55 -0700 Message-Id: <20180119000157.7380-3-ilina@codeaurora.org> X-Mailer: git-send-email 2.15.1 In-Reply-To: <20180119000157.7380-1-ilina@codeaurora.org> References: <20180119000157.7380-1-ilina@codeaurora.org> Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add device binding documentation for Qualcomm Technology Inc's RPMH RSC driver. The hardware block is used for communicating resource state requests for shared resources. Cc: devicetree@vger.kernel.org Signed-off-by: Lina Iyer --- .../devicetree/bindings/arm/msm/rpmh-rsc.txt | 134 +++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt diff --git a/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt b/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt new file mode 100644 index 000000000000..b0cd55caf916 --- /dev/null +++ b/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt @@ -0,0 +1,134 @@ +RPMH RSC: +------------ + +RPMH is the mechanism for communicating with the hardened resource +accelerators. Requests to the resources can be written to the TCS mailbox +registers and using a (addr, val) pair and triggered. Messages in the TCS are +then sent in sequence over an internal bus. + +The hardware block (Direct Resource Voter or DRV) is a part of the h/w entity +(Resource State Coordinator a.k.a RSC) that can handle a multiple sleep and +active/wake resource requests. Multiple such DRVs can exist in a SoC and can +be written to from Linux. The structure of each DRV follows the same template +with a few variations that are captured by the properties here. + +Each DRV could have 'm' TCS instances. Each TCS could have 'n' slots. Each +slot has a header (u32), address (u32), data (u32), status (u32) and a +read-response (u32). A TCS when triggered will send all the enabled commands +of the 'n' commands in that slot in sequence. + +A TCS may be triggered from Linux or triggered by the F/W after all the CPUs +have powered off to faciliate idle power saving. TCS could be classified as - + + SLEEP, /* Triggered by F/W */ + WAKE, /* Triggered by F/W */ + ACTIVE, /* Triggered by Linux */ + CONTROL /* Triggered by F/W */ + +The order in which they are described in the DT, should match the hardware +configuration. + +Requests can be made for the state of a resource, when the subsystem is active +or idle. When all subsystems like Modem, GPU, CPU are idle, the resource state +will be an aggregeate of the sleep votes from each of those subsystem. Drivers +may request a sleep value for their shared resources in addition to the active +mode requests. + +Control requests are instance specific requests that may or may not reach an +accelerator. Only one platform device in Linux can request a control channel +on a DRV. + +CONTROLLER: +---------- + +PROPERTIES: + +- compatible: + Usage: required + Value type: + Definition: Should be "qcom,rpmh-rsc". + +- reg: + Usage: required + Value type: + Definition: the first element specifies the base address of the DRV, + the second element specifies the size of the region. + +- interrupts: + Usage: required + Value type: + Definition: the interrupt that trips when a message complete/response + is received for this DRV from the accelertors. + +- qcom,drv-id: + Usage: required + Value type: + Definition: the id of the DRV in the RSC block. + +- qcom, tcs-config: + Usage: required + Value type: + Definition: the tuple definining the configuration of TCS. + Must have 2 cells which describe each TCS type. + + - Cell #1 (TCS Type): TCS types can be specified - + SLEEP_TCS + WAKE_TCS + ACTIVE_TCS + CONTROL_TCS + - Cell #2 (Number of TCS): + +- label: + Usage: optional + Value type: + Definition: Name for the RSC. The name would be used in trace logs. + +Clients the want to use the RSC to communicate with RPMH would specify their +bindings as child of the corresponding RSC controllers. + +EXAMPLE 1: + +For a TCS whose RSC base address is is 0x179C0000 and is at a DRV of 2, the +register offsets for DRV2 start at 0D00, the register calculations are like +this - +First tuple: 0x179C0000 + 0x10000 * 2 = 0x179E0000 +Second tuple: 0x179E0000 + 0xD00 = 0x179E0D00 + + apps_rsc: rsc@179e000 { + compatible = "qcom,rpmh-rsc"; + label = "apps_rsc"; + reg = <0x179e0000 0x10000>, <0x179e0d00 0x3000>; + interrupts = <0 5 0>; + qcom,drv-id = <2>; + qcom,tcs-config = , + , + , + ; + + foo-clk { + compatible = "foo-clk"; + }; + }; + +EXAMPLE 2: + +For a TCS whose RSC base address is 0xAF20000 and is at DRV of 0, the register +offsets for DRV0 start at 01C00, the register calculations are like this - +First tuple: 0xAF20000 +Second tuple: 0xAF20000 + 0x1C00 + + disp_rsc: rsc@af20000 { + label = "disp_rsc"; + compatible = "qcom,rpmh-rsc"; + reg = <0xaf20000 0x10000>, <0xaf21c00 0x3000>; + interrupts = <0 129 0>; + qcom,drv-id = <0>; + qcom,tcs-config = , + , + , + ; + + foo-clk { + compatible = "foo-clk"; + }; + };