* [PATCH v3 02/10] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs [not found] <20180302164317.10554-1-ilina@codeaurora.org> @ 2018-03-02 16:43 ` Lina Iyer 2018-03-06 22:30 ` Stephen Boyd 0 siblings, 1 reply; 3+ messages in thread From: Lina Iyer @ 2018-03-02 16:43 UTC (permalink / raw) To: andy.gross, david.brown, linux-arm-msm, linux-soc Cc: rnayak, bjorn.andersson, linux-kernel, Lina Iyer, devicetree 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 <ilina@codeaurora.org> --- Changes in v2: - Amend text to describe the registers in reg property - Add reg-names for the registers - Update examples to use GIC_SPI in interrupts instead of 0 - Rephrase incorrect description Changes in v3: - Fix unwanted capitalization - Remove clients from the examples, this doc does not describe them - Rephrase introductory paragraph - Remove hardware specifics from DT bindings --- .../devicetree/bindings/arm/msm/rpmh-rsc.txt | 131 +++++++++++++++++++++ 1 file changed, 131 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..afd3817cc615 --- /dev/null +++ b/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt @@ -0,0 +1,131 @@ +RPMH RSC: +------------ + +Resource Power Manager Hardened (RPMH) is the mechanism for communicating with +the hardened resource accelerators on Qualcomm SoCs. Requests to the resources +can be written to the Trigger Command Set (TCS) 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. + +A TCS may be triggered from Linux or triggered by the F/W after all the CPUs +have powered off to facilitate 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 aggregate 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. + +Properties: + +- compatible: + Usage: required + Value type: <string> + Definition: Should be "qcom,rpmh-rsc". + +- reg: + Usage: required + Value type: <prop-encoded-array> + Definition: The first register specifies the base address of the DRV. + The second register specifies the start address of the + TCS. + +- reg-names: + Usage: required + Value type: <string> + Definition: Maps the register specified in the reg property. Must be + "drv" and "tcs". + +- interrupts: + Usage: required + Value type: <prop-encoded-interrupt> + Definition: The interrupt that trips when a message complete/response + is received for this DRV from the accelerators. + +- qcom,drv-id: + Usage: required + Value type: <u32> + Definition: the id of the DRV in the RSC block. + +- qcom,tcs-config: + Usage: required + Value type: <prop-encoded-array> + Definition: the tuple defining the configuration of TCS. + Must have 2 cells which describe each TCS type. + <type number_of_tcs>. + The order of the TCS must match the hardware + configuration. + - Cell #1 (TCS Type): TCS types to be specified - + SLEEP_TCS + WAKE_TCS + ACTIVE_TCS + CONTROL_TCS + - Cell #2 (Number of TCS): <u32> + +- label: + Usage: optional + Value type: <string> + Definition: Name for the RSC. The name would be used in trace logs. + +Drivers that want to use the RSC to communicate with RPMH must specify their +bindings as child of the RSC controllers they wish to communicate with. + +Example 1: + +For a TCS whose RSC base address is is 0x179C0000 and is at a DRV id 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 { + label = "apps_rsc"; + compatible = "qcom,rpmh-rsc"; + reg = <0x179e0000 0x10000>, <0x179e0d00 0x3000>; + reg-names = "drv", "tcs"; + interrupts = <GIC_SPI 5 IRQ_TYPE_LEVEL_HIGH>; + qcom,drv-id = <2>; + qcom,tcs-config = <SLEEP_TCS 3>, + <WAKE_TCS 3>, + <ACTIVE_TCS 2>, + <CONTROL_TCS 1>; + }; + +Example 2: + +For a TCS whose RSC base address is 0xAF20000 and is at DRV id of 0, the +register offsets for DRV0 start at 01C00, the register calculations are like +this - +First tuple: 0xAF20000 +Second tuple: 0xAF20000 + 0x1C00 = 0xAF21C00 + + disp_rsc: rsc@af20000 { + label = "disp_rsc"; + compatible = "qcom,rpmh-rsc"; + reg = <0xaf20000 0x10000>, <0xaf21c00 0x3000>; + reg-names = "drv", "tcs"; + interrupts = <GIC_SPI 129 IRQ_TYPE_LEVEL_HIGH>; + qcom,drv-id = <0>; + qcom,tcs-config = <SLEEP_TCS 1>, + <WAKE_TCS 1>, + <ACTIVE_TCS 0>, + <CONTROL_TCS 0>; + }; -- The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v3 02/10] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs 2018-03-02 16:43 ` [PATCH v3 02/10] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs Lina Iyer @ 2018-03-06 22:30 ` Stephen Boyd 2018-03-07 20:54 ` Lina Iyer 0 siblings, 1 reply; 3+ messages in thread From: Stephen Boyd @ 2018-03-06 22:30 UTC (permalink / raw) To: andy.gross, david.brown, linux-arm-msm, linux-soc Cc: rnayak, bjorn.andersson, linux-kernel, Lina Iyer, devicetree Quoting Lina Iyer (2018-03-02 08:43:09) > Add device binding documentation for Qualcomm Technology Inc's RPMH RSC > driver. The hardware block is used for communicating resource state s/driver/hardware/ > requests for shared resources. > > Cc: devicetree@vger.kernel.org > Signed-off-by: Lina Iyer <ilina@codeaurora.org> > --- > > Changes in v2: > - Amend text to describe the registers in reg property > - Add reg-names for the registers > - Update examples to use GIC_SPI in interrupts instead of 0 > - Rephrase incorrect description > > Changes in v3: > - Fix unwanted capitalization > - Remove clients from the examples, this doc does not describe > them > - Rephrase introductory paragraph > - Remove hardware specifics from DT bindings > --- > .../devicetree/bindings/arm/msm/rpmh-rsc.txt | 131 +++++++++++++++++++++ > 1 file changed, 131 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..afd3817cc615 > --- /dev/null > +++ b/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt Shouldn't this go into bindings/soc/qcom/ ? > @@ -0,0 +1,131 @@ > +RPMH RSC: > +------------ > + > +Resource Power Manager Hardened (RPMH) is the mechanism for communicating with > +the hardened resource accelerators on Qualcomm SoCs. Requests to the resources > +can be written to the Trigger Command Set (TCS) 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. > + > +A TCS may be triggered from Linux or triggered by the F/W after all the CPUs > +have powered off to facilitate 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 aggregate of the sleep votes from each of those subsystem. Drivers s/subsystem/subsystems/ s/Drivers/Clients/ ? > +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. Not sure what this last sentence has to do with the DT binding. We generally try to avoid saying 'Linux' or 'driver' in DT binding documents, because they usually document hardware. > + > +Properties: > + > +- compatible: > + Usage: required > + Value type: <string> > + Definition: Should be "qcom,rpmh-rsc". > + > +- reg: > + Usage: required > + Value type: <prop-encoded-array> > + Definition: The first register specifies the base address of the DRV. > + The second register specifies the start address of the > + TCS. > + > +- reg-names: > + Usage: required optional? > + Value type: <string> > + Definition: Maps the register specified in the reg property. Must be > + "drv" and "tcs". > + > +- interrupts: > + Usage: required > + Value type: <prop-encoded-interrupt> > + Definition: The interrupt that trips when a message complete/response > + is received for this DRV from the accelerators. > + > +- qcom,drv-id: > + Usage: required > + Value type: <u32> > + Definition: the id of the DRV in the RSC block. > + > +- qcom,tcs-config: > + Usage: required > + Value type: <prop-encoded-array> > + Definition: the tuple defining the configuration of TCS. > + Must have 2 cells which describe each TCS type. > + <type number_of_tcs>. > + The order of the TCS must match the hardware > + configuration. > + - Cell #1 (TCS Type): TCS types to be specified - > + SLEEP_TCS > + WAKE_TCS > + ACTIVE_TCS > + CONTROL_TCS > + - Cell #2 (Number of TCS): <u32> > + > +- label: > + Usage: optional > + Value type: <string> > + Definition: Name for the RSC. The name would be used in trace logs. > + > +Drivers that want to use the RSC to communicate with RPMH must specify their > +bindings as child of the RSC controllers they wish to communicate with. Is that going to work for drivers that want to talk to two or more RSCs? I suppose that they'll have to hook up into some sort of framework like clk or regulator and then drivers that want to use two RSCs for those things would be linked to those sub-device drivers with the normal clk or regulator bindings? > + > +Example 1: > + > +For a TCS whose RSC base address is is 0x179C0000 and is at a DRV id 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 { > + label = "apps_rsc"; > + compatible = "qcom,rpmh-rsc"; > + reg = <0x179e0000 0x10000>, <0x179e0d00 0x3000>; > + reg-names = "drv", "tcs"; > + interrupts = <GIC_SPI 5 IRQ_TYPE_LEVEL_HIGH>; > + qcom,drv-id = <2>; > + qcom,tcs-config = <SLEEP_TCS 3>, > + <WAKE_TCS 3>, > + <ACTIVE_TCS 2>, > + <CONTROL_TCS 1>; Could qcom,tcs-config become something more like below? #qcom,sleep-tcs = <3>; #qcom,wake-tcs = <3>; #qcom,active-tcs = <2>; #qcom,control-tcs = <1>; I don't really understand the binding design to have many cells with the *_TCS defines indicating what comes next. ^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v3 02/10] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs 2018-03-06 22:30 ` Stephen Boyd @ 2018-03-07 20:54 ` Lina Iyer 0 siblings, 0 replies; 3+ messages in thread From: Lina Iyer @ 2018-03-07 20:54 UTC (permalink / raw) To: Stephen Boyd Cc: andy.gross, david.brown, linux-arm-msm, linux-soc, rnayak, bjorn.andersson, linux-kernel, devicetree On Tue, Mar 06 2018 at 15:30 -0700, Stephen Boyd wrote: >Quoting Lina Iyer (2018-03-02 08:43:09) >> Add device binding documentation for Qualcomm Technology Inc's RPMH RSC >> driver. The hardware block is used for communicating resource state > >s/driver/hardware/ > Ok. >> requests for shared resources. >> >> Cc: devicetree@vger.kernel.org >> Signed-off-by: Lina Iyer <ilina@codeaurora.org> >> --- >> >> Changes in v2: >> - Amend text to describe the registers in reg property >> - Add reg-names for the registers >> - Update examples to use GIC_SPI in interrupts instead of 0 >> - Rephrase incorrect description >> >> Changes in v3: >> - Fix unwanted capitalization >> - Remove clients from the examples, this doc does not describe >> them >> - Rephrase introductory paragraph >> - Remove hardware specifics from DT bindings >> --- >> .../devicetree/bindings/arm/msm/rpmh-rsc.txt | 131 +++++++++++++++++++++ >> 1 file changed, 131 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..afd3817cc615 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/arm/msm/rpmh-rsc.txt > >Shouldn't this go into bindings/soc/qcom/ ? > Didn;t realize the location. Thanks for pointing out. > + >> +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 aggregate of the sleep votes from each of those subsystem. Drivers > >s/subsystem/subsystems/ >s/Drivers/Clients/ ? > Ok >> +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. > >Not sure what this last sentence has to do with the DT binding. We >generally try to avoid saying 'Linux' or 'driver' in DT binding >documents, because they usually document hardware. > This para can go away. >> + >> +Properties: >> + >> +- compatible: >> + Usage: required >> + Value type: <string> >> + Definition: Should be "qcom,rpmh-rsc". >> + >> +- reg: >> + Usage: required >> + Value type: <prop-encoded-array> >> + Definition: The first register specifies the base address of the DRV. >> + The second register specifies the start address of the >> + TCS. >> + >> +- reg-names: >> + Usage: required > >optional? > No, it is required. Driver has been using the by_name for clarity. >> + Value type: <string> >> + Definition: Maps the register specified in the reg property. Must be >> + "drv" and "tcs". >> + >> +- interrupts: >> + Usage: required >> + Value type: <prop-encoded-interrupt> >> + Definition: The interrupt that trips when a message complete/response >> + is received for this DRV from the accelerators. >> + >> +- qcom,drv-id: >> + Usage: required >> + Value type: <u32> >> + Definition: the id of the DRV in the RSC block. >> + >> +- qcom,tcs-config: >> + Usage: required >> + Value type: <prop-encoded-array> >> + Definition: the tuple defining the configuration of TCS. >> + Must have 2 cells which describe each TCS type. >> + <type number_of_tcs>. >> + The order of the TCS must match the hardware >> + configuration. >> + - Cell #1 (TCS Type): TCS types to be specified - >> + SLEEP_TCS >> + WAKE_TCS >> + ACTIVE_TCS >> + CONTROL_TCS >> + - Cell #2 (Number of TCS): <u32> >> + >> +- label: >> + Usage: optional >> + Value type: <string> >> + Definition: Name for the RSC. The name would be used in trace logs. >> + >> +Drivers that want to use the RSC to communicate with RPMH must specify their >> +bindings as child of the RSC controllers they wish to communicate with. > >Is that going to work for drivers that want to talk to two or more RSCs? >I suppose that they'll have to hook up into some sort of framework like >clk or regulator and then drivers that want to use two RSCs for those >things would be linked to those sub-device drivers with the normal clk >or regulator bindings? > Correct. This follows the same model as RPM SMD driver. >> + >> +Example 1: >> + >> +For a TCS whose RSC base address is is 0x179C0000 and is at a DRV id 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 { >> + label = "apps_rsc"; >> + compatible = "qcom,rpmh-rsc"; >> + reg = <0x179e0000 0x10000>, <0x179e0d00 0x3000>; >> + reg-names = "drv", "tcs"; >> + interrupts = <GIC_SPI 5 IRQ_TYPE_LEVEL_HIGH>; >> + qcom,drv-id = <2>; >> + qcom,tcs-config = <SLEEP_TCS 3>, >> + <WAKE_TCS 3>, >> + <ACTIVE_TCS 2>, >> + <CONTROL_TCS 1>; > >Could qcom,tcs-config become something more like below? > > #qcom,sleep-tcs = <3>; > #qcom,wake-tcs = <3>; > #qcom,active-tcs = <2>; > #qcom,control-tcs = <1>; > >I don't really understand the binding design to have many cells with the >*_TCS defines indicating what comes next. > This format helps preserve the order in which the TCS are designed in the firmware. Thats additional information that is described by the cells. Thanks, Lina ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-03-07 20:54 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20180302164317.10554-1-ilina@codeaurora.org>
2018-03-02 16:43 ` [PATCH v3 02/10] dt-bindings: introduce RPMH RSC bindings for Qualcomm SoCs Lina Iyer
2018-03-06 22:30 ` Stephen Boyd
2018-03-07 20:54 ` Lina Iyer
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).