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

[Bagas Sanjaya]

On Fri, Mar 24, 2023 at 02:16:08PM +0800, Hao Zhang wrote:
> +Sysfs files and directories
> +---------------------------
> +
> +Root: ``/sys/bus/coresight/devices/dummy<N>``
> +
> +----
> +
> +:File:            ``enable_source`` (RW)
> +:Notes:
> +    - > 0 : enable the datasets of dummy source.
> +
> +    - = 0 : disable the datasets of dummy source.
> +
> +:Syntax:
> +    ``echo 1 > enable_source``
> +
> +----
> +
> +:File:            ``enable_sink`` (RW)
> +:Notes:
> +    - > 0 : enable the datasets of dummy sink.
> +
> +    - = 0 : disable the datasets of dummy sink.
> +
> +:Syntax:
> +    ``echo 1 > enable_sink``

Is enable_{source,sink} integer-valued or bit (0/1)? In other words, is
it OK to `echo 2` to both sysfs files?

> +
> +----
> +
> +Config details
> +---------------------------
> +
> +There are two types of nodes, dummy sink and dummy source. The nodes
> +should be observed at the coresight path
> +"/sys/bus/coresight/devices".

For consistency, inline this sysfs also (thus
``/sys/bus/coresight/devices``.

> +e.g.
e.g.:: (make the shell snippet below code block)
> +/sys/bus/coresight/devices # ls -l | grep dummy
IMO I prefer `PS1=\$` (that is, omit the directory). Alternatively,
you can write `ls -l /sys/bus/coresight/devices | grep dummy` (specify
the directory to `ls`).

Thanks.

-- 
An old man doll... just what I always wanted! - Clara
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20230327/ae0bef0a/attachment.sig>