From patchwork Fri May 7 13:08:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Guangbin Huang X-Patchwork-Id: 12244557 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.4 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 59890C433B4 for ; Fri, 7 May 2021 13:12:59 +0000 (UTC) Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B06FC61466 for ; Fri, 7 May 2021 13:12:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org B06FC61466 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=huawei.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=desiato.20200630; h=Sender:Content-Transfer-Encoding :Content-Type:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-ID:Date: Subject:CC:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=0oooMz9V62WaC79WDZIQRVWE6CC1FlfOxLXHuSyxJUA=; b=pkMZiA4LRtr6kGCOI7oE5frnn kJRGtISYh0JMXBPou3Z+yBidhA2b8E+591fWyL4SITAroLKtWNZlmx0RR1r0/a+M92taYqj4zuTIS 8xYUCTCE/LxI4yabvVm1ptO4in4D3teSvWcX9GbhCLYyc2U3g23tS49PvhdgMul8ITGwKwvEe/tLG aMe7ayS+vZspap4TyLlgZSGVmGIJYPO0NXrxMQVYyElfpeZojqYcf2leQAjXBnEOpQAlCQhyo5TjF OittivpT9amWAdc7Kbow0HSPIRnKWBg96lZ2mdEEMb6jdcWKwUE5t1Ap2XQVKxAHaswGmml9dpeb4 8T73K7/tQ==; Received: from localhost ([::1] helo=desiato.infradead.org) by desiato.infradead.org with esmtp (Exim 4.94 #2 (Red Hat Linux)) id 1lf0GL-0077Mo-Fx; Fri, 07 May 2021 13:11:25 +0000 Received: from bombadil.infradead.org ([2607:7c80:54:e::133]) by desiato.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lf0G9-0077M2-Ha for linux-arm-kernel@desiato.infradead.org; Fri, 07 May 2021 13:11:13 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Type:MIME-Version:References: In-Reply-To:Message-ID:Date:Subject:CC:To:From:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description; bh=7sxEHkKJ/7CEqBHJZytFdSwtlJiXzIsYiZTtwxOSTPU=; b=sJYlOcQ6mekrFGZfoy01Ud3257 YgpVavgoASXl5nRWiyVgK5r4htmApCfwBdrckwgBJMz2GDxWhVPN0fYHxsR9aGuQt+7P+VcxLM3Zt wkjA8GUkBf4heY3CXAO9cyBBrdHSyVmoIC3/NbptREh20NBf3mq/AxNneoVmX2TtgaWibsX1v+pn5 RevykyYbnZCSPsZu7Wp0Hd69h5saQEYnWkpsHyZNIdR30xI/MigHHTxLXF8hVUc5pum3p77GnKt4h TnXrfXZNxxjeqfNKAEfTjkOE7YLzoTM9RjnYDinJpJB/GodgDl0LdaVFiHfoMpA/POcgj/GwAbatx 73JZkN0w==; Received: from szxga07-in.huawei.com ([45.249.212.35]) by bombadil.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lf0G5-006sNS-If for linux-arm-kernel@lists.infradead.org; Fri, 07 May 2021 13:11:12 +0000 Received: from DGGEMS405-HUB.china.huawei.com (unknown [172.30.72.58]) by szxga07-in.huawei.com (SkyGuard) with ESMTP id 4Fc9jy4GW3zCqyb; Fri, 7 May 2021 21:08:22 +0800 (CST) Received: from localhost.localdomain (10.67.165.24) by DGGEMS405-HUB.china.huawei.com (10.3.19.205) with Microsoft SMTP Server id 14.3.498.0; Fri, 7 May 2021 21:10:53 +0800 From: Guangbin Huang To: , , CC: , , , , , , , , , , Subject: [RFC PATCH v2 1/2] drivers/perf: hisi: Add description for HNS3 PMU driver Date: Fri, 7 May 2021 21:08:02 +0800 Message-ID: <1620392883-16625-2-git-send-email-huangguangbin2@huawei.com> X-Mailer: git-send-email 2.8.1 In-Reply-To: <1620392883-16625-1-git-send-email-huangguangbin2@huawei.com> References: <1620392883-16625-1-git-send-email-huangguangbin2@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.67.165.24] X-CFilter-Loop: Reflected X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210507_061109_977456_A736E918 X-CRM114-Status: GOOD ( 14.92 ) 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: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org HNS3 PMU End Point device is supported on HiSilicon HIP09 platform, so add document hns3-pmu.rst to provide guidance on how to use it. Signed-off-by: Guangbin Huang --- Documentation/admin-guide/perf/hns3-pmu.rst | 129 ++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) create mode 100644 Documentation/admin-guide/perf/hns3-pmu.rst diff --git a/Documentation/admin-guide/perf/hns3-pmu.rst b/Documentation/admin-guide/perf/hns3-pmu.rst new file mode 100644 index 0000000..9695688 --- /dev/null +++ b/Documentation/admin-guide/perf/hns3-pmu.rst @@ -0,0 +1,129 @@ +====================================== +HNS3 Performance Monitoring Unit (PMU) +====================================== + +HNS3(HiSilicon network system 3) Performance Monitoring Unit (PMU) is an +End Point device to collect performance statistics of HiSilicon SoC NIC. +On Hip09, each SICL(Super I/O cluster) has one PMU device. + +HNS3 PMU is supported to collect performance statistics of bandwidth, +latency, packet rate and interrupt rate. + +Each HNS3 PMU supports up to 8 hardware events. + +HNS3 PMU driver +=============== + +The HNS3 PMU driver registers a perf PMU with the name of its device id.:: + + /sys/devices/hns3_pmu_ + +The device_id is read from hardware register, it contains information of +chip_id(bit 31:2) and SICL_ID(bit 1:0). One chip may have one or more SICL. + +PMU driver provides description of available events, filter modes, format, +identifier and cpumask in sysfs. + +The "events" directory describes the event code and subevent code of all +supported events shown in perf list. + +The "filtermode" directory describes the supported filter modes of each +event. + +The "format" directory describes all formats of the config (events) and +config1 (filter options) fields of the perf_event_attr structure. + +The "identifier" file shows version of PMU hardware device. + +Example usage of checking event code and subevent code:: + + $# cat /sys/devices/hns3_pmu_0/events/bw_igu_ssu + config=0x0000 + +The upper 8 bits of config is event code, lower 8 bits of config is +subevent code. + +Example usage of checking supported filter mode:: + + $# cat /sys/devices/hns3_pmu_0/filtermode/bw_igu_ssu + filter mode supported: global/port/port-tc/ + +Example usage of perf:: + + $# perf list + hns3_pmu_0/bw_igu_ssu/ [kernel PMU event] + ------------------------------------------ + + $# perf stat -a -e hns3_pmu_0/bw_igu_ssu,global=1/ -I 1000 + or + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,global=1/ -I 1000 + +The current driver does not support sampling. So "perf record" is unsupported. +Also attach to a task is unsupported for HNS3 PMU. + +Filter modes +-------------- + +1. global mode +PMU collect performance statistic of all functions of IO DIE. Set the +"global" filter option to 1 will enable this mode. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,global=1/ -I 1000 + +2. port mode +PMU collect performance statistic of one whole physical port. The port id +is same as mac id. The "tc" filter option must be set to 0xF in this mode. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,port=0,tc=0xF/ -I 1000 + +3. port-tc mode +PMU collect performance statistic of one tc of physical port. The port id +is same as mac id. The "tc" filter option must be set to 0 ~ 7 in this +mode. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,port=0,tc=0/ -I 1000 + +4. func mode +PMU collect performance statistic of one PF/VF. The function id is BDF of +PF/VF, its conversion formula:: + + func = (bus << 8) + (device << 3) + (function) + +for example: + BDF func + 35:00.0 0x3500 + 35:00.1 0x3501 + 35:01.0 0x3508 + +In this mode, the "queue" filter option must be set to 0xFFFF. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,bdf=0x3500,queue=0xFFFF/ -I 1000 + +5. func-queue mode +PMU collect performance statistic of one queue of PF/VF. The function id +is BDF of PF/VF, its conversion formula:: + + func = (bus << 8) + (device << 3) + (function) + +In this mode, the "queue" filter option must be set to the exact queue id +of function. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,bdf=0x3500,queue=0/ -I 1000 + + +6. func-intr mode +PMU collect performance statistic of one interrupt of PF/VF. The function +id is BDF of PF/VF, its conversion formula:: + + func = (bus << 8) + (device << 3) + (function) + +In this mode, the "intr" filter option must be set to the exact interrupt +id of function. +Example usage of perf:: + + $# perf stat -a -e hns3_pmu_0/event=0,subevent=0,bdf=0x3500,intr=0/ -I 1000