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 6ADA5C433FE for ; Fri, 21 Jan 2022 12:50:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1380484AbiAUMuE (ORCPT ); Fri, 21 Jan 2022 07:50:04 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49756 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1346928AbiAUMuD (ORCPT ); Fri, 21 Jan 2022 07:50:03 -0500 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C87CBC061401 for ; Fri, 21 Jan 2022 04:50:02 -0800 (PST) Received: by mail-wm1-x32f.google.com with SMTP id c2so17786111wml.1 for ; Fri, 21 Jan 2022 04:50:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=8WnVlLCad+BTJhIq1dYyjRwPU8yt5oqicLvPToifnLY=; b=ozMEk0hea1zS5Y3gEF5I0OxJbZApnPGXQN5yxCoUM1ZaTRgmEnhgT484AY3aqP03CR sGyWgMkDPHMZmm0ggm39/6hqhQ+L59bkU+PvId3JKs/UvRAFzFGbL0eg/ajSJNXomqpg xL/U7skkjwbL+c/aAQvydDx7expBjDvvULOtP/7lktsgke/CZPAZNCANAhBWE/JQTReT ppHSnxOwqnXco7iYDYuueD5V8AOHdoAr/sO4H4OyLjIcUS0lRve72Nyd1BAGkumQRRmK gadYVgsFJ8FGErL8y9XTplrskdebK1Cf5ESiDKFX7gAokPO0QA241XNezcnRcfpyY5HL U1gg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=8WnVlLCad+BTJhIq1dYyjRwPU8yt5oqicLvPToifnLY=; b=yc7vx1rezFyHVTBK8F6GjV5Lt9ATNlGIaN9xehjiA+nyUtRJs2ifToJA8AiHParRay 3TDZekhr5wnDEVvJ847ippBiGagcEBztnoV9bUimznp8Mi0IGVa+AZWR5yLct1hOBkqP mPk9CZLQC2PvH1+aF+UvTrb2fb9YX6o8h0VUG0rUA5wCZ1S8Na59j5VZZuNwELdYkHt/ WgI7qnZYKJyco3PTQwRGJYah89npyvq3nK07IjG3pfcwuk8ott7OPOn2JAn4RW3Acnzq smgrK08+WZq9uBMRtDKkSiUe+eIuttChb1GesJJci5wipqUNjq5b4cnVod8AzdQt3B6a 2qBw== X-Gm-Message-State: AOAM533LxOViZaxfRe7Z3ZIaoxVEVRLpRax3SX02KXLuAky05DPnaIj8 s9rkdU5uNIopCOLdImgXPxq192c0NP+/r/MZ0lK+3A== X-Google-Smtp-Source: ABdhPJzzbzZ/20qfk+1Vkh9zB6guw8awdzHtefTn02lW4V4lNLfILOv7KJowBpV6DKCtyC6Sz/6TEhNvyzxIJ3Cv8/I= X-Received: by 2002:adf:df84:: with SMTP id z4mr3717112wrl.519.1642769401342; Fri, 21 Jan 2022 04:50:01 -0800 (PST) MIME-Version: 1.0 References: <20220113091056.1297982-1-james.clark@arm.com> <20220113091056.1297982-6-james.clark@arm.com> In-Reply-To: <20220113091056.1297982-6-james.clark@arm.com> From: Mike Leach Date: Fri, 21 Jan 2022 12:49:50 +0000 Message-ID: Subject: Re: [PATCH v2 5/6] Documentation: coresight: Link config options to existing documentation To: James Clark Cc: suzuki.poulose@arm.com, mathieu.poirier@linaro.org, coresight@lists.linaro.org, leo.yan@linaro.com, Leo Yan , John Garry , Will Deacon , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Reviewed-by: Mike Leach On Thu, 13 Jan 2022 at 09:11, James Clark wrote: > > 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 > --- > .../coresight/coresight-etm4x-reference.rst | 4 ++ > Documentation/trace/coresight/coresight.rst | 39 +++++++++++++++++++ > 2 files changed, 43 insertions(+) > > diff --git a/Documentation/trace/coresight/coresight-etm4x-reference.rst b/Documentation/trace/coresight/coresight-etm4x-reference.rst > index d25dfe86af9b..0439b4006227 100644 > --- a/Documentation/trace/coresight/coresight-etm4x-reference.rst > +++ b/Documentation/trace/coresight/coresight-etm4x-reference.rst > @@ -650,6 +650,7 @@ Bit assignments shown below:- > parameter is set this value is applied to the currently indexed > address range. > > +.. _coresight-branch-broadcast: > > **bit (4):** > ETM_MODE_BB > @@ -657,6 +658,7 @@ Bit assignments shown below:- > **description:** > Set to enable branch broadcast if supported in hardware [IDR0]. > > +.. _coresight-cycle-accurate: > > **bit (5):** > ETMv4_MODE_CYCACC > @@ -678,6 +680,7 @@ Bit assignments shown below:- > **description:** > Set to enable virtual machine ID tracing if supported [IDR2]. > > +.. _coresight-timestamp: > > **bit (11):** > ETMv4_MODE_TIMESTAMP > @@ -685,6 +688,7 @@ Bit assignments shown below:- > **description:** > Set to enable timestamp generation if supported [IDR0]. > > +.. _coresight-return-stack: > > **bit (12):** > ETM_MODE_RETURNSTACK > diff --git a/Documentation/trace/coresight/coresight.rst b/Documentation/trace/coresight/coresight.rst > index db66ff45ff4c..803a224dbb0e 100644 > --- a/Documentation/trace/coresight/coresight.rst > +++ b/Documentation/trace/coresight/coresight.rst > @@ -585,6 +585,45 @@ sort example is from the AutoFDO tutorial (https://gcc.gnu.org/wiki/AutoFDO/Tuto > Bubble sorting array of 30000 elements > 5806 ms > > +Config option formats > +~~~~~~~~~~~~~~~~~~~~~ > + > +The following strings can be provided between // on the perf command line to enable various options. > +They are also listed in the folder /sys/bus/event_source/devices/cs_etm/format/ > + > +.. list-table:: > + :header-rows: 1 > + > + * - Option > + - Description > + * - branch_broadcast > + - Session local version of the system wide setting: > + :ref:`ETM_MODE_BB ` > + * - contextid > + - See `Tracing PID`_ > + * - contextid1 > + - See `Tracing PID`_ > + * - contextid2 > + - See `Tracing PID`_ > + * - configid > + - Selection for a custom configuration. This is an implementation detail and not used directly, > + see :ref:`trace/coresight/coresight-config:Using Configurations in perf` > + * - preset > + - Override for parameters in a custom configuration, see > + :ref:`trace/coresight/coresight-config:Using Configurations in perf` > + * - sinkid > + - Hashed version of the string to select a sink, automatically set when using the @ notation. > + This is an internal implementation detail and is not used directly, see `Using perf > + framework`_. > + * - cycacc > + - Session local version of the system wide setting: :ref:`ETMv4_MODE_CYCACC > + ` > + * - retstack > + - Session local version of the system wide setting: :ref:`ETM_MODE_RETURNSTACK > + ` > + * - timestamp > + - Session local version of the system wide setting: :ref:`ETMv4_MODE_TIMESTAMP > + ` > > How to use the STM module > ------------------------- > -- > 2.28.0 > -- Mike Leach Principal Engineer, ARM Ltd. Manchester Design Centre. UK 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 bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 07852C433EF for ; Fri, 21 Jan 2022 12:51:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:Cc:To:Subject:Message-ID:Date:From: In-Reply-To:References:MIME-Version:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=slDfAr09hVxUuryLJk1ZB89RTaSMzgPZMuA9G7c/Kfg=; b=lL8DsBZAoocDFw KoEOOJowZoUuNgdSFOmYGetDKO73r39FPC+YyHMcrd8gcD5P13EfmNhzqhwKYRf7OJrkgPdsOSxbb pbTT06LXIUthZ4XVyA5W7+dz+uIXLxuIliYgh0ly3g/WKDNbazYzhfJvOhKcTgn00KQiHM59P8wMN GPMHq99Zk6c1gW9CC7uzhgjrUBf9chSEXlmeteZD8paPYLfy3vsZV6Ty/B6cfiWHeXgCEGOdZqXOX +39X/3NAUarLyBdurmEHJk+cDSfj/wF4zZA59nHAAiz139wgfjaJeTiksJ6vSpHiqDmL1FNlCCSDp cY4gZciHGDEo2opv4ddw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1nAtMl-00F02t-Eh; Fri, 21 Jan 2022 12:50:07 +0000 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1nAtMh-00F01T-3e for linux-arm-kernel@lists.infradead.org; Fri, 21 Jan 2022 12:50:04 +0000 Received: by mail-wm1-x32e.google.com with SMTP id i187-20020a1c3bc4000000b0034d2ed1be2aso27343612wma.1 for ; Fri, 21 Jan 2022 04:50:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=8WnVlLCad+BTJhIq1dYyjRwPU8yt5oqicLvPToifnLY=; b=ozMEk0hea1zS5Y3gEF5I0OxJbZApnPGXQN5yxCoUM1ZaTRgmEnhgT484AY3aqP03CR sGyWgMkDPHMZmm0ggm39/6hqhQ+L59bkU+PvId3JKs/UvRAFzFGbL0eg/ajSJNXomqpg xL/U7skkjwbL+c/aAQvydDx7expBjDvvULOtP/7lktsgke/CZPAZNCANAhBWE/JQTReT ppHSnxOwqnXco7iYDYuueD5V8AOHdoAr/sO4H4OyLjIcUS0lRve72Nyd1BAGkumQRRmK gadYVgsFJ8FGErL8y9XTplrskdebK1Cf5ESiDKFX7gAokPO0QA241XNezcnRcfpyY5HL U1gg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=8WnVlLCad+BTJhIq1dYyjRwPU8yt5oqicLvPToifnLY=; b=zsSqN+83r+I4wgwRQ1vGnfRUL9QoFqKZYShEUEowNuB4Se05AvwsA4PXWW2r9zS9yC G+GwMC4ZvqwswpJlH6p9wMLEtY033jCs5C8XDFebhBY/itrE4kShfxOpjpzzhl+OhAzm qbQUu0SvCrmx4hIGbGMhwNYAsQAotmlrwnJjOd52/F+ZfXUVXe8JZdw+b1YMjwEqZ7ST oqbIYLlQdwrIzMlTNZZqtE0HKj+DZP4e7WQ6AOd/X7LvIzKJGZaAqwK13S546ZeCNen/ 6ZqwPC7i5jVydo/U/ZatMi9UXM9F6BxvNjPjy4GNmRWrTRCQV9MdpBcqzK3CvRgDrUMz nymw== X-Gm-Message-State: AOAM532QYtGjenAmvUKL7kyRu5+H8nrKV5vyiICxvGeUtqWPqAGF3BhY AfdRZ84ITc0ZyjCY+A5Bz4Rmd8d2LSfCZpsqO3xEww== X-Google-Smtp-Source: ABdhPJzzbzZ/20qfk+1Vkh9zB6guw8awdzHtefTn02lW4V4lNLfILOv7KJowBpV6DKCtyC6Sz/6TEhNvyzxIJ3Cv8/I= X-Received: by 2002:adf:df84:: with SMTP id z4mr3717112wrl.519.1642769401342; Fri, 21 Jan 2022 04:50:01 -0800 (PST) MIME-Version: 1.0 References: <20220113091056.1297982-1-james.clark@arm.com> <20220113091056.1297982-6-james.clark@arm.com> In-Reply-To: <20220113091056.1297982-6-james.clark@arm.com> From: Mike Leach Date: Fri, 21 Jan 2022 12:49:50 +0000 Message-ID: Subject: Re: [PATCH v2 5/6] Documentation: coresight: Link config options to existing documentation To: James Clark Cc: suzuki.poulose@arm.com, mathieu.poirier@linaro.org, coresight@lists.linaro.org, leo.yan@linaro.com, Leo Yan , John Garry , Will Deacon , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220121_045003_189944_BF1AAF10 X-CRM114-Status: GOOD ( 21.58 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Reviewed-by: Mike Leach On Thu, 13 Jan 2022 at 09:11, James Clark wrote: > > 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 > --- > .../coresight/coresight-etm4x-reference.rst | 4 ++ > Documentation/trace/coresight/coresight.rst | 39 +++++++++++++++++++ > 2 files changed, 43 insertions(+) > > diff --git a/Documentation/trace/coresight/coresight-etm4x-reference.rst b/Documentation/trace/coresight/coresight-etm4x-reference.rst > index d25dfe86af9b..0439b4006227 100644 > --- a/Documentation/trace/coresight/coresight-etm4x-reference.rst > +++ b/Documentation/trace/coresight/coresight-etm4x-reference.rst > @@ -650,6 +650,7 @@ Bit assignments shown below:- > parameter is set this value is applied to the currently indexed > address range. > > +.. _coresight-branch-broadcast: > > **bit (4):** > ETM_MODE_BB > @@ -657,6 +658,7 @@ Bit assignments shown below:- > **description:** > Set to enable branch broadcast if supported in hardware [IDR0]. > > +.. _coresight-cycle-accurate: > > **bit (5):** > ETMv4_MODE_CYCACC > @@ -678,6 +680,7 @@ Bit assignments shown below:- > **description:** > Set to enable virtual machine ID tracing if supported [IDR2]. > > +.. _coresight-timestamp: > > **bit (11):** > ETMv4_MODE_TIMESTAMP > @@ -685,6 +688,7 @@ Bit assignments shown below:- > **description:** > Set to enable timestamp generation if supported [IDR0]. > > +.. _coresight-return-stack: > > **bit (12):** > ETM_MODE_RETURNSTACK > diff --git a/Documentation/trace/coresight/coresight.rst b/Documentation/trace/coresight/coresight.rst > index db66ff45ff4c..803a224dbb0e 100644 > --- a/Documentation/trace/coresight/coresight.rst > +++ b/Documentation/trace/coresight/coresight.rst > @@ -585,6 +585,45 @@ sort example is from the AutoFDO tutorial (https://gcc.gnu.org/wiki/AutoFDO/Tuto > Bubble sorting array of 30000 elements > 5806 ms > > +Config option formats > +~~~~~~~~~~~~~~~~~~~~~ > + > +The following strings can be provided between // on the perf command line to enable various options. > +They are also listed in the folder /sys/bus/event_source/devices/cs_etm/format/ > + > +.. list-table:: > + :header-rows: 1 > + > + * - Option > + - Description > + * - branch_broadcast > + - Session local version of the system wide setting: > + :ref:`ETM_MODE_BB ` > + * - contextid > + - See `Tracing PID`_ > + * - contextid1 > + - See `Tracing PID`_ > + * - contextid2 > + - See `Tracing PID`_ > + * - configid > + - Selection for a custom configuration. This is an implementation detail and not used directly, > + see :ref:`trace/coresight/coresight-config:Using Configurations in perf` > + * - preset > + - Override for parameters in a custom configuration, see > + :ref:`trace/coresight/coresight-config:Using Configurations in perf` > + * - sinkid > + - Hashed version of the string to select a sink, automatically set when using the @ notation. > + This is an internal implementation detail and is not used directly, see `Using perf > + framework`_. > + * - cycacc > + - Session local version of the system wide setting: :ref:`ETMv4_MODE_CYCACC > + ` > + * - retstack > + - Session local version of the system wide setting: :ref:`ETM_MODE_RETURNSTACK > + ` > + * - timestamp > + - Session local version of the system wide setting: :ref:`ETMv4_MODE_TIMESTAMP > + ` > > How to use the STM module > ------------------------- > -- > 2.28.0 > -- Mike Leach Principal Engineer, ARM Ltd. Manchester Design Centre. UK _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel