mbox series

[v6,0/8] coresight: enable debug module

Message ID 1491485461-22800-1-git-send-email-leo.yan@linaro.org
Headers show
Series coresight: enable debug module | expand

Message

Leo Yan April 6, 2017, 1:30 p.m. UTC
ARMv8 architecture reference manual (ARM DDI 0487A.k) Chapter H7 "The
Sample-based Profiling Extension" has description for sampling
registers, we can utilize these registers to check program counter
value with combined CPU exception level, secure state, etc. So this is
helpful for CPU lockup bugs, e.g. if one CPU has run into infinite loop
with IRQ disabled; the 'hang' CPU cannot switch context and handle any
interrupt, so it cannot handle SMP call for stack dump, etc.

This patch series is to enable coresight debug module with sample-based
registers and register call back notifier for PCSR register dumping
when panic happens, so we can see below dumping info for panic; and
this patch series has considered the conditions for access permission
for debug registers self, so this can avoid access debug registers when
CPU power domain is off; the driver also try to figure out the CPU is
in secure or non-secure state.

Patch 0001 is to document the dt binding; patch 0002 is to document
boot parameters used in kernel command line and add one detailed
document to describe the Coresight debug module implementation, the
clock and power domain impaction on the driver, some examples for
usage.

Patch 0003 is used to fix the func of_get_coresight_platform_data()
doesn't properly drop the reference to the CPU node pointer; and
patch 0004 is refactor to add new function of_coresight_get_cpu().
Patch 0005 is to add const quality to structure device_node.

Patch 0006 is the driver for CPU debug module.

Patch 0007 in this series are to enable debug unit on 96boards Hikey,
Patch 0008 is to enable debug on 96boards DB410c. Have verified on both
two boards.

We can enable debugging with two methods, adding parameters into kernel
command line for build-in module:
  coresight_cpu_debug.enable=1

Or we can wait the system has booted up to use debugfs nodes to enable
debugging:
  # echo 1 > /sys/kernel/debug/coresight_cpu_debug/enable

As result we can get below log after input command:
echo c > /proc/sysrq-trigger:

ARM external debug module:
CPU[0]:
 EDPRSR:  0000000b (Power:On DLK:Unlock)
 EDPCSR:  [<ffff00000808eb54>] handle_IPI+0xe4/0x150
 EDCIDSR: 00000000
 EDVIDSR: 90000000 (State:Non-secure Mode:EL1/0 Width:64bits VMID:0)
CPU[1]:
 EDPRSR:  0000000b (Power:On DLK:Unlock)
 EDPCSR:  [<ffff0000087a64c0>] debug_notifier_call+0x108/0x288
 EDCIDSR: 00000000
 EDVIDSR: 90000000 (State:Non-secure Mode:EL1/0 Width:64bits VMID:0)

[...]

Changes from v5:
* According to Suzuki and Mathieu suggestions, refined debug module
  driver to drop unused structure members, refactored initialization
  code to distinguish hardware implementation features, refactored
  flow for forcing CPU powered up, supported pm_runtime operations.
* Added one new doc file: Documentation/trace/coresight-cpu-debug.txt,
  which is used to describe detailed info for implementation, clock
  and power domain impaction on debug module, and exmaples for common
  usage.
* Removed "idle constraints" from debug driver.

Changes from v4:
* This version is mainly credit to ARM colleagues many contribution
  ideas for better quality (Thanks a lot Suzuki, Mike and Sudeep!).
* According to Suzuki suggestion, refined debug module driver to avoid
  memory leak for drvdata struct, handle PCSAMPLE_MODE=1, use flag
  drvdata.pc_has_offset to indicate if PCSR has offset, minor fixes.
* According to Mathieu suggestion, refined dt binding description.
* Changed driver to support module mode;
* According to Mike suggestion and very appreciate the pseudo code,
  added support to force CPU powered up with register EDPRCR;
* According to discussions, added command line and debugfs nodes to
  support enabling debugging for boot time, or later can dynamically
  enable/disable debugging by debugfs.
* According to Rob Herring suggestion, one minor fixes in DT binding.
* According to Stephen Boyd suggestion, add const quality to structure
  device_node. And used use of_cpu_device_node_get() to replace
  of_get_cpu_node() in patch 0003.

Changes from v3:
* Added Suzuki K Poulose's patch to fix issue for the func
  of_get_coresight_platform_data() doesn't properly drop the reference
  to the CPU node pointer.
* According to Suzuki suggestion, added code to handl the corner case
  for ARMv8 CPU with aarch32 mode.
* According to Suzuki suggestion, changed compatible string to
  "arm,coresight-cpu-debug".
* According to Mathieu suggestion, added "power-domains" as optional
  properties.

Changes from v2:
* According to Mathieu Poirier suggestion, applied some minor fixes.
* Added two extra patches for enabling debug module on Hikey.

Changes from v1:
* According to Mike Leach suggestion, removed the binding for debug
  module clocks which have been directly provided by CPU clocks.
* According to Mathieu Poirier suggestion, added function
  of_coresight_get_cpu() and some minor refactors for debug module
  driver.

Changes from RFC:
* According to Mike Leach suggestion, added check for EDPRSR to avoid
  lockup; added supporting EDVIDSR and EDCIDSR registers.
* According to Mark Rutland and Mathieu Poirier suggestion, rewrote
  the documentation for DT binding.
* According to Mark and Mathieu suggestion, refined debug driver.


Leo Yan (7):
  coresight: bindings for CPU debug module
  doc: Add documentation for Coresight CPU debug
  coresight: refactor with function of_coresight_get_cpu
  coresight: use const for device_node structures
  coresight: add support for CPU debug module
  arm64: dts: hi6220: register debug module
  arm64: dts: qcom: msm8916: Add debug unit

Suzuki K Poulose (1):
  coresight: of_get_coresight_platform_data: Add missing of_node_put

 Documentation/admin-guide/kernel-parameters.txt    |   7 +
 .../bindings/arm/coresight-cpu-debug.txt           |  49 ++
 Documentation/trace/coresight-cpu-debug.txt        | 173 ++++++
 arch/arm64/boot/dts/hisilicon/hi6220.dtsi          |  64 ++
 arch/arm64/boot/dts/qcom/msm8916.dtsi              |  32 +
 drivers/hwtracing/coresight/Kconfig                |  14 +
 drivers/hwtracing/coresight/Makefile               |   1 +
 drivers/hwtracing/coresight/coresight-cpu-debug.c  | 667 +++++++++++++++++++++
 drivers/hwtracing/coresight/of_coresight.c         |  44 +-
 include/linux/coresight.h                          |   6 +-
 10 files changed, 1041 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt
 create mode 100644 Documentation/trace/coresight-cpu-debug.txt
 create mode 100644 drivers/hwtracing/coresight/coresight-cpu-debug.c

-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Leo Yan April 18, 2017, 11:13 p.m. UTC | #1
Hi Mathieu,

On Tue, Apr 18, 2017 at 09:24:47AM -0600, Mathieu Poirier wrote:
> On Thu, Apr 06, 2017 at 09:30:58PM +0800, Leo Yan wrote:

> > Almost low level functions from open firmware have used const to

> > qualify device_node structures, so add const for device_node

> > parameters in of_coresight related functions.

> > 

> > Reviewed-by: Stephen Boyd <sboyd@codeaurora.org>

> > Signed-off-by: Leo Yan <leo.yan@linaro.org>

> 

> I agree with these changes but the patch needs to be split up - please see

> below.

> 

> > ---

> >  drivers/hwtracing/coresight/of_coresight.c | 6 +++---

> >  include/linux/coresight.h                  | 8 ++++----

> >  2 files changed, 7 insertions(+), 7 deletions(-)

> > 

> > diff --git a/drivers/hwtracing/coresight/of_coresight.c b/drivers/hwtracing/coresight/of_coresight.c

> > index 78d2399..46eec0f 100644

> > --- a/drivers/hwtracing/coresight/of_coresight.c

> > +++ b/drivers/hwtracing/coresight/of_coresight.c

