Re: [PATCH v3 0/9] coresight: Update device tree bindings
From: Mathieu Poirier
Date: Mon Jul 30 2018 - 16:02:39 EST
On Fri, Jul 27, 2018 at 11:15:28AM +0100, Suzuki K Poulose wrote:
> Coresight uses DT graph bindings to describe the connections of the
> components. However we have some undocumented usage of the bindings
> to describe some of the properties of the connections.
>
> The coresight driver needs to know the hardware ports invovled
> in the connection and the direction of data flow to effectively
> manage the trace sessions. So far we have relied on the "port"
> address (as described by the generic graph bindings) to represent
> the hardware port of the component for a connection.
>
> The hardware uses separate numbering scheme for input and output
> ports, which implies, we could have two different (input and output)
> ports with the same port number. This could create problems in the
> graph bindings where the label of the port wouldn't match the address.
>
> e.g, with the existing bindings we get :
>
> port@0{ // Output port 0
> reg = <0>;
> ...
> };
>
> port@1{
> reg = <0>; // Input port 0
> endpoint {
> slave-mode;
> ...
> };
> };
>
> With the new enforcement in the DT rules, mismatches in label and address
> are not allowed (as see in the case for port@1). So, we need a new mechanism
> to describe the hardware port number reliably.
>
> Also, we relied on an undocumented "slave-mode" property (see the above
> example) to indicate if the port is an input port. Let us formalise and
> switch to a new property to describe the direction of data flow.
>
> There were three options considered for the hardware port number scheme:
>
> 1) Use natural ordering in the DT to infer the hardware port number.
> i.e, Mandate that the all ports are listed in the DT and in the ascending
> order for each class (input and output respectively).
> Pros :
> - We don't need new properties and if the existing DTS list them in
> order (which most of them do), they work out of the box.
> Cons :
> - We must list all the ports even if the system cannot/shouldn't use
> it.
> - It is prone to human errors (if the order is not kept).
>
> 2) Use an explicit property to list both the direction and the hw port
> number and direction. Define "coresight,hwid" as 2 member array of u32,
> where the members are port number and the direction respectively.
> e.g
>
> port@0{
> reg = <0>;
> endpoint {
> coresight,hwid = <0 1>; // Port # 0, Output
> }
> };
>
> port@1{
> reg = <1>;
> endpoint {
> coresight,hwid = <0 0>; // Port # 0, Input
> };
> };
>
> Pros:
> - The bindings are formal but not so reader friendly and could
> potentially lead to human errors.
> Cons:
> - Backward compatiblity is lost.
> 3) Use explicit properties (implemented in the series) for the hardware
> port id and direction. We define a new property "coresight,hwid" for
> each endpoint in coresight devices to specify the hardware port number
> explicitly. Also use a separate property "direction" to specify the
> direction of the data flow.
>
> e.g,
>
> port@0{
> reg = <0>;
> endpoint {
> direction = <1>; // Output
> coresight,hwid = <0>; // Port # 0
> }
> };
>
> port@1{
> reg = <1>;
> endpoint {
> direction = <0>; // Input
> coresight,hwid = <0>; // Port # 0
> };
> };
>
> Pros:
> - The bindings are formal and reader friendly, and less prone to errors.
> Cons:
> - Backward compatibility is lost.
>
> After a round of discussions [1], the following option (4) is adopted :
>
> 4) Group ports based on the directions under a dedicated node. This has been
> checked with the upstream DTC tool to resolve the "address mismatch" issue.
>
> e.g,
>
> out-ports { // Output ports for this component
>
> port@0 { // Outport 0
> reg = 0;
> endpoint { ... };
> };
>
> port@1 { // Outport 1
> reg = 1;
> endpoint { ... };
> };
>
> };
>
> in-ports { // Input ports for this component
> port@0 { // Inport 0
> reg = 0;
> endpoint { ... };
> };
>
> port@1 { // Inport 1
> reg = 1;
> endpoint { ... };
> };
>
> };
>
>
> This series implements Option (4) listed above and falls back to the old
> bindings if the new bindings are not available. This allows the systems
> with old bindings work with the new driver. The driver now issues a warning
> (once) when it encounters the old bindings. The series contains DT update
> for Juno platform. The remaining in-kernel sources could be updated once
> we are fine with the proposal.
>
> It also cleans up the platform parsing code to reduce the memory usage by
> reusing the platform description.
>
> Applies on coresight/next
>
> Changes since V2:
> - Clean of_coresight_parse_endpoint() to return 1 to indicate a connection
> record was updated.
> - Drop documentation for old bindings
>
> Changes since V1:
> - Implement the proposal by Rob.
> - Drop the DTS updates for all platforms except Juno
> - Drop the incorrect fix in coresight_register. Instead document the code
> to prevent people trying to un-fix it again.
> - Add a patch to drop remote device references in DT graph parsing
> - Split of_node refcount fixing patch, fix a typo in the comment.
> - Add Reviewed-by tags from Mathieu.
> - Drop patches picked up for 4.18-rc series
>
> Changes since RFC:
> - Fixed style issues
> - Fix an existing memory leak coresight_register (Found in code update)
> - Fix missing of_node_put() in the existing driver (Reported-by Mathieu)
> - Update the existing dts in kernel tree.
>
> Suzuki K Poulose (9):
> coresight: Document error handling in coresight_register
> coresight: platform: Refactor graph endpoint parsing
> coresight: platform: Fix refcounting for graph nodes
> coresight: platform: Fix leaking device reference
> coresight: Fix remote endpoint parsing
> coresight: Add helper to check if the endpoint is input
> coresight: platform: Cleanup coresight connection handling
> coresight: Cleanup coresight DT bindings
> dts: juno: Update coresight bindings
>
> .../devicetree/bindings/arm/coresight.txt | 95 +++++---
> arch/arm64/boot/dts/arm/juno-base.dtsi | 161 ++++++------
> arch/arm64/boot/dts/arm/juno-cs-r1r2.dtsi | 52 ++--
> arch/arm64/boot/dts/arm/juno.dts | 13 +-
> drivers/hwtracing/coresight/coresight.c | 35 +--
> drivers/hwtracing/coresight/of_coresight.c | 269 ++++++++++++++-------
> include/linux/coresight.h | 9 +-
> 7 files changed, 359 insertions(+), 275 deletions(-)
>
Good day,
I have applied patches 1 to 7. I will wait for Rob's ACK before doing the same
with 8 and 9.
Thanks,
Mathieu
> --
> 2.7.4
>