Received: by 2002:a05:6a10:9848:0:0:0:0 with SMTP id x8csp3460558pxf; Mon, 29 Mar 2021 02:53:36 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxhCh+0RpcEULeKoZQuz7JQluD3tDEeWbLJrJ0hjxWCQWUCTHVi5yqX2DVEfzgdoCcuAvG9 X-Received: by 2002:a17:906:1706:: with SMTP id c6mr28269664eje.223.1617011616028; Mon, 29 Mar 2021 02:53:36 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1617011616; cv=none; d=google.com; s=arc-20160816; b=XvrUNZh9PfQTdMv3OAeCFgAwtQXqoS51HHc/1WVqMiyYRyX2DOSoWSjaT3u7TFLGWY 0eseP5n/G1IiDra/pNJSJDabqf+G/tMOgqXHGpt86BotMDguNIqDrUfNMNI1NGGiJgcp mhs7+D/Mghn84zNctUirGGxRXAYppF9YrHf7RAA415AJ3DOlX/LJDPl2hZ0C5mZ0hOP0 ZCL2CpL0aHRI2S9jKqsS3piGLIDzZa/wN3RrhYGDWztfs/tejypIhF3S3Pej5LaTHBTc Z9tChss7VDW/gcp9pTs72F9YMKoAAYg2gXwh51sjD4RBDDwYyWuNMoowfrf8l3JRmrvg m2jg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:references:in-reply-to:references:in-reply-to :message-id:date:subject:to:from:dkim-signature; bh=70ellf74jTzqp1gvld3u64Ynh47z3Ihg7usPx//ArrQ=; b=Piz3Il1On2m7x3bvxlxMyErE6rzX0zw+ILog3pVrhpPlLUky0vQTPp1zcnL10M86R8 PZ7SMzQfareCSj5eOsn/nUc4rcH6ZqojWGBk5xMgT0GstX6+SOXk/kT9vtrXsVDouUJ8 c/kBX2bzDrL5CVmM/OF2bILcSyBLktuhn9CrUoimFKT/cakw13F/nw6C0UqAd0+zCEJl xAq40/8B42uNGCv/S5Y/ofvw/adcyoZVyKzL70lQ0f69C+raygvCrFZ8aFIJsHpz1vmM 95MrNvOtdwdBQFAJ1MQKQBGbbdqEwGEsOcmlN6aorTEXbaMYycGptenh1OlM+fv522kx M+LA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=IYTMPGVv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id p17si12524164ejr.388.2021.03.29.02.53.14; Mon, 29 Mar 2021 02:53:36 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=IYTMPGVv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232448AbhC2JwQ (ORCPT + 99 others); Mon, 29 Mar 2021 05:52:16 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.73.133]:43980 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232102AbhC2Jv4 (ORCPT ); Mon, 29 Mar 2021 05:51:56 -0400 Received: from mailhost.synopsys.com (mdc-mailhost1.synopsys.com [10.225.0.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by smtprelay-out1.synopsys.com (Postfix) with ESMTPS id 4973D4046A; Mon, 29 Mar 2021 09:51:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1617011516; bh=UPhDqPJc04hZvg9p3DifXdydjic8Klb257Kr3LfwRaI=; h=From:To:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=IYTMPGVvFNEtfkcE7kywySaDF1oRkBxKwuURGzL+2s6J7n1oEjPXAU2O/YzQwipAQ ben00RubmVRcxtNX4YYmV56id/6pSZ+M11MvSZGGtA3TgEzpg4c8G3gULq9pH2OpZP fdHW25hMiC+D4ST/FWwqODmCcyB8l6CV4KpSOiWpZxzWD01hlQzv5j4lNXCe3xbXoD sn1K79b9wLqQFtQDFw/JWzsAZhVuiP/uAKVIBTegsFryVdgSw8N7rWOWP7q2GvCGzI rHaklME3tNncK4CnUaZfj67Hwud4ztxcbiVi9a/YHi7rpwoDCtcDXikOSQpkoKK2s4 4dT6aZbWgAQ0A== Received: from de02dwia024.internal.synopsys.com (de02dwia024.internal.synopsys.com [10.225.19.81]) by mailhost.synopsys.com (Postfix) with ESMTP id 0EA52A0230; Mon, 29 Mar 2021 09:51:55 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Gustavo Pimentel To: linux-doc@vger.kernel.org, linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, Derek Kiernan , Dragan Cvetic , Arnd Bergmann , Andrew Morton , Greg Kroah-Hartman , Jonathan Corbet , Bjorn Helgaas , =?UTF-8?q?Krzysztof=20Wilczy=C5=84ski?= , Gustavo Pimentel Subject: [PATCH v8 2/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver Date: Mon, 29 Mar 2021 11:51:35 +0200 Message-Id: X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add Documentation for dw-xdata-pcie driver. Signed-off-by: Gustavo Pimentel --- Documentation/misc-devices/dw-xdata-pcie.rst | 40 ++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Documentation/misc-devices/dw-xdata-pcie.rst diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst new file mode 100644 index 00000000..fd75c93 --- /dev/null +++ b/Documentation/misc-devices/dw-xdata-pcie.rst @@ -0,0 +1,40 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=========================================================================== +Driver for Synopsys DesignWare PCIe traffic generator (also known as xData) +=========================================================================== + +This driver should be used as a host-side (Root Complex) driver and Synopsys +DesignWare prototype that includes this IP. + +The "dw-xdata-pcie" driver can be used to enable/disable PCIe traffic +generator in either direction (mutual exclusion) besides allowing the +PCIe link performance analysis. + +The interaction with this driver is done through the module parameter and +can be changed in runtime. The driver outputs the requested command state +information to /var/log/kern.log or dmesg. + +Request write TLPs traffic generation - Root Complex to Endpoint direction +- Command: + echo 1 > /sys/class/misc/dw-xdata-pcie/write + +Get write TLPs traffic link throughput in MB/s +- Command: + cat /sys/class/misc/dw-xdata-pcie/write +- Output example: + 204 + +Request read TLPs traffic generation - Endpoint to Root Complex direction: +- Command: + echo 1 > /sys/class/misc/dw-xdata-pcie/read + +Get read TLPs traffic link throughput in MB/s +- Command: + cat /sys/class/misc/dw-xdata-pcie/read +- Output example: + 199 + +Request to stop any current TLP transfer: +- Command: + echo 1 > /sys/class/misc/dw-xdata-pcie/stop -- 2.7.4