[PATCH 3/3] Documentation: short descriptions for Flexnoc Performance Monitor driver

From: shubhrajyoti . datta
Date: Mon Nov 25 2019 - 06:00:20 EST


From: Shubhrajyoti Datta <shubhrajyoti.datta@xxxxxxxxxx>

Add short documentation for FlexNoc Performance Monitor driver.

Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xxxxxxxxxx>
---
Documentation/misc-devices/xilinx_flex.txt | 66 ++++++++++++++++++++++++++++++
1 file changed, 66 insertions(+)
create mode 100644 Documentation/misc-devices/xilinx_flex.txt

diff --git a/Documentation/misc-devices/xilinx_flex.txt b/Documentation/misc-devices/xilinx_flex.txt
new file mode 100644
index 0000000..c075934
--- /dev/null
+++ b/Documentation/misc-devices/xilinx_flex.txt
@@ -0,0 +1,66 @@
+Kernel driver xilinx_flex
+============================
+
+Supported chips:
+Versal SOC
+
+Author:
+ Shubhrajyoti Datta <shubhrajyoti.datta@xxxxxxxxxx>
+
+Description
+-----------
+
+Versal uses the Arteris FlexNoC interconnect instead of the ARM NIC. FlexNoC
+provides the capability to integrate performance counters in the interconnect.
+It has configurable probe points to monitor the packet and forwards it to
+observer for logging. It supports read and write transaction counts for
+request and response.
+
+Features:
+---> Run-time programmable selection of packet probe points.
+---> Recording of traffic and link statistics.
+---> Separate read and write response and request count.
+
+SYSFS:
+
+counteridfpd
+ RW - shows the counter number selected for the FPD Flexnoc.
+
+counterfpd_rdreq
+ RO - shows the read request count for the FPD counters.
+
+counterfpdsrc
+ WO - sets the source of the FPD counter.
+
+counterfpd_wrrsp
+ RO - shows the write response count for the FPD counters.
+
+counterfpd_rdrsp
+ RO - shows the read response count for the FPD counters.
+
+counterfpd_wrreq
+ RO - shows the write request count for the FPD counters.
+
+counterfpdport
+ WO - sets the port number selected for the FPD Flexnoc.
+
+counteridlpd
+ RW - shows the counter number selected for the LPD Flexnoc.
+
+counterlpdport
+ WO - sets the port number selected for the LPD Flexnoc.
+
+counterlpd_rdreq
+ RO - shows the read request count for the LPD counters.
+
+counterlpd_wrreq
+ RO - shows the write request count for the LPD counters.
+
+counterlpd_wrrsp
+ RO - shows the write response count for the LPD counters.
+
+counterlpdsrc
+ WO - sets the source of the LPD counter.
+
+counterlpd_rdrsp
+ RO - shows the read response count for the LPD counters.
--
2.1.1