> > @@ -52,7 +52,7 @@ of_coresight_get_endpoint_device(struct device_node *endpoint)

> >  			       endpoint, of_dev_node_match);

> >  }

> >  

> > -static void of_coresight_get_ports(struct device_node *node,

> > +static void of_coresight_get_ports(const struct device_node *node,

> >  				   int *nr_inport, int *nr_outport)

> 

> Move this to a patch by itself as it is not related to this driver.

> 

> >  {

> >  	struct device_node *ep = NULL;

> > @@ -101,7 +101,7 @@ static int of_coresight_alloc_memory(struct device *dev,

> >  	return 0;

> >  }

> >  

> > -int of_coresight_get_cpu(struct device_node *node)

> > +int of_coresight_get_cpu(const struct device_node *node)

> 

> Move this to the previous patch in this set.  There is not need to undo what you

> just did there.

> 

> >  {

> >  	int cpu;

> >  	bool found;

> > @@ -128,7 +128,7 @@ int of_coresight_get_cpu(struct device_node *node)

> >  EXPORT_SYMBOL_GPL(of_coresight_get_cpu);

> >  

> >  struct coresight_platform_data *of_get_coresight_platform_data(

> > -				struct device *dev, struct device_node *node)

> > +			struct device *dev, const struct device_node *node)

> 

> Same here, move this to a new patch (the same one as of_coresight_get_ports()).


Yeah, this is better than my form. Will change.

Thanks,
Leo Yan
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Mathieu Poirier April 19, 2017, 5:25 p.m. UTC | #2
On 6 April 2017 at 07:30, Leo Yan <leo.yan@linaro.org> wrote:
> Update kernel-parameters.txt to add new parameter:

> coresight_cpu_debug.enable is a knob to enable debugging at boot time.

>

> Add detailed documentation, which contains the implementation, Mike

> Leach excellent summary for "clock and power domain". At the end some

> examples on how to enable the debugging functionality are provided.

>

> Suggested-by: Mike Leach <mike.leach@linaro.org>

> Signed-off-by: Leo Yan <leo.yan@linaro.org>

> ---

>  Documentation/admin-guide/kernel-parameters.txt |   7 +

>  Documentation/trace/coresight-cpu-debug.txt     | 173 ++++++++++++++++++++++++

>  2 files changed, 180 insertions(+)

>  create mode 100644 Documentation/trace/coresight-cpu-debug.txt

>

> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt

> index facc20a..cf90146 100644

> --- a/Documentation/admin-guide/kernel-parameters.txt

> +++ b/Documentation/admin-guide/kernel-parameters.txt

> @@ -650,6 +650,13 @@

>                         /proc/<pid>/coredump_filter.

>                         See also Documentation/filesystems/proc.txt.

>

> +       coresight_cpu_debug.enable

> +                       [ARM,ARM64]

> +                       Format: <bool>

> +                       Enable/disable the CPU sampling based debugging.

> +                       0: default value, disable debugging

> +                       1: enable debugging at boot time

> +

>         cpuidle.off=1   [CPU_IDLE]

>                         disable the cpuidle sub-system

>

> diff --git a/Documentation/trace/coresight-cpu-debug.txt b/Documentation/trace/coresight-cpu-debug.txt

> new file mode 100644

> index 0000000..e7ad05e

> --- /dev/null

> +++ b/Documentation/trace/coresight-cpu-debug.txt

> @@ -0,0 +1,173 @@

> +               Coresight CPU Debug Module

> +               ==========================

> +

> +   Author:   Leo Yan <leo.yan@linaro.org>

> +   Date:     April 5th, 2017

> +

> +Introduction

> +------------

> +

> +Coresight CPU debug module is defined in ARMv8-a architecture reference manual

> +(ARM DDI 0487A.k) Chapter 'Part H: External debug', the CPU can integrate

> +debug module and it is mainly used for two modes: self-hosted debug and

> +external debug. Usually the external debug mode is well known as the external

> +debugger connects with SoC from JTAG port; on the other hand the program can

> +explore debugging method which rely on self-hosted debug mode, this document

> +is to focus on this part.

> +

> +The debug module provides sample-based profiling extension, which can be used

> +to sample CPU program counter, secure state and exception level, etc; usually

> +every CPU has one dedicated debug module to be connected. Based on self-hosted

> +debug mechanism, Linux kernel can access these related registers from mmio

> +region when the kernel panic happens. The callback notifier for kernel panic

> +will dump related registers for every CPU; finally this is good for assistant

> +analysis for panic.

> +

> +

> +Implementation

> +--------------

> +

> +- During driver registration, use EDDEVID and EDDEVID1 two device ID

> +  registers to decide if sample-based profiling is implemented or not. On some

> +  platforms this hardware feature is fully or partialy implemented; and if

> +  this feature is not supported then registration will fail.

> +

> +- When write this doc, the debug driver mainly relies on three sampling

> +  registers. The kernel panic callback notifier gathers info from EDPCSR

> +  EDVIDSR and EDCIDSR; from EDPCSR we can get program counter, EDVIDSR has

> +  information for secure state, exception level, bit width, etc; EDCIDSR is

> +  context ID value which contains the sampled value of CONTEXTIDR_EL1.

> +

> +- The driver supports CPU running mode with either AArch64 or AArch32. The

> +  registers naming convention is a bit different between them, AArch64 uses

> +  'ED' for register prefix (ARM DDI 0487A.k, chapter H9.1) and AArch32 uses

> +  'DBG' as prefix (ARM DDI 0487A.k, chapter G5.1). The driver is unified to

> +  use AArch64 naming convention.

> +

> +- ARMv8-a (ARM DDI 0487A.k) and ARMv7-a (ARM DDI 0406C.b) have different

> +  register bits definition. So the driver consolidates two difference:

> +

> +  If PCSROffset=0b0000. ARMv8-a doesn't apply offset on PCSR, but ARMv7-a

> +  defines "PCSR samples are offset by a value that depends on the instruction

> +  set state".


I had to look in the documentation (ID092916) a little here.  On ARMv8
if DEVID1.PCSROffset is 0 then the feature is not implemented - as
such the first part of the sentence should be corrected.  The rest of
the sentence about ARMv7 is correct.

> For ARMv7-a, the driver checks furthermore if CPU runs with ARM

> +  or thumb instruction set and calibrate PCSR value, the detailed description

> +  for offset is in ARMv7-a ARM (ARM DDI 0406C.b) chapter C11.11.34 "DBGPCSR,

> +  Program Counter Sampling Register".

> +

> +  If PCSROffset=0b0010, ARMv8-a defines "EDPCSR implemented, and samples have

> +  no offset applied and do not sample the instruction set state in AArch32

> +  state". So for the case when CPU runs with AArch32 state and PCSROffset=

> +  0b0010, the driver considers PCSR doesn't really work.


Please remove the word "really" - it either works or it doesn't.  So
on ARMv8 if DEVID1.PCSROffset is 0x2 and the CPU operates in AArch32
state, EDPCSR is not sampled.  When the CPU operates in AArch64 state
EDPCSR is sampled and no offset are applied.

> +

> +

> +Clock and power domain

> +----------------------

> +

> +Before accessing debug registers, we should ensure the clock and power domain

> +have been enabled properly. In ARMv8-a ARM (ARM DDI 0487A.k) chapter 'H9.1

> +Debug registers', the debug registers are spread into two domains: the debug

> +domain and the CPU domain.

> +

> +                                +---------------+

> +                                |               |

> +                                |               |

> +                     +----------+--+            |

> +          dbg_clk -->|          |**|            |<-- cpu_clk

> +                     |    Debug |**|   CPU      |

> +           dbg_pd -->|          |**|            |<-- cpu_pd

> +                     +----------+--+            |

> +                                |               |

> +                                |               |

> +                                +---------------+

> +

> +For debug domain, the user uses DT binding "clocks" and "power-domains" to

> +specify the corresponding clock source and power supply for the debug logic.

> +The driver calls the pm_runtime_{put|get} operations as needed to handle the

> +debug power domain.

> +

> +For CPU domain, the different SoC designs have different power management

> +schemes and finally this heavily impacts external debug module. So we can

> +divide into below cases:

> +

> +- On systems with a sane power controller which can behave correctly with

> +  respect to CPU power domain, the CPU power domain can be controlled by

> +  register EDPRCR in driver. The driver firstly writes bit EDPRCR.COREPURQ

> +  to power up the CPU, and then writes bit EDPRCR.CORENPDRQ for emulation

> +  of CPU power down. As result, this can ensure the CPU power domain is

> +  powered on properly during the period when access debug related registers;

> +

> +- Some designs will power down an entire cluster if all CPUs on the cluster

> +  are powered down - including the parts of the debug registers that should

> +  remain powered in the debug power domain. The bits in EDPRCR are not

> +  respected in these cases, so these designs do not really support debug over

> +  power down in the way that the CoreSight / Debug designers anticipated.

> +  This means that even checking EDPRSR has the potential to cause a bus hang

> +  if the target register is unpowered.

> +

> +  In this case, accessing to the debug registers while they are not powered

> +  is a recipe for disaster; so we need preventing CPU low power states at boot

> +  time or when user enable module at the run time. Please see chapter

> +  "How to use the module" for detailed usage info for this.

> +

> +

> +Device Tree Bindings

> +--------------------

> +

> +See Documentation/devicetree/bindings/arm/coresight-cpu-debug.txt for details.

> +

> +

> +How to use the module

> +---------------------

> +

> +If you want to enable debugging functionality at boot time, you can add

> +"coresight_cpu_debug.enable=1" to the kernel command line parameter.

> +

> +The driver also can work as module, so can enable the debugging when insmod

> +module:

> +# insmod coresight_cpu_debug.ko debug=1

> +

> +When boot time or insmod module you have not enabled the debugging, the driver

> +uses the debugfs file system to provide a knob to dynamically enable or disable

> +debugging:

> +

> +To enable it, write a '1' into /sys/kernel/debug/coresight_cpu_debug/enable:

> +# echo 1 > /sys/kernel/debug/coresight_cpu_debug/enable

> +

> +To disable it, write a '0' into /sys/kernel/debug/coresight_cpu_debug/enable:

> +# echo 0 > /sys/kernel/debug/coresight_cpu_debug/enable

> +

> +As explained in chapter "Clock and power domain", if you are working on one

> +platform which has idle states to power off debug logic and the power

> +controller cannot work well for the request from EDPRCR, then you should

> +firstly constraint CPU idle states before enable CPU debugging feature; so can

> +ensure the accessing to debug logic.

> +

> +If you want to limit idle states at boot time, you can use "nohlt" or

> +"cpuidle.off=1" in the kernel command line.

> +

> +At the runtime you can disable idle states with below methods:

> +

> +Set latency request to /dev/cpu_dma_latency to disable all CPUs specific idle

> +states (if latency = 0uS then disable all idle states):

> +# echo "what_ever_latency_you_need_in_uS" > /dev/cpu_dma_latency

> +

> +Disable specific CPU's specific idle state:

> +# echo 1 > /sys/devices/system/cpu/cpu$cpu/cpuidle/state$state/disable

> +

> +

> +Output format

> +-------------

> +

> +Here is an example of the debugging output format:

> +

> +ARM external debug module:

> +CPU[0]:

> + EDPRSR:  0000000b (Power:On DLK:Unlock)

> + EDPCSR:  [<ffff00000808eb54>] handle_IPI+0xe4/0x150

> + EDCIDSR: 00000000

> + EDVIDSR: 90000000 (State:Non-secure Mode:EL1/0 Width:64bits VMID:0)

> +CPU[1]:

> + EDPRSR:  0000000b (Power:On DLK:Unlock)

> + EDPCSR:  [<ffff0000087a64c0>] debug_notifier_call+0x108/0x288

> + EDCIDSR: 00000000

> + EDVIDSR: 90000000 (State:Non-secure Mode:EL1/0 Width:64bits VMID:0)

> --

> 2.7.4

>

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html