Skip to contentSkip to conversation

coresight: Do not default to CPU0 for missing CPU phandle

PATCH Superseded Sai Prakash Ranjan 3 participants 6 messages Jun 24, 2019 – Jun 26, 2019

Subsystems (4)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover coresight: Do not default to CPU0 for missing CPU phandle

In case of missing CPU phandle, the affinity is set default to CPU0 which is not a correct assumption. Fix this in coresight platform to set affinity to invalid and abort the probe in drivers. Also update the dt-bindings accordingly.

v3:
* Addressed review comments from Suzuki and updated acpi_coresight_get_cpu.
* Removed patch 2 which had invalid check for online cpus.

v2:
* Addressed review comments from Suzuki and Mathieu.
* Allows the probe of etm and cpu-debug to abort earlier in case of unavailability of respective cpus.

Sai Prakash Ranjan (1):
coresight: Do not default to CPU0 for missing CPU phandle

 .../bindings/arm/coresight-cpu-debug.txt         |  4 ++--
 .../devicetree/bindings/arm/coresight.txt        |  8 +++++---
 .../hwtracing/coresight/coresight-cpu-debug.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm3x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm4x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-platform.c | 16 ++++++++--------
 6 files changed, 24 insertions(+), 13 deletions(-)
Signature · 2 lines
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
of Code Aurora Forum, hosted by The Linux Foundation
#1 lore raw

PATCH v3 1/1 coresight: Do not default to CPU0 for missing CPU phandle

Coresight platform support assumes that a missing "cpu" phandle defaults to CPU0. This could be problematic and unnecessarily binds components to CPU0, where they may not be. Let us make the DT binding rules a bit stricter by not defaulting to CPU0 for missing "cpu" affinity information.

Also in coresight etm and cpu-debug drivers, abort the probe for such cases.

---
 .../bindings/arm/coresight-cpu-debug.txt         |  4 ++--
 .../devicetree/bindings/arm/coresight.txt        |  8 +++++---
 .../hwtracing/coresight/coresight-cpu-debug.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm3x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm4x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-platform.c | 16 ++++++++--------
 6 files changed, 24 insertions(+), 13 deletions(-)
Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt +2 -2
index 298291211ea4..f1de3247c1b7 100644
@@ -26,8 +26,8 @@ Required properties:
 		processor core is clocked by the internal CPU clock, so it
 		is enabled with CPU clock by default.
 
-- cpu : the CPU phandle the debug module is affined to. When omitted
-	the module is considered to belong to CPU0.
+- cpu : the CPU phandle the debug module is affined to. Do not assume it
+        to default to CPU0 if omitted.
 
 Optional properties:
 
Documentation/devicetree/bindings/arm/coresight.txt +5 -3
index 8a88ddebc1a2..fcc3bacfd8bc 100644
@@ -59,6 +59,11 @@ its hardware characteristcs.
 
 	* port or ports: see "Graph bindings for Coresight" below.
 
+* Additional required property for Embedded Trace Macrocell (version 3.x and
+  version 4.x):
+	* cpu: the cpu phandle this ETM/PTM is affined to. Do not
+	  assume it to default to CPU0 if omitted.
+
 * Additional required properties for System Trace Macrocells (STM):
 	* reg: along with the physical base address and length of the register
 	  set as described above, another entry is required to describe the
@@ -87,9 +92,6 @@ its hardware characteristcs.
 	* arm,cp14: must be present if the system accesses ETM/PTM management
 	  registers via co-processor 14.
 
-	* cpu: the cpu phandle this ETM/PTM is affined to. When omitted the
-	  source is considered to belong to CPU0.
-
 * Optional property for TMC:
 
 	* arm,buffer-size: size of contiguous buffer space for TMC ETR
drivers/hwtracing/coresight/coresight-cpu-debug.c +3 -0
index 07a1367c733f..58bfd6319f65 100644
@@ -579,6 +579,9 @@ static int debug_probe(struct amba_device *adev, const struct amba_id *id)
 		return -ENOMEM;
 
 	drvdata->cpu = coresight_get_cpu(dev);
+	if (drvdata->cpu < 0)
+		return drvdata->cpu;
+
 	if (per_cpu(debug_drvdata, drvdata->cpu)) {
 		dev_err(dev, "CPU%d drvdata has already been initialized\n",
 			drvdata->cpu);
drivers/hwtracing/coresight/coresight-etm3x.c +3 -0
index 225c2982e4fe..e2cb6873c3f2 100644
@@ -816,6 +816,9 @@ static int etm_probe(struct amba_device *adev, const struct amba_id *id)
 	}
 
 	drvdata->cpu = coresight_get_cpu(dev);
+	if (drvdata->cpu < 0)
+		return drvdata->cpu;
+
 	desc.name  = devm_kasprintf(dev, GFP_KERNEL, "etm%d", drvdata->cpu);
 	if (!desc.name)
 		return -ENOMEM;
drivers/hwtracing/coresight/coresight-etm4x.c +3 -0
index 7fe266194ab5..7bcac8896fc1 100644
@@ -1101,6 +1101,9 @@ static int etm4_probe(struct amba_device *adev, const struct amba_id *id)
 	spin_lock_init(&drvdata->spinlock);
 
 	drvdata->cpu = coresight_get_cpu(dev);
+	if (drvdata->cpu < 0)
+		return drvdata->cpu;
+
 	desc.name = devm_kasprintf(dev, GFP_KERNEL, "etm%d", drvdata->cpu);
 	if (!desc.name)
 		return -ENOMEM;
drivers/hwtracing/coresight/coresight-platform.c +8 -8
index 3c5ceda8db24..4990da2c13e9 100644
@@ -159,16 +159,16 @@ static int of_coresight_get_cpu(struct device *dev)
 	struct device_node *dn;
 
 	if (!dev->of_node)
-		return 0;
+		return -ENODEV;
+
 	dn = of_parse_phandle(dev->of_node, "cpu", 0);
-	/* Affinity defaults to CPU0 */
 	if (!dn)
-		return 0;
+		return -ENODEV;
+
 	cpu = of_cpu_node_to_id(dn);
 	of_node_put(dn);
 
-	/* Affinity to CPU0 if no cpu nodes are found */
-	return (cpu < 0) ? 0 : cpu;
+	return cpu;
 }
 
 /*
@@ -734,14 +734,14 @@ static int acpi_coresight_get_cpu(struct device *dev)
 	struct acpi_device *adev = ACPI_COMPANION(dev);
 
 	if (!adev)
-		return 0;
+		return -ENODEV;
 	status = acpi_get_parent(adev->handle, &cpu_handle);
 	if (ACPI_FAILURE(status))
-		return 0;
+		return -ENODEV;
 
 	cpu = acpi_handle_to_logical_cpuid(cpu_handle);
 	if (cpu >= nr_cpu_ids)
-		return 0;
+		return -ENODEV;
 	return cpu;
 }
 
Signature · 2 lines
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
of Code Aurora Forum, hosted by The Linux Foundation
maintainer Reviewed-by on v3 1/1
#2 lore raw

Sai,

Thanks for getting this done.

Quoted 10 lines · Sai Prakash Ranjan

Coresight platform support assumes that a missing "cpu" phandle defaults to CPU0. This could be problematic and unnecessarily binds components to CPU0, where they may not be. Let us make the DT binding rules a bit stricter by not defaulting to CPU0 for missing "cpu" affinity information.

Also in coresight etm and cpu-debug drivers, abort the probe for such cases.

#3 lore raw
Quoted 11 lines · Suzuki K Poulose

Sai,

Thanks for getting this done.

Quoted 6 lines · Sai Prakash Ranjan

Coresight platform support assumes that a missing "cpu" phandle defaults to CPU0. This could be problematic and unnecessarily binds components to CPU0, where they may not be. Let us make the DT binding rules a bit stricter by not defaulting to CPU0 for missing "cpu" affinity information.

Quoted 6 lines
Quoted 4 lines

Also in coresight etm and cpu-debug drivers, abort the probe for such cases.

Thanks for the review Suzuki.

Signature · 2 lines
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
of Code Aurora Forum, hosted by The Linux Foundation
#4 lore raw
In reply to Sai Prakash Ranjan

Hi Sai,

Quoted 117 lines · Sai Prakash Ranjan

Coresight platform support assumes that a missing "cpu" phandle defaults to CPU0. This could be problematic and unnecessarily binds components to CPU0, where they may not be. Let us make the DT binding rules a bit stricter by not defaulting to CPU0 for missing "cpu" affinity information.

Also in coresight etm and cpu-debug drivers, abort the probe for such cases.

---
 .../bindings/arm/coresight-cpu-debug.txt         |  4 ++--
 .../devicetree/bindings/arm/coresight.txt        |  8 +++++---
 .../hwtracing/coresight/coresight-cpu-debug.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm3x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-etm4x.c    |  3 +++
 drivers/hwtracing/coresight/coresight-platform.c | 16 ++++++++--------
 6 files changed, 24 insertions(+), 13 deletions(-)
Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt +2 -2
index 298291211ea4..f1de3247c1b7 100644
@@ -26,8 +26,8 @@ Required properties:
                processor core is clocked by the internal CPU clock, so it
                is enabled with CPU clock by default.
 
-- cpu : the CPU phandle the debug module is affined to. When omitted
-       the module is considered to belong to CPU0.
+- cpu : the CPU phandle the debug module is affined to. Do not assume it
+        to default to CPU0 if omitted.
 
 Optional properties:
 
Documentation/devicetree/bindings/arm/coresight.txt +5 -3
index 8a88ddebc1a2..fcc3bacfd8bc 100644
@@ -59,6 +59,11 @@ its hardware characteristcs.
 
        * port or ports: see "Graph bindings for Coresight" below.
 
+* Additional required property for Embedded Trace Macrocell (version 3.x and
+  version 4.x):
+       * cpu: the cpu phandle this ETM/PTM is affined to. Do not
+         assume it to default to CPU0 if omitted.
+
 * Additional required properties for System Trace Macrocells (STM):
        * reg: along with the physical base address and length of the register
          set as described above, another entry is required to describe the
@@ -87,9 +92,6 @@ its hardware characteristcs.
        * arm,cp14: must be present if the system accesses ETM/PTM management
          registers via co-processor 14.
 
-       * cpu: the cpu phandle this ETM/PTM is affined to. When omitted the
-         source is considered to belong to CPU0.
-
 * Optional property for TMC:
 
        * arm,buffer-size: size of contiguous buffer space for TMC ETR
drivers/hwtracing/coresight/coresight-cpu-debug.c +3 -0
index 07a1367c733f..58bfd6319f65 100644
@@ -579,6 +579,9 @@ static int debug_probe(struct amba_device *adev, const struct amba_id *id)
                return -ENOMEM;
 
        drvdata->cpu = coresight_get_cpu(dev);
+       if (drvdata->cpu < 0)
+               return drvdata->cpu;
+
        if (per_cpu(debug_drvdata, drvdata->cpu)) {
                dev_err(dev, "CPU%d drvdata has already been initialized\n",
                        drvdata->cpu);
drivers/hwtracing/coresight/coresight-etm3x.c +3 -0
index 225c2982e4fe..e2cb6873c3f2 100644
@@ -816,6 +816,9 @@ static int etm_probe(struct amba_device *adev, const struct amba_id *id)
        }
 
        drvdata->cpu = coresight_get_cpu(dev);
+       if (drvdata->cpu < 0)
+               return drvdata->cpu;
+
        desc.name  = devm_kasprintf(dev, GFP_KERNEL, "etm%d", drvdata->cpu);
        if (!desc.name)
                return -ENOMEM;
drivers/hwtracing/coresight/coresight-etm4x.c +3 -0
index 7fe266194ab5..7bcac8896fc1 100644
@@ -1101,6 +1101,9 @@ static int etm4_probe(struct amba_device *adev, const struct amba_id *id)
        spin_lock_init(&drvdata->spinlock);
 
        drvdata->cpu = coresight_get_cpu(dev);
+       if (drvdata->cpu < 0)
+               return drvdata->cpu;
+
        desc.name = devm_kasprintf(dev, GFP_KERNEL, "etm%d", drvdata->cpu);
        if (!desc.name)
                return -ENOMEM;
drivers/hwtracing/coresight/coresight-platform.c +2 -2
index 3c5ceda8db24..4990da2c13e9 100644
@@ -159,16 +159,16 @@ static int of_coresight_get_cpu(struct device *dev)
        struct device_node *dn;
 
        if (!dev->of_node)
-               return 0;
+               return -ENODEV;
+
        dn = of_parse_phandle(dev->of_node, "cpu", 0);
-       /* Affinity defaults to CPU0 */
        if (!dn)

drivers/hwtracing/coresight/coresight-platform.c static int of_coresight_get_cpu(struct device *dev) · line 172

Quoted 10 lines
drivers/hwtracing/coresight/coresight-platform.c +3 -3
-               return 0;
+               return -ENODEV;
+
        cpu = of_cpu_node_to_id(dn);
        of_node_put(dn);
 
-       /* Affinity to CPU0 if no cpu nodes are found */
-       return (cpu < 0) ? 0 : cpu;
+       return cpu;
 }

Function of_coresight_get_cpu() needs to return -ENODEV rather than 0 when !CONFIG_OF

Quoted 10 lines
drivers/hwtracing/coresight/coresight-platform.c +1 -1
 /*
@@ -734,14 +734,14 @@ static int acpi_coresight_get_cpu(struct device *dev)
        struct acpi_device *adev = ACPI_COMPANION(dev);
 
        if (!adev)
-               return 0;
+               return -ENODEV;
        status = acpi_get_parent(adev->handle, &cpu_handle);
        if (ACPI_FAILURE(status))

drivers/hwtracing/coresight/coresight-platform.c static int acpi_coresight_get_cpu(struct device *dev) · line 747

Quoted 10 lines
drivers/hwtracing/coresight/coresight-platform.c +2 -2
-               return 0;
+               return -ENODEV;
 
        cpu = acpi_handle_to_logical_cpuid(cpu_handle);
        if (cpu >= nr_cpu_ids)
-               return 0;
+               return -ENODEV;
        return cpu;
 }
 

Same as above, but for !CONFIG_ACPI

Thanks,
Mathieu

Quoted 4 lines

--
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum, hosted by The Linux Foundation

#5 lore raw

Hi Mathieu,

Quoted 45 lines · Mathieu Poirier

Hi Sai,

Quoted 14 lines · Sai Prakash Ranjan
drivers/hwtracing/coresight/coresight-platform.c +2 -2
index 3c5ceda8db24..4990da2c13e9 100644
@@ -159,16 +159,16 @@ static int of_coresight_get_cpu(struct device *dev)
         struct device_node *dn;
 
         if (!dev->of_node)
-               return 0;
+               return -ENODEV;
+
         dn = of_parse_phandle(dev->of_node, "cpu", 0);
-       /* Affinity defaults to CPU0 */
         if (!dn)

drivers/hwtracing/coresight/coresight-platform.c static int of_coresight_get_cpu(struct device *dev) · line 172

Quoted 10 lines
drivers/hwtracing/coresight/coresight-platform.c +3 -3
-               return 0;
+               return -ENODEV;
+
         cpu = of_cpu_node_to_id(dn);
         of_node_put(dn);
 
-       /* Affinity to CPU0 if no cpu nodes are found */
-       return (cpu < 0) ? 0 : cpu;
+       return cpu;
  }

Function of_coresight_get_cpu() needs to return -ENODEV rather than 0 when !CONFIG_OF

Quoted 13 lines
drivers/hwtracing/coresight/coresight-platform.c +2 -2
  /*
@@ -734,14 +734,14 @@ static int acpi_coresight_get_cpu(struct device *dev)
         struct acpi_device *adev = ACPI_COMPANION(dev);
 
         if (!adev)
-               return 0;
+               return -ENODEV;
         status = acpi_get_parent(adev->handle, &cpu_handle);
         if (ACPI_FAILURE(status))
-               return 0;
+               return -ENODEV;
 
Quoted 10 lines

drivers/hwtracing/coresight/coresight-platform.c static int acpi_coresight_get_cpu(struct device *dev) · line 747

Quoted 7 lines
drivers/hwtracing/coresight/coresight-platform.c +1 -1
         cpu = acpi_handle_to_logical_cpuid(cpu_handle);
         if (cpu >= nr_cpu_ids)
-               return 0;
+               return -ENODEV;
         return cpu;
  }
 

Same as above, but for !CONFIG_ACPI

Have fixed and resent, thanks Mathieu.

-Sai

Signature · 2 lines
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
of Code Aurora Forum, hosted by The Linux Foundation