James Clark
774daad3c0
Documentation: coresight: Expand branch broadcast documentation
...
Now that there is a way of enabling branch broadcast via perf, mention
the possible use cases and known limitations.
Signed-off-by: James Clark <james.clark@arm.com >
Reviewed-by: Mike Leach<mike.leach@linaro.org >
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Link: https://lore.kernel.org/r/20220511144601.2257870-5-james.clark@arm.com
2022-07-06 16:32:08 +01:00
James Clark
32ee00d86e
Documentation: coresight: Link config options to existing documentation
...
In order to document the newly added branch_broadcast option, create a
table that links all of the config option formats to any existing docs.
That way when the branch broadcast docs are expanded they are accessible
from both places.
Signed-off-by: James Clark <james.clark@arm.com >
Reviewed-by: Mike Leach <mike.leach@linaro.org >
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Link: https://lore.kernel.org/r/20220511144601.2257870-4-james.clark@arm.com
2022-07-06 16:32:08 +01:00
James Clark
bcc5834fba
Documentation: coresight: Turn numbered subsections into real subsections
...
This is to allow them to be referenced in a later commit. There was
also a mistake where sysFS was introduced as section 2, but numbered
as section 1. And vice versa for 'Using perf framework'. This can't
happen with unnumbered sections.
Signed-off-by: James Clark <james.clark@arm.com >
Reviewed-by: Mike Leach <mike.leach@linaro.org >
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Link: https://lore.kernel.org/r/20220511144601.2257870-3-james.clark@arm.com
2022-07-06 16:32:08 +01:00
Bagas Sanjaya
c06475910b
Documentation: coresight: Escape coresight bindings file wildcard
...
Stephen Rothwell reported htmldocs warning:
Documentation/trace/coresight/coresight.rst:133: WARNING: Inline emphasis start-string without end-string.
The warning above is due to unescaped wildcard asterisk (*) on CoreSight
devicetree binding filename, which confuses Sphinx as emphasis instead.
Escape the wildcard to fix the warning.
Link: https://lore.kernel.org/linux-next/20220630173801.41bf22a2@canb.auug.org.au/
Fixes: 3c15fddf31 ("dt-bindings: arm: Convert CoreSight bindings to DT schema")
Cc: Mathieu Poirier <mathieu.poirier@linaro.org >
Cc: Suzuki K Poulose <suzuki.poulose@arm.com >
Cc: Mike Leach <mike.leach@linaro.org >
Cc: Leo Yan <leo.yan@linaro.org >
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: Rob Herring <robh@kernel.org >
Cc: coresight@lists.linaro.org
Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-next@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au >
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com >
Link: https://lore.kernel.org/r/20220630101317.102680-1-bagasdotme@gmail.com
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
2022-06-30 10:51:13 -06:00
Rob Herring
3c15fddf31
dt-bindings: arm: Convert CoreSight bindings to DT schema
...
Each CoreSight component has slightly different requirements and
nothing applies to every component, so each CoreSight component has its
own schema document.
Signed-off-by: Rob Herring <robh@kernel.org >
Reviewed-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Link: https://lore.kernel.org/r/20220603011933.3277315-3-robh@kernel.org
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
2022-06-29 10:22:29 -06:00
Mike Leach
f9809d5651
Documentation: coresight: Update coresight configuration docs
...
Update the CoreSight System Configuration document to cover the
use of loadable modules to add configurations and features
to the system.
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Link: https://lore.kernel.org/r/20211124200038.28662-7-mike.leach@linaro.org
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
2021-11-26 11:34:39 -07:00
Mike Leach
66bd1333ab
Documentation: coresight: Fix documentation issue
...
Fix the description of the directories and attributes used
in cs_etm as used by perf.
Drop the references to the 'configurations' sub-directory which
had been removed in an earlier version of the patchset.
Fixes: f71cd93d5e ("Documentation: coresight: Add documentation for CoreSight config")
Reported-by: German Gomex <german.gomez@arm.com >
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Link: https://lore.kernel.org/r/20211117164220.14883-1-mike.leach@linaro.org
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
2021-11-18 09:40:41 -07:00
Mike Leach
f71cd93d5e
Documentation: coresight: Add documentation for CoreSight config
...
Adds documentation for the CoreSight System configuration manager.
Link: https://lore.kernel.org/r/20210723165444.1048-11-mike.leach@linaro.org
[Fixed coresight-config.rst documentation link]
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/20210818194022.379573-11-mathieu.poirier@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2021-08-18 22:33:28 +02:00
Mauro Carvalho Chehab
e480336c25
docs: trace: coresight: coresight.rst: avoid using ReST :doc:foo markup
...
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/c79be625f7c90468e13d5380f0e4e1c1ccfa2fc8.1623824363.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-06-17 13:24:39 -06:00
Mauro Carvalho Chehab
90f40f514f
docs: trace: coresight: coresight-etm4x-reference.rst: replace some characters
...
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.
Replace the occurences of the following characters:
- U+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/b6a04e881bc80a3c1d3d23ccbc8208ca3c9053fd.1623826294.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-06-17 13:22:33 -06:00
Anshuman Khandual
4af4321861
Documentation: trace: Add documentation for TRBE
...
Add documentation for the TRBE under trace/coresight.
Cc: Jonathan Corbet <corbet@lwn.net >
Cc: linux-doc@vger.kernel.org
Signed-off-by: Anshuman Khandual <anshuman.khandual@arm.com >
[ Split from the TRBE driver patch ]
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Link: https://lore.kernel.org/r/20210405164307.1720226-20-suzuki.poulose@arm.com
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
2021-04-06 16:05:38 -06:00
Leo Yan
06c18e28c4
Documentation: coresight: Add PID tracing description
...
After support the PID tracing for the kernel in EL1 or EL2, the usage
gets more complicated.
This patch gives description for the PMU formats of contextID configs,
this can help users to understand how to control the knobs for PID
tracing when the kernel is in different ELs.
Reviewed-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Reviewed-by: Mike Leach <mike.leach@linaro.org >
Signed-off-by: Leo Yan <leo.yan@linaro.org >
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/20210206150833.42120-9-leo.yan@linaro.org
Link: https://lore.kernel.org/r/20210211172038.2483517-4-mathieu.poirier@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2021-02-11 18:31:48 +01:00
Mauro Carvalho Chehab
7f06a1c989
docs: trace: coresight-ect.rst: Fix a build warning
...
Sphinx wants a line after "..", as otherwise it complains with:
Documentation/trace/coresight/coresight-ect.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/20200518180242.7916-8-mathieu.poirier@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2020-05-19 16:31:16 +02:00
Mike Leach
5153e57bf8
coresight: docs: Add information about the topology representations
...
Update the CoreSight documents to describe the new connections directory
and the links between CoreSight devices in this directory.
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/20200518180242.7916-7-mathieu.poirier@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2020-05-19 16:31:16 +02:00
Mike Leach
82e0c782f8
docs: coresight: Update documentation for CoreSight to cover CTI
...
Add new document covering CTI / CTM usage in CoreSight.
Add section in coresight.rst introducing CTI and CTM modules with link
to new document.
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Reviewed-by: Suzuki K Poulose <suzuki.poulose@arm.com >
Reviewed-by: Randy Dunlap <rdunlap@infradead.org >
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Link: https://lore.kernel.org/r/20200320165303.13681-11-mathieu.poirier@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2020-03-21 11:32:21 +01:00
Mike Leach
f0ae2cfae5
coresight: etm4x: docs: Adds detailed document for programming etm4x.
...
Add in detailed programmers reference for users wanting to program the
CoreSight ETM 4.x driver using sysfs.
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2019-11-07 13:17:26 -07:00
Mike Leach
8adf42e293
coresight: docs: Create common sub-directory for coresight trace.
...
There are two files in the Documentation/trace directory relating to
coresight, with more to follow, so create a Documentation/trace/coresight
directory and move existing files there. Fixup index to reference
new location.
Update MAINTAINERS to reference this sub-directory rather than the
individual files.
Signed-off-by: Mike Leach <mike.leach@linaro.org >
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2019-11-07 13:17:26 -07:00