Re: [PATCH v2] Documentation/ABI: update infiniband sysfs interfaces
On 2/6/2018 2:24 AM, Aishwarya Pant wrote: > Add documentation for core and hardware specific infiniband interfaces. > The descriptions have been collected from git commit logs, reading > through code and data sheets. Some drivers have incomplete doc and are > annotated with the comment '[to be documented]'. > > Signed-off-by: Aishwarya Pant Looks good. One nit below. > --- > Changes in v2: > - Move infiniband interface from testing to stable > - Fix typos > - Update description of cap_mask, port_xmit_constraint_errors and > port_rcv_constraint_errors > - Add doc for hw_counters > - Remove old documentation > > Documentation/ABI/stable/sysfs-class-infiniband | 818 > +++ > Documentation/ABI/testing/sysfs-class-infiniband | 16 - > Documentation/infiniband/sysfs.txt | 129 +--- > 3 files changed, 820 insertions(+), 143 deletions(-) > create mode 100644 Documentation/ABI/stable/sysfs-class-infiniband > delete mode 100644 Documentation/ABI/testing/sysfs-class-infiniband > > diff --git a/Documentation/ABI/stable/sysfs-class-infiniband > b/Documentation/ABI/stable/sysfs-class-infiniband > new file mode 100644 > index ..f9c709a8d0ab > --- /dev/null > +++ b/Documentation/ABI/stable/sysfs-class-infiniband > @@ -0,0 +1,818 @@ > +sysfs interface common for all infiniband devices > +- > + > +What:/sys/class/infiniband//node_type > +What:/sys/class/infiniband//node_guid > +What:/sys/class/infiniband//sys_image_guid > +Date:Apr, 2005 > +KernelVersion: v2.6.12 > +Contact: linux-r...@vger.kernel.org > +Description: > + node_type: (RO) Node type (CA, RNIC, usNIC, usNIC UDP, > + switch or router) > + > + node_guid: (RO) Node GUID > + > + sys_image_guid: (RO) System image GUID > + > + > +What:/sys/class/infiniband//node_desc > +Date:Feb, 2006 > +KernelVersion: v2.6.17 > +Contact: linux-r...@vger.kernel.org > +Description: > + (RW) Update the node description with information such as the > + node's hostname, so that IB network management software can tie > + its view to the real world. > + > + > +What:/sys/class/infiniband//fw_ver > +Date:Jun, 2016 > +KernelVersion: v4.10 > +Contact: linux-r...@vger.kernel.org > +Description: > + (RO) Display firmware version > + > + > +What:/sys/class/infiniband//ports//lid > +What:/sys/class/infiniband//ports//rate > +What: > /sys/class/infiniband//ports//lid_mask_count > +What:/sys/class/infiniband//ports//sm_sl > +What:/sys/class/infiniband//ports//sm_lid > +What:/sys/class/infiniband//ports//state > +What: > /sys/class/infiniband//ports//phys_state > +What:/sys/class/infiniband//ports//cap_mask > +Date:Apr, 2005 > +KernelVersion: v2.6.12 > +Contact: linux-r...@vger.kernel.org > +Description: > + > + lid:(RO) Port LID > + > + rate: (RO) Port data rate (active width * active > + speed) > + > + lid_mask_count: (RO) Port LID mask count > + > + sm_sl: (RO) Subnet manager SL for port's subnet > + > + sm_lid: (RO) Subnet manager LID for port's subnet > + > + state: (RO) Port state (DOWN, INIT, ARMED, ACTIVE or > + ACTIVE_DEFER) > + > + phys_state: (RO) Port physical state (Sleep, Polling, > + LinkUp, etc) > + > + cap_mask: (RO) Port capability mask. 2 bits here are > + settable- IsCommunicationManagementSupported > + (set when CM module is loaded) and IsSM (set via > + open of issmN file). > + > + > +What: > /sys/class/infiniband//ports//link_layer > +Date:Oct, 2010 > +KernelVersion: v2.6.37 > +Contact: linux-r...@vger.kernel.org > +Description: > + (RO) Link layer type information (Infiniband or Ethernet type) > + > + > +What: > /sys/class/infiniband//ports//counters/symbol_error > +What: > /sys/class/infiniband//ports//counters/port_rcv_errors > +What: > /sys/class/infiniband//ports//counters/port_rcv_remote_physical_errors > +What: > /sys/class/infiniband//ports//counters/port_rcv_switch_relay_errors > +What: > /sys/class/infiniband//ports//counters/link_error_recovery > +What: > /sys/class/infiniband//ports//counters/port_xmit_constraint_errors > +What: > /sys/class/infiniband//
[PATCH v2] Documentation/ABI: update infiniband sysfs interfaces
Add documentation for core and hardware specific infiniband interfaces. The descriptions have been collected from git commit logs, reading through code and data sheets. Some drivers have incomplete doc and are annotated with the comment '[to be documented]'. Signed-off-by: Aishwarya Pant --- Changes in v2: - Move infiniband interface from testing to stable - Fix typos - Update description of cap_mask, port_xmit_constraint_errors and port_rcv_constraint_errors - Add doc for hw_counters - Remove old documentation Documentation/ABI/stable/sysfs-class-infiniband | 818 +++ Documentation/ABI/testing/sysfs-class-infiniband | 16 - Documentation/infiniband/sysfs.txt | 129 +--- 3 files changed, 820 insertions(+), 143 deletions(-) create mode 100644 Documentation/ABI/stable/sysfs-class-infiniband delete mode 100644 Documentation/ABI/testing/sysfs-class-infiniband diff --git a/Documentation/ABI/stable/sysfs-class-infiniband b/Documentation/ABI/stable/sysfs-class-infiniband new file mode 100644 index ..f9c709a8d0ab --- /dev/null +++ b/Documentation/ABI/stable/sysfs-class-infiniband @@ -0,0 +1,818 @@ +sysfs interface common for all infiniband devices +- + +What: /sys/class/infiniband//node_type +What: /sys/class/infiniband//node_guid +What: /sys/class/infiniband//sys_image_guid +Date: Apr, 2005 +KernelVersion: v2.6.12 +Contact: linux-r...@vger.kernel.org +Description: + node_type: (RO) Node type (CA, RNIC, usNIC, usNIC UDP, + switch or router) + + node_guid: (RO) Node GUID + + sys_image_guid: (RO) System image GUID + + +What: /sys/class/infiniband//node_desc +Date: Feb, 2006 +KernelVersion: v2.6.17 +Contact: linux-r...@vger.kernel.org +Description: + (RW) Update the node description with information such as the + node's hostname, so that IB network management software can tie + its view to the real world. + + +What: /sys/class/infiniband//fw_ver +Date: Jun, 2016 +KernelVersion: v4.10 +Contact: linux-r...@vger.kernel.org +Description: + (RO) Display firmware version + + +What: /sys/class/infiniband//ports//lid +What: /sys/class/infiniband//ports//rate +What: /sys/class/infiniband//ports//lid_mask_count +What: /sys/class/infiniband//ports//sm_sl +What: /sys/class/infiniband//ports//sm_lid +What: /sys/class/infiniband//ports//state +What: /sys/class/infiniband//ports//phys_state +What: /sys/class/infiniband//ports//cap_mask +Date: Apr, 2005 +KernelVersion: v2.6.12 +Contact: linux-r...@vger.kernel.org +Description: + + lid:(RO) Port LID + + rate: (RO) Port data rate (active width * active + speed) + + lid_mask_count: (RO) Port LID mask count + + sm_sl: (RO) Subnet manager SL for port's subnet + + sm_lid: (RO) Subnet manager LID for port's subnet + + state: (RO) Port state (DOWN, INIT, ARMED, ACTIVE or + ACTIVE_DEFER) + + phys_state: (RO) Port physical state (Sleep, Polling, + LinkUp, etc) + + cap_mask: (RO) Port capability mask. 2 bits here are + settable- IsCommunicationManagementSupported + (set when CM module is loaded) and IsSM (set via + open of issmN file). + + +What: /sys/class/infiniband//ports//link_layer +Date: Oct, 2010 +KernelVersion: v2.6.37 +Contact: linux-r...@vger.kernel.org +Description: + (RO) Link layer type information (Infiniband or Ethernet type) + + +What: /sys/class/infiniband//ports//counters/symbol_error +What: /sys/class/infiniband//ports//counters/port_rcv_errors +What: /sys/class/infiniband//ports//counters/port_rcv_remote_physical_errors +What: /sys/class/infiniband//ports//counters/port_rcv_switch_relay_errors +What: /sys/class/infiniband//ports//counters/link_error_recovery +What: /sys/class/infiniband//ports//counters/port_xmit_constraint_errors +What: /sys/class/infiniband//ports//counters/port_rcv_contraint_errors +What: /sys/class/infiniband//ports//counters/local_link_integrity_errors +What: /sys/class/infiniband//ports//counters/excessive_buffer_overrun_errors +What: /sys/class/infiniband//ports//counters/port_xmit_data +What: /sys/class/infiniband//ports//counters/port_rcv_data +What: /sys/class/infiniband//ports//counters/port_xmit_packets +What: /sys/class/inf
