Re: [PATCH v2 3/3] Documentation: trace: Add documentation for Coresight Dummy Trace

[Greg Kroah-Hartman <gregkh@linuxfoundation.org>]

On Fri, Mar 24, 2023 at 02:16:08PM +0800, Hao Zhang wrote:
> Add documentation for Coresight Dummy Trace under trace/coresight.
> 
> Signed-off-by: Hao Zhang <quic_hazha@quicinc.com>
> ---
>  .../trace/coresight/coresight-dummy.rst       | 58 +++++++++++++++++++
>  1 file changed, 58 insertions(+)
>  create mode 100644 Documentation/trace/coresight/coresight-dummy.rst
> 
> diff --git a/Documentation/trace/coresight/coresight-dummy.rst b/Documentation/trace/coresight/coresight-dummy.rst
> new file mode 100644
> index 000000000000..819cabab8623
> --- /dev/null
> +++ b/Documentation/trace/coresight/coresight-dummy.rst
> @@ -0,0 +1,58 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=============================
> +Coresight Dummy Trace Module
> +=============================
> +
> +    :Author:   Hao Zhang <quic_hazha@quicinc.com>
> +    :Date:     March 2023
> +
> +Introduction
> +---------------------------
> +
> +Coresight Dummy Trace Module is for the specific devices that HLOS don't
> +have permission to access or configure. Such as Coresight sink EUD, some
> +TPDMs etc. So there need driver to register dummy devices as Coresight
> +devices. Provide Coresight API for dummy device operations, such as
> +enabling and disabling dummy devices. Build the Coresight path for dummy
> +sink or dummy source for debugging.
> +
> +Sysfs files and directories
> +---------------------------
> +
> +Root: ``/sys/bus/coresight/devices/dummy<N>``

sysfs files are documented in Documentation/ABI/ not in random .rst
files, sorry.  Please use the correct format described there, not a
random one like this :)

thanks,

greg k-h