From patchwork Wed Jul 1 01:07:42 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Lunn X-Patchwork-Id: 1320181 X-Patchwork-Delegate: mkubecek@suse.cz Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=lunn.ch Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 49xNQG0YCZz9sQt for ; Wed, 1 Jul 2020 11:08:22 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726183AbgGABIR (ORCPT ); Tue, 30 Jun 2020 21:08:17 -0400 Received: from vps0.lunn.ch ([185.16.172.187]:40544 "EHLO vps0.lunn.ch" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726074AbgGABIP (ORCPT ); Tue, 30 Jun 2020 21:08:15 -0400 Received: from andrew by vps0.lunn.ch with local (Exim 4.94) (envelope-from ) id 1jqRER-00344y-51; Wed, 01 Jul 2020 03:08:11 +0200 From: Andrew Lunn To: Michal Kubecek Cc: netdev , Chris Healy , Andrew Lunn Subject: [PATCH ethtool v4 5/6] ethtool.8.in: Document the cable test commands Date: Wed, 1 Jul 2020 03:07:42 +0200 Message-Id: <20200701010743.730606-6-andrew@lunn.ch> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20200701010743.730606-1-andrew@lunn.ch> References: <20200701010743.730606-1-andrew@lunn.ch> MIME-Version: 1.0 Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Extend the man page with --cable-test and --cable-test-tdr commands. Reviewed-by: Chris Healy Signed-off-by: Andrew Lunn --- v2: Fixup some grammar/English errors. v3: More grammar/English errors fixed. --- ethtool.8.in | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/ethtool.8.in b/ethtool.8.in index 9c5f45c..60ca37c 100644 --- a/ethtool.8.in +++ b/ethtool.8.in @@ -434,6 +434,16 @@ ethtool \- query or control network driver and hardware settings .I sub_command .RB ... . +.HP +.B ethtool \-\-cable\-test +.I devname +.HP +.B ethtool \-\-cable\-test\-tdr +.I devname +.BN first N +.BN last N +.BN step N +.BN pair N . .\" Adjust lines (i.e. full justification) and hyphenate. .ad @@ -1277,6 +1287,41 @@ Sub command to apply. The supported sub commands include --show-coalesce and --coalesce. .RE .TP +q.B \-\-cable\-test +Perform a cable test and report the results. What results are returned depends +on the capabilities of the network interface. Typically open pairs and shorted +pairs can be reported, along with pairs being O.K. When a fault is detected +the approximate distance to the fault may be reported. +.TP +.B \-\-cable\-test\-tdr +Perform a cable test and report the raw Time Domain Reflectometer +data. A pulse is sent down a cable pair and the amplitude of the +reflection, for a given distance, is reported. A break in the cable +returns a big reflection. Minor damage to the cable returns a small +reflection. If the cable is shorted, the amplitude of the reflection +can be negative. By default, data is returned for lengths between 0 +and 150m at 1m steps, for all pairs. However parameters can be passed +to restrict the collection of data. It should be noted, that the +interface will round the distances to whatever granularity is actually +implemented. This is often 0.8 of a meter. The results should include +the actual rounded first and last distance and step size. +.RS 4 +.TP +.B first \ N +Distance along the cable, in meters, where the first measurement +should be made. +.TP +.B last \ N +Distance along the cable, in meters, where the last measurement should +be made. +.TP +.B step \ N +Distance, in meters, between each measurement. +.TP +.B pair \ N +Which pair should be measured. Typically a cable has 4 pairs. 0 = Pair A, 1 = Pair B, ... +.RE +.TP .B \-\-monitor Listens to netlink notification and displays them. .RS 4