From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CD0A4C77B60 for ; Fri, 24 Mar 2023 11:01:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231445AbjCXLBE (ORCPT ); Fri, 24 Mar 2023 07:01:04 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52468 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230213AbjCXLBC (ORCPT ); Fri, 24 Mar 2023 07:01:02 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id F32D7244B4; Fri, 24 Mar 2023 04:01:00 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id B088411FB; Fri, 24 Mar 2023 04:01:44 -0700 (PDT) Received: from [10.57.55.150] (unknown [10.57.55.150]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id E54483F6C4; Fri, 24 Mar 2023 04:00:56 -0700 (PDT) Message-ID: Date: Fri, 24 Mar 2023 11:00:55 +0000 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0) Gecko/20100101 Thunderbird/102.9.0 Subject: Re: [PATCH v2 3/3] Documentation: trace: Add documentation for Coresight Dummy Trace To: Hao Zhang , Mathieu Poirier , Alexander Shishkin , Konrad Dybcio , Mike Leach , Rob Herring , Krzysztof Kozlowski , Andy Gross , Paul Walmsley , Palmer Dabbelt , Albert Ou , Jonathan Corbet Cc: Leo Yan , Greg Kroah-Hartman , coresight@lists.linaro.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, Tingwei Zhang , Jinlong Mao , Yuanfang Zhang , Tao Zhang , Trilok Soni , linux-arm-msm@vger.kernel.org, Bjorn Andersson , linux-doc@vger.kernel.org References: <20230324061608.33609-1-quic_hazha@quicinc.com> <20230324061608.33609-4-quic_hazha@quicinc.com> From: Suzuki K Poulose In-Reply-To: <20230324061608.33609-4-quic_hazha@quicinc.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 24/03/2023 06:16, Hao Zhang wrote: > Add documentation for Coresight Dummy Trace under trace/coresight. > > Signed-off-by: Hao Zhang > --- > .../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 > + :Date: March 2023 > + > +Introduction > +--------------------------- > + > +Coresight Dummy Trace Module is for the specific devices that HLOS don't Please do not use cryptic abbreviations, please use "kernel" > +have permission to access or configure. Such as Coresight sink EUD, some > +TPDMs etc. Say "e.g., CoreSight TPDMs on Qualcomm platforms.: So there need driver to register dummy devices as Coresight > +devices. Add: "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. I think the following content may not be needed as they are part of the standard source/sink type devices, nothing specific to dummy devices. --- vvvvv --- > + > +Sysfs files and directories > +--------------------------- > + > +Root: ``/sys/bus/coresight/devices/dummy`` > + > +---- > + > +: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`` > + > +---- > + --- You may remove the above ^^^ ---- > +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". > +e.g. > +/sys/bus/coresight/devices # ls -l | grep dummy > +dummy0 -> ../../../devices/platform/soc@0/soc@0:dummy_source/dummy0 > +dummy1 -> ../../../devices/platform/soc@0/soc@0:dummy_sink/dummy1 Suzuki