Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <82aab1d7-0157-983a-5f92-3dcd1e04fe23@quicinc.com>
Date:   Fri, 12 May 2023 15:51:34 +0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.0
Subject: Re: [PATCH v3 3/3] Documentation: trace: Add documentation for
 Coresight Dummy Trace
To:     Bagas Sanjaya <bagasdotme@gmail.com>,
        Suzuki K Poulose <suzuki.poulose@arm.com>,
        Mike Leach <mike.leach@linaro.org>,
        Leo Yan <leo.yan@linaro.org>,
        Alexander Shishkin <alexander.shishkin@linux.intel.com>,
        Mathieu Poirier <mathieu.poirier@linaro.org>,
        Konrad Dybcio <konradybcio@gmail.com>,
        "Rob Herring" <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Andy Gross <agross@kernel.org>,
        "Paul Walmsley" <paul.walmsley@sifive.com>,
        Palmer Dabbelt <palmer@dabbelt.com>,
        Albert Ou <aou@eecs.berkeley.edu>,
        Jonathan Corbet <corbet@lwn.net>
CC:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        <coresight@lists.linaro.org>,
        <linux-arm-kernel@lists.infradead.org>,
        <linux-kernel@vger.kernel.org>, <devicetree@vger.kernel.org>,
        Tingwei Zhang <quic_tingweiz@quicinc.com>,
        Jinlong Mao <quic_jinlmao@quicinc.com>,
        "Yuanfang Zhang" <quic_yuanfang@quicinc.com>,
        Tao Zhang <quic_taozha@quicinc.com>,
        Trilok Soni <quic_tsoni@quicinc.com>,
        <linux-arm-msm@vger.kernel.org>,
        "Bjorn Andersson" <andersson@kernel.org>,
        <linux-doc@vger.kernel.org>
References: <20230422073714.38844-1-quic_hazha@quicinc.com>
 <20230422073714.38844-4-quic_hazha@quicinc.com> <ZFsdvCuTTEkTm9VA@debian.me>
Content-Language: en-US
From:   Hao Zhang <quic_hazha@quicinc.com>
In-Reply-To: <ZFsdvCuTTEkTm9VA@debian.me>
Content-Type: text/plain; charset="UTF-8"; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

Hi Bagas,

On 5/10/2023 12:29 PM, Bagas Sanjaya wrote:
> On Sat, Apr 22, 2023 at 03:37:14PM +0800, Hao Zhang wrote:
>> +Introduction
>> +---------------------------
>> +
>> +Coresight Dummy Trace Module is for the specific devices that kernel
>> +don't have permission to access or configure, e.g., CoreSight TPDMs
>> +on Qualcomm platforms. So there need driver to register dummy devices
>> +as Coresight devices. It may also be used to define components that
>> +may not have any programming interfaces (e.g, static links), so that
>> +paths can be established in the driver. 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.
>> +
>> +Config details
>> +---------------------------
>> +
>> +There are two types of nodes, dummy sink and dummy source. The nodes
>> +should be observed at the below coresight path::
>> +
>> +    ``/sys/bus/coresight/devices``.
>> +
>> +e.g.::
>> +
>> +    / $ ls -l /sys/bus/coresight/devices | grep dummy
>> +    dummy0 -> ../../../devices/platform/soc@0/soc@0:dummy_source/dummy0
>> +    dummy1 -> ../../../devices/platform/soc@0/soc@0:dummy_sink/dummy1
> 
> The wording confuses me, so I have to make the improv:
> 
> ---- >8 ----
> diff --git a/Documentation/trace/coresight/coresight-dummy.rst b/Documentation/trace/coresight/coresight-dummy.rst
> index 7cb59f080c8892..f0a92669288b0c 100644
> --- a/Documentation/trace/coresight/coresight-dummy.rst
> +++ b/Documentation/trace/coresight/coresight-dummy.rst
> @@ -8,27 +8,25 @@ Coresight Dummy Trace Module
>       :Date:     May 2023
>   
>   Introduction
> ----------------------------
> +------------
>   
> -Coresight Dummy Trace Module is for the specific devices that kernel
> -don't have permission to access or configure, e.g., CoreSight TPDMs
> -on Qualcomm platforms. So there need driver to register dummy devices
> -as Coresight devices. It may also be used to define components that
> -may not have any programming interfaces (e.g, static links), so that
> -paths can be established in the driver. 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.
> +The Coresight dummy trace module is for the specific devices that kernel don't
> +have permission to access or configure, e.g., CoreSight TPDMs on Qualcomm
> +platforms. For these devices, a dummy driver is needed to register them as
> +Coresight devices. The module may also be used to define components that may
> +not have any programming interfaces (e.g, static links), so that paths can be
> +created in the driver. It provides Coresight API for operations on dummy
> +devices, such as enabling and disabling them. It also provides the Coresight
> +dummy sink/source paths for debugging.
>   
>   Config details
> ----------------------------
> +--------------
>   
> -There are two types of nodes, dummy sink and dummy source. The nodes
> -should be observed at the below coresight path::
> +There are two types of nodes, dummy sink and dummy source. These nodes
> +are available at ``/sys/bus/coresight/devices``.
>   
> -    ``/sys/bus/coresight/devices``.
> +Example output::
>   
> -e.g.::
> -
> -    / $ ls -l /sys/bus/coresight/devices | grep dummy
> +    $ ls -l /sys/bus/coresight/devices | grep dummy
>       dummy_sink0 -> ../../../devices/platform/soc@0/soc@0:sink/dummy_sink0
>       dummy_source0 -> ../../../devices/platform/soc@0/soc@0:source/dummy_source0
> 
> Thanks.
> 

Thanks for your review and comments, will update it in the next patch 
series.

Thanks,
Hao